purestorage.flashblade.purefb_info (1.17.0) — module

Collect information from Pure Storage FlashBlade

| "added in version" 1.0.0 of purestorage.flashblade"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install purestorage.flashblade:==1.17.0


Add to requirements.yml

  collections:
    - name: purestorage.flashblade
      version: 1.17.0

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: collect default set of info
  purestorage.flashblade.purefb_info:
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  register: blade_info
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show default information
  debug:
    msg: "{{ blade_info['purefb_info']['default'] }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: collect configuration and capacity info
  purestorage.flashblade.purefb_info:
    gather_subset:
      - config
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  register: blade_info
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show config information
  debug:
    msg: "{{ blade_info['purefb_info']['config'] }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: collect all info
  purestorage.flashblade.purefb_info:
    gather_subset:
      - all
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  register: blade_info
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show all information
  debug:
    msg: "{{ blade_info['purefb_info'] }}"

Inputs

    
fb_url:
    description:
    - FlashBlade management IP address or Hostname.
    type: str

api_token:
    description:
    - FlashBlade API token for admin privileged user.
    type: str

gather_subset:
    default: minimum
    description:
    - When supplied, this argument will define the information to be collected. Possible
      values for this include all, minimum, config, performance, capacity, network, subnets,
      lags, filesystems, snapshots, buckets, replication, policies, arrays, accounts,
      admins, ad, kerberos and drives.
    elements: str
    required: false
    type: list

Outputs

purefb_info:
  description: Returns the information collected from the FlashBlade
  returned: always
  type: dict