netapp.storagegrid.na_sg_grid_vlan_interface module – Configure VLAN interface on StorageGRID.

Note

This module is part of the netapp.storagegrid collection (version 21.15.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 netapp.storagegrid.

To use it in a playbook, specify: netapp.storagegrid.na_sg_grid_vlan_interface.

New in netapp.storagegrid 21.15.0

Synopsis

  • Configure VLAN interface on NetApp StorageGRID.

Parameters

Parameter

Comments

api_url

string / required

The url to the StorageGRID Admin Node REST API.

auth_token

string / required

The authorization token for the API request

description

string

Description for this VLAN interface.

interfaces

list / elements=dictionary

List of node interface pairs.

interface_name

string / required

The name of the interface.

node_id

string / required

The node UUID.

state

string

Whether the vlan interface should be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

vlan_id

integer

The numeric ID of the VLAN used for VLAN tagging.

Notes

Note

  • The modules prefixed with na_sg are built to manage NetApp StorageGRID.

Examples

- name: create vlan interface
  na_sg_grid_vlan_interface:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    vlan_id: 428
    description: "vlan interface"
    interfaces:
      - node_id: 6562d5d8-f218-45ff-a466-5bb39b729288
        interface_name: eth0

- name: modify vlan interface
  na_sg_grid_vlan_interface:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    vlan_id: 428
    description: "vlan interface is modified"
    interfaces:
      - node_id: 6562d5d8-f218-45ff-a466-5bb39b729288
        interface_name: eth2

- name: delete vlan interface
  na_sg_grid_vlan_interface:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    vlan_id: 428

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

resp

dictionary

Returns information about the StorageGRID VLAN Interface.

Returned: If state is ‘present’.

Sample: {"description": "vlan interface", "id": "12bcw2a2-7028-4d98-89f8-972414278e3c", "interfaces": [{"interface": "eth0", "nodeId": "6562d5d8-f718-45ff-a716-5bb39b729238"}], "vlanId": 430}

Authors

  • NetApp Ansible Team (@vinaykus)