Users Guide

Retrieve VLAN information
Module: ome_network_vlan_info
Synopsis
This module allows to retrieve the following:
● A list of all the network VLANs with their detailed information.
● Information about a specific network VLAN using VLAN I(id) or VLAN I(name).
Options
Table 50. ome_network_vlan_info
Parameter Required Default Choices Comments
hostname True NA NA Target IP Address or
hostname
username True NA NA Target username
password True NA NA Target user password
port False 443 NA Target HTTPS port
id False NA NA
● A unique identifier
of the network
VLAN available in
the device.
● I(id) and I(name)
are mutually
exclusive.
name False NA NA
● A unique name of
the network VLAN
available in the
device.
● I(name) and I(id)
are mutually
exclusive.
Return Values
msg:
type: dict
description: Detailed information of the network VLAN(s).
returned: success
sample: {
"msg": "Successfully retrieved the network VLAN information.",
"network_vlan_info": [
{
"CreatedBy": "admin",
"CreationTime": "2020-09-02 18:48:42.129",
"Description": "Description of Logical Network - 1",
"Id": 20057,
"InternalRefNWUUId": "42b9903d-93f8-4184-adcf-0772e4492f71",
"Name": "Network VLAN - 1",
"Type": {
"Description": "This is the network for general purpose traffic. QOS
Priority : Bronze.",
"Id": 1,
"Name": "General Purpose (Bronze)",
"NetworkTrafficType": "Ethernet",
"QosType": {
"Id": 4,
"Name": "Bronze"
},
"VendorCode": "GeneralPurpose"
},
"UpdatedBy": null,
128
Modules for OpenManage Enterprise (OME)