purestorage.fusion.fusion_hw module – Create hardware types in Pure Storage Fusion

Note

This module is part of the purestorage.fusion collection (version 1.6.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_hw.

New in purestorage.fusion 1.0.0

DEPRECATED

Removed in:

major release after 2023-08-09

Why:

Hardware type cannot be modified in Pure Storage Fusion

Alternative:

there’s no alternative as this functionality has never worked before

Synopsis

  • Create a hardware type in Pure Storage Fusion.

Requirements

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

  • python >= 3.8

  • purefusion

Parameters

Parameter

Comments

access_token

string

Access token for Fusion Service

Defaults to the set environment variable under FUSION_ACCESS_TOKEN

array_type

string

The array type for the hardware type.

Choices:

  • "FA//X"

  • "FA//C"

display_name

string

The human name of the hardware type.

If not provided, defaults to name.

issuer_id

aliases: app_id

string

Application ID from Pure1 Registration page

eg. pure1:apikey:dssf2331sd

Defaults to the set environment variable under FUSION_ISSUER_ID

media_type

string

Volume size limit in M, G, T or P units.

name

string

The name of the hardware type.

private_key_file

aliases: key_file

string

Path to the private key file

Defaults to the set environment variable under FUSION_PRIVATE_KEY_FILE.

private_key_password

string

Password of the encrypted private key file

state

string

Define whether the hardware type should exist or not.

Currently there is no mechanism to delete a hardware type.

Choices:

  • "present" ← (default)

Notes

Note

  • Supports check mode.

  • This module requires the purefusion Python library

  • You must set FUSION_ISSUER_ID and FUSION_PRIVATE_KEY_FILE environment variables if issuer_id and private_key_file arguments are not passed to the module directly

  • If you want to use access token for authentication, you must use FUSION_ACCESS_TOKEN environment variable if access_token argument is not passed to the module directly

Examples

Status

  • This module will be removed in a major release after 2023-08-09. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Pure Storage Ansible Team (@sdodsley)