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

ibm.getTgRouteReports

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 reports as a read only data source. For more information about Transit Gateway Route Reports, see generating and viewing a route report.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const tgRouteReports = ibm.getTgRouteReports({
    gateway: ibm_tg_gateway.new_tg_gw.id,
});

    import pulumi
import pulumi_ibm as ibm

tg_route_reports = ibm.get_tg_route_reports(gateway=ibm_tg_gateway["new_tg_gw"]["id"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetTgRouteReports(ctx, &ibm.GetTgRouteReportsArgs{
			Gateway: ibm_tg_gateway.New_tg_gw.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var tgRouteReports = Ibm.GetTgRouteReports.Invoke(new()
    {
        Gateway = ibm_tg_gateway.New_tg_gw.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetTgRouteReportsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var tgRouteReports = IbmFunctions.getTgRouteReports(GetTgRouteReportsArgs.builder()
            .gateway(ibm_tg_gateway.new_tg_gw().id())
            .build());

    }
}

    variables:
  tgRouteReports:
    fn::invoke:
      function: ibm:getTgRouteReports
      arguments:
        gateway: ${ibm_tg_gateway.new_tg_gw.id}

    Using getTgRouteReports

    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 getTgRouteReports(args: GetTgRouteReportsArgs, opts?: InvokeOptions): Promise<GetTgRouteReportsResult>
function getTgRouteReportsOutput(args: GetTgRouteReportsOutputArgs, opts?: InvokeOptions): Output<GetTgRouteReportsResult>
    def get_tg_route_reports(gateway: Optional[str] = None,
                         id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetTgRouteReportsResult
def get_tg_route_reports_output(gateway: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetTgRouteReportsResult]
    func GetTgRouteReports(ctx *Context, args *GetTgRouteReportsArgs, opts ...InvokeOption) (*GetTgRouteReportsResult, error)
func GetTgRouteReportsOutput(ctx *Context, args *GetTgRouteReportsOutputArgs, opts ...InvokeOption) GetTgRouteReportsResultOutput

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

    public static class GetTgRouteReports 
{
    public static Task<GetTgRouteReportsResult> InvokeAsync(GetTgRouteReportsArgs args, InvokeOptions? opts = null)
    public static Output<GetTgRouteReportsResult> Invoke(GetTgRouteReportsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTgRouteReportsResult> getTgRouteReports(GetTgRouteReportsArgs args, InvokeOptions options)
public static Output<GetTgRouteReportsResult> getTgRouteReports(GetTgRouteReportsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Gateway string
    The unique identifier of the gateway.
    Id string
    (String) The unique identifier for the transit gateway connection
    Gateway string
    The unique identifier of the gateway.
    Id string
    (String) The unique identifier for the transit gateway connection
    gateway String
    The unique identifier of the gateway.
    id String
    (String) The unique identifier for the transit gateway connection
    gateway string
    The unique identifier of the gateway.
    id string
    (String) The unique identifier for the transit gateway connection
    gateway str
    The unique identifier of the gateway.
    id str
    (String) The unique identifier for the transit gateway connection
    gateway String
    The unique identifier of the gateway.
    id String
    (String) The unique identifier for the transit gateway connection

    getTgRouteReports Result

    The following output properties are available:

    Gateway string
    Id string
    (String) The unique identifier for the transit gateway connection
    RouteReports List<GetTgRouteReportsRouteReport>
    (String) List of all route reports for the transit gateway
    Gateway string
    Id string
    (String) The unique identifier for the transit gateway connection
    RouteReports []GetTgRouteReportsRouteReport
    (String) List of all route reports for the transit gateway
    gateway String
    id String
    (String) The unique identifier for the transit gateway connection
    routeReports List<GetTgRouteReportsRouteReport>
    (String) List of all route reports for the transit gateway
    gateway string
    id string
    (String) The unique identifier for the transit gateway connection
    routeReports GetTgRouteReportsRouteReport[]
    (String) List of all route reports for the transit gateway
    gateway str
    id str
    (String) The unique identifier for the transit gateway connection
    route_reports Sequence[GetTgRouteReportsRouteReport]
    (String) List of all route reports for the transit gateway
    gateway String
    id String
    (String) The unique identifier for the transit gateway connection
    routeReports List<Property Map>
    (String) List of all route reports for the transit gateway

    Supporting Types

    GetTgRouteReportsRouteReport

    Connections List<GetTgRouteReportsRouteReportConnection>
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Id string
    (String) The unique identifier for the transit gateway connection
    OverlappingRoutes List<GetTgRouteReportsRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    Status string
    (String) The route report status.
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    Connections []GetTgRouteReportsRouteReportConnection
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Id string
    (String) The unique identifier for the transit gateway connection
    OverlappingRoutes []GetTgRouteReportsRouteReportOverlappingRoute
    (String) A list of overlapping routes in the gateway
    Status string
    (String) The route report status.
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    connections List<GetTgRouteReportsRouteReportConnection>
    (String) A list of connections in the gateway
    createdAt String
    (Timestamp) The date and time resource is created.
    id String
    (String) The unique identifier for the transit gateway connection
    overlappingRoutes List<GetTgRouteReportsRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    status String
    (String) The route report status.
    updatedAt String
    (Timestamp) The date and time resource is last updated.
    connections GetTgRouteReportsRouteReportConnection[]
    (String) A list of connections in the gateway
    createdAt string
    (Timestamp) The date and time resource is created.
    id string
    (String) The unique identifier for the transit gateway connection
    overlappingRoutes GetTgRouteReportsRouteReportOverlappingRoute[]
    (String) A list of overlapping routes in the gateway
    status string
    (String) The route report status.
    updatedAt string
    (Timestamp) The date and time resource is last updated.
    connections Sequence[GetTgRouteReportsRouteReportConnection]
    (String) A list of connections in the gateway
    created_at str
    (Timestamp) The date and time resource is created.
    id str
    (String) The unique identifier for the transit gateway connection
    overlapping_routes Sequence[GetTgRouteReportsRouteReportOverlappingRoute]
    (String) A list of overlapping routes in the gateway
    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.
    id String
    (String) The unique identifier for the transit gateway connection
    overlappingRoutes List<Property Map>
    (String) A list of overlapping routes in the gateway
    status String
    (String) The route report status.
    updatedAt String
    (Timestamp) The date and time resource is last updated.

    GetTgRouteReportsRouteReportConnection

    Bgps List<GetTgRouteReportsRouteReportConnectionBgp>
    (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<GetTgRouteReportsRouteReportConnectionRoute>
    (String) A list of the connection's routes
    Type string
    (String) The connection type
    Bgps []GetTgRouteReportsRouteReportConnectionBgp
    (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 []GetTgRouteReportsRouteReportConnectionRoute
    (String) A list of the connection's routes
    Type string
    (String) The connection type
    bgps List<GetTgRouteReportsRouteReportConnectionBgp>
    (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<GetTgRouteReportsRouteReportConnectionRoute>
    (String) A list of the connection's routes
    type String
    (String) The connection type
    bgps GetTgRouteReportsRouteReportConnectionBgp[]
    (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 GetTgRouteReportsRouteReportConnectionRoute[]
    (String) A list of the connection's routes
    type string
    (String) The connection type
    bgps Sequence[GetTgRouteReportsRouteReportConnectionBgp]
    (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[GetTgRouteReportsRouteReportConnectionRoute]
    (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

    GetTgRouteReportsRouteReportConnectionBgp

    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

    GetTgRouteReportsRouteReportConnectionRoute

    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

    GetTgRouteReportsRouteReportOverlappingRoute

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

    GetTgRouteReportsRouteReportOverlappingRouteRoute

    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