cisco.dnac.sda_fabric_devices 模块 – Sda Fabric 设备资源模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

• 此模块表示模块 sda_fabric_devices_v1 的别名

注意

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

要求

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

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
deviceRoles 字符串	DeviceRoles 查询参数。Fabric 设备的设备角色。允许的值为 CONTROL_PLANE_NODE、EDGE_NODE、BORDER_NODE、WIRELESS_CONTROLLER_NODE。
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"
fabricId 字符串	FabricId 查询参数。此设备所属的 Fabric 的 ID。
id 字符串	Id 路径参数。Fabric 设备的 ID。
networkDeviceId 字符串	NetworkDeviceId 查询参数。Fabric 设备的网络设备 ID。
payload 列表 / 元素=字典	Sda Fabric 设备的 payload。
borderDeviceSettings 字典	Sda Fabric 设备的 borderDeviceSettings。
borderTypes 列表 / 元素=字符串	Fabric 设备的边界类型列表。允许的值为 LAYER_2、LAYER_3。
layer3Settings 字典	Sda Fabric 设备的 layer3Settings。
borderPriority 整数	Fabric 边界设备的边界优先级。允许的范围为 1-9。值越低表示优先级越高。例如，优先级 1 优先于 5。默认优先级将设置为 10。
importExternalRoutes 布尔值	设置此项以将其他路由协议（如 BGP）的外部路由导入到 Fabric 控制平面。（不允许更新此字段）。 选项 false true
isDefaultExit 布尔值	设置此项以使 Fabric 边界设备成为此站点的最后手段网关。任何未知流量都将从边缘节点发送到此 Fabric 边界设备。（不允许更新此字段）。 选项 false true
localAutonomousSystemNumber 字符串	Fabric 边界设备的 BGP 本地自治系统号。允许的范围为 1 到 4294967295。（不允许更新此字段）。
prependAutonomousSystemCount 整数	Fabric 边界设备的前置自治系统计数。允许的范围为 1 到 10。
deviceRoles 列表 / 元素=字符串	Fabric 设备的角色列表。允许的值为 CONTROL_PLANE_NODE、EDGE_NODE、BORDER_NODE、WIRELESS_CONTROLLER_NODE。（不允许更新此字段）。
fabricId 字符串	此 Fabric 设备的 Fabric 的 ID。（不允许更新此字段）。
id 字符串	Fabric 设备的 ID。（不允许更新此字段）。
networkDeviceId 字符串	Fabric 设备的网络设备 ID。（不允许更新此字段）。
validate_response_schema 布尔值	Cisco DNA Center SDK 启用针对 JSON 模式验证请求体的标志。 选项 false true ← (默认)

注释

注意

• 使用的 SDK 方法是 sda.Sda.add_fabric_devices_v1, sda.Sda.delete_fabric_device_by_id_v1, sda.Sda.update_fabric_devices_v1,

• 使用的路径是 post /dna/intent/api/v1/sda/fabricDevices, delete /dna/intent/api/v1/sda/fabricDevices, delete /dna/intent/api/v1/sda/fabricDevices/{id}, put /dna/intent/api/v1/sda/fabricDevices,

• 应该注意的是，此模块是 sda_fabric_devices_v1 的别名

• 不支持 check_mode

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

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

另请参阅

另请参阅

有关 SDA AddFabricDevicesV1 的 Cisco DNA Center 文档

AddFabricDevicesV1 API 的完整参考。

用于 SDA DeleteFabricDeviceByIdV1 的 Cisco DNA Center 文档

DeleteFabricDeviceByIdV1 API 的完整参考。

用于 SDA DeleteFabricDevicesV1 的 Cisco DNA Center 文档

DeleteFabricDevicesV1 API 的完整参考。

用于 SDA UpdateFabricDevicesV1 的 Cisco DNA Center 文档

UpdateFabricDevicesV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.sda_fabric_devices:
    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:
    - borderDeviceSettings:
        borderTypes:
        - string
        layer3Settings:
          borderPriority: 0
          importExternalRoutes: true
          isDefaultExit: true
          localAutonomousSystemNumber: string
          prependAutonomousSystemCount: 0
      deviceRoles:
      - string
      fabricId: string
      id: string
      networkDeviceId: string

- name: Delete all
  cisco.dnac.sda_fabric_devices:
    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
    deviceRoles: string
    fabricId: string
    networkDeviceId: string

- name: Create
  cisco.dnac.sda_fabric_devices:
    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:
    - borderDeviceSettings:
        borderTypes:
        - string
        layer3Settings:
          borderPriority: 0
          importExternalRoutes: true
          isDefaultExit: true
          localAutonomousSystemNumber: string
          prependAutonomousSystemCount: 0
      deviceRoles:
      - string
      fabricId: string
      networkDeviceId: string

- name: Delete by id
  cisco.dnac.sda_fabric_devices:
    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)

集合链接

• 问题跟踪器
• 存储库（源代码）