dellemc.openmanage.ome_network_vlan – Create, modify & delete a VLAN¶
Note
This plugin is part of the dellemc.openmanage collection (version 3.2.0).
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
|
Target 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
|
Target user password.
|
|
port
integer
|
Default: 443
|
Target HTTPS port.
|
state
string
|
|
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
|
|
Types of supported VLAN networks.
For the description of each network type, use API https://hostname/api/NetworkConfigurationService/NetworkTypes.
|
username
string
/ required
|
Target 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:
Authors¶
Jagadeesh N V(@jagadeeshnv)