1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiAvailableHosts
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getPiAvailableHosts

Explore with Pulumi AI

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>",
});
Copy
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>")
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.GetPiAvailableHosts(ctx, &ibm.GetPiAvailableHostsArgs{
			PiCloudInstanceId: "<value of the cloud_instance_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 piAvailableHosts = Ibm.GetPiAvailableHosts.Invoke(new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_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.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());

    }
}
Copy
variables:
  piAvailableHosts:
    fn::invoke:
      function: ibm:getPiAvailableHosts
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>
Copy

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";
Copy
import pulumi
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

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>
Copy
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]
Copy
func GetPiAvailableHosts(ctx *Context, args *GetPiAvailableHostsArgs, opts ...InvokeOption) (*GetPiAvailableHostsResult, error)
func GetPiAvailableHostsOutput(ctx *Context, args *GetPiAvailableHostsOutputArgs, opts ...InvokeOption) GetPiAvailableHostsResultOutput
Copy

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

The following arguments are supported:

PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
Id string
PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
Id string
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
id String
piCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
id string
pi_cloud_instance_id This property is required. str
The GUID of the service instance associated with an account.
id str
piCloudInstanceId This property is required. 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 This property is required. double
(Float) Core capacity of the host.
AvailableMemory This property is required. double
(Float) Memory capacity of the host (in GB).
Count This property is required. double
(int) The number of hosts with similar types/capacities that are available.
SysType This property is required. string
(String) System type.
AvailableCores This property is required. float64
(Float) Core capacity of the host.
AvailableMemory This property is required. float64
(Float) Memory capacity of the host (in GB).
Count This property is required. float64
(int) The number of hosts with similar types/capacities that are available.
SysType This property is required. string
(String) System type.
availableCores This property is required. Double
(Float) Core capacity of the host.
availableMemory This property is required. Double
(Float) Memory capacity of the host (in GB).
count This property is required. Double
(int) The number of hosts with similar types/capacities that are available.
sysType This property is required. String
(String) System type.
availableCores This property is required. number
(Float) Core capacity of the host.
availableMemory This property is required. number
(Float) Memory capacity of the host (in GB).
count This property is required. number
(int) The number of hosts with similar types/capacities that are available.
sysType This property is required. string
(String) System type.
available_cores This property is required. float
(Float) Core capacity of the host.
available_memory This property is required. float
(Float) Memory capacity of the host (in GB).
count This property is required. float
(int) The number of hosts with similar types/capacities that are available.
sys_type This property is required. str
(String) System type.
availableCores This property is required. Number
(Float) Core capacity of the host.
availableMemory This property is required. Number
(Float) Memory capacity of the host (in GB).
count This property is required. Number
(int) The number of hosts with similar types/capacities that are available.
sysType This property is required. 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.