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

Note

This plugin is part of the purestorage.flasharray collection (version 1.11.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.

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

New in version 1.0.0: of purestorage.flasharray

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 >= 2.7
  • purestorage >= 1.19
  • py-pure-client >= 1.6.0
  • netaddr
  • requests

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashArray API token for admin privileged user.
copyable
boolean
    Choices:
  • no
  • yes ←
Define whether the volume tags are inherited on volume copies.
fa_url
string
FlashArray management IPv4 address or Hostname.
kvp
list / elements=string / required
List of key value pairs to assign to the volume.
Seperate the key from the value using a colon (:) only.
All items in list will use namespace and copyable settings.
Maximum of 5 tags per volume
See examples for exact formatting requirements
name
string / required
The name of the volume.
namespace
string
Default:
"default"
The name of tag namespace
state
string
    Choices:
  • absent
  • present ←
Define whether the volume tag(s) should exist or not.

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries
  • Additional Python librarues 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
  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 an existing tag in namespace test for volume foo
  purefa_volume_tags:
    name: foo
    namespace: test
    kvp:
    - 'key1:value1'
    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
  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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flasharray/purefa_volume_tags_module.html