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

purestorage.flasharray.purefa_network – Manage network 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_network.

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • This module manages the physical and virtual network interfaces on a Pure Storage FlashArray.
  • To manage VLAN interfaces use the purefa_vlan module.
  • To manage network subnets use the purefa_subnet module.
  • To remove an IP address from a non-management port use 0.0.0.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
address
string
IPv4 or IPv6 address of interface in CIDR notation.
To remove an IP address from a non-management port use 0.0.0.0/0
api_token
string
FlashArray API token for admin privileged user.
fa_url
string
FlashArray management IPv4 address or Hostname.
gateway
string
IPv4 or IPv6 address of interface gateway.
mtu
integer
Default:
1500
MTU size of the interface. Range is 1280 to 9216.
name
string / required
Interface name (physical or virtual).
state
string
    Choices:
  • present ←
  • absent
State of existing interface (on/off).

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 network interface ct0.eth8
  purefa_network:
    name: ct0.eth8
    gateway: 10.21.200.1
    address: "10.21.200.18/24"
    mtu: 9000
    state: present
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

- name: Disable physical interface ct1.eth2
  purefa_network:
    name: ct1.eth2
    state: absent
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

- name: Enable virtual network interface vir0
  purefa_network:
    name: vir0
    state: present
    fa_url: 10.10.10.2
    api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40

- name: Remove an IP address from iSCSI interface ct0.eth4
  purefa_network:
    name: ct0.eth4
    address: 0.0.0.0/0
    gateway: 0.0.0.0
    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_network_module.html