W3cubDocs

/Ansible 2.11

purestorage.flasharray.purefa_banner – Configure Pure Storage FlashArray GUI and SSH MOTD message

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_banner.

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • Configure MOTD for Pure Storage FlashArrays.
  • This will be shown during an SSH or GUI login to the array.
  • Multiple line messages can be achieved using \n.

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.
banner
string
Default:
"Welcome to the machine..."
Banner text, or MOTD, to use
fa_url
string
FlashArray management IPv4 address or Hostname.
state
string
    Choices:
  • present ←
  • absent
Set ot delete the MOTD

Notes

Note

  • This module requires the purestorage Python library
  • 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: Set new banner text
  purefa_banner:
    banner: "Banner over\ntwo lines"
    state: present
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete banner text
  purefa_banner:
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

© 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_banner_module.html