netapp_eseries.santricity.netapp_e_alerts module – NetApp E-Series manage email notification settings

Note

This module is part of the netapp_eseries.santricity collection (version 1.4.0).

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 netapp_eseries.santricity.

To use it in a playbook, specify: netapp_eseries.santricity.netapp_e_alerts.

New in netapp_eseries.santricity 2.7

Synopsis

  • Certain E-Series systems have the capability to send email notifications on potentially critical events.

  • This module will allow the owner of the system to specify email recipients for these messages.

Parameters

Parameter

Comments

api_password

string / required

The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.

api_url

string / required

The url to the SANtricity Web Services Proxy or Embedded Web Services API. Example https://prod-1.wahoo.acme.com/devmgr/v2

api_username

string / required

The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.

contact

string

Allows the owner to specify some free-form contact information to be included in the emails.

This is typically utilized to provide a contact phone number.

log_path

string

Path to a file on the Ansible control node to be used for debug logging

recipients

list / elements=string

The email addresses that will receive the email notifications.

Required when state=enabled.

sender

string

This is the sender that the recipient will see. It doesn’t necessarily need to be a valid email account.

Required when state=enabled.

server

string

A fully qualified domain name, IPv4 address, or IPv6 address of a mail server.

To use a fully qualified domain name, you must configure a DNS server on both controllers using ERROR while parsing: While parsing “M(netapp_e_mgmt_interface)” at index 97: Module name “netapp_e_mgmt_interface” is not a FQCN. - Required when state=enabled.

ssid

string

The ID of the array to manage. This value must be unique for each array.

Default: "1"

state

string

Enable/disable the sending of email-based alerts.

Choices:

  • "enabled" ← (default)

  • "disabled"

test

boolean

When a change is detected in the configuration, a test email will be sent.

This may take a few minutes to process.

Only applicable if state=enabled.

Choices:

  • false ← (default)

  • true

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

Notes

Note

  • Check mode is supported.

  • Alertable messages are a subset of messages shown by the Major Event Log (MEL), of the storage-system. Examples of alertable messages include drive failures, failed controllers, loss of redundancy, and other warning/critical events.

  • This API is currently only supported with the Embedded Web Services API v2.0 and higher.

  • The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.

  • Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.

  • ERROR while parsing: While parsing “M(netapp_e_storage_system)” at index 1: Module name “netapp_e_storage_system” is not a FQCN may be utilized for configuring the systems managed by a WSP instance.

Examples

- name: Enable email-based alerting
  netapp_e_alerts:
    state: enabled
    sender: [email protected]
    server: [email protected]
    contact: "Phone: 1-555-555-5555"
    recipients:
        - [email protected]
        - [email protected]
    api_url: "10.1.1.1:8443"
    api_username: "admin"
    api_password: "myPass"

- name: Disable alerting
  netapp_e_alerts:
    state: disabled
    api_url: "10.1.1.1:8443"
    api_username: "admin"
    api_password: "myPass"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Success message

Returned: on success

Sample: "The settings have been updated."

Authors

  • Michael Price (@lmprice)