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

ibm.getPiVolumeGroups

Explore with Pulumi AI

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

    Retrieves information about all volume groups. about managing a volume group, see moving data to the cloud.

    Example Usage

    The following example retrieves information about all volume groups present in Power Systems Virtual Server.

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

const dsVolumeGroups = ibm.getPiVolumeGroups({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});

    import pulumi
import pulumi_ibm as ibm

ds_volume_groups = ibm.get_pi_volume_groups(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")

    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.GetPiVolumeGroups(ctx, &ibm.GetPiVolumeGroupsArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
		}, 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 dsVolumeGroups = Ibm.GetPiVolumeGroups.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });

});

    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.GetPiVolumeGroupsArgs;
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 dsVolumeGroups = IbmFunctions.getPiVolumeGroups(GetPiVolumeGroupsArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}

    variables:
  dsVolumeGroups:
    fn::invoke:
      function: ibm:getPiVolumeGroups
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b

    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 getPiVolumeGroups

    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 getPiVolumeGroups(args: GetPiVolumeGroupsArgs, opts?: InvokeOptions): Promise<GetPiVolumeGroupsResult>
function getPiVolumeGroupsOutput(args: GetPiVolumeGroupsOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeGroupsResult>
    def get_pi_volume_groups(id: Optional[str] = None,
                         pi_cloud_instance_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPiVolumeGroupsResult
def get_pi_volume_groups_output(id: Optional[pulumi.Input[str]] = None,
                         pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeGroupsResult]
    func GetPiVolumeGroups(ctx *Context, args *GetPiVolumeGroupsArgs, opts ...InvokeOption) (*GetPiVolumeGroupsResult, error)
func GetPiVolumeGroupsOutput(ctx *Context, args *GetPiVolumeGroupsOutputArgs, opts ...InvokeOption) GetPiVolumeGroupsResultOutput

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

    public static class GetPiVolumeGroups 
{
    public static Task<GetPiVolumeGroupsResult> InvokeAsync(GetPiVolumeGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeGroupsResult> Invoke(GetPiVolumeGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiVolumeGroupsResult> getPiVolumeGroups(GetPiVolumeGroupsArgs args, InvokeOptions options)
public static Output<GetPiVolumeGroupsResult> getPiVolumeGroups(GetPiVolumeGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getPiVolumeGroups:getPiVolumeGroups
  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 volume group.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The unique identifier of the volume group.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    (String) The unique identifier of the volume group.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The unique identifier of the volume group.

    getPiVolumeGroups Result

    The following output properties are available:

    Id string
    (String) The unique identifier of the volume group.
    PiCloudInstanceId string
    VolumeGroups List<GetPiVolumeGroupsVolumeGroup>
    List of all volume groups.
    Id string
    (String) The unique identifier of the volume group.
    PiCloudInstanceId string
    VolumeGroups []GetPiVolumeGroupsVolumeGroup
    List of all volume groups.
    id String
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    volumeGroups List<GetPiVolumeGroupsVolumeGroup>
    List of all volume groups.
    id string
    (String) The unique identifier of the volume group.
    piCloudInstanceId string
    volumeGroups GetPiVolumeGroupsVolumeGroup[]
    List of all volume groups.
    id str
    (String) The unique identifier of the volume group.
    pi_cloud_instance_id str
    volume_groups Sequence[GetPiVolumeGroupsVolumeGroup]
    List of all volume groups.
    id String
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    volumeGroups List<Property Map>
    List of all volume groups.

    Supporting Types

    GetPiVolumeGroupsVolumeGroup

    Auxiliary bool
    (Boolean) Indicates if the volume group is auxiliary.
    ConsistencyGroupName string
    (String) The name of consistency group at storage controller level.
    Id string
    (String) The unique identifier of the volume group.
    ReplicationSites List<string>
    (List) Indicates the replication sites of the volume group.
    ReplicationStatus string
    (String) The replication status of volume group.
    Status string
    (String) The status of the volume group.
    StatusDescriptionErrors List<GetPiVolumeGroupsVolumeGroupStatusDescriptionError>
    (List) The status details of the volume group.
    StoragePool string
    (String) Storage pool of the volume group.
    VolumeGroupName string
    (String) The name of the volume group.
    Auxiliary bool
    (Boolean) Indicates if the volume group is auxiliary.
    ConsistencyGroupName string
    (String) The name of consistency group at storage controller level.
    Id string
    (String) The unique identifier of the volume group.
    ReplicationSites []string
    (List) Indicates the replication sites of the volume group.
    ReplicationStatus string
    (String) The replication status of volume group.
    Status string
    (String) The status of the volume group.
    StatusDescriptionErrors []GetPiVolumeGroupsVolumeGroupStatusDescriptionError
    (List) The status details of the volume group.
    StoragePool string
    (String) Storage pool of the volume group.
    VolumeGroupName string
    (String) The name of the volume group.
    auxiliary Boolean
    (Boolean) Indicates if the volume group is auxiliary.
    consistencyGroupName String
    (String) The name of consistency group at storage controller level.
    id String
    (String) The unique identifier of the volume group.
    replicationSites List<String>
    (List) Indicates the replication sites of the volume group.
    replicationStatus String
    (String) The replication status of volume group.
    status String
    (String) The status of the volume group.
    statusDescriptionErrors List<GetPiVolumeGroupsVolumeGroupStatusDescriptionError>
    (List) The status details of the volume group.
    storagePool String
    (String) Storage pool of the volume group.
    volumeGroupName String
    (String) The name of the volume group.
    auxiliary boolean
    (Boolean) Indicates if the volume group is auxiliary.
    consistencyGroupName string
    (String) The name of consistency group at storage controller level.
    id string
    (String) The unique identifier of the volume group.
    replicationSites string[]
    (List) Indicates the replication sites of the volume group.
    replicationStatus string
    (String) The replication status of volume group.
    status string
    (String) The status of the volume group.
    statusDescriptionErrors GetPiVolumeGroupsVolumeGroupStatusDescriptionError[]
    (List) The status details of the volume group.
    storagePool string
    (String) Storage pool of the volume group.
    volumeGroupName string
    (String) The name of the volume group.
    auxiliary bool
    (Boolean) Indicates if the volume group is auxiliary.
    consistency_group_name str
    (String) The name of consistency group at storage controller level.
    id str
    (String) The unique identifier of the volume group.
    replication_sites Sequence[str]
    (List) Indicates the replication sites of the volume group.
    replication_status str
    (String) The replication status of volume group.
    status str
    (String) The status of the volume group.
    status_description_errors Sequence[GetPiVolumeGroupsVolumeGroupStatusDescriptionError]
    (List) The status details of the volume group.
    storage_pool str
    (String) Storage pool of the volume group.
    volume_group_name str
    (String) The name of the volume group.
    auxiliary Boolean
    (Boolean) Indicates if the volume group is auxiliary.
    consistencyGroupName String
    (String) The name of consistency group at storage controller level.
    id String
    (String) The unique identifier of the volume group.
    replicationSites List<String>
    (List) Indicates the replication sites of the volume group.
    replicationStatus String
    (String) The replication status of volume group.
    status String
    (String) The status of the volume group.
    statusDescriptionErrors List<Property Map>
    (List) The status details of the volume group.
    storagePool String
    (String) Storage pool of the volume group.
    volumeGroupName String
    (String) The name of the volume group.

    GetPiVolumeGroupsVolumeGroupStatusDescriptionError

    Key string
    (String) The volume group error key.
    Message string
    (String) The failure message providing more details about the error key.
    VolumeIds List<string>
    (List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
    Key string
    (String) The volume group error key.
    Message string
    (String) The failure message providing more details about the error key.
    VolumeIds []string
    (List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
    key String
    (String) The volume group error key.
    message String
    (String) The failure message providing more details about the error key.
    volumeIds List<String>
    (List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
    key string
    (String) The volume group error key.
    message string
    (String) The failure message providing more details about the error key.
    volumeIds string[]
    (List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
    key str
    (String) The volume group error key.
    message str
    (String) The failure message providing more details about the error key.
    volume_ids Sequence[str]
    (List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
    key String
    (String) The volume group error key.
    message String
    (String) The failure message providing more details about the error key.
    volumeIds List<String>
    (List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.

    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