/mgmt/status/default/LinkAggregationStatus GET

Use the HTTP GET method with the /mgmt/status/default/LinkAggregationStatus resource to request statistics for aggregate interfaces.

Resource URL

https://host:port/mgmt/status/default/LinkAggregationStatus
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
Status 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 includes information about aggregated interfaces on the appliance. Each object contains the following fields:
Index
Integer.
Identifies the index that identifies the aggregate interface.
Name
String.
The name of the interface in the system kernel.
MgmtName
String.
Indicates the name of the interface in the configuration.
MTU
Integer.
Identifies the maximum transmission unit (MTU) for the aggregation.
Mode
String.
Indicates the mode for link aggregation.
  • ab Active back up. Indicates that the mode is active-backup. One link is active, and the other link is standby.
  • LACP LACP mode. Indicates that the mode uses the Link Aggregation Control Protocol (LACP). The IEEE 802.1AX-2008 standard defines LACP.
  • tlb Transmit load balancing. Indicates that the mode uses transmit-based load balancing.
  • none Indicates that the mode is not supported. Contact IBM Support.
Status
String.
Indicates the link state of the aggregate interface.
  • ok The interface is responding to the network.
  • noLink The interface is not responding to the network.
Primary
String.
Indicates which link, if any, is primary when the link aggregation mode is active-backup.
Active
Indicates the active link when the link aggregation mode is transmit-based load balancing or active-backup.
LACPHashPolicy
String.
With the LACP aggregation mode, indicates the distribution algorithm for outbound packets among the active physical interfaces. The policy should match the configuration.
LACPDURate
String.
With the LACP aggregation mode, indicates the transmission rate that members send LACP frames. The rate can be either fast or slow. In LACP, the frame uses the term LACPDU.
LACPSelectionPolicy
String.
With the LACP aggregation mode, indicates the selection policy. The policy should match the configuration.
LACPAggregatorID
String.
With the LACP aggregation mode, indicates the ID of the active aggregator.
LACPNumPorts
With the LACP aggregation mode, indicates the number of available ports for the active aggregator.
LACPActorKey
With the LACP aggregation mode, identifies the value of the operational key that the Actor assigned to the port.
LACPPartnerKey
String.
With the LACP aggregation mode, identifies the physical MAC address of the Partner.
LACPPartnerMAC
String.
The physical MAC address of the Partner.
MIIStatus
String.
Indicates the MII link state of the aggregation.
  • ok The interface is responding to the network.
  • noLink The interface is not responding to the network.

Examples

The following example requests information about aggregated interfaces on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/LinkAggregationStatus
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/LinkAggregationStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/LinkAggregationStatus"
    }
  },
  "result": "No status retrieved."
}