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

ibm.getPiVolumeGroup

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 a volume group. For more information, about managing a volume group, see moving data to the cloud.

    Example Usage

    The following example retrieves information about the volume group that is present in Power Systems Virtual Server.

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

const dsVolumeGroup = ibm.getPiVolumeGroup({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    piVolumeGroupId: "810b5fde-e054-4577-ab5e-3f866a1f6f66",
});

    import pulumi
import pulumi_ibm as ibm

ds_volume_group = ibm.get_pi_volume_group(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    pi_volume_group_id="810b5fde-e054-4577-ab5e-3f866a1f6f66")

    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.LookupPiVolumeGroup(ctx, &ibm.LookupPiVolumeGroupArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
			PiVolumeGroupId:   "810b5fde-e054-4577-ab5e-3f866a1f6f66",
		}, 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 dsVolumeGroup = Ibm.GetPiVolumeGroup.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        PiVolumeGroupId = "810b5fde-e054-4577-ab5e-3f866a1f6f66",
    });

});

    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.GetPiVolumeGroupArgs;
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 dsVolumeGroup = IbmFunctions.getPiVolumeGroup(GetPiVolumeGroupArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .piVolumeGroupId("810b5fde-e054-4577-ab5e-3f866a1f6f66")
            .build());

    }
}

    variables:
  dsVolumeGroup:
    fn::invoke:
      function: ibm:getPiVolumeGroup
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
        piVolumeGroupId: 810b5fde-e054-4577-ab5e-3f866a1f6f66

    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 getPiVolumeGroup

    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 getPiVolumeGroup(args: GetPiVolumeGroupArgs, opts?: InvokeOptions): Promise<GetPiVolumeGroupResult>
function getPiVolumeGroupOutput(args: GetPiVolumeGroupOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeGroupResult>
    def get_pi_volume_group(id: Optional[str] = None,
                        pi_cloud_instance_id: Optional[str] = None,
                        pi_volume_group_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPiVolumeGroupResult
def get_pi_volume_group_output(id: Optional[pulumi.Input[str]] = None,
                        pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                        pi_volume_group_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeGroupResult]
    func LookupPiVolumeGroup(ctx *Context, args *LookupPiVolumeGroupArgs, opts ...InvokeOption) (*LookupPiVolumeGroupResult, error)
func LookupPiVolumeGroupOutput(ctx *Context, args *LookupPiVolumeGroupOutputArgs, opts ...InvokeOption) LookupPiVolumeGroupResultOutput

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

    public static class GetPiVolumeGroup 
{
    public static Task<GetPiVolumeGroupResult> InvokeAsync(GetPiVolumeGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeGroupResult> Invoke(GetPiVolumeGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiVolumeGroupResult> getPiVolumeGroup(GetPiVolumeGroupArgs args, InvokeOptions options)
public static Output<GetPiVolumeGroupResult> getPiVolumeGroup(GetPiVolumeGroupArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeGroupId string
    The ID of the volume group.
    Id string
    (String) The unique identifier of the volume group.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeGroupId string
    The ID of the volume group.
    Id string
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeGroupId String
    The ID of the volume group.
    id String
    (String) The unique identifier of the volume group.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piVolumeGroupId string
    The ID of the volume group.
    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.
    pi_volume_group_id str
    The ID of the volume group.
    id str
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeGroupId String
    The ID of the volume group.
    id String
    (String) The unique identifier of the volume group.

    getPiVolumeGroup Result

    The following output properties are available:

    Auxiliary bool
    ConsistencyGroupName string
    (String) The name of consistency group at storage controller level.
    Id string
    (String) The unique identifier of the volume group.
    PiCloudInstanceId string
    PiVolumeGroupId string
    ReplicationSites List<string>
    ReplicationStatus string
    (String) The replication status of volume group.
    Status string
    (String) The status of the volume group.
    StatusDescriptionErrors List<GetPiVolumeGroupStatusDescriptionError>
    (List) The status details of the volume group.
    StoragePool string
    VolumeGroupName string
    (String) The name of the volume group.
    Auxiliary bool
    ConsistencyGroupName string
    (String) The name of consistency group at storage controller level.
    Id string
    (String) The unique identifier of the volume group.
    PiCloudInstanceId string
    PiVolumeGroupId string
    ReplicationSites []string
    ReplicationStatus string
    (String) The replication status of volume group.
    Status string
    (String) The status of the volume group.
    StatusDescriptionErrors []GetPiVolumeGroupStatusDescriptionError
    (List) The status details of the volume group.
    StoragePool string
    VolumeGroupName string
    (String) The name of the volume group.
    auxiliary Boolean
    consistencyGroupName String
    (String) The name of consistency group at storage controller level.
    id String
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    piVolumeGroupId String
    replicationSites List<String>
    replicationStatus String
    (String) The replication status of volume group.
    status String
    (String) The status of the volume group.
    statusDescriptionErrors List<GetPiVolumeGroupStatusDescriptionError>
    (List) The status details of the volume group.
    storagePool String
    volumeGroupName String
    (String) The name of the volume group.
    auxiliary boolean
    consistencyGroupName string
    (String) The name of consistency group at storage controller level.
    id string
    (String) The unique identifier of the volume group.
    piCloudInstanceId string
    piVolumeGroupId string
    replicationSites string[]
    replicationStatus string
    (String) The replication status of volume group.
    status string
    (String) The status of the volume group.
    statusDescriptionErrors GetPiVolumeGroupStatusDescriptionError[]
    (List) The status details of the volume group.
    storagePool string
    volumeGroupName string
    (String) The name of the volume group.
    auxiliary bool
    consistency_group_name str
    (String) The name of consistency group at storage controller level.
    id str
    (String) The unique identifier of the volume group.
    pi_cloud_instance_id str
    pi_volume_group_id str
    replication_sites Sequence[str]
    replication_status str
    (String) The replication status of volume group.
    status str
    (String) The status of the volume group.
    status_description_errors Sequence[GetPiVolumeGroupStatusDescriptionError]
    (List) The status details of the volume group.
    storage_pool str
    volume_group_name str
    (String) The name of the volume group.
    auxiliary Boolean
    consistencyGroupName String
    (String) The name of consistency group at storage controller level.
    id String
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    piVolumeGroupId String
    replicationSites List<String>
    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
    volumeGroupName String
    (String) The name of the volume group.

    Supporting Types

    GetPiVolumeGroupStatusDescriptionError

    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