cisco.catalystcenter.sda_anycast_gateways_info module -- Information module for Sda Anycast Gateways

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

New in cisco.catalystcenter 1.0.0

Synopsis

  • Get all Sda Anycast Gateways.

  • Returns a list of anycast gateways that match the provided query parameters.

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

fabricId

string

FabricId query parameter. ID of the fabric the anycast gateway is assigned to.

headers

dictionary

Additional headers.

id

string

Id query parameter. ID of the anycast gateway.

ipPoolName

list / elements=string

IpPoolName query parameter. Comma-separated list of IP pool names associated with the anycast gateways. For an anycast gateway to be included in the response, it must be associated with all IP pools in this list. However, the anycast gateway can be associated with other additional IP pools as well.

limit

integer

Limit query parameter. Maximum number of records to return. The maximum number of objects supported in a single request is 500.

offset

integer

Offset query parameter. Starting record for pagination.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

virtualNetworkName

string

VirtualNetworkName query parameter. Name of the virtual network associated with the anycast gateways.

vlanId

integer

VlanId query parameter. VLAN ID of the anycast gateways. The allowed range for vlanId is 2-4093 except for reserved VLANs 1002-1005, 2046, and 4094.

vlanName

string

VlanName query parameter. VLAN name of the anycast gateways.

Notes

Note

  • SDK Method used are sda.Sda.get_anycast_gateways,

  • Paths used are get /dna/intent/api/v1/sda/anycastGateways,

  • 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 GetAnycastGateways

Complete reference of the GetAnycastGateways API.

Examples

---
- name: Get all Sda Anycast Gateways
  cisco.catalystcenter.sda_anycast_gateways_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}}"
    id: string
    fabricId: string
    virtualNetworkName: string
    ipPoolName: []
    vlanName: string
    vlanId: 0
    offset: 1
    limit: 500
  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": [{"additionalIpPools": [{"name": "string", "order": 0}], "fabricId": {}, "id": {}, "ipPoolName": {}, "isCriticalPool": {}, "isGroupBasedPolicyEnforcementEnabled": {}, "isIntraSubnetRoutingEnabled": {}, "isIpDirectedBroadcast": {}, "isLayer2FloodingEnabled": {}, "isMacsecEncrypted": {}, "isMultipleIpToMacAddresses": {}, "isResourceGuardEnabled": {}, "isSupplicantBasedExtendedNodeOnboarding": {}, "isWirelessFloodingEnabled": {}, "isWirelessPool": {}, "layer2FloodingAddress": {}, "layer2FloodingAddressAssignment": {}, "poolType": {}, "securityGroupName": {}, "tcpMssAdjustment": {}, "trafficType": {}, "virtualNetworkName": {}, "vlanId": {}, "vlanName": {}}], "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)