cisco.catalystcenter.security_service_insertion_fabric_sites_readiness_info module -- Information module for Security Service Insertion Fabric Sites Readiness

Note

This module is part of the cisco.catalystcenter collection (version 2.11.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.security_service_insertion_fabric_sites_readiness_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Security Service Insertion Fabric Sites Readiness.

  • Get Security Service Insertion Fabric Sites Readiness by id. - > Gets a list of SDA virtual networks for the specified fabric site, including their individual readiness status for Security Service Insertion SSI deployment.

  • Retrieves a list of all SDA fabric sites along with their readiness status for.

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"`

headers

dictionary

Additional headers.

id

string

Id path parameter. Sda fabric site id.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

sortBy

string

SortBy query parameter. Sort results by the fabric site name.

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 sda.Sda.readiness_status_for_a_fabric_site, sda.Sda.sda_fabric_sites_readiness,

  • Paths used are get /dna/intent/api/v1/securityServiceInsertion/fabricSitesReadiness, get /dna/intent/api/v1/securityServiceInsertion/fabricSitesReadiness/{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

  • 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 SDA ReadinessStatusForAFabricSite

Complete reference of the ReadinessStatusForAFabricSite API.

Cisco Catalyst Center documentation for SDA SdaFabricSitesReadiness

Complete reference of the SdaFabricSitesReadiness API.

Examples

---
- name: Get all Security Service Insertion Fabric Sites Readiness
  cisco.catalystcenter.security_service_insertion_fabric_sites_readiness_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    order: string
    sortBy: string
  register: result
- name: Get Security Service Insertion Fabric Sites Readiness by id
  cisco.catalystcenter.security_service_insertion_fabric_sites_readiness_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    order: string
    id: string
  register: result

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": [{"anyCastGateway": 0, "deviceCounts": {"readyDeviceCount": 0, "totalDeviceCount": 0}, "extranetPolicyCounterParts": ["string"], "extranetRole": "string", "id": "string", "layer3VirtualNetworkId": 0, "readiness": "string", "virtualNetworkName": "string"}]}`

Authors

  • Bryan Vargas (@bvargasre)