cisco.dnac.snmpv2_read_community_credential 模块 – 用于 Snmpv2 读取 Community 凭证的资源模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.dnac.snmpv2_read_community_credential

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

comments

字符串

用于标识凭证的注释。

credentialType

字符串

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

description

字符串

凭证的名称/描述。

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"

instanceUuid

字符串

凭证 UUID。

readCommunity

字符串

SNMP 读取 Community。NO!$DATA!$ 表示不更改值。

validate_response_schema

布尔值

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

选择

  • false

  • true ← (默认)

说明

注意

  • 使用的 SDK 方法是 discovery.Discovery.create_snmp_read_community_v1, discovery.Discovery.update_snmp_read_community_v1,

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

  • 应该注意的是,此模块是 snmpv2_read_community_credential_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于 Discovery CreateSNMPReadCommunityV1 的文档

CreateSNMPReadCommunityV1 API 的完整参考。

Cisco DNA Center 关于 Discovery UpdateSNMPReadCommunityV1 的文档

UpdateSNMPReadCommunityV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.snmpv2_read_community_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
    instanceUuid: string
    readCommunity: string

- name: Create
  cisco.dnac.snmpv2_read_community_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
    readCommunity: string

返回值

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

描述

dnac_response

字典

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

返回: 总是

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

作者

  • Rafael Campos (@racampos)