W3cubDocs

/Ansible 2.11

purestorage.flasharray.purefa_vlan – Manage network VLAN interfaces in a Pure Storage FlashArray

Note

This plugin is part of the purestorage.flasharray collection (version 1.5.1).

To install it use: ansible-galaxy collection install purestorage.flasharray.

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

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • This module manages the VLAN network interfaces on a Pure Storage FlashArray.

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
address
string
IPv4 or IPv6 address of interface.
api_token
string
FlashArray API token for admin privileged user.
enabled
boolean
    Choices:
  • no
  • yes ←
Define if VLAN interface is enabled or not.
fa_url
string
FlashArray management IPv4 address or Hostname.
name
string / required
Interface name, including controller indentifier.
VLANs are only supported on iSCSI physical interfaces
state
string
    Choices:
  • present ←
  • absent
State of existing interface (on/off).
subnet
string / required
Name of subnet interface associated with.

Notes

Note

  • This module requires the purestorage Python library
  • 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: Configure and enable VLAN interface ct0.eth8 for subnet test
  purefa_vlan:
    name: ct0.eth8
    subnet: test
    address: 10.21.200.18
    state: present
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

- name: Disable VLAN interface for subnet test on ct1.eth2
  purefa_vlan:
    name: ct1.eth2
    subnet: test
    enabled: false
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

- name: Delete VLAN inteface for subnet test on ct0.eth4
  purefa_vlan:
    name: ct0.eth4
    subnet: test
    state: absent
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

Authors

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