cisco.dnac.global_credential_v2 模块 – 全局凭证 V2 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源全局凭证 V2 的创建、更新和删除操作。
用于创建新全局凭证的 API。可以一次传递各种类型的多个凭证。请参阅示例请求正文以获取更多信息。
删除全局凭证。只需要传递凭证的“id”。
用于更新设备凭证的 API。可以一次传递多个凭证，但一次只能传递给定类型的单个凭证。请参阅示例请求正文以获取更多信息。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
cliCredential 字典	全局凭证 V2 的 cliCredential。
描述字符串	CLI 凭证的描述。
enablePassword 字符串	CLI 启用密码。
id 字符串	UUID 格式的 CLI 凭证的 ID。
password 字符串	CLI 密码。
username 字符串	CLI 用户名。
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"`
httpsRead 字典	全局凭证 V2 的 httpsRead。
描述字符串	HTTP(S) 读取凭证的描述。
id 字符串	UUID 格式的 HTTP(S) 读取凭证的 ID。
password 字符串	HTTP(S) 读取密码。
端口整数	HTTP(S) 端口。
username 字符串	HTTP(S) 读取用户名。
httpsWrite 字典	全局凭证 V2 的 httpsWrite。
描述字符串	HTTP(S) 写入凭证的描述。
id 字符串	UUID 格式的 HTTP(S) 读取凭证的 ID。
password 字符串	HTTP(S) 写入密码。
端口整数	HTTP(S) 端口。
username 字符串	HTTP(S) 写入用户名。
id 字符串	Id 路径参数。全局凭证 ID。
snmpV2cRead 字典	全局凭证 V2 的 snmpV2cRead。
描述字符串	Snmp RO 社区的描述。
id 字符串	UUID 格式的 SNMP 读取凭证的 ID。
readCommunity 字符串	Snmp RO 社区。
snmpV2cWrite 字典	全局凭证 V2 的 snmpV2cWrite。
描述字符串	Snmp RW 社区的描述。
id 字符串	UUID 格式的 SNMP 写入凭证的 ID。
writeCommunity 字符串	Snmp RW 社区。
snmpV3 字典	全局凭证 V2 的 snmpV3。
authPassword 字符串	SNMP V3 的身份验证密码。
authType 字符串	SNMP 身份验证协议。“SHA”或“MD5”。
描述字符串	Snmp V3 凭证的描述。
id 字符串	UUID 格式的 SNMP V3 凭证的 ID。
privacyPassword 字符串	SNMP 隐私的隐私密码。
privacyType 字符串	SNMP 隐私协议。“AES128”、“AES192”、“AES256”。
snmpMode 字符串	SNMP 的模式。“AUTHPRIV”或“AUTHNOPRIV”或“NOAUTHNOPRIV”。
username 字符串	SNMP V3 用户名。
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文的功能。选项 `false` `true` ← (默认)

说明 

注意

使用的 SDK 方法包括 discovery.Discovery.create_global_credentials_v2，discovery.Discovery.delete_global_credential_v2，discovery.Discovery.update_global_credentials_v2。
使用的路径包括 post /dna/intent/api/v2/global-credential，delete /dna/intent/api/v2/global-credential/{id}，put /dna/intent/api/v2/global-credential。
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅 

另请参阅

Cisco DNA Center 关于 Discovery CreateGlobalCredentialsV2 的文档: CreateGlobalCredentialsV2 API 的完整参考。
Cisco DNA Center 关于 Discovery DeleteGlobalCredentialV2 的文档: DeleteGlobalCredentialV2 API 的完整参考。
Cisco DNA Center 关于 Discovery UpdateGlobalCredentialsV2 的文档: UpdateGlobalCredentialsV2 API 的完整参考。

示例 

- name: Update all
  cisco.dnac.global_credential_v2:
    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
    cliCredential:
      description: string
      enablePassword: string
      id: string
      password: string
      username: string
    httpsRead:
      description: string
      id: string
      password: string
      port: 0
      username: string
    httpsWrite:
      description: string
      id: string
      password: string
      port: 0
      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: Create
  cisco.dnac.global_credential_v2:
    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
    cliCredential:
    - description: string
      enablePassword: string
      password: string
      username: string
    httpsRead:
    - description: string
      password: string
      port: 0
      username: string
    httpsWrite:
    - description: 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: Delete by id
  cisco.dnac.global_credential_v2:
    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": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)