cisco.dnac.netconf_credential 模块 – Netconf 凭据资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 netconf_credential_v1 的别名。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

comments

字符串

用于标识 netconf 凭据的注释。

credentialType

字符串

用于标识使用 netconf 凭据的应用程序的凭据类型。

description

字符串

Netconf 凭据的描述。

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

字符串

Netconf 凭据的 ID（UUID 格式）。

instanceTenantId

字符串

已弃用。

instanceUuid

字符串

已弃用。

netconfPort

字符串

设备上的 Netconf 端口。有效端口应在 1 到 65535 之间。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 discovery.Discovery.create_netconf_credentials_v1、discovery.Discovery.update_netconf_credentials_v1。

  • 使用的路径为 post /dna/intent/api/v1/global-credential/netconf、put /dna/intent/api/v1/global-credential/netconf。

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

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档，了解 Discovery CreateNetconfCredentialsV1。

CreateNetconfCredentialsV1 API 的完整参考。

Cisco DNA Center 文档，了解 Discovery UpdateNetconfCredentialsV1。

UpdateNetconfCredentialsV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.netconf_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
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    netconfPort: string

- name: Create
  cisco.dnac.netconf_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
    payload:
    - comments: string
      credentialType: string
      description: string
      id: string
      instanceTenantId: string
      instanceUuid: string
      netconfPort: string

返回值

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

键

描述

dnac_response

字典

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

返回：始终

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

作者

  • Rafael Campos (@racampos)