cisco.dnac.endpoint_analytics_endpoints_info module – Information module for Endpoint Analytics Endpoints Info
Note
This module is part of the cisco.dnac collection (version 6.31.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.endpoint_analytics_endpoints_info.
New in cisco.dnac 6.16.0
Synopsis
This module represents an alias of the module endpoint_analytics_endpoints_v1_info
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
AiSpoofingTrustLevel query parameter. Trust level of the endpoint due to AI spoofing. Possible values are ‘low’, ‘medium’, ‘high’. |
|
AncPolicy query parameter. ANC policy. Only exact match will be returned. |
|
AuthMethod query parameter. Authentication method. Partial string is allowed. |
|
ChangedProfileTrustLevel query parameter. Trust level of the endpoint due to changing profile labels. Possible values are ‘low’, ‘medium’, ‘high’. |
|
ConcurrentMacTrustLevel query parameter. Trust level of the endpoint due to concurrent MAC address. Possible values are ‘low’, ‘medium’, ‘high’. |
|
DeviceType query parameter. Type of device to search for. Partial string is allowed. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
EpId path parameter. Unique identifier for the endpoint. |
|
HardwareManufacturer query parameter. Hardware manufacturer to search for. Partial string is allowed. |
|
HardwareModel query parameter. Hardware model to search for. Partial string is allowed. |
|
Additional headers. |
|
Include query parameter. The datasets that should be included in the response. By default, value of this parameter is blank, and the response will include only basic details of the endpoint. To include other datasets or dictionaries, send comma separated list of following values ‘ALL’ - Include all attributes. ‘CDP’, ‘DHCP’, etc. - Include attributes from given dictionaries. To get full list of dictionaries, use corresponding GET API. ‘ANC’ - Include ANC policy related details. ‘TRUST’ - Include trust score details. |
|
Ip query parameter. IP address to search for. Partial string is allowed. |
|
IpBlocklistDetected query parameter. Flag to fetch endpoints hitting IP blocklist or not. Choices:
|
|
Limit query parameter. Maximum number of records to be fetched. If not provided, 50 records will be fetched by default. Maximum 1000 records can be fetched at a time. Use pagination if more records need to be fetched. |
|
MacAddress query parameter. MAC address to search for. Partial string is allowed. |
|
MacAddresses query parameter. List of MAC addresses to filter on. Only exact matches will be returned. |
|
NatTrustLevel query parameter. Trust level of the endpoint due to NAT access. Possible values are ‘low’, ‘medium’, ‘high’. |
|
Offset query parameter. Record offset to start data fetch at. Offset starts at zero. |
|
OperatingSystem query parameter. Operating system to search for. Partial string is allowed. |
|
Order query parameter. Order to be used for sorting. Possible values are ‘asc’, ‘desc’. |
|
PostureStatus query parameter. Posture status. |
|
ProfilingStatus query parameter. Profiling status of the endpoint. Possible values are ‘profiled’, ‘partialProfiled’, ‘notProfiled’. |
|
RandomMac query parameter. Flag to fetch endpoints having randomized MAC or not. Choices:
|
|
Registered query parameter. Flag to fetch manually registered or non-registered endpoints. Choices:
|
|
SortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. Possible values are ‘macAddress’, ‘ip’. |
|
TrustScore query parameter. Overall trust score of the endpoint. It can be provided either as a number value (e.g. 5), or as a range (e.g. 3-7). Provide value as ‘-’ if you want to search for all endpoints where trust score is not assigned. |
|
UnauthPortDetected query parameter. Flag to fetch endpoints exposing unauthorized ports or not. Choices:
|
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
WeakCredDetected query parameter. Flag to fetch endpoints having weak credentials or not. Choices:
|
Notes
Note
SDK Method used are a_i_endpoint_analytics.AIEndpointAnalytics.get_endpoint_details_v1, a_i_endpoint_analytics.AIEndpointAnalytics.query_the_endpoints_v1,
Paths used are get /dna/intent/api/v1/endpoint-analytics/endpoints, get /dna/intent/api/v1/endpoint-analytics/endpoints/{epId},
It should be noted that this module is an alias of endpoint_analytics_endpoints_v1_info
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for AI Endpoint Analytics GetEndpointDetailsV1
Complete reference of the GetEndpointDetailsV1 API.
- Cisco DNA Center documentation for AI Endpoint Analytics QueryTheEndpointsV1
Complete reference of the QueryTheEndpointsV1 API.
Examples
- name: Get all Endpoint Analytics Endpoints Info
cisco.dnac.endpoint_analytics_endpoints_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
profilingStatus: string
macAddress: string
macAddresses: []
ip: string
deviceType: string
hardwareManufacturer: string
hardwareModel: string
operatingSystem: string
registered: true
randomMac: true
trustScore: string
authMethod: string
postureStatus: string
aiSpoofingTrustLevel: string
changedProfileTrustLevel: string
natTrustLevel: string
concurrentMacTrustLevel: string
ipBlocklistDetected: true
unauthPortDetected: true
weakCredDetected: true
ancPolicy: string
limit: 0
offset: 0
sortBy: string
order: string
include: string
register: result
- name: Get Endpoint Analytics Endpoints Info by id
cisco.dnac.endpoint_analytics_endpoints_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
include: string
epId: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |