purefb_facts – Collect facts from Pure Storage FlashBlade¶
New in version 2.7.
Synopsis¶
- Collect facts information from a Pure Storage FlashBlade running the Purity//FB 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
- purity_fb >= 1.1
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_token
-
|
FlashBlade API token for admin privilaed user.
|
|
fb_url
-
|
FlashBlade management IP 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, subnets, lags, filesystems and snapshots.
|
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: collect default set of facts
purefb_facts:
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: collect configuration and capacity facts
purefb_facts:
gather_subset:
- config
- capacity
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: collect all facts
purefb_facts:
gather_subset:
- all
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
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
-
|
|
|
filesystems
-
|
|
|
lag
-
|
|
|
network
-
|
|
|
performance
-
|
|
|
snapshots
-
|
|
|
subnet
-
|
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Simon Dodsley (@sdodsley)
Hint
If you notice any issues in this documentation you can edit this document to improve it.