/mgmt/config/default/EthernetInterface PUT

Use the HTTP PUT method with the /mgmt/config/default/EthernetInterface/Ethernet_interface_name resource to amend Ethernet interface settings,

Resource URL
Request headers
Request body format
Security requirements
Response status codes
Response headers
Response body format
Examples

Resource URL

https://host:port/mgmt/config/default/EthernetInterface/Ethernet_interface_name

Where port is 5554 by default.

Ethernet_interface_name is the name of the Ethernet interface that you want to amend, and can be one of the following values:

eth10
eth11
eth12
eth13
eth14
eth15
eth16
eth17
eth20
eth21
eth22
eth23
eth30
eth31
eth32
eth33
eth40
eth41
eth42
eth43

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 Ethernet interface, can be one of the following values:

enabled
disabled

IPConfigMode

Identifies the configuration mode for the Ethernet 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 Ethernet 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.

StaticRoutes

Defines the static routes in the routing table for the Ethernet interface. Contains the following fields:

Destination

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.

Gateway

Specifies the IP address of the next-hop router.

Metric

Optionally specifies the preference for the route. The lesser the value, the more preferred the route. For each IP family, the supported range differs.

For IPv4, enter a value in the range 0 - 255. The default value is 0.
For IPv6, enter a value in the range 0 - 65536. The default value is 512.

DefaultGateway

String

Designates the IP address for the default gateway for this interface.

DADTransmits

Integer.

Sets the number of IPv6 duplication address detection attempts for the Ethernet interface. The default value is 1.

DADRetransmitTimer

Integer.

Sets the interval between IPv6 neighbor discovery attempts for the Ethernet interface in milliseconds. The default value is 1000.

LinkAggMode

String.

Set to "on" or "off". Set to "on" to specifies that the interface is part of a link aggregation interface. The default value is "off".

MTU

Integer.

Sets the maximum transmission unit of the Ethernet interface. Specifies the maximum size in bytes. Enter a value in the range 576 - 16128. The default value is 1500.

Mode

String.

Sets the interface speed and direction. Set to one of the following values:

Auto: String.; For interfaces that do autonegotiation, the appliance uses standard IEEE 802.3 autonegotiation for interface speed and direction. Preference is given to the highest speed. Preference is for full-duplex over half-duplex. This setting is the default value.
10baseT-FD: Advertises 10BASE-T PHY (10 Mbps) in full-duplex mode.
10baseT-HD: Advertises 10BASE-T PHY (10 Mbps) in half-duplex mode.
100baseTx-FD: Advertises 100BASE-TX PHY (100 Mbps) in full-duplex mode.
100baseTx-HD: Advertises 100BASE-TX PHY (100 Mbps) in half-duplex mode.
1000baseTx-FD: Advertises 1000BASE-T PHY (1 Gbps) in full-duplex mode.
10000baseTx-FD: Advertises 10000BASE-T PHY (10 Gbps) in full-duplex mode.

ForceMode

String.

Set to "on" or "off". Set to "on" to force Ethernet physical mode instead of autonegotiation behavior. The default value is "off".

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".

FlowControl

String.

Sets the flow control mode of the Ethernet interface, set to one of the following values:

auto: For interfaces that support autonegotiation, performs standard IEEE 802.3 autonegotiation for flow control. This setting is the default value.
disabled: Disables flow control. The interface does not send flow control PAUSE frames and ignores received PAUSE frames.
tx: Enables transmit mode. The interface transmits flow control PAUSE frames but ignores the received PAUSE frames.
rx: Enables receive mode. The interface honors received flow control PAUSE frames but does not transmit PAUSE frames.
full: Enables full flow control. The interface transmits flow control PAUSE frames and honors the received PAUSE frames.

LinkLayerDiscoveryProtocolHardwareOffload

String.

Controls how the Ethernet interface responds to LLDP packets. Set to "on" or "off". Set to "on" to indicate that the NIC responds to LLDP packets. The default value is "off".

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 settings for the Ethernet interface, eth10.

The following URL is used with the HTTP PUT method:

PUT /mgmt/config/default/EthernetInterface/eth10

The following listing shows the request:

{
  "EthernetInterface" :{
      "name" : "eth13", 
        "_links" : {
          "self" : {"href" : "/mgmt/config/default/EthernetInterface/eth13"}, 
          "doc" : {"href" : "/mgmt/docs/config/EthernetInterface"}
        }, 
        "mAdminState" : "enabled", 
        "UserSummary" : "HA Control - Primary", 
        "IPConfigMode" : {
          "static" : "on", 
          "dhcp" : "off", 
          "slaac" : "off"
        }, 
        "IPAddress" : "198.168.100.0/16", 
        "StaticRoutes" : {
          "Destination" : "198.51.100.0/16", 
          "Gateway" : "192.168.123.11", 
          "Metric" : 0
        }, 
        "DADTransmits" : 1, 
        "DADRetransmitTimer" : 1000, 
        "LinkAggMode" : "off", 
        "MTU" : 1500, 
        "Mode" : "Auto", 
        "ForceMode" : "off", 
        "HardwareOffload" : "on", 
        "FlowControl" : "auto", 
        "LinkLayerDiscoveryProtocolHardwareOffload" : "off"
       },
}

After the Protocol field is updated, the following response is returned:

{
        "_links" : {
          "self" : {
             "href" : "/mgmt/config/default/EthernetInterface/eth13"
          }, 
             "doc" : {
               "href" : "/mgmt/docs/config/EthernetInterface"
          }
        }, 
        "Main-Name-Service" : "Configuration was updated."
}