cisco.dnac.sites_device_credentials_v1 模块 – 站点设备凭据 V1 的资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.dnac.sites_device_credentials_v1。

cisco.dnac 6.15.0 中的新增功能

概要

  • 管理资源站点设备凭据 V1 的操作更新。

  • 更新站点的设备凭据设置；`null` 值表示该设置将从父站点继承；空对象 `{}` 表示凭据未设置，并且该类型的凭据将不用于该站点。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

cliCredentialsId

字典

站点设备凭据的 cliCredentialsId。

credentialsId

字符串

凭据的 `id`。

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"

httpReadCredentialsId

字典

站点设备凭据的 httpReadCredentialsId。

credentialsId

字符串

凭据的 `id`。

httpWriteCredentialsId

字典

站点设备凭据的 httpWriteCredentialsId。

credentialsId

字符串

凭据的 `id`。

id

字符串

Id 路径参数。站点 Id，可从 `/dna/intent/api/v1/sites` 中的 `id` 属性检索。

snmpv2cReadCredentialsId

字典

站点设备凭据的 snmpv2cReadCredentialsId。

credentialsId

字符串

凭据的 `id`。

snmpv2cWriteCredentialsId

字典

站点设备凭据的 snmpv2cWriteCredentialsId。

credentialsId

字符串

凭据的 `id`。

snmpv3CredentialsId

字典

站点设备凭据的 snmpv3CredentialsId。

credentialsId

字符串

凭据的 `id`。

validate_response_schema

布尔值

Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式的请求主体验证。

选择

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 network_settings.NetworkSettings.update_device_credential_settings_for_a_site_v1，

  • 使用的路径是 put /dna/intent/api/v1/sites/{id}/deviceCredentials，

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关网络设置 UpdateDeviceCredentialSettingsForASiteV1 的 Cisco DNA Center 文档

UpdateDeviceCredentialSettingsForASiteV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.sites_device_credentials_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
    cliCredentialsId:
      credentialsId: string
    httpReadCredentialsId:
      credentialsId: string
    httpWriteCredentialsId:
      credentialsId: string
    id: string
    snmpv2cReadCredentialsId:
      credentialsId: string
    snmpv2cWriteCredentialsId:
      credentialsId: string
    snmpv3CredentialsId:
      credentialsId: string

返回值

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

键

描述

dnac_response

字典

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

返回： 始终

示例： {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)