Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiRouteReport
ibm 1.80.4 published on Tuesday, Jul 15, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiRouteReport

Explore with Pulumi AI

ibm logo
ibm 1.80.4 published on Tuesday, Jul 15, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve a route report. For more information, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

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

const example = ibm.getPiRouteReport({
    piCloudInstanceId: "<value of the cloud_instance_id>",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_pi_route_report(pi_cloud_instance_id="<value of the cloud_instance_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.GetPiRouteReport(ctx, &ibm.GetPiRouteReportArgs{
			PiCloudInstanceId: "<value of the cloud_instance_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 example = Ibm.GetPiRouteReport.Invoke(new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_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.GetPiRouteReportArgs;
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 example = IbmFunctions.getPiRouteReport(GetPiRouteReportArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getPiRouteReport
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

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

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Using getPiRouteReport

    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 getPiRouteReport(args: GetPiRouteReportArgs, opts?: InvokeOptions): Promise<GetPiRouteReportResult>
function getPiRouteReportOutput(args: GetPiRouteReportOutputArgs, opts?: InvokeOptions): Output<GetPiRouteReportResult>
    def get_pi_route_report(id: Optional[str] = None,
                        pi_cloud_instance_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPiRouteReportResult
def get_pi_route_report_output(id: Optional[pulumi.Input[str]] = None,
                        pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPiRouteReportResult]
    func GetPiRouteReport(ctx *Context, args *GetPiRouteReportArgs, opts ...InvokeOption) (*GetPiRouteReportResult, error)
func GetPiRouteReportOutput(ctx *Context, args *GetPiRouteReportOutputArgs, opts ...InvokeOption) GetPiRouteReportResultOutput

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

    public static class GetPiRouteReport 
{
    public static Task<GetPiRouteReportResult> InvokeAsync(GetPiRouteReportArgs args, InvokeOptions? opts = null)
    public static Output<GetPiRouteReportResult> Invoke(GetPiRouteReportInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiRouteReportResult> getPiRouteReport(GetPiRouteReportArgs args, InvokeOptions options)
public static Output<GetPiRouteReportResult> getPiRouteReport(GetPiRouteReportArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String

    getPiRouteReport Result

    The following output properties are available:

    Id string
    PiCloudInstanceId string
    Routes List<GetPiRouteReportRoute>
    (List) List of all route report routes.
    Id string
    PiCloudInstanceId string
    Routes []GetPiRouteReportRoute
    (List) List of all route report routes.
    id String
    piCloudInstanceId String
    routes List<GetPiRouteReportRoute>
    (List) List of all route report routes.
    id string
    piCloudInstanceId string
    routes GetPiRouteReportRoute[]
    (List) List of all route report routes.
    id str
    pi_cloud_instance_id str
    routes Sequence[GetPiRouteReportRoute]
    (List) List of all route report routes.
    id String
    piCloudInstanceId String
    routes List<Property Map>
    (List) List of all route report routes.

    Supporting Types

    GetPiRouteReportRoute

    Destination string
    (String) The route destination.
    Type string
    (String) The route type.
    Destination string
    (String) The route destination.
    Type string
    (String) The route type.
    destination String
    (String) The route destination.
    type String
    (String) The route type.
    destination string
    (String) The route destination.
    type string
    (String) The route type.
    destination str
    (String) The route destination.
    type str
    (String) The route type.
    destination String
    (String) The route destination.
    type String
    (String) The route type.

    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.80.4 published on Tuesday, Jul 15, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm