1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiPlacementGroups
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getPiPlacementGroups

Explore with Pulumi AI

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

    Retrieve information about all placement groups. 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.getPiPlacementGroups({
        piCloudInstanceId: "<value of the cloud_instance_id>",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_pi_placement_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.GetPiPlacementGroups(ctx, &ibm.GetPiPlacementGroupsArgs{
    			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.GetPiPlacementGroups.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.GetPiPlacementGroupsArgs;
    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.getPiPlacementGroups(GetPiPlacementGroupsArgs.builder()
                .piCloudInstanceId("<value of the cloud_instance_id>")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getPiPlacementGroups
          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 getPiPlacementGroups

    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 getPiPlacementGroups(args: GetPiPlacementGroupsArgs, opts?: InvokeOptions): Promise<GetPiPlacementGroupsResult>
    function getPiPlacementGroupsOutput(args: GetPiPlacementGroupsOutputArgs, opts?: InvokeOptions): Output<GetPiPlacementGroupsResult>
    def get_pi_placement_groups(id: Optional[str] = None,
                                pi_cloud_instance_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetPiPlacementGroupsResult
    def get_pi_placement_groups_output(id: Optional[pulumi.Input[str]] = None,
                                pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetPiPlacementGroupsResult]
    func GetPiPlacementGroups(ctx *Context, args *GetPiPlacementGroupsArgs, opts ...InvokeOption) (*GetPiPlacementGroupsResult, error)
    func GetPiPlacementGroupsOutput(ctx *Context, args *GetPiPlacementGroupsOutputArgs, opts ...InvokeOption) GetPiPlacementGroupsResultOutput

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

    public static class GetPiPlacementGroups 
    {
        public static Task<GetPiPlacementGroupsResult> InvokeAsync(GetPiPlacementGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetPiPlacementGroupsResult> Invoke(GetPiPlacementGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiPlacementGroupsResult> getPiPlacementGroups(GetPiPlacementGroupsArgs args, InvokeOptions options)
    public static Output<GetPiPlacementGroupsResult> getPiPlacementGroups(GetPiPlacementGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiPlacementGroups:getPiPlacementGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The ID of the placement group.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The ID of the placement group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The ID of the placement group.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    (String) The ID of the placement group.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    (String) The ID of the placement group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The ID of the placement group.

    getPiPlacementGroups Result

    The following output properties are available:

    Id string
    (String) The ID of the placement group.
    PiCloudInstanceId string
    PlacementGroups List<GetPiPlacementGroupsPlacementGroup>
    (List) List of all the placement groups.
    Id string
    (String) The ID of the placement group.
    PiCloudInstanceId string
    PlacementGroups []GetPiPlacementGroupsPlacementGroup
    (List) List of all the placement groups.
    id String
    (String) The ID of the placement group.
    piCloudInstanceId String
    placementGroups List<GetPiPlacementGroupsPlacementGroup>
    (List) List of all the placement groups.
    id string
    (String) The ID of the placement group.
    piCloudInstanceId string
    placementGroups GetPiPlacementGroupsPlacementGroup[]
    (List) List of all the placement groups.
    id str
    (String) The ID of the placement group.
    pi_cloud_instance_id str
    placement_groups Sequence[GetPiPlacementGroupsPlacementGroup]
    (List) List of all the placement groups.
    id String
    (String) The ID of the placement group.
    piCloudInstanceId String
    placementGroups List<Property Map>
    (List) List of all the placement groups.

    Supporting Types

    GetPiPlacementGroupsPlacementGroup

    Id string
    (String) The ID of the placement group.
    Members List<string>
    (List) List of server instances IDs that are members of the placement group.
    Name string
    (String) User defined name for the placement group.
    Policy string
    (String) The value of the group's affinity policy. Valid values are affinity and anti-affinity.
    Id string
    (String) The ID of the placement group.
    Members []string
    (List) List of server instances IDs that are members of the placement group.
    Name string
    (String) User defined name for the placement group.
    Policy string
    (String) The value of the group's affinity policy. Valid values are affinity and anti-affinity.
    id String
    (String) The ID of the placement group.
    members List<String>
    (List) List of server instances IDs that are members of the placement group.
    name String
    (String) User defined name for the placement group.
    policy String
    (String) The value of the group's affinity policy. Valid values are affinity and anti-affinity.
    id string
    (String) The ID of the placement group.
    members string[]
    (List) List of server instances IDs that are members of the placement group.
    name string
    (String) User defined name for the placement group.
    policy string
    (String) The value of the group's affinity policy. Valid values are affinity and anti-affinity.
    id str
    (String) The ID of the placement group.
    members Sequence[str]
    (List) List of server instances IDs that are members of the placement group.
    name str
    (String) User defined name for the placement group.
    policy str
    (String) The value of the group's affinity policy. Valid values are affinity and anti-affinity.
    id String
    (String) The ID of the placement group.
    members List<String>
    (List) List of server instances IDs that are members of the placement group.
    name String
    (String) User defined name for the placement group.
    policy String
    (String) The value of the group's affinity policy. Valid values are affinity and anti-affinity.

    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