cisco.dnac.sda_anycast_gateways 模块 – SDA Anycast 网关资源模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅要求了解详情。

要在 playbook 中使用它，请指定： cisco.dnac.sda_anycast_gateways。

cisco.dnac 6.14.0 中的新增功能

概要 

此模块表示模块 sda_anycast_gateways_v1 的别名

注意

此模块具有相应的 action 插件。

要求 

执行此模块的主机需要以下要求。

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
dnac_debug 布尔值	用于 Cisco DNA Center SDK 以启用调试。选项 `false` ← (默认) `true`
dnac_host 字符串 / 必需	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。默认值： `443`
dnac_username 别名：user 字符串	用于身份验证的 Cisco DNA Center 用户名。默认值： `"admin"`
dnac_verify 布尔值	启用或禁用 SSL 证书验证的标志。选项 `false` `true` ← (默认)
dnac_version 字符串	通知 SDK 使用哪个版本的 Cisco DNA Center。默认值： `"2.3.7.6"`
id 字符串	ID 路径参数。Anycast 网关的 ID。
payload 列表 / 元素=字典	SDA Anycast 网关的有效负载。
fabricId 字符串	此 anycast 网关分配到的结构域的 ID。不允许更新结构域区域上的 anycast 网关——而应更新结构域站点上的相应 anycast 网关，更新将应用于所有适用的结构域区域（不允许更新此字段）。
id 字符串	Anycast 网关的 ID（不允许更新此字段）。
ipPoolName 字符串	与 anycast 网关关联的 IP 池的名称（不允许更新此字段）。
isCriticalPool 布尔值	启用/禁用关键 VLAN（不适用于 INFRA_VN；不允许更新此字段）。选项 `false` `true`
isGroupBasedPolicyEnforcementEnabled 布尔值	启用/禁用基于组的策略执行（仅适用于 INFRA_VN；默认为 false）。选项 `false` `true`
isIntraSubnetRoutingEnabled 布尔值	启用/禁用子网内路由（不适用于 INFRA_VN；不允许更新此字段）。选项 `false` `true`
isIpDirectedBroadcast 布尔值	启用/禁用 IP 指向广播（不适用于 INFRA_VN）。选项 `false` `true`
isLayer2FloodingEnabled 布尔值	启用/禁用第 2 层泛洪（不适用于 INFRA_VN）。选项 `false` `true`
isMultipleIpToMacAddresses 布尔值	启用/禁用多个 IP 到 MAC 地址（无线桥接网络虚拟机；不适用于 INFRA_VN）。选项 `false` `true`
isSupplicantBasedExtendedNodeOnboarding 布尔值	启用/禁用基于客户端的扩展节点入网（仅适用于 INFRA_VN 请求；当 poolType 为 EXTENDED_NODE 时，不得为空）。选项 `false` `true`
isWirelessPool 布尔值	启用/禁用结构域启用的无线（不适用于 INFRA_VN）。选项 `false` `true`
poolType 字符串	anycast 网关的池类型（对于 INFRA_VN 是必需的且仅适用于 INFRA_VN；不允许更新此字段）。
securityGroupName 字符串	关联的安全组的名称（不适用于 INFRA_VN）。
tcpMssAdjustment 整数	TCP 最大分段大小调整。
trafficType 字符串	anycast 网关服务的流量类型。
virtualNetworkName 字符串	与 anycast 网关关联的第 3 层虚拟网络的名称（不允许更新此字段）。
vlanId 整数	anycast 网关的 VLAN 的 ID（不允许更新此字段）。
vlanName 字符串	anycast 网关的 VLAN 的名称（不允许更新此字段）。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用针对 JSON 架构的请求正文验证的标志。选项 `false` `true` ← (默认)

注释 

注意

使用的 SDK 方法为 sda.Sda.add_anycast_gateways_v1、sda.Sda.delete_anycast_gateway_by_id_v1、sda.Sda.update_anycast_gateways_v1，
使用的路径为 post /dna/intent/api/v1/sda/anycastGateways、delete /dna/intent/api/v1/sda/anycastGateways/{id}、put /dna/intent/api/v1/sda/anycastGateways，
需要注意的是，此模块是 sda_anycast_gateways_v1 的别名
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center SDA AddAnycastGatewaysV1 文档: AddAnycastGatewaysV1 API 的完整参考。
Cisco DNA Center SDA DeleteAnycastGatewayByIdV1 文档: DeleteAnycastGatewayByIdV1 API 的完整参考。
Cisco DNA Center SDA UpdateAnycastGatewaysV1 文档: UpdateAnycastGatewaysV1 API 的完整参考。

示例 

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

- 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
      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_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

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
dnac_response 字典	包含Cisco DNAC Python SDK返回的响应的字典或列表返回：始终示例： `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)