StartBgpFailoverTest - AWS Direct Connect

StartBgpFailoverTest

Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

Request Syntax

{ "bgpPeers": [ "string" ], "testDurationInMinutes": number, "virtualInterfaceId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

bgpPeers

The BGP peers to place in the DOWN state.

Type: Array of strings

Required: No

testDurationInMinutes

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

Type: Integer

Required: No

virtualInterfaceId

The ID of the virtual interface you want to test.

Type: String

Required: Yes

Response Syntax

{ "virtualInterfaceTest": { "bgpPeers": [ "string" ], "endTime": number, "ownerAccount": "string", "startTime": number, "status": "string", "testDurationInMinutes": number, "testId": "string", "virtualInterfaceId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

virtualInterfaceTest

Information about the virtual interface failover test.

Type: VirtualInterfaceTestHistory object

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: