Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getTgRouteReport
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getTgRouteReport

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information of an existing IBM Cloud infrastructure transit gateway route report as a read only data source. For more information about Transit Gateway Route Reports, see generating and viewing a route report.

    Using getTgRouteReport

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTgRouteReport(args: GetTgRouteReportArgs, opts?: InvokeOptions): Promise<GetTgRouteReportResult>
function getTgRouteReportOutput(args: GetTgRouteReportOutputArgs, opts?: InvokeOptions): Output<GetTgRouteReportResult>
    def get_tg_route_report(gateway: Optional[str] = None,
                        id: Optional[str] = None,
                        route_report: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTgRouteReportResult
def get_tg_route_report_output(gateway: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        route_report: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTgRouteReportResult]
    func LookupTgRouteReport(ctx *Context, args *LookupTgRouteReportArgs, opts ...InvokeOption) (*LookupTgRouteReportResult, error)
func LookupTgRouteReportOutput(ctx *Context, args *LookupTgRouteReportOutputArgs, opts ...InvokeOption) LookupTgRouteReportResultOutput

    > Note: This function is named LookupTgRouteReport in the Go SDK.

    public static class GetTgRouteReport 
{
    public static Task<GetTgRouteReportResult> InvokeAsync(GetTgRouteReportArgs args, InvokeOptions? opts = null)
    public static Output<GetTgRouteReportResult> Invoke(GetTgRouteReportInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTgRouteReportResult> getTgRouteReport(GetTgRouteReportArgs args, InvokeOptions options)
public static Output<GetTgRouteReportResult> getTgRouteReport(GetTgRouteReportArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getTgRouteReport:getTgRouteReport
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Gateway string
    The unique identifier of the gateway.
    RouteReport string
    The unique identifier of the gateway route report
    Id string
    (String) The unique identifier for the transit gateway connection
    Gateway string
    The unique identifier of the gateway.
    RouteReport string
    The unique identifier of the gateway route report
    Id string
    (String) The unique identifier for the transit gateway connection
    gateway String
    The unique identifier of the gateway.
    routeReport String
    The unique identifier of the gateway route report
    id String
    (String) The unique identifier for the transit gateway connection
    gateway string
    The unique identifier of the gateway.
    routeReport string
    The unique identifier of the gateway route report
    id string
    (String) The unique identifier for the transit gateway connection
    gateway str
    The unique identifier of the gateway.
    route_report str
    The unique identifier of the gateway route report
    id str
    (String) The unique identifier for the transit gateway connection
    gateway String
    The unique identifier of the gateway.
    routeReport String
    The unique identifier of the gateway route report
    id String
    (String) The unique identifier for the transit gateway connection

    getTgRouteReport Result

    The following output properties are available:

    Connections List<GetTgRouteReportConnection>
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Gateway string
    Id string
    (String) The unique identifier for the transit gateway connection
    OverlappingRoutes List<GetTgRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    RouteReport string
    Status string
    (String) The route report status.
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    Connections []GetTgRouteReportConnection
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Gateway string
    Id string
    (String) The unique identifier for the transit gateway connection
    OverlappingRoutes []GetTgRouteReportOverlappingRoute
    (String) A list of overlapping routes in the gateway
    RouteReport string
    Status string
    (String) The route report status.
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    connections List<GetTgRouteReportConnection>
    (String) A list of connections in the gateway
    createdAt String
    (Timestamp) The date and time resource is created.
    gateway String
    id String
    (String) The unique identifier for the transit gateway connection
    overlappingRoutes List<GetTgRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    routeReport String
    status String
    (String) The route report status.
    updatedAt String
    (Timestamp) The date and time resource is last updated.
    connections GetTgRouteReportConnection[]
    (String) A list of connections in the gateway
    createdAt string
    (Timestamp) The date and time resource is created.
    gateway string
    id string
    (String) The unique identifier for the transit gateway connection
    overlappingRoutes GetTgRouteReportOverlappingRoute[]
    (String) A list of overlapping routes in the gateway
    routeReport string
    status string
    (String) The route report status.
    updatedAt string
    (Timestamp) The date and time resource is last updated.
    connections Sequence[GetTgRouteReportConnection]
    (String) A list of connections in the gateway
    created_at str
    (Timestamp) The date and time resource is created.
    gateway str
    id str
    (String) The unique identifier for the transit gateway connection
    overlapping_routes Sequence[GetTgRouteReportOverlappingRoute]
    (String) A list of overlapping routes in the gateway
    route_report str
    status str
    (String) The route report status.
    updated_at str
    (Timestamp) The date and time resource is last updated.
    connections List<Property Map>
    (String) A list of connections in the gateway
    createdAt String
    (Timestamp) The date and time resource is created.
    gateway String
    id String
    (String) The unique identifier for the transit gateway connection
    overlappingRoutes List<Property Map>
    (String) A list of overlapping routes in the gateway
    routeReport String
    status String
    (String) The route report status.
    updatedAt String
    (Timestamp) The date and time resource is last updated.

    Supporting Types

    GetTgRouteReportConnection

    Bgps List<GetTgRouteReportConnectionBgp>
    (String) A list of the connection's bgps Nested scheme for bgps:
    Id string
    (String) The unique identifier for the transit gateway connection
    Name string
    (String) The user-defined name for the transit gateway connection.
    Routes List<GetTgRouteReportConnectionRoute>
    (String) A list of the connection's routes
    Type string
    (String) The connection type
    Bgps []GetTgRouteReportConnectionBgp
    (String) A list of the connection's bgps Nested scheme for bgps:
    Id string
    (String) The unique identifier for the transit gateway connection
    Name string
    (String) The user-defined name for the transit gateway connection.
    Routes []GetTgRouteReportConnectionRoute
    (String) A list of the connection's routes
    Type string
    (String) The connection type
    bgps List<GetTgRouteReportConnectionBgp>
    (String) A list of the connection's bgps Nested scheme for bgps:
    id String
    (String) The unique identifier for the transit gateway connection
    name String
    (String) The user-defined name for the transit gateway connection.
    routes List<GetTgRouteReportConnectionRoute>
    (String) A list of the connection's routes
    type String
    (String) The connection type
    bgps GetTgRouteReportConnectionBgp[]
    (String) A list of the connection's bgps Nested scheme for bgps:
    id string
    (String) The unique identifier for the transit gateway connection
    name string
    (String) The user-defined name for the transit gateway connection.
    routes GetTgRouteReportConnectionRoute[]
    (String) A list of the connection's routes
    type string
    (String) The connection type
    bgps Sequence[GetTgRouteReportConnectionBgp]
    (String) A list of the connection's bgps Nested scheme for bgps:
    id str
    (String) The unique identifier for the transit gateway connection
    name str
    (String) The user-defined name for the transit gateway connection.
    routes Sequence[GetTgRouteReportConnectionRoute]
    (String) A list of the connection's routes
    type str
    (String) The connection type
    bgps List<Property Map>
    (String) A list of the connection's bgps Nested scheme for bgps:
    id String
    (String) The unique identifier for the transit gateway connection
    name String
    (String) The user-defined name for the transit gateway connection.
    routes List<Property Map>
    (String) A list of the connection's routes
    type String
    (String) The connection type

    GetTgRouteReportConnectionBgp

    AsPath string
    (String) The bgp AS path
    IsUsed bool
    (Bool) Indicates whether the current route is used or not
    LocalPreference string
    (String) The local preference
    Prefix string
    (String) The overlapping prefix
    AsPath string
    (String) The bgp AS path
    IsUsed bool
    (Bool) Indicates whether the current route is used or not
    LocalPreference string
    (String) The local preference
    Prefix string
    (String) The overlapping prefix
    asPath String
    (String) The bgp AS path
    isUsed Boolean
    (Bool) Indicates whether the current route is used or not
    localPreference String
    (String) The local preference
    prefix String
    (String) The overlapping prefix
    asPath string
    (String) The bgp AS path
    isUsed boolean
    (Bool) Indicates whether the current route is used or not
    localPreference string
    (String) The local preference
    prefix string
    (String) The overlapping prefix
    as_path str
    (String) The bgp AS path
    is_used bool
    (Bool) Indicates whether the current route is used or not
    local_preference str
    (String) The local preference
    prefix str
    (String) The overlapping prefix
    asPath String
    (String) The bgp AS path
    isUsed Boolean
    (Bool) Indicates whether the current route is used or not
    localPreference String
    (String) The local preference
    prefix String
    (String) The overlapping prefix

    GetTgRouteReportConnectionRoute

    Prefix string
    (String) The overlapping prefix
    Prefix string
    (String) The overlapping prefix
    prefix String
    (String) The overlapping prefix
    prefix string
    (String) The overlapping prefix
    prefix str
    (String) The overlapping prefix
    prefix String
    (String) The overlapping prefix

    GetTgRouteReportOverlappingRoute

    Routes List<GetTgRouteReportOverlappingRouteRoute>
    (String) A list of the connection's routes
    Routes []GetTgRouteReportOverlappingRouteRoute
    (String) A list of the connection's routes
    routes List<GetTgRouteReportOverlappingRouteRoute>
    (String) A list of the connection's routes
    routes GetTgRouteReportOverlappingRouteRoute[]
    (String) A list of the connection's routes
    routes Sequence[GetTgRouteReportOverlappingRouteRoute]
    (String) A list of the connection's routes
    routes List<Property Map>
    (String) A list of the connection's routes

    GetTgRouteReportOverlappingRouteRoute

    ConnectionId string
    (String) The unique identifier for the transit gateway connection
    Prefix string
    (String) The overlapping prefix
    ConnectionId string
    (String) The unique identifier for the transit gateway connection
    Prefix string
    (String) The overlapping prefix
    connectionId String
    (String) The unique identifier for the transit gateway connection
    prefix String
    (String) The overlapping prefix
    connectionId string
    (String) The unique identifier for the transit gateway connection
    prefix string
    (String) The overlapping prefix
    connection_id str
    (String) The unique identifier for the transit gateway connection
    prefix str
    (String) The overlapping prefix
    connectionId String
    (String) The unique identifier for the transit gateway connection
    prefix String
    (String) The overlapping prefix

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm