ieisystem.inmanage.edit_snmp_trap (1.1.1) — module

Install collection

Install with ansible-galaxy collection install ieisystem.inmanage:==1.1.1

Add to requirements.yml

  collections:
    - name: ieisystem.inmanage
      version: 1.1.1

Description

Set snmp trap on ieisystem Server.

Requirements

• Python 3.7+
• inManage

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Inputs

    
os:
    description:
    - Set the host operating system, can be NULL.
    - Only the M5 model supports this parameter.
    type: str

host:
    description:
    - 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.
    type: str

contact:
    description:
    - Set the contact, can be NULL.
    - Only the M5 model supports this parameter.
    type: str

host_id:
    choices:
    - HostName
    - SerialNum
    - AssertTag
    description:
    - Host id.
    - Only the M6 model supports this parameter.
    type: str

version:
    choices:
    - 0
    - 1
    - 2
    - 3
    description:
    - SNMP trap version, 1 is v1, 2 is v2c(v2), 3 is v3, 0 is disable snmp trap.
    - Only the M6 model supports C(0) Settings.
    type: int

location:
    description:
    - Set the host location, can be NULL.
    - Only the M5 model supports this parameter.
    type: str

password:
    description:
    - 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 C(ANSIBLE_NET_PASSWORD)
      will be used instead.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      host:
        description:
        - 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.
        type: str
      password:
        description:
        - 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
          C(ANSIBLE_NET_PASSWORD) will be used instead.
        type: str
      username:
        description:
        - 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 C(ANSIBLE_NET_USERNAME) will be used instead.
        type: str
    type: dict

username:
    description:
    - 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 C(ANSIBLE_NET_USERNAME)
      will be used instead.
    type: str

community:
    description:
    - Community of v1/v2c.
    type: str

engine_id:
    description:
    - 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.
    type: str

system_id:
    description:
    - Set the system ID, can be NULL.
    - Only the M5 model supports this parameter.
    type: str

trap_port:
    description:
    - Set a port for the SNMP trap in the range of 1 to 65535.
    - Only the M5 model supports this parameter.
    type: int

v3username:
    description:
    - Set the username for the V3 trap.
    type: str

system_name:
    description:
    - Set the system name, can be NULL.
    - Only the M5 model supports this parameter.
    type: str

auth_password:
    description:
    - Set the authentication password for the V3 trap.
    - The password is a string of 8 to 16 alphanumeric characters.
    - Required when I(auth_protocol) is either C(SHA) or C(MD5).
    type: str

auth_protocol:
    choices:
    - NONE
    - SHA
    - MD5
    description:
    - Choose the authentication protocol for the V3 trap.
    type: str

priv_password:
    description:
    - Set the privacy password for the V3 trap.
    - The password is a string of 8 to 16 alphanumeric characters.
    - Required when I(priv_protocol) is either C(DES) or C(AES).
    type: str

priv_protocol:
    choices:
    - NONE
    - DES
    - AES
    description:
    - Choose the privacy protocol for the V3 trap.
    type: str

event_severity:
    choices:
    - all
    - warning
    - critical
    description:
    - Event Severity.
    type: str

Outputs

changed:
  description: Check to see if a change was made on the device.
  returned: always
  type: bool
message:
  description: Messages returned after module execution.
  returned: always
  type: str
state:
  description: Status after module execution.
  returned: always
  type: str