Docs4dev
Docs
ansible / 2.10 / collections / purestorage / flasharray / purefa_timeout_module.html

purestorage.flasharray.purefa_timeout – Configure Pure Storage FlashArray GUI idle timeout

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

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • Configure GUI idle timeout for Pure Storage FlashArrays.
  • This does not affect existing GUI sessions.

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.
state
string
    Choices:
  • present ←
  • absent
Set or disable the GUI idle timeout
timeout
integer
Default:
30
Minutes for idle timeout.

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 GUI idle timeout to 25 minutes
  purefa_gui:
    timeout: 25
    state: present
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Disable idle timeout
  purefa_gui:
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/purestorage/flasharray/purefa_timeout_module.html