dellemc.openmanage.ome_template_network_vlan – Set tagged and untagged vlans to native network card supported by a template on OpenManage Enterprise¶
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_template_network_vlan
.
New in version 2.0.0: of dellemc.openmanage
Synopsis¶
This module allows to set tagged and untagged vlans to native network card supported by a template on OpenManage Enterprise.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7.5
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
hostname
string
/ required
|
Target IP address or hostname.
|
||
nic_identifier
string
/ required
|
Display name of NIC port in the template for VLAN configuration.
|
||
password
string
/ required
|
Target user password.
|
||
port
integer
|
Default: 443
|
Target HTTPS port.
|
|
tagged_networks
list
/ elements=dictionary
|
List of tagged VLANs and their corresponding NIC ports.
|
||
port
integer
/ required
|
NIC port number of the tagged VLAN
|
||
tagged_network_ids
list
/ elements=integer
|
List of IDs of the tagged VLANs
Enter [] to remove the tagged VLAN from a port.
List of tagged_network_ids is combined with list of tagged_network_names when adding tagged VLANs to a port.
To get the VLAN network ID use the API https://hostname/api/NetworkConfigurationService/Networks
|
||
tagged_network_names
list
/ elements=string
|
List of names of tagged VLANs
Enter [] to remove the tagged VLAN from a port.
List of tagged_network_names is combined with list of tagged_network_ids when adding tagged VLANs to a port.
|
||
template_id
integer
|
Id of the template.
It is mutually exclusive with template_name.
|
||
template_name
string
|
Name of the template.
It is mutually exclusive with template_id.
|
||
untagged_networks
list
/ elements=dictionary
|
List of untagged networks and their corresponding NIC ports.
|
||
port
integer
/ required
|
NIC port number of the untagged VLAN.
|
||
untagged_network_id
integer
|
ID of the untagged VLAN
Enter 0 to clear the untagged VLAN from the port.
This option is mutually exclusive with untagged_network_name
To get the VLAN network ID use the API https://hostname/api/NetworkConfigurationService/Networks
|
||
untagged_network_name
string
|
name of the vlan for untagging
provide 0 for clearing the untagging for this port
This parameter is mutually exclusive with untagged_network_id
|
||
username
string
/ required
|
Target username.
|
Notes¶
Note
Run this module from a system that has direct access to DellEMC OpenManage Enterprise.
This module does not support
check_mode
.
Examples¶
---
- name: Add tagged or untagged VLANs to a template using VLAN ID and name
dellemc.openmanage.ome_template_network_vlan:
hostname: "192.168.0.1"
username: "username"
password: "password"
template_id: 78
nic_identifier: NIC Slot 4
untagged_networks:
- port: 1
untagged_network_id: 127656
- port: 2
untagged_network_name: vlan2
tagged_networks:
- port: 1
tagged_network_ids:
- 12767
- 12768
- port: 4
tagged_network_ids:
- 12767
- 12768
tagged_network_names:
- vlan3
- port: 2
tagged_network_names:
- vlan4
- vlan1
- name: Clear the tagged and untagged VLANs from a template
dellemc.openmanage.ome_template_network_vlan:
hostname: "192.168.0.1"
username: "username"
password: "password"
template_id: 78
nic_identifier: NIC Slot 4
untagged_networks:
# For removing the untagged VLANs for the port 1 and 2
- port: 1
untagged_network_id: 0
- port: 2
untagged_network_name: 0
tagged_networks:
# For removing the tagged VLANs for port 1, 4 and 2
- port: 1
tagged_network_ids: []
- port: 4
tagged_network_ids: []
tagged_network_names: []
- port: 2
tagged_network_names: []
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Jagadeesh N V(@jagadeeshnv)