cisco.dnac.sda_anycast_gateways module -- Resource module for Sda Anycast Gateways

Note

This module is part of the cisco.dnac collection (version 6.46.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.sda_anycast_gateways.

New in cisco.dnac 6.14.0

Synopsis

  • Manage operations create, update and delete of the resource Sda Anycast Gateways.

  • Adds anycast gateways based on user input.

  • Deletes an anycast gateway based on id.

  • Updates anycast gateways based on user input.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

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

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

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

id

string

Id path parameter. ID of the anycast gateway.

payload

list / elements=dictionary

Sda Anycast Gateways's payload.

autoGenerateVlanName

boolean

This field cannot be true when vlanName is provided. The vlanName will be generated as "{ipPoolGroupV4Cidr}-{virtualNetworkName}" for non-critical VLANs. For critical VLANs with DATA trafficType, vlanName will be "CRITICAL_VLAN". For critical VLANs with VOICE trafficType, vlanName will be "VOICE_VLAN".

Choices:

fabricId

string

ID of the fabric this anycast gateway is to be assigned to.

ipPoolName

string

Name of the IP pool associated with the anycast gateway.

isCriticalPool

boolean

Enable/disable critical VLAN. If true, autoGenerateVlanName must also be true. (isCriticalPool is not applicable to INFRA_VN).

Choices:

isGroupBasedPolicyEnforcementEnabled

boolean

Enable/disable Group-Based Policy Enforcement (defaults to false when using INFRA_VN; defaults to true for other VNs).

Choices:

isIntraSubnetRoutingEnabled

boolean

Enable/disable Intra-Subnet Routing (not applicable to INFRA_VN).

Choices:

isIpDirectedBroadcast

boolean

Enable/disable IP-directed broadcast (not applicable to INFRA_VN).

Choices:

isLayer2FloodingEnabled

boolean

Enable/disable layer 2 flooding (not applicable to INFRA_VN).

Choices:

isMultipleIpToMacAddresses

boolean

Enable/disable multiple IP-to-MAC Addresses (Wireless Bridged-Network Virtual Machine; not applicable to INFRA_VN).

Choices:

isResourceGuardEnabled

boolean

Enable/disable Resource Guard (not applicable to INFRA_VN).

Choices:

isSupplicantBasedExtendedNodeOnboarding

boolean

Enable/disable Supplicant-Based Extended Node Onboarding (applicable only to INFRA_VN).

Choices:

isWirelessFloodingEnabled

boolean

Enable/disable wireless flooding (not applicable to INFRA_VN; can only be true when isWirelessPool is true).

Choices:

isWirelessPool

boolean

Enable/disable fabric-enabled wireless (not applicable to INFRA_VN).

Choices:

layer2FloodingAddress

string

The flooding address to use for layer 2 flooding. The IP address must be in the 239.0.0.0/8 range. This property is applicable only when the flooding address source is set to "CUSTOM".

layer2FloodingAddressAssignment

string

The source of the flooding address for layer 2 flooding. Layer 2 flooding must be enabled to configure this property. "SHARED" means that the anycast gateway will inherit the flooding address from the fabric. "CUSTOM" allows the anycast gateway to use a different flooding address (not applicable to INFRA_VN; defaults to "SHARED").

poolType

string

The pool type of the anycast gateway (required for & applicable only to INFRA_VN).

securityGroupName

string

Name of the associated Security Group (not applicable to INFRA_VN).

tcpMssAdjustment

integer

TCP maximum segment size adjustment.

trafficType

string

The type of traffic the anycast gateway serves.

virtualNetworkName

string

Name of the layer 3 virtual network associated with the anycast gateway. The virtual network must have already been added to the site before creating an anycast gateway with it.

vlanId

integer

ID of the VLAN of the anycast gateway. Allowed VLAN range is 2-4093 except for reserved VLANs 1002-1005, 2046, and 4094. If deploying an anycast gateway on a fabric zone, this vlanId must match the vlanId of the corresponding anycast gateway on the fabric site.

vlanName

string

Name of the VLAN of the anycast gateway.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are sda.Sda.add_anycast_gateways, sda.Sda.delete_anycast_gateway_by_id, sda.Sda.update_anycast_gateways,

  • Paths used are post /dna/intent/api/v1/sda/anycastGateways, delete /dna/intent/api/v1/sda/anycastGateways/{id}, put /dna/intent/api/v1/sda/anycastGateways,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA AddAnycastGateways

Complete reference of the AddAnycastGateways API.

Cisco DNA Center documentation for SDA DeleteAnycastGatewayById

Complete reference of the DeleteAnycastGatewayById API.

Cisco DNA Center documentation for SDA UpdateAnycastGateways

Complete reference of the UpdateAnycastGateways API.

Examples

---
- name: Create
  cisco.dnac.sda_anycast_gateways:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    payload:
      - autoGenerateVlanName: true
        fabricId: string
        ipPoolName: string
        isCriticalPool: true
        isGroupBasedPolicyEnforcementEnabled: true
        isIntraSubnetRoutingEnabled: true
        isIpDirectedBroadcast: true
        isLayer2FloodingEnabled: true
        isMultipleIpToMacAddresses: true
        isResourceGuardEnabled: true
        isSupplicantBasedExtendedNodeOnboarding: true
        isWirelessFloodingEnabled: true
        isWirelessPool: true
        layer2FloodingAddress: string
        layer2FloodingAddressAssignment: string
        poolType: string
        securityGroupName: string
        tcpMssAdjustment: 0
        trafficType: string
        virtualNetworkName: string
        vlanId: 0
        vlanName: string
- name: Update all
  cisco.dnac.sda_anycast_gateways:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    payload:
      - fabricId: string
        id: string
        ipPoolName: string
        isCriticalPool: true
        isGroupBasedPolicyEnforcementEnabled: true
        isIntraSubnetRoutingEnabled: true
        isIpDirectedBroadcast: true
        isLayer2FloodingEnabled: true
        isMultipleIpToMacAddresses: true
        isResourceGuardEnabled: true
        isSupplicantBasedExtendedNodeOnboarding: true
        isWirelessFloodingEnabled: true
        isWirelessPool: true
        layer2FloodingAddress: string
        layer2FloodingAddressAssignment: string
        poolType: string
        securityGroupName: string
        tcpMssAdjustment: 0
        trafficType: string
        virtualNetworkName: string
        vlanId: 0
        vlanName: string
- name: Delete by id
  cisco.dnac.sda_anycast_gateways:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: absent
    id: string

Return Values

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

Key

Description

dnac_response

dictionary

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

Returned: always

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

Authors

  • Rafael Campos (@racampos)