inspur.sm.edit_alert_policy – Set alert policy.

From Get docs
Ansible/docs/2.11/collections/inspur/sm/edit alert policy module


inspur.sm.edit_alert_policy – Set alert policy.

Note

This plugin is part of the inspur.sm collection (version 1.1.2).

To install it use: ansible-galaxy collection install inspur.sm.

To use it in a playbook, specify: inspur.sm.edit_alert_policy.


New in version 0.1.0: of inspur.sm


Synopsis

  • Set alert policy on Inspur server.

Parameters

Parameter Choices/Defaults Comments

channel

string

  • shared
  • dedicated

LAN Channel.

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

  • 1
  • 2
  • 3

Alert id.

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

  • enable
  • disable

Alert policy status.

type

string

  • snmp
  • email
  • snmpdomain

Alert Type.

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.



Examples

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

  tasks:

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

  - name: "Set alert policy"
    inspur.sm.edit_alert_policy:
      id: 1
      status: "disable"
      provider: "{{ ism }}"

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 (@ISIB-group)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/inspur/sm/edit_alert_policy_module.html