New in version 2.7.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_password
required |
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
api_url
required |
The url to the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
api_username
required |
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
contact |
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 |
Path to a file on the Ansible control node to be used for debug logging
|
|
recipients |
The email addresses that will receive the email notifications.
Required when state=enabled.
|
|
sender |
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 |
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 netapp_e_mgmt_interface. - Required when state=enabled.
|
|
ssid
required |
The ID of the array to manage. This value must be unique for each array.
|
|
state |
|
Enable/disable the sending of email-based alerts.
|
test
bool |
|
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.
|
validate_certs
bool |
|
Should https certificates be validated?
|
Note
- name: Enable email-based alerting
netapp_e_alerts:
state: enabled
sender: noreply@example.com
server: mail@example.com
contact: "Phone: 1-555-555-5555"
recipients:
- name1@example.com
- name2@example.com
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"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg
string
|
on success |
Success message
Sample:
The settings have been updated.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.