Skip to content

StartRouteAnalysisRequest

Source code in docs_src/capo_networkmanager/types/start_route_analysis_request.py
class StartRouteAnalysisRequest(TypedDict, closed=True):
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId"
    """<p>The ID of the global network.</p>"""
    source: "capo_networkmanager.types.route_analysis_endpoint_options_specification.RouteAnalysisEndpointOptionsSpecification"
    """<p>The source from which traffic originates.</p>"""
    destination: "capo_networkmanager.types.route_analysis_endpoint_options_specification.RouteAnalysisEndpointOptionsSpecification"
    """<p>The destination.</p>"""
    include_return_path: "capo_networkmanager.types.boolean.Boolean"
    """<p>Indicates whether to analyze the return path. The default is <code>false</code>.</p>"""
    use_middleboxes: "capo_networkmanager.types.boolean.Boolean"
    """<p>Indicates whether to include the location of middlebox appliances in the route analysis. The default is <code>false</code>.</p>"""

destination instance-attribute

The destination.

global_network_id instance-attribute

global_network_id: GlobalNetworkId

The ID of the global network.

include_return_path instance-attribute

include_return_path: Boolean

Indicates whether to analyze the return path. The default is false.

source instance-attribute

The source from which traffic originates.

use_middleboxes instance-attribute

use_middleboxes: Boolean

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.