Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiRoutes
ibm 1.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiRoutes

Explore with Pulumi AI

ibm logo
ibm 1.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information about all routes. 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.getPiRoutes({
    piCloudInstanceId: "<value of the cloud_instance_id>",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_pi_routes(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.GetPiRoutes(ctx, &ibm.GetPiRoutesArgs{
			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.GetPiRoutes.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.GetPiRoutesArgs;
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.getPiRoutes(GetPiRoutesArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getPiRoutes
      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 getPiRoutes

    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 getPiRoutes(args: GetPiRoutesArgs, opts?: InvokeOptions): Promise<GetPiRoutesResult>
function getPiRoutesOutput(args: GetPiRoutesOutputArgs, opts?: InvokeOptions): Output<GetPiRoutesResult>
    def get_pi_routes(id: Optional[str] = None,
                  pi_cloud_instance_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetPiRoutesResult
def get_pi_routes_output(id: Optional[pulumi.Input[str]] = None,
                  pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetPiRoutesResult]
    func GetPiRoutes(ctx *Context, args *GetPiRoutesArgs, opts ...InvokeOption) (*GetPiRoutesResult, error)
func GetPiRoutesOutput(ctx *Context, args *GetPiRoutesOutputArgs, opts ...InvokeOption) GetPiRoutesResultOutput

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

    public static class GetPiRoutes 
{
    public static Task<GetPiRoutesResult> InvokeAsync(GetPiRoutesArgs args, InvokeOptions? opts = null)
    public static Output<GetPiRoutesResult> Invoke(GetPiRoutesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiRoutesResult> getPiRoutes(GetPiRoutesArgs args, InvokeOptions options)
public static Output<GetPiRoutesResult> getPiRoutes(GetPiRoutesArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getPiRoutes:getPiRoutes
  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

    getPiRoutes Result

    The following output properties are available:

    Id string
    PiCloudInstanceId string
    Routes List<GetPiRoutesRoute>
    (List) List of all routes.
    Id string
    PiCloudInstanceId string
    Routes []GetPiRoutesRoute
    (List) List of all routes.
    id String
    piCloudInstanceId String
    routes List<GetPiRoutesRoute>
    (List) List of all routes.
    id string
    piCloudInstanceId string
    routes GetPiRoutesRoute[]
    (List) List of all routes.
    id String
    piCloudInstanceId String
    routes List<Property Map>
    (List) List of all routes.

    Supporting Types

    GetPiRoutesRoute

    Action string
    (String) The route action.
    string
    (String) Indicates if the route is advertised.
    Crn string
    (String) The CRN of this resource.
    Destination string
    (String) The route destination.
    DestinationType string
    (String) The destination type.
    Enabled bool
    (Boolean) Indicates if the route should be enabled in the fabric.
    Name string
    (String) Name of the route.
    NextHop string
    (String) The next hop in the route.
    NextHopType string
    (String) The next hop type.
    RouteId string
    State string
    (String) The state of the route.
    UserTags List<string>
    (Set of String) List of user tags attached to the resource.
    Action string
    (String) The route action.
    string
    (String) Indicates if the route is advertised.
    Crn string
    (String) The CRN of this resource.
    Destination string
    (String) The route destination.
    DestinationType string
    (String) The destination type.
    Enabled bool
    (Boolean) Indicates if the route should be enabled in the fabric.
    Name string
    (String) Name of the route.
    NextHop string
    (String) The next hop in the route.
    NextHopType string
    (String) The next hop type.
    RouteId string
    State string
    (String) The state of the route.
    UserTags []string
    (Set of String) List of user tags attached to the resource.
    action String
    (String) The route action.
    String
    (String) Indicates if the route is advertised.
    crn String
    (String) The CRN of this resource.
    destination String
    (String) The route destination.
    destinationType String
    (String) The destination type.
    enabled Boolean
    (Boolean) Indicates if the route should be enabled in the fabric.
    name String
    (String) Name of the route.
    nextHop String
    (String) The next hop in the route.
    nextHopType String
    (String) The next hop type.
    routeId String
    state String
    (String) The state of the route.
    userTags List<String>
    (Set of String) List of user tags attached to the resource.
    action string
    (String) The route action.
    string
    (String) Indicates if the route is advertised.
    crn string
    (String) The CRN of this resource.
    destination string
    (String) The route destination.
    destinationType string
    (String) The destination type.
    enabled boolean
    (Boolean) Indicates if the route should be enabled in the fabric.
    name string
    (String) Name of the route.
    nextHop string
    (String) The next hop in the route.
    nextHopType string
    (String) The next hop type.
    routeId string
    state string
    (String) The state of the route.
    userTags string[]
    (Set of String) List of user tags attached to the resource.
    action str
    (String) The route action.
    str
    (String) Indicates if the route is advertised.
    crn str
    (String) The CRN of this resource.
    destination str
    (String) The route destination.
    destination_type str
    (String) The destination type.
    enabled bool
    (Boolean) Indicates if the route should be enabled in the fabric.
    name str
    (String) Name of the route.
    next_hop str
    (String) The next hop in the route.
    next_hop_type str
    (String) The next hop type.
    route_id str
    state str
    (String) The state of the route.
    user_tags Sequence[str]
    (Set of String) List of user tags attached to the resource.
    action String
    (String) The route action.
    String
    (String) Indicates if the route is advertised.
    crn String
    (String) The CRN of this resource.
    destination String
    (String) The route destination.
    destinationType String
    (String) The destination type.
    enabled Boolean
    (Boolean) Indicates if the route should be enabled in the fabric.
    name String
    (String) Name of the route.
    nextHop String
    (String) The next hop in the route.
    nextHopType String
    (String) The next hop type.
    routeId String
    state String
    (String) The state of the route.
    userTags List<String>
    (Set of String) List of user tags attached to the resource.

    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.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm