cisco.catalystcenter.iot_fabric_rep_rings_delete module -- Resource module for Iot Fabric Rep Rings Delete

Note

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

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

New in cisco.catalystcenter 2.3.0

Synopsis

  • Manage operation delete of the resource Iot Fabric Rep Rings Delete. - > This API deletes the REP ring configured in the FABRIC deployment 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.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

forceDelete

boolean

ForceDelete query parameter. When set as true, REP Ring force delete will be invoked. `Force Delete` is supported only after REP Ring delete has been attempted and has either failed or partially completed where REP configurations are not cleared from all the REP Ring members. Force Delete of REP Ring would delete the REP Ring from Catalyst center alone, it would not remove REP configurations from any REP Ring members. Manual cleanup would be needed to clear REP configuration on the failed or unreachable devices.

Choices:

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

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

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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Industrial Configuration DeleteREPRingConfiguredInTheFABRICDeployment

Complete reference of the DeleteREPRingConfiguredInTheFABRICDeployment API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.iot_fabric_rep_rings_delete:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    forceDelete: true
    id: 0bb11acd-5f3f-42bd-9509-8d7c8891aa84

Return Values

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

Key

Description

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)