inspur.sm.edit_snmp – Set snmp.
Note
This plugin is part of the inspur.sm collection (version 1.1.2).
To install it use: ansible-galaxy collection install inspur.sm
.
To use it in a playbook, specify: inspur.sm.edit_snmp
.
New in version 0.1.0: of inspur.sm
Synopsis
- Set snmp on Inspur server.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_password string | Set auth password of V3 trap or v3get/v3set, Password is a string of 8 to 16 alpha-numeric characters. Required when auth_protocol is either SHA or MD5 . | ||
auth_protocol string |
| Choose authentication of V3 trap or v3get/v3set. | |
community string | Community of v1/v2c or v1get/v1set/v2cget/v2cset. | ||
host string | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
password string | Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. | ||
priv_password string | Set privacy password of V3 trap or v3get/v3set, password is a string of 8 to 16 alpha-numeric characters. Required when priv_protocol is either DES or AES . | ||
priv_protocol string |
| Choose Privacy of V3 trap or v3get/v3set. | |
provider dictionary | A dict object containing connection details. | ||
host string | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
password string | Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. | ||
username string | Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. | ||
snmp_status list / elements=string | NMP read/write status of customize, the input parameters are 'v1get', 'v1set', 'v2cget', 'v2cset', 'v3get', 'v3set',separated by commas,such as v1get,v1set,v2cget. | ||
username string | Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. | ||
v3username string | Set user name of V3 trap or v3get/v3set. | ||
version integer |
| SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'. |
Examples
- name: Snmp test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set snmp get/set" inspur.sm.edit_snmp: community: "test" v3username: "Inspur" provider: "{{ ism }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed boolean | always | Check to see if a change was made on the device. |
message string | always | Messages returned after module execution. |
state string | always | Status after module execution. |
Authors
- WangBaoshan (@ISIB-group)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/inspur/sm/edit_snmp_module.html