cisco.dnac.sda_fabric_sites 模块 – 用于 Sda Fabric Sites 的资源模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

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

注意

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

要求

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

  • 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 站点的 ID。

payload

列表 / 元素=字典

Sda Fabric Sites 的负载。

authenticationProfileName

字符串

用于此 fabric 的身份验证配置文件。

isPubSubEnabled

布尔值

指定此 fabric 站点是否将使用 pub/sub 用于控制节点。

选择

  • false

  • true

siteId

字符串

网络层次结构的 ID。

validate_response_schema

布尔值

Cisco DNA Center SDK 的标志,用于启用针对 JSON 架构的请求正文验证。

选择

  • false

  • true ← (默认)

说明

注意

  • 使用的 SDK 方法是 sda.Sda.add_fabric_site_v1、sda.Sda.delete_fabric_site_by_id_v1、sda.Sda.update_fabric_site_v1,

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

  • 应该注意的是,此模块是 sda_fabric_sites_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关 SDA AddFabricSiteV1 的 Cisco DNA Center 文档

AddFabricSiteV1 API 的完整参考。

有关 SDA DeleteFabricSiteByIdV1 的 Cisco DNA Center 文档

DeleteFabricSiteByIdV1 API 的完整参考。

有关 SDA UpdateFabricSiteV1 的 Cisco DNA Center 文档

UpdateFabricSiteV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.sda_fabric_sites:
    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
      isPubSubEnabled: true
      siteId: string

- name: Update all
  cisco.dnac.sda_fabric_sites:
    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
      isPubSubEnabled: true
      siteId: string

- name: Delete by id
  cisco.dnac.sda_fabric_sites:
    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": "字符串", "url": "字符串"}, "version": "字符串"}

作者

  • Rafael Campos (@racampos)