dellemc.openmanage.ome_network_vlan module – Create, modify & delete a VLAN
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_network_vlan
.
New in dellemc.openmanage 2.1.0
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 >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Short description of the VLAN to be created or modified. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Provide the name of the VLAN to be created, deleted or modified. |
|
Provide the name of the VLAN to be modified. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
WARNING Deleting a VLAN can impact the network infrastructure. Choices:
|
|
The socket level timeout in seconds. Default: |
|
Types of supported VLAN networks. For the description of each network type, use API https://I%28hostname/api/NetworkConfigurationService/NetworkTypes). Choices:
|
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
|
The maximum VLAN value of the range. A single value VLAN is created if the vlan_maximum and vlan_minmum values are the same. |
|
The minimum VLAN value of the range. |
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode
.
Examples
---
- name: Create a VLAN range
dellemc.openmanage.ome_network_vlan:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
ca_path: "/path/to/ca_cert.pem"
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}}"
ca_path: "/path/to/ca_cert.pem"
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}}"
ca_path: "/path/to/ca_cert.pem"
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}}"
ca_path: "/path/to/ca_cert.pem"
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 |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the VLAN operation. Returned: always Sample: |
|
Details of the VLAN that is either created or modified. Returned: when state=present Sample: |