purestorage.flasharray.purefa_smtp module – Configure FlashArray SMTP settings

Note

This module is part of the purestorage.flasharray collection (version 1.24.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 purestorage.flasharray. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.flasharray.purefa_smtp.

New in purestorage.flasharray 1.0.0

Synopsis

  • Set or erase configuration for the SMTP settings.

  • If username/password are set this will always force a change as there is no way to see if the password is differnet from the current SMTP configuration.

  • Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • packaging

Parameters

Parameter

Comments

api_token

string

FlashArray API token for admin privileged user.

fa_url

string

FlashArray management IPv4 address or Hostname.

password

string

The SMTP password.

relay_host

string

IPv4 or IPv6 address or FQDN. A port number may be appended.

sender_domain

string

Domain name.

state

string

Set or delete SMTP configuration

Choices:

  • "absent"

  • "present" ← (default)

user

string

The SMTP username.

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries

  • Additional Python librarues may be required for specific modules.

  • You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly

Examples

- name: Delete exisitng SMTP settings
  purestorage.flasharray.purefa_smtp:
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Set SMTP settings
  purestorage.flasharray.purefa_smtp:
    sender_domain: purestorage.com
    password: account_password
    user: smtp_account
    relay_host: 10.2.56.78:2345
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage ansible Team (@sdodsley)