cisco.dnac.sda_provision_device 模块 – 用于 SDA 部署设备的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceManagementIpAddress

字符串

DeviceManagementIpAddress 查询参数。当前在 Fabric 站点中部署的设备的有效 IP 地址。

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"

siteNameHierarchy

字符串

部署设备的 SiteNameHierarchy。

validate_response_schema

布尔值

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

选项

  • false

  • true ←(默认)

注释

注意

  • 使用的 SDK 方法是 sda.Sda.delete_provisioned_wired_device_v1、sda.Sda.provision_wired_device_v1、sda.Sda.re_provision_wired_device_v1,

  • 使用的路径是 post /dna/intent/api/v1/business/sda/provision-device、delete /dna/intent/api/v1/business/sda/provision-device、put /dna/intent/api/v1/business/sda/provision-device,

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

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关 SDA ProvisionWiredDeviceV1 的 Cisco DNA Center 文档

ProvisionWiredDeviceV1 API 的完整参考。

有关 SDA DeleteProvisionedWiredDeviceV1 的 Cisco DNA Center 文档

DeleteProvisionedWiredDeviceV1 API 的完整参考。

有关 SDA ReProvisionWiredDeviceV1 的 Cisco DNA Center 文档

ReProvisionWiredDeviceV1 API 的完整参考。

示例

- name: Delete all
  cisco.dnac.sda_provision_device:
    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

- name: Update all
  cisco.dnac.sda_provision_device:
    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
    deviceManagementIpAddress: string
    siteNameHierarchy: string

- name: Create
  cisco.dnac.sda_provision_device:
    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
    deviceManagementIpAddress: string
    siteNameHierarchy: string

返回值

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

描述

dnac_response

字典

一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应

返回: 始终

示例: {"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}

作者

  • Rafael Campos (@racampos)