getPiInstanceVolumes

ibm 1.87.1, Jan 14 26

ibm 1.87.1 published on Wednesday, Jan 14, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

ibm 1.87.1 published on Wednesday, Jan 14, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Using getPiInstanceVolumes

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 getPiInstanceVolumes(args: GetPiInstanceVolumesArgs, opts?: InvokeOptions): Promise<GetPiInstanceVolumesResult>
function getPiInstanceVolumesOutput(args: GetPiInstanceVolumesOutputArgs, opts?: InvokeOptions): Output<GetPiInstanceVolumesResult>

def get_pi_instance_volumes(id: Optional[str] = None,
                            pi_cloud_instance_id: Optional[str] = None,
                            pi_instance_id: Optional[str] = None,
                            pi_instance_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPiInstanceVolumesResult
def get_pi_instance_volumes_output(id: Optional[pulumi.Input[str]] = None,
                            pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                            pi_instance_id: Optional[pulumi.Input[str]] = None,
                            pi_instance_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPiInstanceVolumesResult]

func GetPiInstanceVolumes(ctx *Context, args *GetPiInstanceVolumesArgs, opts ...InvokeOption) (*GetPiInstanceVolumesResult, error)
func GetPiInstanceVolumesOutput(ctx *Context, args *GetPiInstanceVolumesOutputArgs, opts ...InvokeOption) GetPiInstanceVolumesResultOutput

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

public static class GetPiInstanceVolumes 
{
    public static Task<GetPiInstanceVolumesResult> InvokeAsync(GetPiInstanceVolumesArgs args, InvokeOptions? opts = null)
    public static Output<GetPiInstanceVolumesResult> Invoke(GetPiInstanceVolumesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPiInstanceVolumesResult> getPiInstanceVolumes(GetPiInstanceVolumesArgs args, InvokeOptions options)
public static Output<GetPiInstanceVolumesResult> getPiInstanceVolumes(GetPiInstanceVolumesArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getPiInstanceVolumes:getPiInstanceVolumes
  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.
PiInstanceId string: The PVM instance ID.
PiInstanceName string: The unique identifier or name of the instance. Passing the name of the instance could fail or fetch stale data. Please pass an id and use pi_instance_id instead.
Deprecated: Deprecated

PiCloudInstanceId string: The GUID of the service instance associated with an account.
Id string: (String) The unique identifier of the volume.
PiInstanceId string: The PVM instance ID.
PiInstanceName string: The unique identifier or name of the instance. Passing the name of the instance could fail or fetch stale data. Please pass an id and use pi_instance_id instead.
Deprecated: Deprecated

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String: (String) The unique identifier of the volume.
piInstanceId String: The PVM instance ID.
piInstanceName String: The unique identifier or name of the instance. Passing the name of the instance could fail or fetch stale data. Please pass an id and use pi_instance_id instead.
Deprecated: Deprecated

piCloudInstanceId string: The GUID of the service instance associated with an account.
id string: (String) The unique identifier of the volume.
piInstanceId string: The PVM instance ID.
piInstanceName string: The unique identifier or name of the instance. Passing the name of the instance could fail or fetch stale data. Please pass an id and use pi_instance_id instead.
Deprecated: Deprecated

pi_cloud_instance_id str: The GUID of the service instance associated with an account.
id str: (String) The unique identifier of the volume.
pi_instance_id str: The PVM instance ID.
pi_instance_name str: The unique identifier or name of the instance. Passing the name of the instance could fail or fetch stale data. Please pass an id and use pi_instance_id instead.
Deprecated: Deprecated

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String: (String) The unique identifier of the volume.
piInstanceId String: The PVM instance ID.
piInstanceName String: The unique identifier or name of the instance. Passing the name of the instance could fail or fetch stale data. Please pass an id and use pi_instance_id instead.
Deprecated: Deprecated

getPiInstanceVolumes Result

The following output properties are available:

BootVolumeId string: (String) The unique identifier of the boot volume.
Id string: (String) The unique identifier of the volume.
InstanceVolumes List<GetPiInstanceVolumesInstanceVolume>: (List) List of volumes attached to instance.
PiCloudInstanceId string
PiInstanceId string
PiInstanceName string: Deprecated: Deprecated

BootVolumeId string: (String) The unique identifier of the boot volume.
Id string: (String) The unique identifier of the volume.
InstanceVolumes []GetPiInstanceVolumesInstanceVolume: (List) List of volumes attached to instance.
PiCloudInstanceId string
PiInstanceId string
PiInstanceName string: Deprecated: Deprecated

bootVolumeId String: (String) The unique identifier of the boot volume.
id String: (String) The unique identifier of the volume.
instanceVolumes List<GetPiInstanceVolumesInstanceVolume>: (List) List of volumes attached to instance.
piCloudInstanceId String
piInstanceId String
piInstanceName String: Deprecated: Deprecated

bootVolumeId string: (String) The unique identifier of the boot volume.
id string: (String) The unique identifier of the volume.
instanceVolumes GetPiInstanceVolumesInstanceVolume[]: (List) List of volumes attached to instance.
piCloudInstanceId string
piInstanceId string
piInstanceName string: Deprecated: Deprecated

boot_volume_id str: (String) The unique identifier of the boot volume.
id str: (String) The unique identifier of the volume.
instance_volumes Sequence[GetPiInstanceVolumesInstanceVolume]: (List) List of volumes attached to instance.
pi_cloud_instance_id str
pi_instance_id str
pi_instance_name str: Deprecated: Deprecated

bootVolumeId String: (String) The unique identifier of the boot volume.
id String: (String) The unique identifier of the volume.
instanceVolumes List<Property Map>: (List) List of volumes attached to instance.
piCloudInstanceId String
piInstanceId String
piInstanceName String: Deprecated: Deprecated

Supporting Types

GetPiInstanceVolumesInstanceVolume

Auxiliary bool: (Boolean) Indicates if the volume is auxiliary or not.
AuxiliaryVolumeName string: (String) The auxiliary volume name.
Bootable bool: (Boolean) Indicates if the volume is boot capable.
ConsistencyGroupName string: (String) The 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.
DeleteOnTermination bool: (Boolean) Indicates if the volume should be deleted when the server terminates.
FreezeTime string: (String) Time of remote copy relationship.
GroupId string: (String) The volume group id to which volume belongs.
Href string: (String) The hyper link of the volume.
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.
Pool string: (String) Volume pool, name of storage pool where the volume is located.
PrimaryRole string: (String) Indicates whether master/auxiliary volume is playing the primary role.
ReplicationEnabled bool: (Boolean) Indicates whether replication is enabled on the volume.
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 this volume in GB.
State string: (String) The state of the volume.
Type string: (String) The disk type that is used for this volume.
UserTags List<string>: (List) List of user tags attached to the resource.
VolumePool string: (String) Name of the storage pool where the volume is located.
VolumeType string: (String) 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 or not.
AuxiliaryVolumeName string: (String) The auxiliary volume name.
Bootable bool: (Boolean) Indicates if the volume is boot capable.
ConsistencyGroupName string: (String) The 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.
DeleteOnTermination bool: (Boolean) Indicates if the volume should be deleted when the server terminates.
FreezeTime string: (String) Time of remote copy relationship.
GroupId string: (String) The volume group id to which volume belongs.
Href string: (String) The hyper link of the volume.
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.
Pool string: (String) Volume pool, name of storage pool where the volume is located.
PrimaryRole string: (String) Indicates whether master/auxiliary volume is playing the primary role.
ReplicationEnabled bool: (Boolean) Indicates whether replication is enabled on the volume.
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 this volume in GB.
State string: (String) The state of the volume.
Type string: (String) The disk type that is used for this volume.
UserTags []string: (List) List of user tags attached to the resource.
VolumePool string: (String) Name of the storage pool where the volume is located.
VolumeType string: (String) 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 or not.
auxiliaryVolumeName String: (String) The auxiliary volume name.
bootable Boolean: (Boolean) Indicates if the volume is boot capable.
consistencyGroupName String: (String) The 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.
deleteOnTermination Boolean: (Boolean) Indicates if the volume should be deleted when the server terminates.
freezeTime String: (String) Time of remote copy relationship.
groupId String: (String) The volume group id to which volume belongs.
href String: (String) The hyper link of the volume.
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.
pool String: (String) Volume pool, name of storage pool where the volume is located.
primaryRole String: (String) Indicates whether master/auxiliary volume is playing the primary role.
replicationEnabled Boolean: (Boolean) Indicates whether replication is enabled on the volume.
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 this volume in GB.
state String: (String) The state of the volume.
type String: (String) The disk type that is used for this volume.
userTags List<String>: (List) List of user tags attached to the resource.
volumePool String: (String) Name of the storage pool where the volume is located.
volumeType String: (String) 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 or not.
auxiliaryVolumeName string: (String) The auxiliary volume name.
bootable boolean: (Boolean) Indicates if the volume is boot capable.
consistencyGroupName string: (String) The 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.
deleteOnTermination boolean: (Boolean) Indicates if the volume should be deleted when the server terminates.
freezeTime string: (String) Time of remote copy relationship.
groupId string: (String) The volume group id to which volume belongs.
href string: (String) The hyper link of the volume.
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.
pool string: (String) Volume pool, name of storage pool where the volume is located.
primaryRole string: (String) Indicates whether master/auxiliary volume is playing the primary role.
replicationEnabled boolean: (Boolean) Indicates whether replication is enabled on the volume.
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 this volume in GB.
state string: (String) The state of the volume.
type string: (String) The disk type that is used for this volume.
userTags string[]: (List) List of user tags attached to the resource.
volumePool string: (String) Name of the storage pool where the volume is located.
volumeType string: (String) 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 or not.
auxiliary_volume_name str: (String) The auxiliary volume name.
bootable bool: (Boolean) Indicates if the volume is boot capable.
consistency_group_name str: (String) The 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.
delete_on_termination bool: (Boolean) Indicates if the volume should be deleted when the server terminates.
freeze_time str: (String) Time of remote copy relationship.
group_id str: (String) The volume group id to which volume belongs.
href str: (String) The hyper link of the volume.
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.
pool str: (String) Volume pool, name of storage pool where the volume is located.
primary_role str: (String) Indicates whether master/auxiliary volume is playing the primary role.
replication_enabled bool: (Boolean) Indicates whether replication is enabled on the volume.
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 this volume in GB.
state str: (String) The state of the volume.
type str: (String) The disk type that is used for this volume.
user_tags Sequence[str]: (List) List of user tags attached to the resource.
volume_pool str: (String) Name of the storage pool where the volume is located.
volume_type str: (String) 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 or not.
auxiliaryVolumeName String: (String) The auxiliary volume name.
bootable Boolean: (Boolean) Indicates if the volume is boot capable.
consistencyGroupName String: (String) The 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.
deleteOnTermination Boolean: (Boolean) Indicates if the volume should be deleted when the server terminates.
freezeTime String: (String) Time of remote copy relationship.
groupId String: (String) The volume group id to which volume belongs.
href String: (String) The hyper link of the volume.
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.
pool String: (String) Volume pool, name of storage pool where the volume is located.
primaryRole String: (String) Indicates whether master/auxiliary volume is playing the primary role.
replicationEnabled Boolean: (Boolean) Indicates whether replication is enabled on the volume.
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 this volume in GB.
state String: (String) The state of the volume.
type String: (String) The disk type that is used for this volume.
userTags List<String>: (List) List of user tags attached to the resource.
volumePool String: (String) Name of the storage pool where the volume is located.
volumeType String: (String) Name of storage template used to create the volume.
wwn String: (String) The world wide name of the volume.