ieisystem.inmanage.edit_snmp – Set snmp

Note

This plugin is part of the ieisystem.inmanage collection.

To install it use: ansible-galaxy collection install ieisystem.inmanage.

To use it in a playbook, specify: ieisystem.inmanage.edit_snmp.

New in version 1.0.0: of ieisystem.inmanage

Synopsis

  • Set snmp on ieisystem Server.

Requirements

The below requirements are needed on the host that executes this module.

  • Python 3.7+

  • inManage

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
    Choices:
  • NONE
  • SHA
  • MD5
Choose authentication of V3 trap or v3get/v3set.
community
string
Community of v1/v2c or v1get/v1set/v2cget/v2cset.
Only the M5 models support this feature.
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
    Choices:
  • NONE
  • DES
  • AES
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.
read_community
string
Read Only Community,Community should between 1 and 16 characters.
Only the M6 models support this feature.
read_write_community
string
Read And Write Community,Community should between 1 and 16 characters.
Only the M6 models support this feature.
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.
Only the M5 models support this feature.
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.
v1status
string
    Choices:
  • enable
  • disable
SNMP V1 enable.
v2status
string
    Choices:
  • enable
  • disable
SNMP V2 enable.
v3status
string
    Choices:
  • enable
  • disable
SNMP V3 enable.
v3username
string
Set user name of V3 trap or v3get/v3set.
version
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'.
Only the M5 models support this feature.

Notes

Note

  • Does not support check_mode.

Examples

- name: Snmp test
  hosts: inmanage
  no_log: true
  connection: local
  gather_facts: no
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set snmp get/set"
    ieisystem.inmanage.edit_snmp:
      community: "test"
      v3username: "test"
      provider: "{{ inmanage }}"

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 (@ieisystem)