W3cubDocs

/Ansible

purestorage.flashblade.purefb_banner module – Configure Pure Storage FlashBlade GUI and SSH MOTD message

Note

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

To use it in a playbook, specify: purestorage.flashblade.purefb_banner.

New in purestorage.flashblade 1.4.0

Synopsis

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

Requirements

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

  • python >= 3.9
  • py-pure-client
  • purity_fb >= 1.12.2
  • netaddr
  • datetime
  • pytz
  • distro
  • pycountry
  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashBlade API token for admin privileged user.

banner

string

Banner text, or MOTD, to use

Default: "Welcome to the machine..."

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)
  • true

fb_url

string

FlashBlade management IP address or Hostname.

state

string

Set ot delete the MOTD

Choices:

  • "present" ← (default)
  • "absent"

Notes

Note

  • This module requires the purity_fb Python library
  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Set new banner text
  purestorage.flashblade.purefb_banner:
    banner: "Banner over\ntwo lines"
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete banner text
  purestorage.flashblade.purefb_banner:
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

  • Pure Storage Ansible Team (@sdodsley)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flashblade/purefb_banner_module.html