inspur.ispim.edit_snmp_trap module – Set snmp trap
Note
This module is part of the inspur.ispim collection (version 2.2.3).
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 inspur.ispim
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: inspur.ispim.edit_snmp_trap
.
New in inspur.ispim 1.0.0
Synopsis
Set snmp trap on Inspur server.
Requirements
The below requirements are needed on the host that executes this module.
Python 3.7+
inspursmsdk
Parameters
Parameter |
Comments |
---|---|
Set auth password of V3 trap, password is a string of 8 to 16 alpha-numeric characters. Required when auth_protocol is either |
|
Choose authentication. Choices:
|
|
Community of v1/v2c. |
|
Set contact, can set NULL. Only the M5 model supports this parameter. |
|
Set Engine ID of V3 trap, engine ID is a string of 10 to 48 hex characters, must even, can set 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 host Location, can set NULL. Only the M5 model supports this parameter. |
|
Set host OS, can set 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 privacy password of V3 trap, password is a string of 8 to 16 alpha-numeric characters. Required when priv_protocol is either |
|
Choose Privacy. 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 system ID, can set NULL. Only the M5 model supports this parameter. |
|
Set system name, can set NULL. Only the M5 model supports this parameter. |
|
Set SNMP trap Port(1-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 user name of 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: ism
no_log: true
connection: local
gather_facts: no
vars:
ism:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Set snmp trap v2c"
inspur.ispim.edit_snmp_trap:
version: 2
event_severity: "warning"
inspur: "test"
system_name: "Inspur"
provider: "{{ ism }}"
- name: "Set snmp trap v3"
inspur.ispim.edit_snmp_trap:
version: 3
event_severity: "all"
v3username: "Inspur"
engine_id: "1234567890"
auth_protocol: "SHA"
auth_password: "12345678"
priv_protocol: "AES"
priv_password: "123454678"
trap_port: 162
provider: "{{ ism }}"
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 |