cisco.aci.aci_snmp_user 模块 – 管理 SNMP v3 用户 (snmp:UserP)

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.aci。

要在 playbook 中使用它，请指定： cisco.aci.aci_snmp_user。

概要

• 管理 SNMP v3 用户。

• 请注意，snmpUserP 类中的所有属性都是只创建的。要修改现有用户的任何属性，必须删除并重新创建它。

参数

参数	注释
注解 字符串	用于注释对象的由用户定义的字符串。 如果任务中未指定该值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定该值，并且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
auth_key 字符串	SNMP 身份验证密钥 提供此选项将始终导致更改，因为它是一个安全属性，无法从 APIC 中检索。
auth_type 字符串	SNMP 身份验证方法 选项 "hmac-md5-96" "hmac-sha1-96" "hmac-sha2-224" "hmac-sha2-256" "hmac-sha2-384" "hmac-sha2-512"
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名（无扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定该值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
description 别名：descr 字符串	SNMP 用户策略的描述
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将使用环境变量 ACI_HOST 的值。
name 别名：snmp_user_policy 字符串	SNMP 用户策略的名称
output_level 字符串	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ← (默认值)
output_path 字符串	将用于转储模块生成的 ACI JSON 配置对象的文件的路径。 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_PATH 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将使用它。 如果任务中未指定值，则将改用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
policy 别名：snmp_policy, snmp_policy_name 字符串	现有SNMP策略的名称
port 整数	用于REST连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定值，则将改用环境变量ACI_PORT的值。
privacy_key 字符串	SNMP隐私密钥 提供此选项将始终导致更改，因为它是一个安全属性，无法从 APIC 中检索。
privacy_type 字符串	SNMP隐私类型 选项 "aes-128" "des" "none"
private_key 别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将忽略它。 如果任务中未指定值，则将改用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
state 字符串	使用present或absent添加或删除。 使用query列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous 别名：no_previous, ignore_previous 布尔值	如果为true，则在对APIC进行POST更新之前不会发送GET请求来检查之前的状态。 如果任务中未指定值，则将改用环境变量ACI_SUPPRESS_PREVIOUS的值。 默认值为false。 警告 - 这会导致之前的返回值为空。 不会检查对象的先前状态，POST更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为true，则在对APIC进行POST更新后不会发送验证GET请求。 如果任务中未指定值，则将改用环境变量ACI_SUPPRESS_VERIFICATION的值。 默认值为false。 警告 - 这会导致当前返回值设置为建议值。 包含默认值在内的当前对象在一个任务中将无法验证。 选项 false true
timeout 整数	以秒为单位的套接字级别超时。 如果任务中未指定值，则将改用环境变量ACI_TIMEOUT的值。 默认值为30。
use_proxy 布尔值	如果为false，则即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定值，则将改用环境变量ACI_USE_PROXY的值。 默认值为true。 选项 false true
use_ssl 布尔值	如果为false，则将使用HTTP连接而不是默认的HTTPS连接。 如果任务中未指定值，则将改用环境变量ACI_USE_SSL的值。 当连接为本地连接时，默认值为true。 选项 false true
username 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定值，则将改用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为admin。
validate_certs 布尔值	如果为false，则不会验证SSL证书。 只有在使用自签名证书的个人控制站点上时，才应将其设置为false。 如果任务中未指定值，则将改用环境变量ACI_VALIDATE_CERTS的值。 默认值为true。 选项 false true

注释

注意

• 在您的剧本中使用此模块之前，必须存在所使用的policy。cisco.aci.aci_snmp_policy模块可用于此目的。

另请参见

另请参见

cisco.aci.aci_snmp_policy

管理Syslog组(snmp:Pol)。

APIC管理信息模型参考

有关内部APIC类snmp:UserP的更多信息。

Cisco ACI指南

有关如何使用Ansible管理ACI基础设施的详细信息。

开发Cisco ACI模块

有关如何编写您自己的Cisco ACI模块以进行贡献的详细指南。

示例

- name: Create an SNMP user
  cisco.aci.aci_snmp_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    policy: my_snmp_policy
    name: my_snmp_user
    auth_type: hmac-sha2-256
    auth_key: "{{ hmac_key }}"
    state: present
  delegate_to: localhost

- name: Create an SNMP user with both authentication and privacy
  cisco.aci.aci_snmp_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    policy: my_snmp_policy
    name: my_snmp_user
    auth_type: hmac-sha1-96
    auth_key: "{{ hmac_key }}"
    privacy_type: aes-128
    privacy_key: "{{ aes_key }}"
    state: present
  delegate_to: localhost

- name: Remove an SNMP user
  cisco.aci.aci_snmp_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    policy: my_snmp_policy
    name: my_snmp_user
    state: absent
  delegate_to: localhost

- name: Query an SNMP user
  cisco.aci.aci_snmp_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    policy: my_snmp_policy
    name: my_snmp_user
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all SNMP users
  cisco.aci.aci_snmp_user:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成后APIC中存在的配置 返回：成功 示例： [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	APIC返回的错误信息 返回：失败 示例： {"code": "122", "text": "unknown managed object class foo"}
filter_string 字符串	用于请求的过滤字符串 返回：失败或调试 示例： "?rsp-prop-include=config-only"
method 字符串	用于向APIC发出请求的HTTP方法 返回：失败或调试 示例： "POST"
previous 列表 / 元素=字符串	模块启动前APIC中的原始配置 返回：信息 示例： [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	根据用户提供的参数组装的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw 字符串	APIC REST API返回的原始输出（xml或json） 返回：解析错误 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
response 字符串	来自APIC的HTTP响应 返回：失败或调试 示例： "OK (30 bytes)"
sent 列表 / 元素=字符串	推送到APIC的实际/最小配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "生产 环境"}}}
状态 整数	APIC返回的HTTP状态码 返回：失败或调试 示例： 200
URL 字符串	用于向APIC发送请求的HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Tim Cragg (@timcragg)

• Akini Ross (@akinross)

资源链接

• 问题追踪器
• 代码仓库