Users Guide

Table 49. ome_network_vlan (continued)
Parameters Required Default Choices Comments
description False NA NA Provide a short
description of the
VLAN to be created or
modified.
vlan_minimum False NA NA The minimum value of
the VLAN range.
vlan_maximum False NA NA
● The maximum value
of the VLAN range.
● A single value
VLAN is created if
the vlan_maximum
and vlan_minmum
values are the same.
type False NA 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, and VMWare
FT Logging.
● Types of the
supported VLAN
networks.
● For the description
of each network
type, use API
U(https://
I(hostname)/api/
NetworkConfigurati
onService/
NetworkTypes ).
Return Values
msg:
type: str
description: Overall status of the VLAN operation.
returned: always
sample: "Successfully created the VLAN."
vlan_status:
type: dict
description: Details of the VLAN that is either created or modified.
returned: when I(state=present)
sample: {
"@odata.context": "/api/$metadata#NetworkConfigurationService.Network",
"@odata.type": "#NetworkConfigurationService.Network",
"@odata.id": "/api/NetworkConfigurationService/Networks(1234)",
"Id": 1234,
"Name": "vlan1",
"Description": "VLAN description",
"VlanMaximum": 130,
"VlanMinimum": 140,
"Type": 1,
"CreatedBy": "admin",
"CreationTime": "2020-01-01 05:54:36.113",
"UpdatedBy": null,
"UpdatedTime": "2020-01-01 05:54:36.113",
"InternalRefNWUUId": "6d6effcc-eca4-44bd-be07-1234ab5cd67e"
}
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
type: dict
sample: {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more
information.",
126
Modules for OpenManage Enterprise (OME)