ibm.getPiHostGroups

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Example Usage

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

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

import pulumi
import pulumi_ibm as ibm

host_group = ibm.get_pi_host_groups(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.GetPiHostGroups(ctx, &ibm.GetPiHostGroupsArgs{
			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 hostGroup = Ibm.GetPiHostGroups.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.GetPiHostGroupsArgs;
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 hostGroup = IbmFunctions.getPiHostGroups(GetPiHostGroupsArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

variables:
  hostGroup:
    fn::invoke:
      function: ibm:getPiHostGroups
      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 getPiHostGroups

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 getPiHostGroups(args: GetPiHostGroupsArgs, opts?: InvokeOptions): Promise<GetPiHostGroupsResult>
function getPiHostGroupsOutput(args: GetPiHostGroupsOutputArgs, opts?: InvokeOptions): Output<GetPiHostGroupsResult>

def get_pi_host_groups(id: Optional[str] = None,
                       pi_cloud_instance_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPiHostGroupsResult
def get_pi_host_groups_output(id: Optional[pulumi.Input[str]] = None,
                       pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPiHostGroupsResult]

func GetPiHostGroups(ctx *Context, args *GetPiHostGroupsArgs, opts ...InvokeOption) (*GetPiHostGroupsResult, error)
func GetPiHostGroupsOutput(ctx *Context, args *GetPiHostGroupsOutputArgs, opts ...InvokeOption) GetPiHostGroupsResultOutput

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

public static class GetPiHostGroups 
{
    public static Task<GetPiHostGroupsResult> InvokeAsync(GetPiHostGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiHostGroupsResult> Invoke(GetPiHostGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPiHostGroupsResult> getPiHostGroups(GetPiHostGroupsArgs args, InvokeOptions options)
public static Output<GetPiHostGroupsResult> getPiHostGroups(GetPiHostGroupsArgs args, InvokeOptions options)

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

The following arguments are supported:

PiCloudInstanceId string: The GUID of the service instance associated with an account.
Id string: (String) The unique identifier of the host group.

PiCloudInstanceId string: The GUID of the service instance associated with an account.
Id string: (String) The unique identifier of the host group.

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String: (String) The unique identifier of the host group.

piCloudInstanceId string: The GUID of the service instance associated with an account.
id string: (String) The unique identifier of the host group.

pi_cloud_instance_id str: The GUID of the service instance associated with an account.
id str: (String) The unique identifier of the host group.

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String: (String) The unique identifier of the host group.

getPiHostGroups Result

The following output properties are available:

HostGroups List<GetPiHostGroupsHostGroup>

(List) List of host groups.

Nested sheme for host_groups:

Id string