cisco.dnac.sda_fabric_site_v1 模块 – SDA Fabric Site V1 资源模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.sda_fabric_site_v1

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理 SDA Fabric Site V1 资源的创建和删除操作。

  • 在 SDA Fabric 中添加站点。

  • 从 SDA Fabric 中删除站点。

注意

此模块具有相应的 动作插件

要求

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

  • 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"

fabricName

字符串

在 cisco.dnac 4.0.0 中添加

警告 - 从 DNA Center 2.2.3.5 版本开始,此字段已被弃用。SD-Access Fabric 不再需要它。它将在未来的 DNA Center 版本中删除。

fabricType

字符串

SD-Access Fabric 的类型。允许的值为“FABRIC_SITE”或“FABRIC_ZONE”。默认值为“FABRIC_SITE”。

siteNameHierarchy

字符串

SiteNameHierarchy 查询参数。站点名称层次结构。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 sda.Sda.add_site, sda.Sda.delete_site,

  • 使用的路径为 post /dna/intent/api/v1/business/sda/fabric-site, delete /dna/intent/api/v1/business/sda/fabric-site,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center SDA AddSiteInSDAFabricV1 文档

AddSiteInSDAFabricV1 API 的完整参考。

Cisco DNA Center SDA DeleteSiteFromSDAFabricV1 文档

DeleteSiteFromSDAFabricV1 API 的完整参考。

示例

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

- name: Create
  cisco.dnac.sda_fabric_site_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
    fabricName: string
    fabricType: string
    siteNameHierarchy: string

返回值

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

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回:始终

示例: {"description": "字符串", "executionId": "字符串", "executionStatusUrl": "字符串", "status": "字符串", "taskId": "字符串", "taskStatusUrl": "字符串"}

作者

  • Rafael Campos (@racampos)