community.general.purefb_facts – Collect facts from Pure Storage FlashBlade

From Get docs
Ansible/docs/2.11/collections/community/general/purefb facts module


community.general.purefb_facts – Collect facts from Pure Storage FlashBlade

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.purefb_facts.


DEPRECATED

Removed in
version 3.0.0
Why
Deprecated in favor of _info module.
Alternative
Use purestorage.flashblade.purefb_info instead.

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

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

string

FlashBlade API token for admin privileged user.

fb_url

string

FlashBlade management IP address or Hostname.

gather_subset

list / elements=string

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
  community.general.purefb_facts:
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Collect configuration and capacity facts
  community.general.purefb_facts:
    gather_subset:
      - config
      - capacity
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Collect all facts
  community.general.purefb_facts:
    gather_subset:
      - all
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Status

  • This module will be removed in version 3.0.0. [deprecated]
  • For more information see DEPRECATED.

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/community/general/purefb_facts_module.html