Skip to content

Latest commit

 

History

History
134 lines (96 loc) · 5.36 KB

IntentClientsApi.md

File metadata and controls

134 lines (96 loc) · 5.36 KB
Raw

dnac_api_client.IntentClientsApi

All URIs are relative to http://localhost

Method HTTP request Description
dna_intent_api_v1_client_detail_get GET /dna/intent/api/v1/client-detail Client Detail
dna_intent_api_v1_client_health_get GET /dna/intent/api/v1/client-health Client Health

dna_intent_api_v1_client_detail_get

ClientDetailResponse dna_intent_api_v1_client_detail_get(timestamp, mac_address, runsync=runsync, timeout=timeout)

Client Detail

Get Client Details for a single client

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentClientsApi(dnac_api_client.ApiClient(configuration))
timestamp = 'timestamp_example' # str | timestamp
mac_address = 'mac_address_example' # str | MAC Address of the client
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Client Detail
    api_response = api_instance.dna_intent_api_v1_client_detail_get(timestamp, mac_address, runsync=runsync, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntentClientsApi->dna_intent_api_v1_client_detail_get: %s\n" % e)

Parameters

Name Type Description Notes
timestamp str timestamp
mac_address str MAC Address of the client
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

ClientDetailResponse

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_client_health_get

ClientHealthResponse dna_intent_api_v1_client_health_get(start_time, end_time, runsync=runsync, timeout=timeout)

Client Health

Get overall Client Health along with beak down on categories of wired and wireless

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentClientsApi(dnac_api_client.ApiClient(configuration))
start_time = 'start_time_example' # str | Start Time
end_time = 'end_time_example' # str | End Time
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Client Health
    api_response = api_instance.dna_intent_api_v1_client_health_get(start_time, end_time, runsync=runsync, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntentClientsApi->dna_intent_api_v1_client_health_get: %s\n" % e)

Parameters

Name Type Description Notes
start_time str Start Time
end_time str End Time
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

ClientHealthResponse

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]