[ aws . directconnect ]
delete-lag¶
Description¶
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
delete-lag
--lag-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--lag-id (string)
The ID of the LAG.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To delete a LAG
The following example deletes the specified LAG.
Command:
aws directconnect delete-lag --lag-id dxlag-ffrhowd9
Output:
{
"awsDevice": "EqDC2-4h6ce2r1bes6",
"numberOfConnections": 0,
"lagState": "deleted",
"ownerAccount": "123456789012",
"lagName": "TestLAG",
"connections": [],
"lagId": "dxlag-ffrhowd9",
"minimumLinks": 0,
"connectionsBandwidth": "1Gbps",
"region": "us-east-1",
"location": "EqDC2"
}
Output¶
connectionsBandwidth -> (string)
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
numberOfConnections -> (integer)
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
lagId -> (string)
The ID of the LAG.
ownerAccount -> (string)
The ID of the AWS account that owns the LAG.
lagName -> (string)
The name of the LAG.
lagState -> (string)
The state of the LAG. The following are the possible values:
requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.
location -> (string)
The location of the LAG.
region -> (string)
The AWS Region where the connection is located.
minimumLinks -> (integer)
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
awsDevice -> (string)
The AWS Direct Connect endpoint that hosts the LAG.
awsDeviceV2 -> (string)
The AWS Direct Connect endpoint that hosts the LAG.
connections -> (list)
The connections bundled by the LAG.
(structure)
Information about an AWS Direct Connect connection.
ownerAccount -> (string)
The ID of the AWS account that owns the connection.
connectionId -> (string)
The ID of the connection.
connectionName -> (string)
The name of the connection.
connectionState -> (string)
The state of the connection. The following are the possible values:
ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in theorderingstate enters therejectedstate if it is deleted by the customer.
unknown: The state of the connection is not available.region -> (string)
The AWS Region where the connection is located.
location -> (string)
The location of the connection.
bandwidth -> (string)
The bandwidth of the connection.
vlan -> (integer)
The ID of the VLAN.
partnerName -> (string)
The name of the AWS Direct Connect service provider associated with the connection.
loaIssueTime -> (timestamp)
The time of the most recent call to DescribeLoa for this connection.
lagId -> (string)
The ID of the LAG.
awsDevice -> (string)
The Direct Connect endpoint on which the physical connection terminates.
jumboFrameCapable -> (boolean)
Indicates whether jumbo frames (9001 MTU) are supported.
awsDeviceV2 -> (string)
The Direct Connect endpoint on which the physical connection terminates.
hasLogicalRedundancy -> (string)
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags -> (list)
The tags associated with the connection.
(structure)
Information about a tag.
key -> (string)
The key.
value -> (string)
The value.
providerName -> (string)
The name of the service provider associated with the connection.
allowsHostedConnections -> (boolean)
Indicates whether the LAG can host other connections.
jumboFrameCapable -> (boolean)
Indicates whether jumbo frames (9001 MTU) are supported.
hasLogicalRedundancy -> (string)
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
tags -> (list)
The tags associated with the LAG.
(structure)
Information about a tag.
key -> (string)
The key.
value -> (string)
The value.
providerName -> (string)
The name of the service provider associated with the LAG.