/mgmt/config/default/VLANInterface/name PUT

Use the HTTP PUT method with the /mgmt/config/default/VLANInterface/VLAN_name resource to amend VLAN interface settings.

Resource URL

https://host:port/mgmt/config/default/VLANInterface/VLAN_name
Where port is 5554 by default.

VLAN_name is the name of the VLAN interface that you want to amend:

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

The request is in JSON format. It can contain the following fields, depending on the system setting that you want to update:
mAdminState
String.
The administrative state of the VLAN interface, can be one of the following values:
  • enabled
  • disabled
UserSummary
String.
An optional description of the VLAN interface.
IPConfigMode
Identifies the configuration mode for the VLAN interface. Contains the following fields:
static
String.
Set to "on" or "off". Set to "on" to specify a static, manual configuration. The default value is "on".
dhcp
String.
Set to "on" or "off". Set to "on" to specify IPv4 autoconfiguration with DHCP. The default value is "off".
slaac
String.
Set to "on" or "off". Set to "on" to specify IPv6 autoconfiguration with SLAAC. The default value is "off".
IPAddress
String.
Assigns the primary network address for the VLAN interface. Specifies the IP address and netmask. The netmask is in CIDR format and is the integer that assigns the prefix length.
  • For version 4, the prefix length can be in the range of 0 through 32.
  • For version 6, the prefix length can be in the range of 0 through 128.
DADTransmits
Integer.
Sets the number of IPv6 duplication address detection attempts for the aggregated interface. The default value is 1.
DADRetransmitTimer
Integer.
Sets the interval between IPv6 neighbor discovery attempts for the aggregated interface in milliseconds. The default value is 1000.
OverType
String.
Specifies the parent interface type for the VLAN interface. and is one of the following values:
ethernet
Indicates that the parent is an Ethernet interface. This setting is the default value.
link-aggregation
Indicates that the parent is an aggregate interface.
EthernetInterface
If OverType is set to ethernet, specifies the Ethernet interface used. Comprises a JSON structure containing the following field:
  • value - the name of the Ethernet interface.
LinkAggInterface
If OverType is set to link-aggregation, specifies the aggregated interface used. Comprises a JSON structure containing the following field:
  • value - the name of the aggregated interface.
Identifier
Integer.
Specifies the number of the VLAN identifier. The identifier specifies the VLAN identifier to send traffic as well as to receive traffic. The identifier must be unique among all VLAN interfaces on the same Ethernet interface. Is a value in the range 1 - 4094. The default value is 2.
DefaultOutboundPriority
Integer.
The outbound-priority command sets the priority value in outgoing VLAN headers for packets. These packets are sent on this VLAN interface. This value is placed in the user_control field of the Tag Control Information (TCI). The exact interpretation of the value depends on the VLAN switch configuration. Is a value in the range 0 - 7. The default value is 0.
MTU
Integer.
Sets the maximum transmission unit of the VLAN interface. Specifies the maximum size in bytes. Enter a value in the range 576 - 16128. The default value is 1500.
HardwareOffload
String.
Set to "on" or "off". Set to "on" to enable the hardware offload of TCP/IP packet processing. The default value is "on".

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
The system settings were successfully updated.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. Each object contains the following fields:
self
String.
The URL of the PUT request.
doc
String.
Not currently used.
Location
String.
The URL of the object updated.

Examples

The following example updates the user summary for the VLAN interface named testVLAN.

The following URL is used with the HTTP PUT method:
PUT /mgmt/config/default/VLANInterface/testVLAN
The following listing shows the request:
{
  "VLANInterface" :{
      "name" : "testVLAN", 
      "mAdminState" : "enabled", 
      "UserSummary" : "Example of changing the summary"
}
}
After the Protocol field is updated, the following response is returned:
{
        "_links" : {
          "self" : {
             "href" : "/mgmt/config/default/VLANInterface/testVLAN"
          }, 
             "doc" : {
               "href" : "/mgmt/docs/config/VLANInterface"
          }
        }, 
        "VLANInterface" : "Configuration was updated."
}