ieisystem.inmanage.edit_snmp_trap module – Set snmp trap
Note
This module is part of the ieisystem.inmanage collection (version 2.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ieisystem.inmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ieisystem.inmanage.edit_snmp_trap
.
New in ieisystem.inmanage 1.0.0
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 |
Comments |
---|---|
Set the authentication password for the V3 trap. The password is a string of 8 to 16 alphanumeric characters. Required when auth_protocol is either |
|
Choose the authentication protocol for the V3 trap. Choices:
|
|
Community of v1/v2c. |
|
Set the contact, can be NULL. Only the M5 model supports this parameter. |
|
Specifies an engine identifier for the V3 trap. The value should be string of 10 to 48 hex characters, must be even, can be NULL. |
|
Event Severity. Choices:
|
|
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. Only the M6 model supports this parameter. Choices:
|
|
Set the host location, can be NULL. Only the M5 model supports this parameter. |
|
Set the host operating system, can be NULL. Only the M5 model supports this parameter. |
|
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 |
|
Set the privacy password for the V3 trap. The password is a string of 8 to 16 alphanumeric characters. Required when priv_protocol is either |
|
Choose the privacy protocol for the V3 trap. Choices:
|
|
A dict object containing connection details. |
|
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. |
|
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 |
|
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 |
|
Set the system ID, can be NULL. Only the M5 model supports this parameter. |
|
Set the system name, can be NULL. Only the M5 model supports this parameter. |
|
Set a port for the SNMP trap in the range of 1 to 65535. Only the M5 model supports this parameter. |
|
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 |
|
Set the username for the V3 trap. |
|
SNMP trap version, 1 is v1, 2 is v2c(v2), 3 is v3, 0 is disable snmp trap. Only the M6 model supports Choices:
|
Notes
Note
Does not support
check_mode
.
Examples
- name: Trap test
hosts: inmanage
no_log: true
connection: local
gather_facts: false
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 |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |