cisco.dnac.iot_rep_rings_query_count module -- Resource module for Iot Rep Rings Query Count

Note

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

New in cisco.dnac 6.18.0

Synopsis

• Manage operation create of the resource Iot Rep Rings Query Count. - > This API returns the count of REP rings for the given fields - networkDeviceId Network device ID of the REP ring member. The networkDeviceId is the instanceUuid attribute in the response of API - /dna/intent/api/v1/networkDevices and deploymentMode FABRIC/NON_FABRIC .

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.11.0

• python >= 3.12

Parameters

Parameter	Comments
deploymentMode string	Deployment mode of the configured REP ring.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"`
networkDeviceId string	Network device id of the REP ring member. API `/dna/intent/api/v1/networkDevices` can be used to get the list of networkDeviceIds of the neighbors , `instanceUuid` attribute in the response contains networkDeviceId.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are industrial_configuration.IndustrialConfiguration.retrieves_the_count_of_r_e_p_rings,

• Paths used are post /dna/intent/api/v1/iot/repRings/query/count,

• Does not support 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 Industrial Configuration RetrievesTheCountOfREPRings

Complete reference of the RetrievesTheCountOfREPRings API.

Examples

---
- name: Create
  cisco.dnac.iot_rep_rings_query_count:
    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}}"
    deploymentMode: string
    networkDeviceId: string

Return Values

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

Key	Description
dnac_response list / elements=string	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`["[\\n {\\n \\"response\\": [\\n {\\n \\"count\\": 0\\n }\\n ]", "\\n \\"version\\": 0\\n }\\n]\\n"]`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)