/mgmt/config/default/LinkAggregation GET

Use the HTTP GET method with the /mgmt/config/default/LinkAggregation resource to request a list of current link aggregation configurations.

Resource URL

https://host:port/mgmt/config/default/LinkAggregation
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.
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. 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.
The administrative state of the link aggregation interface, can be one of the following values:
  • enabled
  • disabled
UserSummary
String.
An optional description of the link aggregation interface.
IPConfigMode
Identifies the configuration mode for the link aggregation 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 link aggregation 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 link aggregations 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.
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.
Type
String.
Specifies the aggregation mode, and is one of the following values:
active-backup
One link is active and the other link is backup. If the active link is lost, switches to the backup link.
transmit
Uses a single link for incoming traffic, but distributes outgoing traffic among all links.
LACP
Uses the link aggregation control protocol (LACP). This mode requires support on the network switch.
Links
String.
Specifies the Ethernet interfaces in the link aggregation configuration. The link is identified by the following fields:
  • Value - the name of the Ethernet interface.
  • URL - the URL of the Ethernet interface.
MTU
Integer.
Sets the maximum transmission unit of the aggregated interface. Specifies the maximum size in bytes. Enter a value in the range 576 - 16128. The default value is 1500.
LACPAggregatorSelectionPolicy
String.
If the LACP aggregation mode is selected, indicates the LACP selection algorithm. When there is more than one LACP aggregator for the members of an LACP aggregation, the appliance uses the algorithm to determine which aggregator to use. In other words, the algorithm determines which group of aggregate interfaces is active. Set to one of the following values:
stable
Does not change the aggregator when a better one is available. This setting is the default value.
count
Selects the aggregator with the most NICs.
bandwith
Chooses the aggregator with the highest bandwidth.
TransmitHashingAlgorithm
String.
If the LACP aggregation mode is selected, sets which hash function the LACP aggregation uses to determine the interface for outbound packets. Set to one of the following values:
ip-port
Indicates that the hash function uses both IP addresses and TCP/UDP ports. IP addresses are layer 3. TCP/UDP ports are layer 4. This approach is not strictly compliant to the LACP standard.
mac
Indicates that the hash function uses only MAC addresses, which is layer 2 data.
mac-ip
Indicates that the hash function uses both MAC addresses and IP addresses. MAC addresses are layer 2. IP addresses are layer 3. This setting is the default value.
LACPRate
String.
If the LACP aggregation mode is selected, specifies the rate of LACP aggregation. Set to one of the following values:
fast
Uses the fast rate (every one second).
slow
Uses the slow rate (every thirty seconds).
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".

Examples

The following example shows an extract from the result of requesting the link aggregation interface settings on the appliance:

The following URL is used with the HTTP GET method:
GET /mgmt/config/default/LinkAggregation
The following listing shows the received response:
{
    "_links": {
        "self": {
            "href": "/mgmt/config/default/LinkAggregation
        "doc": {
            "href": "/mgmt/docs/config/LinkAggregation"
        }
    },
    "LinkAggregation": {
        "name": "testLinkAgg",
        "_links": {
            "self": {
                "href": "/mgmt/config/default/LinkAggregation/testLinkAgg"
            },
            "doc": {
                "href": "/mgmt/docs/config/LinkAggregation"
            }
        },
        "mAdminState" : "enabled", 
        "UserSummary" : "A simple example link aggregation", 
        "IPConfigMode" : {
            "static" : "on", 
            "dhcp" : "off", 
            "slaac" : "off"}, 
        "IPAddress" : "10.40.107.110/16", 
        "StaticRoutes" : {
            "Destination" : "10.40.0.0/16", 
            "Gateway" : "10.40.0.1", 
            "Metric" : 0}, 
        "DADTransmits" : 1, 
        "DADRetransmitTimer" : 1000, 
        "Type" : "active-backup", 
        "Links" : {
            "value": "eth40", 
            "href" : "/mgmt/config/default/EthernetInterface/eth40"}, 
        "MTU" : 1500, 
        "LACPAggregatorSelectionPolicy" : "stable", 
        "TransmitHashingAlgorithm" : "mac-ip", 
        "LACPRate" : "fast", 
        "HardwareOffload" : "on"}}