cisco.dnac.sda_fabric_border_device_v1 模块 – 用于 Sda Fabric 边界设备 V1 的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 以获取详细信息。

要在剧本中使用它，请指定：cisco.dnac.sda_fabric_border_device_v1。

cisco.dnac 3.1.0 中的新增功能

概要

• 管理 Sda Fabric 边界设备 V1 资源的创建和删除操作。

• 在 SDA Fabric 中添加边界设备。

• 从 SDA Fabric 中删除边界设备。

注意

此模块具有相应的 操作插件。

要求

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

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
deviceManagementIpAddress 字符串 在 cisco.dnac 4.0.0 中添加	DeviceManagementIpAddress 查询参数。
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"
payload 列表 / 元素=字典	Sda Fabric 边界设备的 payload。
borderPriority 字符串	与给定设备关联的边界优先级。边界优先级的允许范围为 1-9。较低的值表示较高的优先级。例如，优先级 1 优先于 5。默认优先级将设置为 10。
borderSessionType 字符串 在 cisco.dnac 4.0.0 中添加	边界会话类型。
borderWithExternalConnectivity 布尔值	具有外部连接的边界（注意：对于传输边界为 True，对于非传输边界为 False）。 选项 false true
connectedToInternet 布尔值 在 cisco.dnac 4.0.0 中添加	连接到互联网。 选项 false true
deviceManagementIpAddress 字符串 在 cisco.dnac 4.0.0 中添加	已配置设备的管理 IP 地址。
deviceRole 列表 / 元素=字符串	SD-Access Fabric 中支持的设备角色。允许的角色为“Border_Node”、“Control_Plane_Nod… 例如，“Border_Node”或“Border_Node”、“Control_Plane_Node”或“Border_Node”、“Control_Plane_Node”、“Edge_Node”。
externalConnectivityIpPoolName 字符串 在 cisco.dnac 4.0.0 中添加	外部连接 IpPool 名称。
externalConnectivitySettings 列表 / 元素=字典 在 cisco.dnac 4.0.0 中添加	Sda Fabric 边界设备的 externalConnectivitySettings。
externalAutonomouSystemNumber 字符串 在 cisco.dnac 4.0.0 中添加	外部自治系统编号对等体（例如，1-65535）。
interfaceDescription 字符串	接口描述。
interfaceName 字符串 在 cisco.dnac 4.0.0 中添加	接口名称。
l2Handoff 列表 / 元素=字典	Sda Fabric 边界设备的 l2Handoff。
virtualNetworkName 字符串 在 cisco.dnac 4.0.0 中添加	与 Fabric 站点关联的虚拟网络名称。
vlanName 字符串	L2 Handoff 的 Vlan 名称。
l3Handoff 列表 / 元素=字典 在 cisco.dnac 4.0.0 中添加	Sda Fabric 边界设备的 l3Handoff。
virtualNetwork 字典 在 cisco.dnac 4.0.0 中添加	Sda Fabric 边界设备的 virtualNetwork。
virtualNetworkName 字符串 在 cisco.dnac 4.0.0 中添加	与 Fabric 站点关联的虚拟网络名称。
vlanId 字符串 在 cisco.dnac 4.0.0 中添加	Vlan ID（例如，2-4096，但保留的 VLAN (1002-1005、2046、4095) 除外）。
externalDomainRoutingProtocolName 字符串	外部域路由协议名称。
internalAutonomouSystemNumber 字符串	内部自治系统编号。
routeDistributionProtocol 字符串	控制平面设备的路由分发协议。允许的值为“LISP_BGP”或“LISP_PUB_SUB”。默认值为“LISP_BGP”。
sdaTransitNetworkName 字符串	SD-Access 传输网络名称。
siteNameHierarchy 字符串	已配置设备的站点名称层次结构（站点应属于 Fabric 站点）。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用针对 JSON 架构验证请求正文的标志。 选项 false true ← (默认)

备注

注意

• 使用的 SDK 方法是 sda.Sda.adds_border_device、sda.Sda.deletes_border_device，

• 使用的路径是 post /dna/intent/api/v1/business/sda/border-device、delete /dna/intent/api/v1/business/sda/border-device，

• 不支持 check_mode

• 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

• 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关 SDA AddBorderDeviceInSDAFabricV1 的 Cisco DNA Center 文档

AddBorderDeviceInSDAFabricV1 API 的完整参考。

有关 SDA DeleteBorderDeviceFromSDAFabricV1 的 Cisco DNA Center 文档

DeleteBorderDeviceFromSDAFabricV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.sda_fabric_border_device_v1:
    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:
    - borderPriority: string
      borderSessionType: string
      borderWithExternalConnectivity: true
      connectedToInternet: true
      deviceManagementIpAddress: string
      deviceRole:
      - string
      externalConnectivityIpPoolName: string
      externalConnectivitySettings:
      - externalAutonomouSystemNumber: string
        interfaceDescription: string
        interfaceName: string
        l2Handoff:
        - virtualNetworkName: string
          vlanName: string
        l3Handoff:
        - virtualNetwork:
            virtualNetworkName: string
            vlanId: string
      externalDomainRoutingProtocolName: string
      internalAutonomouSystemNumber: string
      routeDistributionProtocol: string
      sdaTransitNetworkName: string
      siteNameHierarchy: string

- name: Delete all
  cisco.dnac.sda_fabric_border_device_v1:
    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
    deviceManagementIpAddress: string

返回值

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

键	描述
dnac_response 字典	一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应 已返回： 始终 示例: {"description": "字符串", "executionId": "字符串", "executionStatusUrl": "字符串", "status": "字符串", "taskId": "字符串", "taskStatusUrl": "字符串"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 仓库 (源代码)