cisco.catalystcenter.iot_rep_rings_id_info module -- Information module for Iot Rep Rings Id

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

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

New in cisco.catalystcenter 6.18.0

Synopsis

  • Get Iot Rep Rings Id by id. - > This API returns REP ring for the given id The id of configured REP ring can be retrieved using the API /dna/intent/api/v1/iot/repRings/query .

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

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

headers

dictionary

Additional headers.

id

string

Id path parameter. Ring ID of configured REP ring can be fetched using the API `/dna/intent/api/v1/iot/repRings/query`.

validate_response_schema

boolean

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.get_the_r_e_p_ring_based_on_the_ring_id,

  • Paths used are get /dna/intent/api/v1/iot/repRings/{id},

  • Supports check_mode

  • The 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 GetTheREPRingBasedOnTheRingId

Complete reference of the GetTheREPRingBasedOnTheRingId API.

Examples

---
- name: Get Iot Rep Rings Id by id
  cisco.catalystcenter.iot_rep_rings_id_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    headers: "{{my_headers | from_json}}"
    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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"response\\": [\\n {\\n \\"id\\": \\"string\\",\\n \\"rootNetworkDeviceId\\": \\"string\\",\\n \\"rootNeighbourNetworkDeviceIds\\": [\\n \\"string\\"\\n ],\\n \\"status\\": \\"string\\",\\n \\"repSegmentId\\": 0,\\n \\"deploymentMode\\": \\"string\\",\\n \\"ringName\\": \\"string\\",\\n \\"ringMembers\\": [\\n {\\n \\"networkDeviceId\\": \\"string\\",\\n \\"nodeName\\": \\"string\\",\\n \\"portName1\\": \\"string\\",\\n \\"portName2\\": \\"string\\",\\n \\"ringOrder\\": 0\\n }\\n ]\\n }\\n ],\\n \\"version\\": 0\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)