kaytus.ksmanage.edit_snmp_trap module – Set snmp trap

Note

This module is part of the kaytus.ksmanage collection (version 1.2.1).

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 kaytus.ksmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kaytus.ksmanage.edit_snmp_trap.

New in kaytus.ksmanage 1.0.0

Synopsis

  • Set snmp trap on kaytus Server.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

auth_password

string

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 SHA or MD5.

auth_protocol

string

Choose the authentication protocol for the V3 trap.

Choices:

  • "NONE"

  • "SHA"

  • "MD5"

community

string

Community of v1/v2c.

contact

string

Set the contact, can be NULL.

Only the M5 model supports this parameter.

engine_id

string

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

string

Event Severity.

Choices:

  • "all"

  • "warning"

  • "critical"

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

Host id.

Only the M6 model supports this parameter.

Choices:

  • "HostName"

  • "SerialNum"

  • "AssertTag"

location

string

Set the host location, can be NULL.

Only the M5 model supports this parameter.

os

string

Set the host operating system, can be 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 the privacy password for the V3 trap.

The password is a string of 8 to 16 alphanumeric characters.

Required when priv_protocol is either DES or AES.

priv_protocol

string

Choose the privacy protocol for the V3 trap.

Choices:

  • "NONE"

  • "DES"

  • "AES"

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 the system ID, can be NULL.

Only the M5 model supports this parameter.

system_name

string

Set the system name, can be NULL.

Only the M5 model supports this parameter.

trap_port

integer

Set a port for the SNMP trap in the range of 1 to 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 the username for the V3 trap.

version

integer

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.

Choices:

  • 0

  • 1

  • 2

  • 3

Notes

Note

  • Does not support check_mode.

Examples

- name: Trap test
  hosts: ksmanage
  no_log: true
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set snmp trap v2c"
    kaytus.ksmanage.edit_snmp_trap:
      version: 2
      event_severity: "warning"
      community: "test"
      system_name: "ieisystem"
      provider: "{{ ksmanage }}"

  - name: "Set snmp trap v3"
    kaytus.ksmanage.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: "{{ ksmanage }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Check to see if a change was made on the device.

Returned: always

message

string

Messages returned after module execution.

Returned: always

state

string

Status after module execution.

Returned: always

Authors

  • WangBaoshan (@ieisystem)