dellemc.openmanage.ome_network_vlan – Create, modify & delete a VLAN

Note

This plugin is part of the dellemc.openmanage collection (version 4.3.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 dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.ome_network_vlan.

New in version 2.1.0: of dellemc.openmanage

Synopsis

  • This module allows to,

  • Create a VLAN on OpenManage Enterprise.

  • Modify or delete an existing VLAN on OpenManage Enterprise.

Requirements

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

  • python >= 2.7.17

Parameters

Parameter Choices/Defaults Comments
description
string
Short description of the VLAN to be created or modified.
hostname
string / required
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
name
string / required
Provide the name of the VLAN to be created, deleted or modified.
new_name
string
Provide the name of the VLAN to be modified.
password
string / required
OpenManage Enterprise or OpenManage Enterprise Modular password.
port
integer
Default:
443
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
state
string
    Choices:
  • present ←
  • absent
present creates a new VLAN or modifies an existing VLAN.
absent deletes an existing VLAN.
WARNING Deleting a VLAN can impact the network infrastructure.
type
string
    Choices:
  • General Purpose (Bronze)
  • General Purpose (Silver)
  • General Purpose (Gold)
  • General Purpose (Platinum)
  • Cluster Interconnect
  • Hypervisor Management
  • Storage - iSCSI
  • Storage - FCoE
  • Storage - Data Replication
  • VM Migration
  • VMWare FT Logging
Types of supported VLAN networks.
For the description of each network type, use API https://hostname/api/NetworkConfigurationService/NetworkTypes.
username
string / required
OpenManage Enterprise or OpenManage Enterprise Modular username.
vlan_maximum
integer
The maximum VLAN value of the range.
A single value VLAN is created if the vlan_maximum and vlan_minmum values are the same.
vlan_minimum
integer
The minimum VLAN value of the range.

Notes

Note

  • Run this module from a system that has direct access to DellEMC OpenManage Enterprise.

  • This module supports check_mode.

Examples

---
- name: Create a VLAN range
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: present
    name: "vlan1"
    description: "VLAN desc"
    type: "General Purpose (Bronze)"
    vlan_minimum: 35
    vlan_maximum: 40
  tags: create_vlan_range

- name: Create a VLAN with a single value
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: present
    name: "vlan2"
    description: "VLAN desc"
    type: "General Purpose (Bronze)"
    vlan_minimum: 127
    vlan_maximum: 127
  tags: create_vlan_single

- name: Modify a VLAN
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: present
    name: "vlan1"
    new_name: "vlan_gold1"
    description: "new description"
    type: "General Purpose (Gold)"
    vlan_minimum: 45
    vlan_maximum: 50
  tags: modify_vlan

- name: Delete a VLAN
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: "absent"
    name: "vlan1"
  tags: delete_vlan

Return Values

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

Key Returned Description
error_info
dictionary
on HTTP error
Details of the HTTP Error.

Sample:
{'@Message.ExtendedInfo': [{'Message': 'Unable to create or update the network because the entered VLAN minimum 0 is not within a valid range ( 1 - 4000 or 4021 - 4094 ).', 'MessageArgs': ['0', '1', '4000', '4021', '4094'], 'MessageId': 'CTEM1043', 'RelatedProperties': [], 'Resolution': 'Enter a valid VLAN minimum as identified in the message and retry the operation.', 'Severity': 'Warning'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}
msg
string
always
Overall status of the VLAN operation.

Sample:
Successfully created the VLAN.
vlan_status
dictionary
when state=present
Details of the VLAN that is either created or modified.

Sample:
{'@odata.context': '/api/$metadata#NetworkConfigurationService.Network', '@odata.id': '/api/NetworkConfigurationService/Networks(1234)', '@odata.type': '#NetworkConfigurationService.Network', 'CreatedBy': 'admin', 'CreationTime': '2020-01-01 05:54:36.113', 'Description': 'VLAN description', 'Id': 1234, 'InternalRefNWUUId': '6d6effcc-eca4-44bd-be07-1234ab5cd67e', 'Name': 'vlan1', 'Type': 1, 'UpdatedBy': None, 'UpdatedTime': '2020-01-01 05:54:36.113', 'VlanMaximum': 130, 'VlanMinimum': 140}


Authors

  • Jagadeesh N V(@jagadeeshnv)