purestorage.flashblade.purefb_subnet module – Manage network subnets in a Everpure FlashBlade

Note

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

To use it in a playbook, specify: purestorage.flashblade.purefb_subnet.

New in purestorage.flashblade 1.0.0

Synopsis

  • This module manages network subnets on Everpure FlashBlade.

Requirements

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

  • python >= 3.9

  • py-pure-client

  • netaddr

  • datetime

  • pytz

  • distro

  • pycountry

  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashBlade API token for admin privileged user.

client_id

string

added in purestorage.flashblade 1.26.0

ID of the API Client that issues the identity token.

Used with private_key_file.

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)

  • true

fb_url

string

FlashBlade management IP address or Hostname.

gateway

string

IPv4 or IPv6 address of subnet gateway.

id_token

string

added in purestorage.flashblade 1.26.0

A pre-signed JWT to authenticate with, as an alternative to api_token.

The token is exchanged by the array for a short-lived access token.

Requires a matching API Client to be registered on the array (see purestorage.flashblade.purefb_apiclient).

issuer

string

added in purestorage.flashblade 1.26.0

The API Client’s trusted identity issuer registered on the array.

Used with private_key_file.

key_id

string

added in purestorage.flashblade 1.26.0

Key ID of the API Client that issues the identity token.

Used with private_key_file.

lag

string

added in purestorage.flashblade 1.7.0

Name of the Link Aggreation Group to use for the subnet.

Default: "uplink"

mtu

integer

MTU size of the subnet. Range is 1280 to 9216.

Default: 1500

name

string / required

Subnet Name.

prefix

string

IPv4 or IPv6 address associated with the subnet.

Supply the prefix length (CIDR) as well as the IP address.

Required for subnet creation.

private_key_file

string

added in purestorage.flashblade 1.26.0

Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token.

Requires client_id, key_id, issuer and username.

private_key_password

string

added in purestorage.flashblade 1.26.0

Password protecting private_key_file, if encrypted.

state

string

Create, delete or modifies a subnet.

Choices:

  • "present" ← (default)

  • "absent"

username

string

added in purestorage.flashblade 1.26.0

Username the issued token should be granted to.

Must be a valid user on the array. Used with private_key_file.

vlan

integer

VLAN ID of the subnet.

Default: 0

Notes

Note

  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

  • Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via purestorage.flashblade.purefb_apiclient

Examples

- name: Create new network subnet named foo
  purestorage.flashblade.purefb_subnet:
    name: foo
    prefix: "10.21.200.3/24"
    gateway: 10.21.200.1
    mtu: 9000
    vlan: 2200
    lag: bar
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Change configuration of existing subnet foo
  purestorage.flashblade.purefb_subnet:
    name: foo
    state: present
    prefix: "10.21.100.3/24"
    gateway: 10.21.100.1
    mtu: 1500
    address: 10.21.200.123
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete network subnet named foo
  purestorage.flashblade.purefb_subnet:
    name: foo
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

  • Everpure Ansible Team (@sdodsley)