dellemc.powerstore.smtp_config (3.2.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0

Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 3.2.0

Description

Performs all SMTP configuration operations on a PowerStore Storage System.

This module supports get details of an existing SMTP configuration. You can modify an existing SMTP configuration with supported parameters. You can also send a test mail through configured SMTP server.

Requirements

• A Dell PowerStore storage system version 3.0.0.0 or later.
• Ansible-core 2.14 or later.
• PyPowerStore 3.1.0.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get details of SMTP configuration
  dellemc.powerstore.smtp_config:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    smtp_id: "0"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify SMTP config details
  dellemc.powerstore.smtp_config:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    smtp_id: "0"
    smtp_address: "sample.smtp.com"
    source_email: "def@dell.com"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Send a test mail through the SMTP server
  dellemc.powerstore.smtp_config:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    smtp_id: "0"
    destination_email: "abc@dell.com"
    state: "present"

Inputs

    
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 SMTP configuration after the task is performed.
    - For Delete operation only, it should be set to C(absent)
    - For all operations it should be set to C(present).
    required: true
    type: str

smtp_id:
    default: 0
    description:
    - Unique identifier of the SMTP configuration. This value is always '0'.
    type: int

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

password:
    description:
    - The password of the PowerStore host.
    required: true
    type: str

smtp_port:
    description:
    - Port used for sending SMTP messages.
    type: int

smtp_address:
    description:
    - IP address of the SMTP server.
    type: str

source_email:
    description:
    - Source email address used for sending SMTP messages.
    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

destination_email:
    description:
    - Destination email address for the test.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
smtp_config_details:
  contains:
    address:
      description: IP address of the SMTP server.
      type: str
    id:
      description: Unique identifier of SMTP configuration.
      type: int
    port:
      description: Port used for sending SMTP messages.
      type: int
    source_email:
      description: Source email address used for sending SMTP messages.
      type: str
  description: Details of the SMTP configuration.
  returned: When SMTP configuration exists.
  sample:
    address: sample.com
    id: '0'
    port: 25
    source_email: sample_source@dell.com
  type: complex