cisco.dnac.network_devices_count_v1_info module – Information module for Network Devices Count V1

Note

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

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

New in cisco.dnac 6.15.0

Synopsis 

Get all Network Devices Count V1.
Gets the total Network device counts. When there is no start and end time specified returns the latest interfaces total count. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-1.0.2-resolved.yaml.

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
attribute string	Attribute query parameter. The List of Network Device model attributes. This is helps to specify the interested fields in the request.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: `false` ← (default) `true`
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: `443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: `"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: `false` `true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: `"2.3.7.6"`
endTime float	EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
family string	Family query parameter. The list of network device family names Examples family=Switches and Hubs (single network device family name )family=Switches and Hubs&family=Router&family=Wireless Controller (multiple Network device family names with & separator). This field is not case sensitive.
headers dictionary	Additional headers.
healthScore string	HealthScore query parameter. The list of entity health score categories Examples healthScore=good,healthScore=good&healthScore=fair (multiple entity healthscore values with & separator). This field is not case sensitive.
id string	Id query parameter. The list of entity Uuids. (Ex.”6bef213c-19ca-4170-8375-b694e251101c”) Examples id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca-4170-8375- b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with ‘&’ separator).
macAddress string	MacAddress query parameter. The macAddress of the network device or client This field supports wildcard (``) character-based search. Ex `AB AB AB` or `AB AB AB` or `*AB AB AB` Examples `macAddress=AB AB AB CD CD CD` (single macAddress requested) `macAddress=AB AB AB CD CD DC&macAddress=AB AB AB CD CD FE` (multiple macAddress requested).
maintenanceMode boolean	MaintenanceMode query parameter. The device maintenanceMode status true or false. Choices: `false` `true`
managementIpAddress string	ManagementIpAddress query parameter. The list of entity management IP Address. It can be either Ipv4 or Ipv6 address or combination of both(Ex. “121.1.1.10”) This field supports wildcard (``) character-based search. Ex `1.1` or `1.1` or `*1.1` Examples managementIpAddresses=121.1.1.10 managementIpAddresses=121.1.1.10&managementIpAddresses=172.20.1.10&managementIpAddresses=200 10&=managementIpAddresses172.20.3.4 (multiple entity IP Address with & separator).
role string	Role query parameter. The list of network device role. Examples role=CORE, role=CORE&role=ACCESS&role=ROUTER (multiple Network device roles with & separator). This field is not case sensitive.
serialNumber string	SerialNumber query parameter. The list of network device serial numbers. This field supports wildcard (``) character-based search. Ex `MS1SV` or `MS1SV` or `*MS1SV` Examples serialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX(multiple Network device serial number with & separator).
siteHierarchy string	SiteHierarchy query parameter. The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named “Global” (Ex. `Global/AreaName/BuildingName/FloorName`) This field supports wildcard asterisk () character search support. E.g. /San, /San, /San* Examples `?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested) `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaNam e2/BuildingName2/FloorName2` (multiple siteHierarchies requested).
siteHierarchyId string	SiteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`) This field supports wildcard asterisk () character search support. E.g. `uuid, uuid, uuid* Examples `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHiera rchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUu id2` (multiple siteHierarchyIds requested).
siteId string	SiteId query parameter. The UUID of the site. (Ex. `flooruuid`) This field supports wildcard asterisk () character search support. E.g.flooruuid, flooruuid, flooruuid* Examples `?siteId=id1` (single id requested) `?siteId=id1&siteId=id2&siteId=id3` (multiple ids requested).
softwareVersion string	SoftwareVersion query parameter. The list of network device software version This field supports wildcard (``) character-based search. Ex `17.8` or `17.8` or `17.8` Examples softwareVersion=2.3.4.0 (single network device software version ) softwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=.17.7 (multiple Network device software versions with & separator).
startTime float	StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If `startTime` is not provided, API will default to current time.
type string	Type query parameter. The list of network device type This field supports wildcard (``) character-based search. Ex `9407R` or `9407R` or `9407R*`Examples type=SwitchesCisco Catalyst 9407R Switch (single network device types )type=Cisco Catalyst 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2 (multiple Network device types with & separator).
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: `false` `true` ← (default)
view string	View query parameter. The List of Network Device model views. Please refer to ```NetworkDeviceView``` for the supported list.

Notes 

Note

SDK Method used are devices.Devices.gets_the_total_network_device_counts_based_on_the_provided_query_parameters_v1,
Paths used are get /dna/data/api/v1/networkDevices/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

Examples 

- name: Get all Network Devices Count V1
  cisco.dnac.network_devices_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}}"
    startTime: 0
    endTime: 0
    id: string
    siteHierarchy: string
    siteHierarchyId: string
    siteId: string
    managementIpAddress: string
    macAddress: string
    family: string
    type: string
    role: string
    serialNumber: string
    maintenanceMode: True
    softwareVersion: string
    healthScore: string
    view: string
    attribute: 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: `{"response": {"count": 0}, "version": "string"}`

Authors

Rafael Campos (@racampos)

cisco.dnac.network_devices_count_v1_info module – Information module for Network Devices Count V1

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 

Authors

Collection links

cisco.dnac.network_devices_count_v1_info module – Information module for Network Devices Count V1

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 