purestorage.flasharray.purefa_smtp – Configure FlashArray SMTP settings
Note
This plugin is part of the purestorage.flasharray collection (version 1.5.1).
To install it use: ansible-galaxy collection install purestorage.flasharray
.
To use it in a playbook, specify: purestorage.flasharray.purefa_smtp
.
New in version 1.0.0: of purestorage.flasharray
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 >= 2.7
- purestorage >= 1.19
- py-pure-client >= 1.6.0
- netaddr
- requests
Parameters
Parameter | Choices/Defaults | 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 |
user string | The SMTP username. |
Notes
Note
- This module requires the
purestorage
Python library - You must set
PUREFA_URL
andPUREFA_API
environment variables if fa_url and api_token arguments are not passed to the module directly
Examples
- name: Delete exisitng SMTP settings purefa_smtp: state: absent fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 - name: Set SMTP settings 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) <pure-ansible-team@purestorage.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/purestorage/flasharray/purefa_smtp_module.html