ansible / ansible.builtin / v2.9.27 / module / purefa_info Collect information from Pure Storage FlashArray | "added in version" 2.9 of ansible.builtin" Authors: Pure Storage ansible Team (@sdodsley) <pure-ansible-team@purestorage.com> preview | supported by communityansible.builtin.purefa_info (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
Collect information from a Pure Storage Flasharray running the Purity//FA 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 arguments.
- name: collect default set of information purefa_info: fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 register: array_info
- name: show default information debug: msg: "{{ array_info['purefa_info']['default'] }}"
- name: collect configuration and capacity information purefa_info: gather_subset: - config fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 register: array_info
- name: show configuration information debug: msg: "{{ array_info['purefa_info']['config'] }}"
- name: collect all information purefa_info: gather_subset: - all fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: show all information debug: msg: "{{ array_info['purefa_info'] }}"
fa_url: description: - FlashArray management IPv4 address or Hostname. required: true type: str api_token: description: - FlashArray API token for admin privileged user. required: true 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, subnet, interfaces, hgroups, pgroups, hosts, admins, volumes, snapshots, pods, vgroups, offload, apps, arrays, certs and kmip. required: false type: list
purefa_info: description: Returns the information collected from the FlashArray returned: always sample: admins: pureuser: role: array_admin type: local apps: offload: description: Snapshot offload to NFS or Amazon S3 status: healthy version: 5.2.1 arrays: {} capacity: data_reduction: 11.664774599686346 free_space: 6995782867042 provisioned_space: 442391871488 shared_space: 3070918120 snapshot_space: 284597118 system_space: 0 thin_provisioning: 0.8201773449669771 total_capacity: 7002920315199 total_reduction: 64.86821472825108 volume_space: 3781932919 config: directory_service: base_dn: null bind_password: null bind_user: null check_peer: false enabled: false uri: [] user_login_attribute: null user_object_class: null directory_service_roles: array_admin: group: null group_base: null ops_admin: group: null group_base: null readonly: group: null group_base: null storage_admin: group: null group_base: null dns: domain: acme.com nameservers: - 8.8.4.4 global_admin: lockout_duration: null max_login_attempts: null min_password_length: 1 single_sign_on_enabled: false idle_timeout: 0 ntp: - prod-ntp1.puretec.purestorage.com phonehome: enabled proxy: '' relayhost: smtp.puretec.purestorage.com scsi_timeout: 60 senderdomain: purestorage.com smtp: - enabled: true name: flasharray-alerts@purestorage.com snmp: - auth_passphrase: null auth_protocol: null community: '****' host: 10.21.23.34 name: manager1 notification: trap privacy_passphrase: null privacy_protocol: null user: null version: v2c syslog: - udp://prod-ntp2.puretec.purestorage.com:333 default: admins: 1 array_model: FA-405 array_name: array connected_arrays: 0 connection_key: c6033033-fe69-2515-a9e8-966bb7fe4b40 hostgroups: 0 hosts: 15 pods: 1 protection_groups: 1 purity_version: 5.2.1 snapshots: 2 volume_groups: 1 hgroups: {} hosts: '@offload': hgroup: null iqn: [] nqn: [] personality: null preferred_array: [] target_port: [] wwn: [] docker-host: hgroup: null iqn: - iqn.1994-05.com.redhat:d97adf78472 nqn: [] personality: null preferred_array: [] target_port: - CT0.ETH4 - CT1.ETH4 wwn: [] interfaces: CT0.ETH4: iqn.2010-06.com.purestorage:flasharray.2111b767484e4682 CT1.ETH4: iqn.2010-06.com.purestorage:flasharray.2111b767484e4682 network: '@offload.data0': address: 10.21.200.222 gateway: 10.21.200.1 hwaddr: 52:54:30:02:b9:4e mtu: 1500 netmask: 255.255.255.0 services: - app speed: 10000000000 ct0.eth0: address: 10.21.200.211 gateway: 10.21.200.1 hwaddr: ec:f4:bb:c8:8a:04 mtu: 1500 netmask: 255.255.255.0 services: - management speed: 1000000000 ct0.eth2: address: 10.21.200.218 gateway: null hwaddr: ec:f4:bb:c8:8a:00 mtu: 1500 netmask: 255.255.255.0 services: - replication speed: 10000000000 ct0.eth4: address: 10.21.200.214 gateway: null hwaddr: 90:e2:ba:83:79:0c mtu: 1500 netmask: 255.255.255.0 services: - iscsi speed: 10000000000 ct1.eth0: address: 10.21.200.212 gateway: 10.21.200.1 hwaddr: ec:f4:bb:e4:c6:3c mtu: 1500 netmask: 255.255.255.0 services: - management speed: 1000000000 ct1.eth2: address: 10.21.200.220 gateway: null hwaddr: ec:f4:bb:e4:c6:38 mtu: 1500 netmask: 255.255.255.0 services: - replication speed: 10000000000 ct1.eth4: address: 10.21.200.216 gateway: null hwaddr: 90:e2:ba:8b:b1:8c mtu: 1500 netmask: 255.255.255.0 services: - iscsi speed: 10000000000 vir0: address: 10.21.200.210 gateway: 10.21.200.1 hwaddr: fe:ba:e9:e7:6b:0f mtu: 1500 netmask: 255.255.255.0 services: - management speed: 1000000000 nfs_offload: {} performance: input_per_sec: 0 local_queue_usec_per_op: 0 output_per_sec: 0 qos_rate_limit_usec_per_read_op: 0 qos_rate_limit_usec_per_write_op: 0 queue_depth: 0 queue_usec_per_read_op: 0 queue_usec_per_write_op: 0 reads_per_sec: 0 san_usec_per_read_op: 0 san_usec_per_write_op: 0 time: '2019-08-14T21:33:51Z' usec_per_read_op: 0 usec_per_write_op: 0 writes_per_sec: 0 pgroups: test_pg: hgroups: null hosts: null source: docker-host targets: null volumes: null pods: test: arrays: - array_id: 043be47c-1233-4399-b9d6-8fe38727dd9d mediator_status: online name: array2 status: online source: null s3_offload: s3-offload: access_key_id: AKIAILNVEPWZTV4FGWZQ bucket: offload-bucket protocol: s3 status: connected snapshots: '@offload_boot.1': created: '2019-03-14T15:29:20Z' size: 68719476736 source: '@offload_boot' subnet: {} vgroups: test: volumes: - test/test - test/test1 volumes: '@offload_boot': bandwidth: null hosts: - - '@offload' - 1 serial: 43BE47C12334399B00013959 size: 68719476736 source: null docker-store: bandwidth: null hosts: - - docker-host - 1 serial: 43BE47C12334399B00011418 size: 21474836480 source: null type: complex