purestorage.flasharray.purefa_subnet module – Manage network subnets in a Everpure FlashArray
Note
This module is part of the purestorage.flasharray collection (version 1.43.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.flasharray.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: purestorage.flasharray.purefa_subnet.
Note
The purestorage.flasharray collection has been renamed to everpure.flasharray and will be removed from Ansible 17. The content of purestorage.flasharray will be replaced by redirects to everpure.flasharray in Ansible 15. If you use content from purestorage.flasharray, please update FQCNs in your playbooks and roles! When creating new playbooks or roles, directly use content from everpure.flasharray instead. See the discussion thread for more information.
New in purestorage.flasharray 1.0.0
Synopsis
This module manages the network subnets on a Everpure FlashArray.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.3
purestorage >= 1.19
py-pure-client >= 1.26.0
netaddr
requests
pycountry
urllib3
Parameters
Parameter |
Comments |
|---|---|
FlashArray API token for admin privileged user. |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
Disable insecure certificate warnings in debug logs Choices:
|
|
whether the subnet should be enabled or not Choices:
|
|
FlashArray management IPv4 address or Hostname. |
|
IPv4 or IPv6 address of subnet gateway. To clear the gateway enter “0.0.0.0” or “::” depending on IP type |
|
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.flasharray.purefa_apiclient). |
|
The API Client’s trusted identity issuer registered on the array. Used with private_key_file. |
|
Key ID of the API Client that issues the identity token. Used with private_key_file. |
|
MTU size of the subnet. Range is 568 to 9000. |
|
Subnet name. |
|
Set the IPv4 or IPv6 address to be associated with the subnet. |
|
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. |
|
Password protecting private_key_file, if encrypted. |
|
Create or delete subnet. Choices:
|
|
Username the issued token should be granted to. Must be a valid user on the array. Used with private_key_file. |
|
VLAN ID. Range is 0 to 4094. |
Notes
Note
This module requires the
purestorageandpy-pure-clientPython libraries.Additional Python libraries may be required for specific modules.
You must set
PUREFA_URLandPUREFA_APIenvironment variables if fa_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.flasharray.purefa_apiclient.
Examples
- name: Create subnet subnet100
purestorage.flasharray.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
purestorage.flasharray.purefa_subnet:
name: subnet100
enabled: false
fa_url: 10.10.10.2
api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40
- name: Delete subnet subnet100
purestorage.flasharray.purefa_subnet:
name: subnet100
state: absent
fa_url: 10.10.10.2
api_token: c6033033-fe69-2515-a9e8-966bb7fe4b40