Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiVolume
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiVolume

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Retrieves information about a persistent storage volume that is mounted to a Power Systems Virtual Server instance. For more information, about managin a volume, see moving data to the cloud.

Example Usage

The following example retrieves information about the volume_1 volume that is mounted to the Power Systems Virtual Server instance with the ID.

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

const dsVolume = ibm.getPiVolume({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    piVolumeName: "volume_1",
});
Copy
import pulumi
import pulumi_ibm as ibm

ds_volume = ibm.get_pi_volume(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    pi_volume_name="volume_1")
Copy
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.LookupPiVolume(ctx, &ibm.LookupPiVolumeArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
			PiVolumeName:      "volume_1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dsVolume = Ibm.GetPiVolume.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        PiVolumeName = "volume_1",
    });

});
Copy
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.GetPiVolumeArgs;
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.getPiVolume(GetPiVolumeArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .piVolumeName("volume_1")
            .build());

    }
}
Copy
variables:
  dsVolume:
    fn::invoke:
      function: ibm:getPiVolume
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
        piVolumeName: volume_1
Copy

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";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Using getPiVolume

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 getPiVolume(args: GetPiVolumeArgs, opts?: InvokeOptions): Promise<GetPiVolumeResult>
function getPiVolumeOutput(args: GetPiVolumeOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeResult>
Copy
def get_pi_volume(id: Optional[str] = None,
                  pi_cloud_instance_id: Optional[str] = None,
                  pi_volume_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetPiVolumeResult
def get_pi_volume_output(id: Optional[pulumi.Input[str]] = None,
                  pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                  pi_volume_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeResult]
Copy
func LookupPiVolume(ctx *Context, args *LookupPiVolumeArgs, opts ...InvokeOption) (*LookupPiVolumeResult, error)
func LookupPiVolumeOutput(ctx *Context, args *LookupPiVolumeOutputArgs, opts ...InvokeOption) LookupPiVolumeResultOutput
Copy

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

public static class GetPiVolume 
{
    public static Task<GetPiVolumeResult> InvokeAsync(GetPiVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeResult> Invoke(GetPiVolumeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPiVolumeResult> getPiVolume(GetPiVolumeArgs args, InvokeOptions options)
public static Output<GetPiVolumeResult> getPiVolume(GetPiVolumeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getPiVolume:getPiVolume
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
PiVolumeName This property is required. string
The name of the volume for which you want to retrieve detailed information.
Id string
(String) The unique identifier of the volume.
PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
PiVolumeName This property is required. string
The name of the volume for which you want to retrieve detailed information.
Id string
(String) The unique identifier of the volume.
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
piVolumeName This property is required. String
The name of the volume for which you want to retrieve detailed information.
id String
(String) The unique identifier of the volume.
piCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
piVolumeName This property is required. string
The name of the volume for which you want to retrieve detailed information.
id string
(String) The unique identifier of the volume.
pi_cloud_instance_id This property is required. str
The GUID of the service instance associated with an account.
pi_volume_name This property is required. str
The name of the volume for which you want to retrieve detailed information.
id str
(String) The unique identifier of the volume.
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
piVolumeName This property is required. String
The name of the volume for which you want to retrieve detailed information.
id String
(String) The unique identifier of the volume.

getPiVolume Result

The following output properties are available:

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.
PiCloudInstanceId string
PiVolumeName string
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) Volume pool, name of storage pool where the volume is located.
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.
PiCloudInstanceId string
PiVolumeName string
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) Volume pool, name of storage pool where the volume is located.
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.
piCloudInstanceId String
piVolumeName String
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) Volume pool, name of storage pool where the volume is located.
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.
piCloudInstanceId string
piVolumeName string
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) Volume pool, name of storage pool where the volume is located.
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.
pi_cloud_instance_id str
pi_volume_name str
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) Volume pool, name of storage pool where the volume is located.
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.
piCloudInstanceId String
piVolumeName String
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) Volume pool, name of storage pool where the volume is located.
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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm