/mgmt/config/default/VLANInterface/name GET
Use the HTTP GET method with the
/mgmt/config/default/VLANInterface/VLANInterface_name
resource
to request the details of the specified VLAN interface.
Resource URL
https://host:port/mgmt/config/default/VLANInterface/VLANInterface_name
Where
port is 5554 by default.Request headers
The following header must be sent with the request:
- Authorization
- This header must be sent to perform authentication.
Request body format
None.
Security requirements
The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.
Response status codes
- 200
- Information retrieved successfully.
- 400
- Invalid data provided.
- 401
- Not authenticated.
- 403
- Not authorized.
Response headers
- Content-Type
- This header is returned with a value of
application/json
.
Response body format
The response is in JSON format. The response comprises a JSON structure that contains definitions
for each link aggregation configuration on the appliance. Each definition contains the following fields:
- mAdminState
- String.
- UserSummary
- String.
- IPConfigMode
- Identifies the configuration mode for the VLAN interface. Contains the following fields:
- IPAddress
- String.
- DADTransmits
- Integer.
- DADRetransmitTimer
- Integer.
- OverType
- String.
- EthernetInterface
- If
OverType
is set toethernet
, specifies the Ethernet interface used. Comprises a JSON structure containing the following fields:value
- the name of the Ethernet interface.href
- the URL of the Ethernet interface.
- LinkAggInterface
- If
OverType
is set tolink-aggregation
, specifies the aggregated interface used. Comprises a JSON structure containing the following fields:value
- the name of the aggregated interface.href
- the URL of the aggregated interface.
- Identifier
- Integer.
- DefaultOutboundPriority
- Integer.
- MTU
- Integer.
- HardwareOffload
- String.
Examples
The following example shows the result of requesting the VLAN configuration settings for the interface named testVLAN2 on the appliance:
The following URL is used with the HTTP GET
method:
GET /mgmt/config/default/VLANInterface/testVLAN2
The following listing shows the received response:
{
"_links": {
"self": {
"href": "/mgmt/config/default/VLANInterface
"doc": {
"href": "/mgmt/docs/config/VLANInterface"
}
},
"VLANInterface": {
"name": "testVLAN2",
"_links": {
"self": {
"href": "/mgmt/config/default/VLANInterface/testVLAN2"
},
"doc": {
"href": "/mgmt/docs/config/VLANInterface"
}
},
"mAdminState" : "enabled",
"UserSummary" : "A VLAN example configuration",
"IPConfigMode" : {
"static" : "on",
"dhcp" : "off",
"slaac" : "off"},
"IPAddress" : "10.40.107.110/16",
"DADTransmits" : 1,
"DADRetransmitTimer" : 1000,
"OverType" : "ethernet",
"EthernetInterface" : {
"value": "eth41",
"href" : "/mgmt/config/default/EthernetInterface/eth41"},
"LinkAggInterface" : {
"value": "testLinkAgg",
"href" : "/mgmt/config/default/LinkAggregation/testLinkAgg"},
"Identifier" : 2,
"DefaultOutboundPriority" : 0,
"MTU" : 1500,
"HardwareOffload" : "on"}}