cisco.dnac.sda_anycast_gateways module – Resource module for Sda Anycastgateways

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

  • 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.7.2

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

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: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

id

string

Id path parameter. ID of the anycast gateway to be deleted.

payload

list / elements=dictionary

Sda Anycast Gateways’s payload.

fabricId

string

ID of the fabric containing this anycast gateway. Updating anycast gateways on fabric zones is not allowed–instead, update the corresponding anycast gateway on the fabric site and the updates will be applied on all applicable fabric zones (updating this field is not allowed).

id

string

ID of the anycast gateway (updating this field is not allowed).

ipPoolName

string

Name of the IP pool associated with the anycast gateway (updating this field is not allowed).

isCriticalPool

boolean

Enable/disable critical VLAN (not applicable to INFRA_VN; updating this field is not allowed).

Choices:

  • false

  • true

isIntraSubnetRoutingEnabled

boolean

Enable/disable Intra-Subnet Routing (not applicable to INFRA_VN; updating this field is not allowed).

Choices:

  • false

  • true

isIpDirectedBroadcast

boolean

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

Choices:

  • false

  • true

isLayer2FloodingEnabled

boolean

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

Choices:

  • false

  • true

isMultipleIpToMacAddresses

boolean

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

Choices:

  • false

  • true

isSupplicantBasedExtendedNodeOnboarding

boolean

Enable/disable Supplicant-Based Extended Node Onboarding (applicable only to INFRA_VN; required when poolType is EXTENDED_NODE).

Choices:

  • false

  • true

isWirelessPool

boolean

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

Choices:

  • false

  • true

poolType

string

The pool type of the anycast gateway (applicable only to INFRA_VN; updating this field is not allowed).

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 (updating this field is not allowed).

vlanId

integer

ID of the VLAN of the anycast gateway (updating this field is not allowed).

vlanName

string

Name of the VLAN of the anycast gateway (updating this field is not allowed).

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

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: 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
      isIntraSubnetRoutingEnabled: true
      isIpDirectedBroadcast: true
      isLayer2FloodingEnabled: true
      isMultipleIpToMacAddresses: true
      isSupplicantBasedExtendedNodeOnboarding: true
      isWirelessPool: true
      poolType: string
      securityGroupName: string
      tcpMssAdjustment: 0
      trafficType: string
      virtualNetworkName: string
      vlanId: 0
      vlanName: string

- name: Create
  cisco.dnac.sda_anycastGateways:
    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
      isIntraSubnetRoutingEnabled: true
      isIpDirectedBroadcast: true
      isLayer2FloodingEnabled: true
      isMultipleIpToMacAddresses: true
      isSupplicantBasedExtendedNodeOnboarding: true
      isWirelessPool: true
      poolType: string
      securityGroupName: string
      tcpMssAdjustment: 0
      trafficType: string
      virtualNetworkName: string
      vlanId: 0
      vlanName: string

- name: Delete by id
  cisco.dnac.sda_anycastGateways:
    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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)