purestorage.flasharray.purefa_endpoint module – Manage VMware protocol-endpoints on Pure Storage FlashArrays

Note

This module is part of the purestorage.flasharray collection (version 1.13.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_endpoint.

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • Create, delete or eradicate the an endpoint on a Pure Storage FlashArray.

Requirements

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.22.0

  • netaddr

  • requests

  • pycountry

  • packaging

Parameters

Parameter

Comments

api_token

string

FlashArray API token for admin privileged user.

eradicate

boolean

Define whether to eradicate the endpoint on delete or leave in trash.

Choices:

  • no ← (default)

  • yes

fa_url

string

FlashArray management IPv4 address or Hostname.

hgroup

string

name of hostgroup to attach endpoint to

host

string

name of host to attach endpoint to

name

string / required

The name of the endpoint.

rename

string

Value to rename the specified endpoint to.

Rename only applies to the container the current endpoint is in.

state

string

Define whether the endpoint should exist or not.

Choices:

  • absent

  • present ← (default)

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 endpoint named foo
  purestorage.flasharray.purefa_endpoint:
    name: test-endpoint
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Delete and eradicate endpoint named foo
  purestorage.flasharray.purefa_endpoint:
    name: foo
    eradicate: yes
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Rename endpoint foor to bar
  purestorage.flasharray.purefa_endpoint:
    name: foo
    rename: bar
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

volume

dictionary

A dictionary describing the changed volume. Only some attributes below will be returned with various actions.

Returned: success

created

string

Volume creation time

Returned: success

Sample: “2019-03-13T22:49:24Z”

name

string

Volume name

Returned: success

serial

string

Volume serial number

Returned: success

Sample: “361019ECACE43D83000120A4”

source

string

Volume name of source volume used for volume copy

Returned: success

Authors

  • Pure Storage Ansible Team (@sdodsley)