cisco.catalystcenter.iot_rep_rings_query module -- Resource module for Iot Rep Rings Query
Note
This module is part of the cisco.catalystcenter collection (version 2.2.2).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.iot_rep_rings_query.
New in cisco.catalystcenter 6.18.0
Synopsis
Manage operation create of the resource Iot Rep Rings Query. - > This API returns the list of REP rings for the given fields - networkDeviceId Network device ID of the REP ring member. In case of successful REP ring creation, any of the REP ring member networkDeviceId can be provided. In case of failed REP ring creation, provide only root node networkDeviceId. The networkDeviceId is the instanceUuid attribute in the response of API - /dna/intent/api/v1/networkDevice 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.
catalystcentersdk >= 3.1.3.0.0
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Deployment mode of the configured REP ring. |
|
The number of records to show for this page. |
|
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. |
|
The first record to show for this page; the first record is numbered 1. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are industrial_configuration.IndustrialConfiguration.retrieves_the_list_of_r_e_p_rings,
Paths used are post /dna/intent/api/v1/iot/repRings/query,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
See Also
See also
- Cisco DNA Center documentation for Industrial Configuration RetrievesTheListOfREPRings
Complete reference of the RetrievesTheListOfREPRings API.
Examples
---
- name: Create
cisco.catalystcenter.iot_rep_rings_query:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_api_port: "{{catalystcenter_api_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
deploymentMode: string
limit: 0
networkDeviceId: string
offset: 0
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always |