cisco.dnac.transit_network_health_summaries_count_v1_info module – Information module for Transit Network Health Summaries Count V1

Note

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

New in cisco.dnac 6.17.0

Synopsis

• Get all Transit Network Health Summaries Count V1.

• Get a count of transit networks. Use available query parameters to get the count of a subset of transit networks.

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: 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.
headers dictionary	Additional headers.
id string	Id query parameter. The list of transit entity ids. (Ex “1551156a-bc97-3c63-aeda-8a6d3765b5b9”) Examples id=1551156a-bc97-3c63-aeda-8a6d3765b5b9 (single entity uuid requested) id=1551156a-bc97-3c63-aeda-8a6d3765b5b9&id=4aa20652-237c-4625-b2b4-fd7e82b6a81e (multiple entity uuids 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.
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)

Notes

Note

• SDK Method used are sda.Sda.read_transit_networks_count_v1,

• Paths used are get /dna/data/api/v1/transitNetworkHealthSummaries/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 SDA ReadTransitNetworksCountV1

Complete reference of the ReadTransitNetworksCountV1 API.

Examples

- name: Get all Transit Network Health Summaries Count V1
  cisco.dnac.transit_network_health_summaries_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
  register: result

Return Values

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

Key	Description
dnac_response list / elements=dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: "[\n  {\n    \"errorCode\": 0,\n    \"message\": \"string\",\n    \"detail\": \"string\"\n  }\n]\n"

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)