1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiVolumes
ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getPiVolumes

ibm logo
ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Retrieves information about all persistent storage volumes that in a Power Systems Virtual Server workspace. For more information, about managing volumes, see moving data to the cloud.

    Example Usage

    The following example retrieves information about all volumes present in a Power Systems Virtual Server workspace.

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

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

    import pulumi
import pulumi_ibm as ibm

ds_volume = ibm.get_pi_volumes(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.GetPiVolumes(ctx, &ibm.GetPiVolumesArgs{
			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 dsVolume = Ibm.GetPiVolumes.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.GetPiVolumesArgs;
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 dsVolume = IbmFunctions.getPiVolumes(GetPiVolumesArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}

    variables:
  dsVolume:
    fn::invoke:
      function: ibm:getPiVolumes
      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 getPiVolumes

    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 getPiVolumes(args: GetPiVolumesArgs, opts?: InvokeOptions): Promise<GetPiVolumesResult>
function getPiVolumesOutput(args: GetPiVolumesOutputArgs, opts?: InvokeOptions): Output<GetPiVolumesResult>
    def get_pi_volumes(id: Optional[str] = None,
                   pi_cloud_instance_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPiVolumesResult
def get_pi_volumes_output(id: Optional[pulumi.Input[str]] = None,
                   pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumesResult]
    func GetPiVolumes(ctx *Context, args *GetPiVolumesArgs, opts ...InvokeOption) (*GetPiVolumesResult, error)
func GetPiVolumesOutput(ctx *Context, args *GetPiVolumesOutputArgs, opts ...InvokeOption) GetPiVolumesResultOutput

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

    public static class GetPiVolumes 
{
    public static Task<GetPiVolumesResult> InvokeAsync(GetPiVolumesArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumesResult> Invoke(GetPiVolumesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiVolumesResult> getPiVolumes(GetPiVolumesArgs args, InvokeOptions options)
public static Output<GetPiVolumesResult> getPiVolumes(GetPiVolumesArgs args, InvokeOptions options)

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

    getPiVolumes Result

    The following output properties are available:

    Id string
    (String) The unique identifier of the volume.
    PiCloudInstanceId string
    Volumes List<GetPiVolumesVolume>
    (List) The list of volumes.
    Id string
    (String) The unique identifier of the volume.
    PiCloudInstanceId string
    Volumes []GetPiVolumesVolume
    (List) The list of volumes.
    id String
    (String) The unique identifier of the volume.
    piCloudInstanceId String
    volumes List<GetPiVolumesVolume>
    (List) The list of volumes.
    id string
    (String) The unique identifier of the volume.
    piCloudInstanceId string
    volumes GetPiVolumesVolume[]
    (List) The list of volumes.
    id str
    (String) The unique identifier of the volume.
    pi_cloud_instance_id str
    volumes Sequence[GetPiVolumesVolume]
    (List) The list of volumes.
    id String
    (String) The unique identifier of the volume.
    piCloudInstanceId String
    volumes List<Property Map>
    (List) The list of volumes.

    Supporting Types

    GetPiVolumesVolume

    Auxiliary bool
    (Boolean) Indicates if the volume is auxiliary.
    AuxiliaryVolumeName string
    (String) The auxiliary volume name.
    Bootable bool
    (Boolean) Indicates if the volume is boot capable.
    ConsistencyGroupName string
    (String) Consistency group name if volume is a part of volume group.
    CreationDate string
    (String) Date of volume creation.
    Crn string
    (String) The CRN of this resource.
    DiskType string
    (String) The disk type that is used for the volume.
    FreezeTime string
    (String) Time of remote copy relationship.
    GroupId string
    (String) The volume group id in which the volume belongs.
    Id string
    (String) The unique identifier of the volume.
    IoThrottleRate string
    (String) Amount of iops assigned to the volume.
    LastUpdateDate string
    (String) The date when the volume last updated.
    MasterVolumeName string
    (String) The master volume name.
    MirroringState string
    (String) Mirroring state for replication enabled volume.
    Name string
    (String) The name of the volume.
    OutOfBandDeleted bool
    (Bool) Indicates if the volume does not exist on storage controller.
    PrimaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    ReplicationEnabled bool
    (Boolean) Indicates if the volume should be replication enabled or not.
    ReplicationSites List<string>
    (List) List of replication sites for volume replication.
    ReplicationStatus string
    (String) The replication status of the volume.
    ReplicationType string
    (String) The replication type of the volume, metro or global.
    Shreable bool
    Size double
    (Integer) The size of the volume in GB.
    State string
    (String) The state of the volume.
    UserTags List<string>
    (List) List of user tags attached to the resource.
    VolumePool string
    (String) The name of storage pool where the volume is located.
    VolumeType string
    (String) The name of storage template used to create the volume.
    Wwn string
    (String) The world wide name of the volume.
    Auxiliary bool
    (Boolean) Indicates if the volume is auxiliary.
    AuxiliaryVolumeName string
    (String) The auxiliary volume name.
    Bootable bool
    (Boolean) Indicates if the volume is boot capable.
    ConsistencyGroupName string
    (String) Consistency group name if volume is a part of volume group.
    CreationDate string
    (String) Date of volume creation.
    Crn string
    (String) The CRN of this resource.
    DiskType string
    (String) The disk type that is used for the volume.
    FreezeTime string
    (String) Time of remote copy relationship.
    GroupId string
    (String) The volume group id in which the volume belongs.
    Id string
    (String) The unique identifier of the volume.
    IoThrottleRate string
    (String) Amount of iops assigned to the volume.
    LastUpdateDate string
    (String) The date when the volume last updated.
    MasterVolumeName string
    (String) The master volume name.
    MirroringState string
    (String) Mirroring state for replication enabled volume.
    Name string
    (String) The name of the volume.
    OutOfBandDeleted bool
    (Bool) Indicates if the volume does not exist on storage controller.
    PrimaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    ReplicationEnabled bool
    (Boolean) Indicates if the volume should be replication enabled or not.
    ReplicationSites []string
    (List) List of replication sites for volume replication.
    ReplicationStatus string
    (String) The replication status of the volume.
    ReplicationType string
    (String) The replication type of the volume, metro or global.
    Shreable bool
    Size float64
    (Integer) The size of the volume in GB.
    State string
    (String) The state of the volume.
    UserTags []string
    (List) List of user tags attached to the resource.
    VolumePool string
    (String) The name of storage pool where the volume is located.
    VolumeType string
    (String) The name of storage template used to create the volume.
    Wwn string
    (String) The world wide name of the volume.
    auxiliary Boolean
    (Boolean) Indicates if the volume is auxiliary.
    auxiliaryVolumeName String
    (String) The auxiliary volume name.
    bootable Boolean
    (Boolean) Indicates if the volume is boot capable.
    consistencyGroupName String
    (String) Consistency group name if volume is a part of volume group.
    creationDate String
    (String) Date of volume creation.
    crn String
    (String) The CRN of this resource.
    diskType String
    (String) The disk type that is used for the volume.
    freezeTime String
    (String) Time of remote copy relationship.
    groupId String
    (String) The volume group id in which the volume belongs.
    id String
    (String) The unique identifier of the volume.
    ioThrottleRate String
    (String) Amount of iops assigned to the volume.
    lastUpdateDate String
    (String) The date when the volume last updated.
    masterVolumeName String
    (String) The master volume name.
    mirroringState String
    (String) Mirroring state for replication enabled volume.
    name String
    (String) The name of the volume.
    outOfBandDeleted Boolean
    (Bool) Indicates if the volume does not exist on storage controller.
    primaryRole String
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    replicationEnabled Boolean
    (Boolean) Indicates if the volume should be replication enabled or not.
    replicationSites List<String>
    (List) List of replication sites for volume replication.
    replicationStatus String
    (String) The replication status of the volume.
    replicationType String
    (String) The replication type of the volume, metro or global.
    shreable Boolean
    size Double
    (Integer) The size of the volume in GB.
    state String
    (String) The state of the volume.
    userTags List<String>
    (List) List of user tags attached to the resource.
    volumePool String
    (String) The name of storage pool where the volume is located.
    volumeType String
    (String) The name of storage template used to create the volume.
    wwn String
    (String) The world wide name of the volume.
    auxiliary boolean
    (Boolean) Indicates if the volume is auxiliary.
    auxiliaryVolumeName string
    (String) The auxiliary volume name.
    bootable boolean
    (Boolean) Indicates if the volume is boot capable.
    consistencyGroupName string
    (String) Consistency group name if volume is a part of volume group.
    creationDate string
    (String) Date of volume creation.
    crn string
    (String) The CRN of this resource.
    diskType string
    (String) The disk type that is used for the volume.
    freezeTime string
    (String) Time of remote copy relationship.
    groupId string
    (String) The volume group id in which the volume belongs.
    id string
    (String) The unique identifier of the volume.
    ioThrottleRate string
    (String) Amount of iops assigned to the volume.
    lastUpdateDate string
    (String) The date when the volume last updated.
    masterVolumeName string
    (String) The master volume name.
    mirroringState string
    (String) Mirroring state for replication enabled volume.
    name string
    (String) The name of the volume.
    outOfBandDeleted boolean
    (Bool) Indicates if the volume does not exist on storage controller.
    primaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    replicationEnabled boolean
    (Boolean) Indicates if the volume should be replication enabled or not.
    replicationSites string[]
    (List) List of replication sites for volume replication.
    replicationStatus string
    (String) The replication status of the volume.
    replicationType string
    (String) The replication type of the volume, metro or global.
    shreable boolean
    size number
    (Integer) The size of the volume in GB.
    state string
    (String) The state of the volume.
    userTags string[]
    (List) List of user tags attached to the resource.
    volumePool string
    (String) The name of storage pool where the volume is located.
    volumeType string
    (String) The name of storage template used to create the volume.
    wwn string
    (String) The world wide name of the volume.
    auxiliary bool
    (Boolean) Indicates if the volume is auxiliary.
    auxiliary_volume_name str
    (String) The auxiliary volume name.
    bootable bool
    (Boolean) Indicates if the volume is boot capable.
    consistency_group_name str
    (String) Consistency group name if volume is a part of volume group.
    creation_date str
    (String) Date of volume creation.
    crn str
    (String) The CRN of this resource.
    disk_type str
    (String) The disk type that is used for the volume.
    freeze_time str
    (String) Time of remote copy relationship.
    group_id str
    (String) The volume group id in which the volume belongs.
    id str
    (String) The unique identifier of the volume.
    io_throttle_rate str
    (String) Amount of iops assigned to the volume.
    last_update_date str
    (String) The date when the volume last updated.
    master_volume_name str
    (String) The master volume name.
    mirroring_state str
    (String) Mirroring state for replication enabled volume.
    name str
    (String) The name of the volume.
    out_of_band_deleted bool
    (Bool) Indicates if the volume does not exist on storage controller.
    primary_role str
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    replication_enabled bool
    (Boolean) Indicates if the volume should be replication enabled or not.
    replication_sites Sequence[str]
    (List) List of replication sites for volume replication.
    replication_status str
    (String) The replication status of the volume.
    replication_type str
    (String) The replication type of the volume, metro or global.
    shreable bool
    size float
    (Integer) The size of the volume in GB.
    state str
    (String) The state of the volume.
    user_tags Sequence[str]
    (List) List of user tags attached to the resource.
    volume_pool str
    (String) The name of storage pool where the volume is located.
    volume_type str
    (String) The name of storage template used to create the volume.
    wwn str
    (String) The world wide name of the volume.
    auxiliary Boolean
    (Boolean) Indicates if the volume is auxiliary.
    auxiliaryVolumeName String
    (String) The auxiliary volume name.
    bootable Boolean
    (Boolean) Indicates if the volume is boot capable.
    consistencyGroupName String
    (String) Consistency group name if volume is a part of volume group.
    creationDate String
    (String) Date of volume creation.
    crn String
    (String) The CRN of this resource.
    diskType String
    (String) The disk type that is used for the volume.
    freezeTime String
    (String) Time of remote copy relationship.
    groupId String
    (String) The volume group id in which the volume belongs.
    id String
    (String) The unique identifier of the volume.
    ioThrottleRate String
    (String) Amount of iops assigned to the volume.
    lastUpdateDate String
    (String) The date when the volume last updated.
    masterVolumeName String
    (String) The master volume name.
    mirroringState String
    (String) Mirroring state for replication enabled volume.
    name String
    (String) The name of the volume.
    outOfBandDeleted Boolean
    (Bool) Indicates if the volume does not exist on storage controller.
    primaryRole String
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    replicationEnabled Boolean
    (Boolean) Indicates if the volume should be replication enabled or not.
    replicationSites List<String>
    (List) List of replication sites for volume replication.
    replicationStatus String
    (String) The replication status of the volume.
    replicationType String
    (String) The replication type of the volume, metro or global.
    shreable Boolean
    size Number
    (Integer) The size of the volume in GB.
    state String
    (String) The state of the volume.
    userTags List<String>
    (List) List of user tags attached to the resource.
    volumePool String
    (String) The name of storage pool where the volume is located.
    volumeType String
    (String) The name of storage template used to create the volume.
    wwn String
    (String) The world wide name of the volume.

    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.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm
      Meet Neo: Your AI Platform Teammate