.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.endpoint_analytics_endpoints_info module -- Information module for Endpoint Analytics Endpoints Info +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.27.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.endpoint_analytics_endpoints_info`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.16.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module endpoint\_analytics\_endpoints\_v1\_info .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-aispoofingtrustlevel: .. rst-class:: ansible-option-title **aiSpoofingTrustLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AiSpoofingTrustLevel query parameter. Trust level of the endpoint due to AI spoofing. Possible values are 'low', 'medium', 'high'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-ancpolicy: .. rst-class:: ansible-option-title **ancPolicy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AncPolicy query parameter. ANC policy. Only exact match will be returned. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-authmethod: .. rst-class:: ansible-option-title **authMethod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AuthMethod query parameter. Authentication method. Partial string is allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-changedprofiletrustlevel: .. rst-class:: ansible-option-title **changedProfileTrustLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ChangedProfileTrustLevel query parameter. Trust level of the endpoint due to changing profile labels. Possible values are 'low', 'medium', 'high'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-concurrentmactrustlevel: .. rst-class:: ansible-option-title **concurrentMacTrustLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ConcurrentMacTrustLevel query parameter. Trust level of the endpoint due to concurrent MAC address. Possible values are 'low', 'medium', 'high'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-devicetype: .. rst-class:: ansible-option-title **deviceType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
DeviceType query parameter. Type of device to search for. Partial string is allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-epid: .. rst-class:: ansible-option-title **epId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
EpId path parameter. Unique identifier for the endpoint. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-hardwaremanufacturer: .. rst-class:: ansible-option-title **hardwareManufacturer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HardwareManufacturer query parameter. Hardware manufacturer to search for. Partial string is allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-hardwaremodel: .. rst-class:: ansible-option-title **hardwareModel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HardwareModel query parameter. Hardware model to search for. Partial string is allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-ip: .. rst-class:: ansible-option-title **ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ip query parameter. IP address to search for. Partial string is allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-ipblocklistdetected: .. rst-class:: ansible-option-title **ipBlocklistDetected** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IpBlocklistDetected query parameter. Flag to fetch endpoints hitting IP blocklist or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-macaddress: .. rst-class:: ansible-option-title **macAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
MacAddress query parameter. MAC address to search for. Partial string is allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-macaddresses: .. rst-class:: ansible-option-title **macAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
MacAddresses query parameter. List of MAC addresses to filter on. Only exact matches will be returned. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-nattrustlevel: .. rst-class:: ansible-option-title **natTrustLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NatTrustLevel query parameter. Trust level of the endpoint due to NAT access. Possible values are 'low', 'medium', 'high'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Offset query parameter. Record offset to start data fetch at. Offset starts at zero. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-operatingsystem: .. rst-class:: ansible-option-title **operatingSystem** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
OperatingSystem query parameter. Operating system to search for. Partial string is allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Order query parameter. Order to be used for sorting. Possible values are 'asc', 'desc'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-posturestatus: .. rst-class:: ansible-option-title **postureStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
PostureStatus query parameter. Posture status. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-profilingstatus: .. rst-class:: ansible-option-title **profilingStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ProfilingStatus query parameter. Profiling status of the endpoint. Possible values are 'profiled', 'partialProfiled', 'notProfiled'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-randommac: .. rst-class:: ansible-option-title **randomMac** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
RandomMac query parameter. Flag to fetch endpoints having randomized MAC or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-registered: .. rst-class:: ansible-option-title **registered** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Registered query parameter. Flag to fetch manually registered or non-registered endpoints. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-sortby: .. rst-class:: ansible-option-title **sortBy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-trustscore: .. rst-class:: ansible-option-title **trustScore** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-unauthportdetected: .. rst-class:: ansible-option-title **unauthPortDetected** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
UnauthPortDetected query parameter. Flag to fetch endpoints exposing unauthorized ports or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__parameter-weakcreddetected: .. rst-class:: ansible-option-title **weakCredDetected** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
WeakCredDetected query parameter. Flag to fetch endpoints having weak credentials or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`check\_mode`\ - The 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 .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.endpoint_analytics_endpoints_info_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"ancPolicy": "string", "attributes": {}, "deviceType": ["string"], "duid": "string", "granularAncPolicy": [{"name": "string", "nasIpAddress": "string"}], "hardwareManufacturer": ["string"], "hardwareModel": ["string"], "id": "string", "lastProbeCollectionTimestamp": 0, "macAddress": "string", "operatingSystem": ["string"], "randomMac": true, "registered": true, "trustData": {"aiSpoofingTrustLevel": "string", "authMethod": "string", "changedProfileTrustLevel": "string", "concurrentMacTrustLevel": "string", "ipBlocklistDetected": true, "natTrustLevel": "string", "postureStatus": "string", "trustScore": 0, "unauthPortDetected": true, "weakCredDetected": true}}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors