Docs4dev
Docs
ansible / 2.10 / collections / purestorage / flasharray / purefa_subnet_module.html

purestorage.flasharray.purefa_subnet – Manage network subnets 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_subnet.

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • This module manages the network subnets 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
api_token
string
FlashArray API token for admin privileged user.
enabled
boolean
    Choices:
  • no
  • yes ←
whether the subnet should be enabled or not
fa_url
string
FlashArray management IPv4 address or Hostname.
gateway
string
IPv4 or IPv6 address of subnet gateway.
mtu
integer
Default:
1500
MTU size of the subnet. Range is 568 to 9000.
name
string / required
Subnet name.
prefix
string
Set the IPv4 or IPv6 address to be associated with the subnet.
state
string
    Choices:
  • present ←
  • absent
Create or delete subnet.
vlan
integer
VLAN ID. Range is 0 to 4094.

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: Create subnet subnet100
  purefa_subnet:
    name: subnet100
    vlan: 100
    gateway: 10.21.200.1
    prefix: "10.21.200.0/24"
    mtu: 9000
    state: present
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

- name: Disable subnet subnet100
  purefa_subnet:
    name: subnet100
    enabled: false
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

- name: Delete subnet subnet100
  purefa_subnet:
    name: subnet100
    state: absent
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

Authors

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