purestorage.fusion.fusion_array module – Manage arrays in Pure Storage Fusion

Note

This module is part of the purestorage.fusion collection (version 1.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install purestorage.fusion. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.fusion.fusion_array.

New in purestorage.fusion 1.0.0

Synopsis

  • Create or delete an array in Pure Storage Fusion.

Requirements

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

  • python >= 3.5

  • purefusion

Parameters

Parameter

Comments

app_id

string

Application ID from Pure1 Registration page

eg. pure1:apikey:dssf2331sd

Defaults to the set environment variable under FUSION_APP_ID

appliance_id

string / required

Appliance ID of the array.

availability_zone

aliases: az

string / required

The availability zone the array is located in.

display_name

string

The human name of the array.

If not provided, defaults to name.

hardware_type

string / required

Hardware type to which the storage class applies.

Choices:

  • "flash-array-x"

  • "flash-array-c"

  • "flash-array-x-optane"

  • "flash-array-xl"

host_name

string / required

Management IP address of the array, or FQDN.

key_file

string

Path to the private key file

Defaults to the set environment variable under FUSION_PRIVATE_KEY_FILE.

maintenance_mode

boolean

Set the array in maintenance mode or not.

Choices:

  • false

  • true

name

string / required

The name of the array.

region

string / required

The region the AZ is in.

state

string

Define whether the array should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Supports check mode.

  • This module requires the purefusion Python library

  • You must set FUSION_APP_ID and FUSION_PRIVATE_KEY_FILE environment variables if app_id and key_file arguments are not passed to the module directly

Examples

- name: Create new array foo
  purestorage.fusion.fusion_array:
    name: foo
    az: zone_1
    hardware_type: bigfast
    display_name: "foo array"
    appliance_id: 1227571-198887878-35016350232000707
    app_id: key_name
    key_file: "az-admin-private-key.pem"

Authors

  • Pure Storage Ansible Team (@sdodsley)