cisco.dnac.endpoint_analytics_endpoints_count_v1_info module -- Information module for Endpoint Analytics Endpoints Count V1

Note

This module is part of the cisco.dnac collection (version 6.30.0).

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_count_v1_info.

New in cisco.dnac 6.16.0

Synopsis

  • Get all Endpoint Analytics Endpoints Count V1.

  • Fetch the total count of endpoints that match the given filter criteria.

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

string

AiSpoofingTrustLevel query parameter. Trust level of the endpoint due to AI spoofing. Possible values are 'low', 'medium', 'high'.

ancPolicy

string

AncPolicy query parameter. ANC policy. Only exact match will be returned.

authMethod

string

AuthMethod query parameter. Authentication method. Partial string is allowed.

changedProfileTrustLevel

string

ChangedProfileTrustLevel query parameter. Trust level of the endpoint due to changing profile labels. Possible values are 'low', 'medium', 'high'.

concurrentMacTrustLevel

string

ConcurrentMacTrustLevel query parameter. Trust level of the endpoint due to concurrent MAC address. Possible values are 'low', 'medium', 'high'.

deviceType

string

DeviceType query parameter. Type of device to search for. Partial string is allowed.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

hardwareManufacturer

string

HardwareManufacturer query parameter. Hardware manufacturer to search for. Partial string is allowed.

hardwareModel

string

HardwareModel query parameter. Hardware model to search for. Partial string is allowed.

headers

dictionary

Additional headers.

ip

string

Ip query parameter. IP address to search for. Partial string is allowed.

ipBlocklistDetected

boolean

IpBlocklistDetected query parameter. Flag to fetch endpoints hitting IP blocklist or not.

Choices:

macAddress

string

MacAddress query parameter. MAC address to search for. Partial string is allowed.

macAddresses

list / elements=string

MacAddresses query parameter. List of MAC addresses to filter on. Only exact matches will be returned.

natTrustLevel

string

NatTrustLevel query parameter. Trust level of the endpoint due to NAT access. Possible values are 'low', 'medium', 'high'.

operatingSystem

string

OperatingSystem query parameter. Operating system to search for. Partial string is allowed.

postureStatus

string

PostureStatus query parameter. Posture status.

profilingStatus

string

ProfilingStatus query parameter. Profiling status of the endpoint. Possible values are 'profiled', 'partialProfiled', 'notProfiled'.

randomMac

boolean

RandomMac query parameter. Flag to fetch endpoints having randomized MAC or not.

Choices:

registered

boolean

Registered query parameter. Flag to fetch manually registered or non-registered endpoints.

Choices:

trustScore

string

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

boolean

UnauthPortDetected query parameter. Flag to fetch endpoints exposing unauthorized ports or not.

Choices:

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

weakCredDetected

boolean

WeakCredDetected query parameter. Flag to fetch endpoints having weak credentials or not.

Choices:

Notes

Note

  • SDK Method used are a_i_endpoint_analytics.AIEndpointAnalytics.fetch_the_count_of_endpoints_v1,

  • Paths used are get /dna/intent/api/v1/endpoint-analytics/endpoints/count,

  • Supports 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

See Also

See also

Cisco DNA Center documentation for AI Endpoint Analytics FetchTheCountOfEndpointsV1

Complete reference of the FetchTheCountOfEndpointsV1 API.

Examples

- name: Get all Endpoint Analytics Endpoints Count V1
  cisco.dnac.endpoint_analytics_endpoints_count_v1_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
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"count": 0}`

Authors

  • Rafael Campos (@racampos)