Skip to content

Latest commit

 

History

History
136 lines (98 loc) · 5.74 KB

IntentDetailApi.md

File metadata and controls

136 lines (98 loc) · 5.74 KB

dnac_api_client.IntentDetailApi

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_network_device_detail_get GET /dna/intent/api/v1/network-device-detail Network Device Detail

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.IntentDetailApi(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 IntentDetailApi->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_network_device_detail_get

NetworkDeviceDetailResponse dna_intent_api_v1_network_device_detail_get(runsync=runsync, timeout=timeout, timestamp=timestamp, search_by=search_by, identifier=identifier)

Network Device Detail

Get Network Device Detail

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.IntentDetailApi(dnac_api_client.ApiClient(configuration))
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)
timestamp = 'timestamp_example' # str | timestamp (optional)
search_by = 'search_by_example' # str | MAC Address or UUID or Name of the Device (optional)
identifier = 'identifier_example' # str | macAddress or uuid or nwDeviceName (optional)

try:
    # Network Device Detail
    api_response = api_instance.dna_intent_api_v1_network_device_detail_get(runsync=runsync, timeout=timeout, timestamp=timestamp, search_by=search_by, identifier=identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntentDetailApi->dna_intent_api_v1_network_device_detail_get: %s\n" % e)

Parameters

Name Type Description Notes
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]
timestamp str timestamp [optional]
search_by str MAC Address or UUID or Name of the Device [optional]
identifier str macAddress or uuid or nwDeviceName [optional]

Return type

NetworkDeviceDetailResponse

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]