cisco.dnac.sda_fabric_zones 模块 – SDA Fabric Zones 资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。要使用此模块,您需要其他要求,请参阅 要求 获取详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.sda_fabric_zones

cisco.dnac 6.14.0 中的新增功能

概要

  • 此模块表示模块 sda_fabric_zones_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 路径参数。Fabric Zone 的 ID。

payload

列表 / 元素=字典

SDA Fabric Zones 的有效负载。

authenticationProfileName

字符串

此 Fabric 使用的身份验证配置文件。

id

字符串

Fabric Zone 的 ID(不允许更新此字段)。

siteId

字符串

网络层次结构的 ID(不允许更新此字段)。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 sda.Sda.add_fabric_zone_v1、sda.Sda.delete_fabric_zone_by_id_v1、sda.Sda.update_fabric_zone_v1,

  • 使用的路径为 post /dna/intent/api/v1/sda/fabricZones、delete /dna/intent/api/v1/sda/fabricZones/{id}、put /dna/intent/api/v1/sda/fabricZones,

  • 需要注意的是,此模块是 sda_fabric_zones_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center SDA AddFabricZoneV1 文档

AddFabricZoneV1 API 的完整参考。

Cisco DNA Center SDA DeleteFabricZoneByIdV1 文档

DeleteFabricZoneByIdV1 API 的完整参考。

Cisco DNA Center SDA UpdateFabricZoneV1 文档

UpdateFabricZoneV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.sda_fabric_zones:
    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:
    - authenticationProfileName: string
      id: string
      siteId: string

- name: Create
  cisco.dnac.sda_fabric_zones:
    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:
    - authenticationProfileName: string
      siteId: string

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