purestorage.flasharray.purefa_inventory – Collect information from Pure Storage FlashArray

Note

This plugin is part of the purestorage.flasharray collection (version 1.11.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.flasharray.

To use it in a playbook, specify: purestorage.flasharray.purefa_inventory.

New in version 1.0.0: of purestorage.flasharray

Synopsis

Collect hardware inventory information from 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.

Notes

Note

This module requires the purestorage and py-pure-client Python libraries
Additional Python librarues may be required for specific modules.
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: collect FlashArray invenroty
  purefa_inventory:
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: show inventory information
  debug:
    msg: "{{ array_info['purefa_info'] }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
purefa_inventory complex	always	Returns the inventory information for the FlashArray Sample: {'controllers': {'CT0': {'model': None, 'serial': None, 'status': 'ok'}, 'CT1': {'model': 'FA-405', 'serial': 'FHVBT52', 'status': 'ok'}}, 'drives': {'SH0.BAY0': {'capacity': 2147483648, 'protocol': 'SAS', 'serial': 'S18NNEAFA01416', 'status': 'healthy', 'type': 'NVRAM'}, 'SH0.BAY1': {'capacity': 511587647488, 'protocol': 'SAS', 'serial': 'S0WZNEACC00517', 'status': 'healthy', 'type': 'SSD'}, 'SH0.BAY10': {'capacity': 511587647488, 'protocol': 'SAS', 'serial': 'S0WZNEACB00266', 'status': 'healthy', 'type': 'SSD'}}, 'fans': {'CT0.FAN0': {'status': 'ok'}, 'CT0.FAN1': {'status': 'ok'}, 'CT0.FAN10': {'status': 'ok'}}, 'interfaces': {'CT0.ETH0': {'speed': 1000000000, 'status': 'ok'}, 'CT0.ETH1': {'speed': 0, 'status': 'ok'}, 'CT0.FC0': {'speed': 8000000000, 'status': 'ok'}, 'CT1.IB1': {'speed': 56000000000, 'status': 'ok'}, 'CT1.SAS0': {'speed': 24000000000, 'status': 'ok'}}, 'power': {'CT0.PWR0': {'model': None, 'serial': None, 'status': 'ok', 'voltage': None}, 'CT0.PWR1': {'model': None, 'serial': None, 'status': 'ok', 'voltage': None}}, 'temps': {'CT0.TMP0': {'status': 'ok', 'temperature': 18}, 'CT0.TMP1': {'status': 'ok', 'temperature': 32}}}

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/latest/collections/purestorage/flasharray/purefa_inventory_module.html

Docs

Docs4dev

Title here