Users Guide

Table 62. ome_template_network_vlan (continued)
Parameter Required Default Choices Comments
○ This option is mutually exclusive with
I(untagged_network_name).
○ To get the vLAN network ID use the API
U( https://I(hostname)/api/
NetworkConfigurationService/
Networks)
• untagged_network_name-
○ Name of the untagged vLAN
○ Enter 0 to clear the untagged vLAN
from the port.
○ This option is mutually exclusive with
I(untagged_network_id).
tagged_networks False NA NA List of tagged vLANs and their corresponding
NIC ports.
Suboptions-
• port- NIC port number of the tagged vLAN
• tagged_network_ids-
○ List of IDs of the tagged vLANs
○ Enter [] to remove the tagged VLAN
from a port.
○ List of I(tagged_network_ids) is
combined with list of
I(tagged_network_names) when adding
tagged vLANs to a port.
○ To get the vLAN network ID use the API
U( https://I(hostname)/api/
NetworkConfigurationService/
Networks)
• tagged_network_names-
○ List of names of tagged vLANs
○ Enter [] to remove the tagged VLAN
from a port.
○ List of I(tagged_network_names) is
combined with list of
I(tagged_network_ids) when adding
tagged vLANs to a port.
Return Values
msg:
type: str
description: Overall status of the template vlan operation.
returned: always
sample: "Successfully applied the network settings to template"
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
type: dict
sample: {
"error": {
"@Message.ExtendedInfo": [{
"Message": "Unable to process the request because an error occurred:",
"MessageArgs": "",
"MessageId": "CGEN6001",
"RelatedProperties": [],
"Resolution": "Retry the operation. If the issue persists, contact your system
administrator.",
Modules for OpenManage Enterprise (OME)
75