ieisystem.inmanage.edit_snmp_trap – Set snmp trap

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_trap.

New in version 1.0.0: of ieisystem.inmanage

Synopsis

  • Set snmp trap 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, 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.
community
string
Community of v1/v2c.
contact
string
Set contact, can set NULL.
Only the M5 model supports this parameter.
engine_id
string
Set Engine ID of V3 trap, engine ID is a string of 10 to 48 hex characters, must even, can set NULL.
event_severity
string
    Choices:
  • all
  • warning
  • critical
Event Severity.
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.
host_id
string
    Choices:
  • HostName
  • SerialNum
  • AssertTag
Host id.
Only the M6 model supports this parameter.
location
string
Set host Location, can set NULL.
Only the M5 model supports this parameter.
os
string
Set host OS, can set NULL.
Only the M5 model supports this parameter.
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, 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.
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.
system_id
string
Set system ID, can set NULL.
Only the M5 model supports this parameter.
system_name
string
Set system name, can set NULL.
Only the M5 model supports this parameter.
trap_port
integer
Set SNMP trap Port(1-65535).
Only the M5 model supports this parameter.
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.
version
integer
    Choices:
  • 0
  • 1
  • 2
  • 3
SNMP trap version,1 is v1,2 is v2c(v2),3 is v3,0 is disable snmp trap.
Only the M6 model supports 0 Settings.

Notes

Note

  • Does not support check_mode.

Examples

- name: Trap 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 trap v2c"
    ieisystem.inmanage.edit_snmp_trap:
      version: 2
      event_severity: "warning"
      community: "test"
      system_name: "ieisystem"
      provider: "{{ inmanage }}"

  - name: "Set snmp trap v3"
    ieisystem.inmanage.edit_snmp_trap:
      version: 3
      event_severity: "all"
      v3username: "ieisystem"
      engine_id: "1234567890"
      auth_protocol: "SHA"
      auth_password: "12345678"
      priv_protocol: "AES"
      priv_password: "123454678"
      trap_port: 162
      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)