cisco.dnac.device_credential 模块 – 设备凭证的资源模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.dnac.device_credential。

cisco.dnac 3.1.0 中的新增功能

概要

• 此模块表示模块 device_credential_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 路径参数。全局凭证 ID。
settings 字典	设备凭证的设置。
cliCredential 列表 / 元素=字典	设备凭证的 cliCredential。
description 字符串	CLI 凭证的名称或描述。
enablePassword 字符串	CLI 凭证的启用密码。
password 字符串	CLI 凭证的密码。
username 字符串	CLI 凭证的用户名。
httpsRead 列表 / 元素=字典	设备凭证的 httpsRead。
name 字符串	http 读取凭证的名称或描述。
password 字符串	http 读取凭证的密码。
port 浮点数	http 读取凭证的端口。
username 字符串	http 读取凭证的用户名。
httpsWrite 列表 / 元素=字典	设备凭证的 httpsWrite。
name 字符串	http 写入凭证的名称或描述。
password 字符串	http 写入凭证的密码。
port 浮点数	http 写入凭证的端口。
username 字符串	http 写入凭证的用户名。
snmpV2cRead 列表 / 元素=字典	设备凭证的 snmpV2cRead。
description 字符串	snmp v2 读取的描述。
readCommunity 字符串	snmp v2 读取凭证的就绪社区。
snmpV2cWrite 列表 / 元素=字典	设备凭证的 snmpV2cWrite。
description 字符串	snmp v2 写入的描述。
writeCommunity 字符串	snmp v2 写入凭证的写入社区。
snmpV3 列表 / 元素=字典	设备凭证的 snmpV3。
authPassword 字符串	snmpv3 凭证的身份验证密码。
authType 字符串	snmpv3 凭证的身份验证类型。
description 字符串	SNMPV3 凭证的名称或描述。
privacyPassword 字符串	snmpv3 凭证的隐私密码。
privacyType 字符串	snmpv3 凭证的隐私类型。
snmpMode 字符串	snmpv3 凭证的模式。
username 字符串	SNMPv3 凭证的用户名。
validate_response_schema 布尔值	用于启用 Cisco DNA Center SDK 针对 JSON 模式验证请求正文的标志。 选择 false true ← (默认)

备注

注意

• 使用的 SDK 方法为 network_settings.NetworkSettings.create_device_credentials_v1, network_settings.NetworkSettings.delete_device_credential_v1, network_settings.NetworkSettings.update_device_credentials_v1,

• 使用的路径为 post /dna/intent/api/v1/device-credential, delete /dna/intent/api/v1/device-credential/{id}, put /dna/intent/api/v1/device-credential,

• 需要注意的是，此模块是 device_credential_v1 的别名。

• 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于 Network Settings CreateDeviceCredentialsV1 的文档

CreateDeviceCredentialsV1 API 的完整参考。

Cisco DNA Center 关于 Network Settings DeleteDeviceCredentialV1 的文档

DeleteDeviceCredentialV1 API 的完整参考。

Cisco DNA Center 关于 Network Settings UpdateDeviceCredentialsV1 的文档

UpdateDeviceCredentialsV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.device_credential:
    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
    settings:
      cliCredential:
      - description: string
        enablePassword: string
        password: string
        username: string
      httpsRead:
      - name: string
        password: string
        port: 0
        username: string
      httpsWrite:
      - name: string
        password: string
        port: 0
        username: string
      snmpV2cRead:
      - description: string
        readCommunity: string
      snmpV2cWrite:
      - description: string
        writeCommunity: string
      snmpV3:
      - authPassword: string
        authType: string
        description: string
        privacyPassword: string
        privacyType: string
        snmpMode: string
        username: string

- name: Update all
  cisco.dnac.device_credential:
    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
    settings:
      cliCredential:
        description: string
        enablePassword: string
        id: string
        password: string
        username: string
      httpsRead:
        id: string
        name: string
        password: string
        port: string
        username: string
      httpsWrite:
        id: string
        name: string
        password: string
        port: string
        username: string
      snmpV2cRead:
        description: string
        id: string
        readCommunity: string
      snmpV2cWrite:
        description: string
        id: string
        writeCommunity: string
      snmpV3:
        authPassword: string
        authType: string
        description: string
        id: string
        privacyPassword: string
        privacyType: string
        snmpMode: string
        username: string

- name: Delete by id
  cisco.dnac.device_credential:
    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 返回的响应。 返回: 始终 示例: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 存储库（源代码）