aci_snmp_user
Manage SNMP v3 Users (snmp:UserP)
Collection: cisco.aci
Full Name: cisco.aci.aci_snmp_user
Synopsis
Manage SNMP v3 Users (snmp:UserP)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| auth_key | string | SNMP authentication key Providing this option will always result in a change because it is a secure property that cannot be retrieved from APIC. | ||
| auth_type | string | SNMP authentication method | ||
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| description | string | Description of the SNMP user policy | ||
| host | string | IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable C(ACI_HOST) will be used instead. | ||
| name | string | Name of the SNMP user policy | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| output_path | string | Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_PATH) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| policy | string | Name of an existing SNMP policy | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| privacy_key | string | SNMP privacy key Providing this option will always result in a change because it is a secure property that cannot be retrieved from APIC. | ||
| privacy_type | string | SNMP privacy type | ||
| private_key | string | Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| use_proxy | bool | If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_snmp_user": {"auth_key": "{{ hmac_key }}", "auth_type": "hmac-sha2-256", "host": "apic", "name": "my_snmp_user", "password": "SomeSecretPassword", "policy": "my_snmp_policy", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Create an SNMP user"}
- {"cisco.aci.aci_snmp_user": {"auth_key": "{{ hmac_key }}", "auth_type": "hmac-sha1-96", "host": "apic", "name": "my_snmp_user", "password": "SomeSecretPassword", "policy": "my_snmp_policy", "privacy_key": "{{ aes_key }}", "privacy_type": "aes-128", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Create an SNMP user with both authentication and privacy"}
- {"cisco.aci.aci_snmp_user": {"host": "apic", "name": "my_snmp_user", "password": "SomeSecretPassword", "policy": "my_snmp_policy", "state": "absent", "username": "admin"}, "delegate_to": "localhost", "name": "Remove an SNMP user"}
- {"cisco.aci.aci_snmp_user": {"host": "apic", "name": "my_snmp_user", "password": "SomeSecretPassword", "policy": "my_snmp_policy", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query an SNMP user", "register": "query_result"}
- {"cisco.aci.aci_snmp_user": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all SNMP users", "register": "query_result"}