cisco.dnac.http_read_credential_v1 模块 – 用于 Http 读取凭据 V1 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源 Http 读取凭据 V1 的创建和更新操作。

  • 添加 HTTP 读取凭据。

  • 更新全局 HTTP 读取凭据。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

comments

字符串

用于标识 HTTP(S) 读取凭据的注释。

credentialType

字符串

用于标识使用 HTTP(S) 读取凭据的应用程序的凭据类型。

description

字符串

HTTP(S) 读取凭据的描述。

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

字符串

HTTP(S) 读取凭据的 ID，格式为 UUID。

instanceTenantId

字符串

已弃用。

instanceUuid

字符串

已弃用。

password

字符串

HTTP(S) 读取密码。

port

整数

HTTP(S) 端口。有效端口应在 1 到 65535 的范围内。

secure

布尔值

HTTPS 读取的标志。

选项

  • false

  • true

username

字符串

HTTP(S) 读取用户名。

validate_response_schema

布尔值

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

选项

  • false

  • true ←（默认）

注释

注意

  • 使用的 SDK 方法是 discovery.Discovery.create_http_read_credentials_v1，discovery.Discovery.update_http_read_credential_v1，

  • 使用的路径是 post /dna/intent/api/v1/global-credential/http-read，put /dna/intent/api/v1/global-credential/http-read，

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关 Discovery CreateHTTPReadCredentialsV1 的 Cisco DNA Center 文档

CreateHTTPReadCredentialsV1 API 的完整参考。

有关 Discovery UpdateHTTPReadCredentialV1 的 Cisco DNA Center 文档

UpdateHTTPReadCredentialV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.http_read_credential_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
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    password: string
    port: 0
    secure: true
    username: string

- name: Update all
  cisco.dnac.http_read_credential_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
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    password: string
    port: 0
    secure: true
    username: string

返回值

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

键

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回： 始终

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

作者

  • Rafael Campos (@racampos)