purestorage.flasharray.purefa_console – Enable or Disable Pure Storage FlashArray Console Lock

From Get docs
Ansible/docs/2.11/collections/purestorage/flasharray/purefa console module


purestorage.flasharray.purefa_console – Enable or Disable Pure Storage FlashArray Console Lock

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


New in version 1.0.0: of purestorage.flasharray


Synopsis

  • Enablke or Disable root lockout from the array at the physical console for a Pure Storage FlashArray.

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

  • enable
  • disable

Define state of console lockout

When set to enable the console port is locked from root login.



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: Enable Console Lockout
  purefa_console:
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Disable Console Lockout
  purefa_console:
    state: disable
    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_console_module.html