Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiHostGroup
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiHostGroup

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about a host group you can use in Power Systems Virtual Server. For more information, about Power Systems Virtual Server host group, see host groups.

    Example Usage

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

const dsHostGroup = ibm.getPiHostGroup({
    piCloudInstanceId: "<value of the cloud_instance_id>",
    piHostGroupId: "<value of the host_group_id>",
});

    import pulumi
import pulumi_ibm as ibm

ds_host_group = ibm.get_pi_host_group(pi_cloud_instance_id="<value of the cloud_instance_id>",
    pi_host_group_id="<value of the host_group_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.LookupPiHostGroup(ctx, &ibm.LookupPiHostGroupArgs{
			PiCloudInstanceId: "<value of the cloud_instance_id>",
			PiHostGroupId:     "<value of the host_group_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 dsHostGroup = Ibm.GetPiHostGroup.Invoke(new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
        PiHostGroupId = "<value of the host_group_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.GetPiHostGroupArgs;
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 dsHostGroup = IbmFunctions.getPiHostGroup(GetPiHostGroupArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .piHostGroupId("<value of the host_group_id>")
            .build());

    }
}

    variables:
  dsHostGroup:
    fn::invoke:
      function: ibm:getPiHostGroup
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>
        piHostGroupId: <value of the host_group_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 getPiHostGroup

    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 getPiHostGroup(args: GetPiHostGroupArgs, opts?: InvokeOptions): Promise<GetPiHostGroupResult>
function getPiHostGroupOutput(args: GetPiHostGroupOutputArgs, opts?: InvokeOptions): Output<GetPiHostGroupResult>
    def get_pi_host_group(id: Optional[str] = None,
                      pi_cloud_instance_id: Optional[str] = None,
                      pi_host_group_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPiHostGroupResult
def get_pi_host_group_output(id: Optional[pulumi.Input[str]] = None,
                      pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                      pi_host_group_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPiHostGroupResult]
    func LookupPiHostGroup(ctx *Context, args *LookupPiHostGroupArgs, opts ...InvokeOption) (*LookupPiHostGroupResult, error)
func LookupPiHostGroupOutput(ctx *Context, args *LookupPiHostGroupOutputArgs, opts ...InvokeOption) LookupPiHostGroupResultOutput

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

    public static class GetPiHostGroup 
{
    public static Task<GetPiHostGroupResult> InvokeAsync(GetPiHostGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPiHostGroupResult> Invoke(GetPiHostGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiHostGroupResult> getPiHostGroup(GetPiHostGroupArgs args, InvokeOptions options)
public static Output<GetPiHostGroupResult> getPiHostGroup(GetPiHostGroupArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiHostGroupId string
    Host group ID.
    Id string
    The unique identifier of the host group.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiHostGroupId string
    Host group ID.
    Id string
    The unique identifier of the host group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piHostGroupId String
    Host group ID.
    id String
    The unique identifier of the host group.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piHostGroupId string
    Host group ID.
    id string
    The unique identifier of the host group.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_host_group_id str
    Host group ID.
    id str
    The unique identifier of the host group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piHostGroupId String
    Host group ID.
    id String
    The unique identifier of the host group.

    getPiHostGroup Result

    The following output properties are available:

    CreationDate string
    (String) Date/Time of host group creation.
    Hosts List<string>
    (List) List of hosts.
    Id string
    The unique identifier of the host group.
    Name string
    (String) Name of the host group.
    PiCloudInstanceId string
    PiHostGroupId string
    Primary string
    (String) ID of the workspace owning the host group.
    Secondaries List<string>
    (List) IDs of workspaces the host group has been shared with.
    CreationDate string
    (String) Date/Time of host group creation.
    Hosts []string
    (List) List of hosts.
    Id string
    The unique identifier of the host group.
    Name string
    (String) Name of the host group.
    PiCloudInstanceId string
    PiHostGroupId string
    Primary string
    (String) ID of the workspace owning the host group.
    Secondaries []string
    (List) IDs of workspaces the host group has been shared with.
    creationDate String
    (String) Date/Time of host group creation.
    hosts List<String>
    (List) List of hosts.
    id String
    The unique identifier of the host group.
    name String
    (String) Name of the host group.
    piCloudInstanceId String
    piHostGroupId String
    primary String
    (String) ID of the workspace owning the host group.
    secondaries List<String>
    (List) IDs of workspaces the host group has been shared with.
    creationDate string
    (String) Date/Time of host group creation.
    hosts string[]
    (List) List of hosts.
    id string
    The unique identifier of the host group.
    name string
    (String) Name of the host group.
    piCloudInstanceId string
    piHostGroupId string
    primary string
    (String) ID of the workspace owning the host group.
    secondaries string[]
    (List) IDs of workspaces the host group has been shared with.
    creation_date str
    (String) Date/Time of host group creation.
    hosts Sequence[str]
    (List) List of hosts.
    id str
    The unique identifier of the host group.
    name str
    (String) Name of the host group.
    pi_cloud_instance_id str
    pi_host_group_id str
    primary str
    (String) ID of the workspace owning the host group.
    secondaries Sequence[str]
    (List) IDs of workspaces the host group has been shared with.
    creationDate String
    (String) Date/Time of host group creation.
    hosts List<String>
    (List) List of hosts.
    id String
    The unique identifier of the host group.
    name String
    (String) Name of the host group.
    piCloudInstanceId String
    piHostGroupId String
    primary String
    (String) ID of the workspace owning the host group.
    secondaries List<String>
    (List) IDs of workspaces the host group has been shared with.

    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.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm