Try SpotterDestination Email operations on a PowerStore storage system
| "added in version" 1.5.0 of dellemc.powerstore"
Authors: Trisha Datta (@Trisha_Datta) <ansible.team@dell.com>
Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0
collections:
- name: dellemc.powerstore
version: 3.2.0Performs all destination email operations on a PowerStore Storage System.
This module supports get details of an existing destination email address. Create/Add new destination email address for all supported parameters.
This Module supports modify destination email address with supported parameters.
This Module supports delete/remove a specific destination email address. Send a test mail to a specific destination email address.
- name: Get details of destination email with email_id
dellemc.powerstore.email:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98"
state: "present"
- name: Get details of destination email with email_address
dellemc.powerstore.email:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
email_address: "abc@dell.com"
state: "present"
- name: Create destination email
dellemc.powerstore.email:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
email_address: "abc_xyz@dell.com"
notify:
info: true
critical: true
major: false
state: "present"
- name: Modify destination email
dellemc.powerstore.email:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
email_address: "abc_xyz@dell.com"
new_address: "def_pqr@dell.com"
notify:
info: false
major: false
state: "present"
- name: Send a test mail to the destination email with email_id
dellemc.powerstore.email:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98"
send_test_email: true
state: "present"
- name: Delete destination email
dellemc.powerstore.email:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
email_address: "def_pqr@dell.com"
state: "absent"
port:
description:
- Port number for the PowerStore array.
- If not passed, it will take 443 as default.
type: int
user:
description:
- The username of the PowerStore host.
required: true
type: str
state:
choices:
- present
- absent
description:
- The state of the destination email address after the task is performed.
- For Delete operation only, it should be set to C(absent).
- For all Create, Modify, Test or Get details operations it should be set to C(present).
required: true
type: str
notify:
description:
- Whether to send different types of notifications. It contains below optional candidate
variables.
suboptions:
critical:
description:
- Whether to send notifications for critical alerts.
type: bool
info:
description:
- Whether to send notifications for informational alerts.
type: bool
major:
description:
- Whether to send notifications for major alerts.
type: bool
minor:
description:
- Whether to send notifications for minor alerts.
type: bool
type: dict
timeout:
default: 120
description:
- Time after which the connection will get terminated.
- It is to be mentioned in seconds.
type: int
array_ip:
description:
- IP or FQDN of the PowerStore management system.
required: true
type: str
email_id:
description:
- Unique identifier of the destination email address.
- Mutually exclusive with I(email_address).
type: str
password:
description:
- The password of the PowerStore host.
required: true
type: str
new_address:
description:
- New email address to receive notifications.
type: str
email_address:
description:
- Email address to receive notifications.
- Mutually exclusive with I(email_id).
type: str
validate_certs:
aliases:
- verifycert
default: true
description:
- Boolean variable to specify whether to validate SSL certificate or not.
- C(true) - indicates that the SSL certificate should be verified. Set the environment
variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
- C(false) - indicates that the SSL certificate should not be verified.
type: bool
send_test_email:
default: false
description:
- Whether to send the test email to the destination email address.
type: bool
changed:
description: Whether or not the resource has changed.
returned: always
sample: 'false'
type: bool
email_details:
contains:
email_address:
description: Email address to receive notifications.
type: str
id:
description: The system generated ID of the destination email instance.
type: str
notify:
contains:
critical:
description: Whether to send notifications for critical alerts.
type: bool
info:
description: Whether to send notifications for informational alerts.
type: bool
major:
description: Whether to send notifications for major alerts.
type: bool
minor:
description: Whether to send notifications for minor alerts.
type: bool
description:
- Whether to send different types of notifications.
type: complex
description: Details of the destination email address.
returned: When destination email address exists
sample:
email_address: abc@dell.com
id: e49c9469-a055-4207-898e-0c4150737722
notify:
critical: true
info: true
major: true
minor: true
type: complex