cisco.dnac.snmpv3_credential 模块 – Snmpv3 凭证的资源模块

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.dnac.snmpv3_credential。

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 snmpv3_credential_v1 的别名

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

authPassword

字符串

SNMPv3 的身份验证密码。如果 snmpMode 为 ‘AUTHPRIV’ 或 ‘AUTHNOPRIV’，则为必需。如果不需要更改，请使用 ‘NO!$DATA!$’。

authType

字符串

SNMPv3 身份验证协议。‘SHA’ 或 ‘MD5’。如果 snmpMode 为 ‘AUTHPRIV’ 或 ‘AUTHNOPRIV’，则为必需。

comments

字符串

用于标识 SNMPv3 凭证的注释。

credentialType

字符串

用于标识使用 SNMPv3 凭证的应用程序的凭证类型。

description

字符串

SNMPv3 凭证的描述。

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

字符串

SNMPv3 凭证的 ID。

instanceTenantId

字符串

已弃用。此属性将在未来的版本中删除，不应使用，并且将忽略提供的任何值。

instanceUuid

字符串

已弃用。此属性将在未来的版本中删除，不应使用，并且将忽略提供的任何值。

privacyPassword

字符串

SNMPv3 隐私的隐私密码。如果 snmpMode 为 ‘AUTHPRIV’，则为必需。如果不需要更改，请使用 ‘NO!$DATA!$’。

privacyType

字符串

SNMPv3 隐私协议。如果 snmpMode 为 ‘AUTHPRIV’，则为必需。

snmpMode

字符串

SNMPv3 的模式。‘AUTHPRIV’ 或 ‘AUTHNOPRIV’ 或 ‘NOAUTHNOPRIV’。

username

字符串

SNMPv3 用户名。

validate_response_schema

布尔值

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

选项

  • false

  • true ←（默认）

说明

注意

  • 使用的 SDK 方法是 discovery.Discovery.create_snmpv3_credentials_v1, discovery.Discovery.update_snmpv3_credentials_v1,

  • 使用的路径是 post /dna/intent/api/v1/global-credential/snmpv3, put /dna/intent/api/v1/global-credential/snmpv3,

  • 应该注意的是，此模块是 snmpv3_credential_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档，了解 Discovery CreateSNMPv3CredentialsV1

CreateSNMPv3CredentialsV1 API 的完整参考。

Cisco DNA Center 文档，了解 Discovery UpdateSNMPv3CredentialsV1

UpdateSNMPv3CredentialsV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.snmpv3_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
    authPassword: string
    authType: string
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    privacyPassword: string
    privacyType: string
    snmpMode: string
    username: string

- name: Create
  cisco.dnac.snmpv3_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
    authPassword: string
    authType: string
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    privacyPassword: string
    privacyType: string
    snmpMode: string
    username: string

返回值

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

键

描述

dnac_response

字典

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

返回: 总是

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

作者

  • Rafael Campos (@racampos)