DirectConnect / Client / start_bgp_failover_test

start_bgp_failover_test#

DirectConnect.Client.start_bgp_failover_test(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.start_bgp_failover_test(
    virtualInterfaceId='string',
    bgpPeers=[
        'string',
    ],
    testDurationInMinutes=123
)
Parameters:

  • virtualInterfaceId (string) –

    [REQUIRED]

    The ID of the virtual interface you want to test.

  • bgpPeers (list) –

    The BGP peers to place in the DOWN state.

    • (string) –

  • testDurationInMinutes (integer) –

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

    Maximum value: 4,320 minutes (72 hours).

    Default: 180 minutes (3 hours).

Return type:

dict

Returns:

Response Syntax

{
    'virtualInterfaceTest': {
        'testId': 'string',
        'virtualInterfaceId': 'string',
        'bgpPeers': [
            'string',
        ],
        'status': 'string',
        'ownerAccount': 'string',
        'testDurationInMinutes': 123,
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • virtualInterfaceTest (dict) –

      Information about the virtual interface failover test.

      • testId (string) –

        The ID of the virtual interface failover test.

      • virtualInterfaceId (string) –

        The ID of the tested virtual interface.

      • bgpPeers (list) –

        The BGP peers that were put in the DOWN state as part of the virtual interface failover test.

        • (string) –

      • status (string) –

        The status of the virtual interface failover test.

      • ownerAccount (string) –

        The owner ID of the tested virtual interface.

      • testDurationInMinutes (integer) –

        The time that the virtual interface failover test ran in minutes.

      • startTime (datetime) –

        The time that the virtual interface moves to the DOWN state.

      • endTime (datetime) –

        The time that the virtual interface moves out of the DOWN state.

Exceptions