ieisystem.inmanage.edit_alert_policy (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 alert policy 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: Alert policy test
  hosts: inmanage
  connection: local
  gather_facts: no
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set alert policy"
    ieisystem.inmanage.edit_alert_policy:
      id: 1
      status: "enable"
      type: "snmp"
      destination: "100.2.2.2"
      channel: "shared"
      provider: "{{ inmanage }}"

  - name: "Set alert policy"
    ieisystem.inmanage.edit_alert_policy:
      id: 1
      status: "disable"
      provider: "{{ inmanage }}"

Inputs

    
id:
    choices:
    - 1
    - 2
    - 3
    - 4
    description:
    - Alert id. Customize the channel for sending alarms in Trap.
    - The values for M5 modules are 1, 2, 3.
    - The values for M6 modules are 1, 2, 3, 4.
    required: true
    type: int

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

type:
    choices:
    - snmp
    - email
    - snmpdomain
    description:
    - Alert Type.
    - Only the M5 model supports this parameter.
    type: str

status:
    choices:
    - enable
    - disable
    description:
    - Alert policy status. Whether to enable the receiving end for sending messages in
      trap mode.
    type: str

channel:
    choices:
    - shared
    - dedicated
    description:
    - LAN Channel.
    - 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

trap_port:
    description:
    - SNMP trap port(1-65535).
    - Only the M6 model supports this parameter.
    type: int

destination:
    description:
    - Alert destination. The address of the server receiving trap information sent by
      Trap.
    - When type is snmp, specify an IP address.
    - When type is email, specify a username.
    - When type is snmpdomain, specify a domain.
    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