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

ibm.getTgRouteReports

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 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,
});
Copy
import pulumi
import pulumi_ibm as ibm

tg_route_reports = ibm.get_tg_route_reports(gateway=ibm_tg_gateway["new_tg_gw"]["id"])
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func GetTgRouteReports(ctx *Context, args *GetTgRouteReportsArgs, opts ...InvokeOption) (*GetTgRouteReportsResult, error)
func GetTgRouteReportsOutput(ctx *Context, args *GetTgRouteReportsOutputArgs, opts ...InvokeOption) GetTgRouteReportsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetTgRouteReportsResult> getTgRouteReports(GetTgRouteReportsArgs args, InvokeOptions options)
public static Output<GetTgRouteReportsResult> getTgRouteReports(GetTgRouteReportsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getTgRouteReports:getTgRouteReports
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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

GetTgRouteReportsRouteReportConnection

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

GetTgRouteReportsRouteReportConnectionBgp

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

GetTgRouteReportsRouteReportConnectionRoute

Prefix This property is required. string
(String) The overlapping prefix
Prefix This property is required. string
(String) The overlapping prefix
prefix This property is required. String
(String) The overlapping prefix
prefix This property is required. string
(String) The overlapping prefix
prefix This property is required. str
(String) The overlapping prefix
prefix This property is required. String
(String) The overlapping prefix

GetTgRouteReportsRouteReportOverlappingRoute

Routes This property is required. List<GetTgRouteReportsRouteReportOverlappingRouteRoute>
(String) A list of the connection's routes
Routes This property is required. []GetTgRouteReportsRouteReportOverlappingRouteRoute
(String) A list of the connection's routes
routes This property is required. List<GetTgRouteReportsRouteReportOverlappingRouteRoute>
(String) A list of the connection's routes
routes This property is required. GetTgRouteReportsRouteReportOverlappingRouteRoute[]
(String) A list of the connection's routes
routes This property is required. Sequence[GetTgRouteReportsRouteReportOverlappingRouteRoute]
(String) A list of the connection's routes
routes This property is required. List<Property Map>
(String) A list of the connection's routes

GetTgRouteReportsRouteReportOverlappingRouteRoute

ConnectionId This property is required. string
(String) The unique identifier for the transit gateway connection
Prefix This property is required. string
(String) The overlapping prefix
ConnectionId This property is required. string
(String) The unique identifier for the transit gateway connection
Prefix This property is required. string
(String) The overlapping prefix
connectionId This property is required. String
(String) The unique identifier for the transit gateway connection
prefix This property is required. String
(String) The overlapping prefix
connectionId This property is required. string
(String) The unique identifier for the transit gateway connection
prefix This property is required. string
(String) The overlapping prefix
connection_id This property is required. str
(String) The unique identifier for the transit gateway connection
prefix This property is required. str
(String) The overlapping prefix
connectionId This property is required. String
(String) The unique identifier for the transit gateway connection
prefix This property is required. 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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm