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

ibm.getTgRouteReport

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 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>
Copy
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]
Copy
func LookupTgRouteReport(ctx *Context, args *LookupTgRouteReportArgs, opts ...InvokeOption) (*LookupTgRouteReportResult, error)
func LookupTgRouteReportOutput(ctx *Context, args *LookupTgRouteReportOutputArgs, opts ...InvokeOption) LookupTgRouteReportResultOutput
Copy

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

The following arguments are supported:

Gateway This property is required. string
The unique identifier of the gateway.
RouteReport This property is required. string
The unique identifier of the gateway route report
Id string
(String) The unique identifier for the transit gateway connection
Gateway This property is required. string
The unique identifier of the gateway.
RouteReport This property is required. string
The unique identifier of the gateway route report
Id string
(String) The unique identifier for the transit gateway connection
gateway This property is required. String
The unique identifier of the gateway.
routeReport This property is required. String
The unique identifier of the gateway route report
id String
(String) The unique identifier for the transit gateway connection
gateway This property is required. string
The unique identifier of the gateway.
routeReport This property is required. string
The unique identifier of the gateway route report
id string
(String) The unique identifier for the transit gateway connection
gateway This property is required. str
The unique identifier of the gateway.
route_report This property is required. str
The unique identifier of the gateway route report
id str
(String) The unique identifier for the transit gateway connection
gateway This property is required. String
The unique identifier of the gateway.
routeReport This property is required. 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 This property is required. List<GetTgRouteReportConnectionBgp>
(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<GetTgRouteReportConnectionRoute>
(String) A list of the connection's routes
Type This property is required. string
(String) The connection type
Bgps This property is required. []GetTgRouteReportConnectionBgp
(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. []GetTgRouteReportConnectionRoute
(String) A list of the connection's routes
Type This property is required. string
(String) The connection type
bgps This property is required. List<GetTgRouteReportConnectionBgp>
(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<GetTgRouteReportConnectionRoute>
(String) A list of the connection's routes
type This property is required. String
(String) The connection type
bgps This property is required. GetTgRouteReportConnectionBgp[]
(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. GetTgRouteReportConnectionRoute[]
(String) A list of the connection's routes
type This property is required. string
(String) The connection type
bgps This property is required. Sequence[GetTgRouteReportConnectionBgp]
(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[GetTgRouteReportConnectionRoute]
(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

GetTgRouteReportConnectionBgp

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

GetTgRouteReportConnectionRoute

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

GetTgRouteReportOverlappingRoute

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

GetTgRouteReportOverlappingRouteRoute

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