kaytus.ksmanage.edit_alert_policy module – Set alert policy

Note

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

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_alert_policy.

New in kaytus.ksmanage 1.0.0

Synopsis

  • Set alert policy on kaytus Server.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

channel

string

LAN Channel.

Only the M5 model supports this parameter.

Choices:

  • "shared"

  • "dedicated"

destination

string

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.

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.

id

integer / required

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.

Choices:

  • 1

  • 2

  • 3

  • 4

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.

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.

status

string

Alert policy status. Whether to enable the receiving end for sending messages in trap mode.

Choices:

  • "enable"

  • "disable"

trap_port

integer

SNMP trap port(1-65535).

Only the M6 model supports this parameter.

type

string

Alert Type.

Only the M5 model supports this parameter.

Choices:

  • "snmp"

  • "email"

  • "snmpdomain"

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.

Notes

Note

  • Does not support check_mode.

Examples

- name: Alert policy test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

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

  - name: "Set alert policy"
    kaytus.ksmanage.edit_alert_policy:
      id: 1
      status: "disable"
      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)