cisco.dnac.pnp_virtual_account_deregister_v1 模块 – PnP 虚拟帐户注销 V1 资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list。
要安装它,请使用: ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,有关详细信息,请参见 要求。
要在 playbook 中使用它,请指定: cisco.dnac.pnp_virtual_account_deregister_v1。
cisco.dnac 3.1.0 中的新增功能
概要
- 管理资源 PnP 虚拟帐户注销 V1 的删除操作。 
- 从 PnP 系统和数据库中注销指定的智能帐户和虚拟帐户信息以及关联的设备信息。与已注销的虚拟帐户关联的设备也将从 PnP 数据库中删除。响应有效负载包含已注销的智能帐户和虚拟帐户信息。 
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
- dnacentersdk >= 2.4.9 
- python >= 3.5 
参数
| 参数 | 注释 | 
|---|---|
| 用于 Cisco DNA Center SDK 的标志,用于启用调试。 选项 
 | |
| Cisco DNA Center 主机名。 | |
| 用于身份验证的 Cisco DNA Center 密码。 | |
| Cisco DNA Center 端口。 默认值:  | |
| 用于身份验证的 Cisco DNA Center 用户名。 默认值:  | |
| 启用或禁用 SSL 证书验证的标志。 选项 
 | |
| 通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值:  | |
| 域查询参数。智能帐户域。 | |
| 名称查询参数。虚拟帐户名称。 | |
| 用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。 选项 
 | 
备注
注意
- 使用的 SDK 方法是 device_onboarding_pnp.DeviceOnboardingPnp.deregister_virtual_account_v1, 
- 使用的路径是 delete /dna/intent/api/v1/onboarding/pnp-settings/vacct, 
- 不支持 - check_mode
- 插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器 
- 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接 
另请参见
另请参见
- Cisco DNA Center 设备入网 (PnP) DeregisterVirtualAccountV1 文档
- DeregisterVirtualAccountV1 API 的完整参考。 
示例
- name: Delete all
  cisco.dnac.pnp_virtual_account_deregister_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}}"
    domain: string
    name: string
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
| 键 | 描述 | 
|---|---|
| 包含 Cisco DNAC Python SDK 返回的响应的字典或列表 已返回:始终 示例:  | 
