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

ibm.getPiAvailableHosts

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 the details information about available hosts. For more information, about available host, see dedicated hosts.

    Example Usage

    The following example shows how to retrieve information using ibm.getPiAvailableHosts.

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

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

    import pulumi
import pulumi_ibm as ibm

pi_available_hosts = ibm.get_pi_available_hosts(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.GetPiAvailableHosts(ctx, &ibm.GetPiAvailableHostsArgs{
			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 piAvailableHosts = Ibm.GetPiAvailableHosts.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.GetPiAvailableHostsArgs;
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 piAvailableHosts = IbmFunctions.getPiAvailableHosts(GetPiAvailableHostsArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

    variables:
  piAvailableHosts:
    fn::invoke:
      function: ibm:getPiAvailableHosts
      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 getPiAvailableHosts

    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 getPiAvailableHosts(args: GetPiAvailableHostsArgs, opts?: InvokeOptions): Promise<GetPiAvailableHostsResult>
function getPiAvailableHostsOutput(args: GetPiAvailableHostsOutputArgs, opts?: InvokeOptions): Output<GetPiAvailableHostsResult>
    def get_pi_available_hosts(id: Optional[str] = None,
                           pi_cloud_instance_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPiAvailableHostsResult
def get_pi_available_hosts_output(id: Optional[pulumi.Input[str]] = None,
                           pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPiAvailableHostsResult]
    func GetPiAvailableHosts(ctx *Context, args *GetPiAvailableHostsArgs, opts ...InvokeOption) (*GetPiAvailableHostsResult, error)
func GetPiAvailableHostsOutput(ctx *Context, args *GetPiAvailableHostsOutputArgs, opts ...InvokeOption) GetPiAvailableHostsResultOutput

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

    public static class GetPiAvailableHosts 
{
    public static Task<GetPiAvailableHostsResult> InvokeAsync(GetPiAvailableHostsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiAvailableHostsResult> Invoke(GetPiAvailableHostsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiAvailableHostsResult> getPiAvailableHosts(GetPiAvailableHostsArgs args, InvokeOptions options)
public static Output<GetPiAvailableHostsResult> getPiAvailableHosts(GetPiAvailableHostsArgs args, InvokeOptions options)

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

    getPiAvailableHosts Result

    The following output properties are available:

    AvailableHosts List<GetPiAvailableHostsAvailableHost>
    (List) Lists of all availabe hosts.
    Id string
    PiCloudInstanceId string
    AvailableHosts []GetPiAvailableHostsAvailableHost
    (List) Lists of all availabe hosts.
    Id string
    PiCloudInstanceId string
    availableHosts List<GetPiAvailableHostsAvailableHost>
    (List) Lists of all availabe hosts.
    id String
    piCloudInstanceId String
    availableHosts GetPiAvailableHostsAvailableHost[]
    (List) Lists of all availabe hosts.
    id string
    piCloudInstanceId string
    availableHosts List<Property Map>
    (List) Lists of all availabe hosts.
    id String
    piCloudInstanceId String

    Supporting Types

    GetPiAvailableHostsAvailableHost

    AvailableCores double
    (Float) Core capacity of the host.
    AvailableMemory double
    (Float) Memory capacity of the host (in GB).
    Count double
    (int) The number of hosts with similar types/capacities that are available.
    SysType string
    (String) System type.
    AvailableCores float64
    (Float) Core capacity of the host.
    AvailableMemory float64
    (Float) Memory capacity of the host (in GB).
    Count float64
    (int) The number of hosts with similar types/capacities that are available.
    SysType string
    (String) System type.
    availableCores Double
    (Float) Core capacity of the host.
    availableMemory Double
    (Float) Memory capacity of the host (in GB).
    count Double
    (int) The number of hosts with similar types/capacities that are available.
    sysType String
    (String) System type.
    availableCores number
    (Float) Core capacity of the host.
    availableMemory number
    (Float) Memory capacity of the host (in GB).
    count number
    (int) The number of hosts with similar types/capacities that are available.
    sysType string
    (String) System type.
    available_cores float
    (Float) Core capacity of the host.
    available_memory float
    (Float) Memory capacity of the host (in GB).
    count float
    (int) The number of hosts with similar types/capacities that are available.
    sys_type str
    (String) System type.
    availableCores Number
    (Float) Core capacity of the host.
    availableMemory Number
    (Float) Memory capacity of the host (in GB).
    count Number
    (int) The number of hosts with similar types/capacities that are available.
    sysType String
    (String) System 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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm