cisco.dnac.network_devices_intent_count_info module -- Information module for Network Devices Intent Count Info

Note

This module is part of the cisco.dnac collection (version 6.27.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.network_devices_intent_count_info.

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module network_devices_intent_count_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

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"`

family

string

Family query parameter. Product family of the network device. For example, Switches, Routers, etc.

headers

dictionary

Additional headers.

id

string

Id query parameter. Network device Id.

managementAddress

string

ManagementAddress query parameter. Management address of the network device.

managementState

string

ManagementState query parameter. The status of the network device's manageability. Available values MANAGED, UNDER_MAINTENANCE, NEVER_MANAGED. Refer features for more details.

reachabilityStatus

string

ReachabilityStatus query parameter. Reachability status of the network device. Available values REACHABLE, ONLY_PING_REACHABLE, UNREACHABLE, UNKNOWN. Refer features for more details.

role

string

Role query parameter. Role assigned to the network device. Available values BORDER_ROUTER, CORE, DISTRIBUTION, ACCESS, UNKNOWN.

serialNumber

string

SerialNumber query parameter. Serial number of the network device.

stackDevice

string

StackDevice query parameter. Flag indicating if the device is a stack device.

status

string

Status query parameter. Inventory related status of the network device. Available values MANAGED, SYNC_NOT_STARTED, SYNC_INIT_FAILED, SYNC_PRECHECK_FAILED, SYNC_IN_PROGRESS, SYNC_INTERNAL_ERROR, SYNC_DISABLED, DELETING_DEVICE, UNDER_MAINTENANCE, QUARANTINED, UNASSOCIATED, UNREACHABLE, UNKNOWN. Refer features for more details.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are devices.Devices.count_the_number_of_network_devices_v1,

  • Paths used are get /dna/intent/api/v1/networkDevices/count,

  • It should be noted that this module is an alias of network_devices_intent_count_v1_info

  • 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 Devices CountTheNumberOfNetworkDevicesV1

Complete reference of the CountTheNumberOfNetworkDevicesV1 API.

Examples

- name: Get all Network Devices Intent Count Info
  cisco.dnac.network_devices_intent_count_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}}"
    id: string
    managementAddress: string
    serialNumber: string
    family: string
    stackDevice: string
    role: string
    status: string
    reachabilityStatus: string
    managementState: 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:`{"response": {"count": 0}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)