purestorage.fusion.fusion_nig module – Manage Network Interface Groups in Pure Storage Fusion

Note

This module is part of the purestorage.fusion collection (version 1.2.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.fusion. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.fusion.fusion_nig.

New in purestorage.fusion 1.0.0

Synopsis

  • Create, delete and modify network interface groups in Pure Storage Fusion.

  • Currently this only supports a single tenant subnet per tenant network

Requirements

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

  • python >= 3.5

  • purefusion

Parameters

Parameter

Comments

app_id

string

Application ID from Pure1 Registration page

eg. pure1:apikey:dssf2331sd

Defaults to the set environment variable under FUSION_APP_ID

availability_zone

aliases: az

string / required

The name of the availability zone for the network interface group.

display_name

string

The human name of the network interface group.

If not provided, defaults to name.

gateway

string

Address of the subnet gateway.

group_type

string

The type of network interface group.

Choices:

  • "eth" ← (default)

key_file

string

Path to the private key file

Defaults to the set environment variable under FUSION_PRIVATE_KEY_FILE.

mtu

integer

MTU setting for the subnet.

Default: 1500

name

string / required

The name of the network interface group.

prefix

string

Network prefix in CIDR format.

region

string / required

Region for the network interface group.

state

string

Define whether the network interface group should exist or not.

Choices:

  • "absent"

  • "present" ← (default)

Notes

Note

  • Supports check mode.

  • This module requires the purefusion Python library

  • You must set FUSION_APP_ID and FUSION_PRIVATE_KEY_FILE environment variables if app_id and key_file arguments are not passed to the module directly

Examples

- name: Create new network interface group foo in AZ bar
  purestorage.fusion.fusion_nig:
    name: foo
    availability_zone: bar
    region: region1
    mtu: 9000
    gateway: 10.21.200.1
    prefix: 10.21.200.0/24
    state: present
    app_id: key_name
    key_file: "az-admin-private-key.pem"

- name: Delete network interface group foo in AZ bar
  purestorage.fusion.fusion_nig:
    name: foo
    availability_zone: bar
    region: region1
    state: absent
    app_id: key_name
    key_file: "az-admin-private-key.pem"

Authors

  • Pure Storage Ansible Team (@sdodsley)