kaytus.ksmanage.edit_alert_policy – Set alert policy

Note

This plugin is part of the kaytus.ksmanage collection.

To install it use: ansible-galaxy collection install kaytus.ksmanage.

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

New in version 1.0.0: of kaytus.ksmanage

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 Choices/Defaults Comments
channel
string
    Choices:
  • shared
  • dedicated
LAN Channel.
Only the M5 model supports this parameter.
destination
string
Alert destination,when type is snmp,fill in IP.
When type is email,fill in user name.
When type is snmpdomain,fill in 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
    Choices:
  • 1
  • 2
  • 3
  • 4
Alert id.
The values for M5 modules are 1,2,3.
The values for M6 modules are 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
    Choices:
  • enable
  • disable
Alert policy status.
trap_port
integer
SNMP trap port(1-65535).
Only the M6 model supports this parameter.
type
string
    Choices:
  • snmp
  • email
  • snmpdomain
Alert Type.
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.

Notes

Note

  • Does not support check_mode.

Examples

- name: Alert policy test
  hosts: ksmanage
  connection: local
  gather_facts: no
  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 Returned Description
changed
boolean
always
Check to see if a change was made on the device.
message
string
always
Messages returned after module execution.
state
string
always
Status after module execution.


Authors

  • WangBaoshan (@ieisystem)