purefa_facts - Collect facts from Pure Storage FlashArray¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Returned Facts
Status
- Author

Synopsis ¶

Collect facts information from a Pure Storage Flasharray running the Purity//FA operating system. By default, the module will collect basic fact information including hosts, host groups, protection groups and volume counts. Additional fact information can be collected based on the configured set of arguements.

Requirements ¶

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

python >= 2.7
purestorage

Parameters ¶

Parameter	Choices/Defaults	Comments
api_token required		FlashArray API token for admin privilaged user.
fa_url required		FlashArray management IPv4 address or Hostname.
gather_subset	Default: minimum	When supplied, this argument will define the facts to be collected. Possible values for this include all, minimum, config, performance, capacity, network, subnet, interfaces, hgroups, pgroups, hosts, volumes and snapshots.

Notes ¶

Note

This module requires purestorage python library
You must set PUREFA_URL and PUREFA_API environment variables if url and api_token arguments are not passed to the module directly

Examples ¶

- name: collect default set of facts
  purefa_facts:
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: collect configuration and capacity facts
  purefa_facts:
    gather_subset:
      - config
      - capacity
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: collect all facts
  purefa_facts:
    gather_subset:
      - all
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Returned Facts ¶

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Fact	Returned	Description
capacity
config
default
hgroups
hosts
interfaces
network
performance
pgroups
snapshots
subnet
volumes

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Simon Dodsley (@sdodsley)

Hint

If you notice any issues in this documentation you can edit this document to improve it.