purestorage.flasharray.purefa_volume_tags module – Manage volume tags on Pure Storage FlashArrays

Note

This module is part of the purestorage.flasharray collection (version 1.42.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.flasharray. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.flasharray.purefa_volume_tags.

New in purestorage.flasharray 1.0.0

Synopsis

  • Manage volume tags for volumes on Pure Storage FlashArray.

  • Requires a minimum of Purity 6.0.0

Requirements

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashArray API token for admin privileged user.

context

string

added in purestorage.flasharray 1.38.0

Name of fleet member on which to perform the operation.

This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet.

Default: ""

copyable

boolean

Define whether the volume tags are inherited on volume copies.

Choices:

  • false

  • true ← (default)

disable_warnings

boolean

added in purestorage.flasharray 1.29.0

Disable insecure certificate warnings in debug logs

Choices:

  • false ← (default)

  • true

fa_url

string

FlashArray management IPv4 address or Hostname.

kvp

list / elements=string

List of key value pairs to assign to the volume.

Separate the key from the value using a colon (:) only.

All items in list will use namespace and copyable settings.

See examples for exact formatting requirements

name

string / required

The name of the volume.

namespace

string

The name of tag namespace

Default: "default"

state

string

Define whether the volume tag(s) should exist or not.

Choices:

  • "absent"

  • "present" ← (default)

tag

list / elements=string

added in purestorage.flasharray 1.38.0

List of volume tags to be deleted from a volume

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries.

  • Additional Python libraries may be required for specific modules.

  • You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly.

Examples

- name: Create new tags in namespace test for volume foo
  purestorage.flasharray.purefa_volume_tags:
    name: foo
    namespace: test
    copyable: false
    kvp:
    - 'key1:value1'
    - 'key2:value2'
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Remove existing tags, by key, in namespace test for volume foo
  purestorage.flasharray.purefa_volume_tags:
    name: foo
    namespace: test
    tag:
    - key1
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Update an existing tag in namespace test for volume foo
  purestorage.flasharray.purefa_volume_tags:
    name: foo
    namespace: test
    kvp:
    - 'key1:value2'
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

Authors

  • Pure Storage Ansible Team (@sdodsley)