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

ibm.PiVolume

Explore with Pulumi AI

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

    Create, update, or delete a volume to attach it to a Power Systems Virtual Server instance. For more information, about managing volume, see cloning a volume.

    Example Usage

    The following example creates a 20 GB volume.

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

const testaccVolume = new ibm.PiVolume("testaccVolume", {
    piCloudInstanceId: "<value of the cloud_instance_id>",
    piVolumeName: "test-volume",
    piVolumeShareable: true,
    piVolumeSize: 20,
    piVolumeType: "tier3",
});

    import pulumi
import pulumi_ibm as ibm

testacc_volume = ibm.PiVolume("testaccVolume",
    pi_cloud_instance_id="<value of the cloud_instance_id>",
    pi_volume_name="test-volume",
    pi_volume_shareable=True,
    pi_volume_size=20,
    pi_volume_type="tier3")

    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.NewPiVolume(ctx, "testaccVolume", &ibm.PiVolumeArgs{
			PiCloudInstanceId: pulumi.String("<value of the cloud_instance_id>"),
			PiVolumeName:      pulumi.String("test-volume"),
			PiVolumeShareable: pulumi.Bool(true),
			PiVolumeSize:      pulumi.Float64(20),
			PiVolumeType:      pulumi.String("tier3"),
		})
		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 testaccVolume = new Ibm.PiVolume("testaccVolume", new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
        PiVolumeName = "test-volume",
        PiVolumeShareable = true,
        PiVolumeSize = 20,
        PiVolumeType = "tier3",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiVolume;
import com.pulumi.ibm.PiVolumeArgs;
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) {
        var testaccVolume = new PiVolume("testaccVolume", PiVolumeArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .piVolumeName("test-volume")
            .piVolumeShareable(true)
            .piVolumeSize(20)
            .piVolumeType("tier3")
            .build());

    }
}

    resources:
  testaccVolume:
    type: ibm:PiVolume
    properties:
      piCloudInstanceId: <value of the cloud_instance_id>
      piVolumeName: test-volume
      piVolumeShareable: true
      piVolumeSize: 20
      piVolumeType: tier3

    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) {
    }
}

    {}

    Create PiVolume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PiVolume(name: string, args: PiVolumeArgs, opts?: CustomResourceOptions);
    @overload
def PiVolume(resource_name: str,
             args: PiVolumeArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def PiVolume(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             pi_cloud_instance_id: Optional[str] = None,
             pi_volume_size: Optional[float] = None,
             pi_volume_name: Optional[str] = None,
             pi_user_tags: Optional[Sequence[str]] = None,
             pi_anti_affinity_volumes: Optional[Sequence[str]] = None,
             pi_anti_affinity_instances: Optional[Sequence[str]] = None,
             pi_replication_enabled: Optional[bool] = None,
             pi_replication_sites: Optional[Sequence[str]] = None,
             pi_affinity_instance: Optional[str] = None,
             pi_volume_id: Optional[str] = None,
             pi_affinity_volume: Optional[str] = None,
             pi_volume_pool: Optional[str] = None,
             pi_volume_shareable: Optional[bool] = None,
             pi_affinity_policy: Optional[str] = None,
             pi_volume_type: Optional[str] = None,
             timeouts: Optional[PiVolumeTimeoutsArgs] = None)
    func NewPiVolume(ctx *Context, name string, args PiVolumeArgs, opts ...ResourceOption) (*PiVolume, error)
    public PiVolume(string name, PiVolumeArgs args, CustomResourceOptions? opts = null)
    public PiVolume(String name, PiVolumeArgs args)
public PiVolume(String name, PiVolumeArgs args, CustomResourceOptions options)

    type: ibm:PiVolume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PiVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PiVolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PiVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PiVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PiVolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var piVolumeResource = new Ibm.PiVolume("piVolumeResource", new()
{
    PiCloudInstanceId = "string",
    PiVolumeSize = 0,
    PiVolumeName = "string",
    PiUserTags = new[]
    {
        "string",
    },
    PiAntiAffinityVolumes = new[]
    {
        "string",
    },
    PiAntiAffinityInstances = new[]
    {
        "string",
    },
    PiReplicationEnabled = false,
    PiReplicationSites = new[]
    {
        "string",
    },
    PiAffinityInstance = "string",
    PiVolumeId = "string",
    PiAffinityVolume = "string",
    PiVolumePool = "string",
    PiVolumeShareable = false,
    PiAffinityPolicy = "string",
    PiVolumeType = "string",
    Timeouts = new Ibm.Inputs.PiVolumeTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewPiVolume(ctx, "piVolumeResource", &ibm.PiVolumeArgs{
	PiCloudInstanceId: pulumi.String("string"),
	PiVolumeSize:      pulumi.Float64(0),
	PiVolumeName:      pulumi.String("string"),
	PiUserTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiAntiAffinityVolumes: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiAntiAffinityInstances: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiReplicationEnabled: pulumi.Bool(false),
	PiReplicationSites: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiAffinityInstance: pulumi.String("string"),
	PiVolumeId:         pulumi.String("string"),
	PiAffinityVolume:   pulumi.String("string"),
	PiVolumePool:       pulumi.String("string"),
	PiVolumeShareable:  pulumi.Bool(false),
	PiAffinityPolicy:   pulumi.String("string"),
	PiVolumeType:       pulumi.String("string"),
	Timeouts: &ibm.PiVolumeTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var piVolumeResource = new PiVolume("piVolumeResource", PiVolumeArgs.builder()
    .piCloudInstanceId("string")
    .piVolumeSize(0)
    .piVolumeName("string")
    .piUserTags("string")
    .piAntiAffinityVolumes("string")
    .piAntiAffinityInstances("string")
    .piReplicationEnabled(false)
    .piReplicationSites("string")
    .piAffinityInstance("string")
    .piVolumeId("string")
    .piAffinityVolume("string")
    .piVolumePool("string")
    .piVolumeShareable(false)
    .piAffinityPolicy("string")
    .piVolumeType("string")
    .timeouts(PiVolumeTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    pi_volume_resource = ibm.PiVolume("piVolumeResource",
    pi_cloud_instance_id="string",
    pi_volume_size=0,
    pi_volume_name="string",
    pi_user_tags=["string"],
    pi_anti_affinity_volumes=["string"],
    pi_anti_affinity_instances=["string"],
    pi_replication_enabled=False,
    pi_replication_sites=["string"],
    pi_affinity_instance="string",
    pi_volume_id="string",
    pi_affinity_volume="string",
    pi_volume_pool="string",
    pi_volume_shareable=False,
    pi_affinity_policy="string",
    pi_volume_type="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const piVolumeResource = new ibm.PiVolume("piVolumeResource", {
    piCloudInstanceId: "string",
    piVolumeSize: 0,
    piVolumeName: "string",
    piUserTags: ["string"],
    piAntiAffinityVolumes: ["string"],
    piAntiAffinityInstances: ["string"],
    piReplicationEnabled: false,
    piReplicationSites: ["string"],
    piAffinityInstance: "string",
    piVolumeId: "string",
    piAffinityVolume: "string",
    piVolumePool: "string",
    piVolumeShareable: false,
    piAffinityPolicy: "string",
    piVolumeType: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:PiVolume
properties:
    piAffinityInstance: string
    piAffinityPolicy: string
    piAffinityVolume: string
    piAntiAffinityInstances:
        - string
    piAntiAffinityVolumes:
        - string
    piCloudInstanceId: string
    piReplicationEnabled: false
    piReplicationSites:
        - string
    piUserTags:
        - string
    piVolumeId: string
    piVolumeName: string
    piVolumePool: string
    piVolumeShareable: false
    piVolumeSize: 0
    piVolumeType: string
    timeouts:
        create: string
        delete: string
        update: string

    PiVolume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PiVolume resource accepts the following input properties:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeName string
    The name of the volume.
    PiVolumeSize double
    The size of the volume in GB.
    PiAffinityInstance string
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    PiAffinityVolume string
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances List<string>
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes List<string>
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiReplicationEnabled bool

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    PiReplicationSites List<string>
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    PiUserTags List<string>
    The user tags attached to this resource.
    PiVolumeId string
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    PiVolumePool string
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    PiVolumeShareable bool
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    PiVolumeType string
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    Timeouts PiVolumeTimeouts
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeName string
    The name of the volume.
    PiVolumeSize float64
    The size of the volume in GB.
    PiAffinityInstance string
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    PiAffinityVolume string
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances []string
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes []string
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiReplicationEnabled bool

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    PiReplicationSites []string
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    PiUserTags []string
    The user tags attached to this resource.
    PiVolumeId string
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    PiVolumePool string
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    PiVolumeShareable bool
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    PiVolumeType string
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    Timeouts PiVolumeTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeName String
    The name of the volume.
    piVolumeSize Double
    The size of the volume in GB.
    piAffinityInstance String
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    piAffinityVolume String
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piReplicationEnabled Boolean

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    piReplicationSites List<String>
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    piUserTags List<String>
    The user tags attached to this resource.
    piVolumeId String
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    piVolumePool String
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    piVolumeShareable Boolean
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    piVolumeType String
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    timeouts PiVolumeTimeouts
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piVolumeName string
    The name of the volume.
    piVolumeSize number
    The size of the volume in GB.
    piAffinityInstance string
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy string
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    piAffinityVolume string
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances string[]
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes string[]
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piReplicationEnabled boolean

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    piReplicationSites string[]
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    piUserTags string[]
    The user tags attached to this resource.
    piVolumeId string
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    piVolumePool string
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    piVolumeShareable boolean
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    piVolumeType string
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    timeouts PiVolumeTimeouts
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_volume_name str
    The name of the volume.
    pi_volume_size float
    The size of the volume in GB.
    pi_affinity_instance str
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    pi_affinity_policy str
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    pi_affinity_volume str
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    pi_anti_affinity_instances Sequence[str]
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    pi_anti_affinity_volumes Sequence[str]
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    pi_replication_enabled bool

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    pi_replication_sites Sequence[str]
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    pi_volume_id str
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    pi_volume_pool str
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    pi_volume_shareable bool
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    pi_volume_type str
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    timeouts PiVolumeTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeName String
    The name of the volume.
    piVolumeSize Number
    The size of the volume in GB.
    piAffinityInstance String
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    piAffinityVolume String
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piReplicationEnabled Boolean

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    piReplicationSites List<String>
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    piUserTags List<String>
    The user tags attached to this resource.
    piVolumeId String
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    piVolumePool String
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    piVolumeShareable Boolean
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    piVolumeType String
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PiVolume resource produces the following output properties:

    Auxiliary bool
    (Boolean) Indicates if the volume is auxiliary or not.
    AuxiliaryVolumeName string
    (String) The auxiliary volume name.
    ConsistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    Crn string
    (String) The CRN of this resource.
    DeleteOnTermination bool
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    GroupId string
    (String) The volume group id to which volume belongs.
    Id string
    The provider-assigned unique ID for this managed resource.
    IoThrottleRate string
    (String) Amount of iops assigned to the volume.
    MasterVolumeName string
    (String) The master volume name.
    MirroringState string
    (String) Mirroring state for replication enabled volume.
    PrimaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    VolumeId string
    (String) The unique identifier of the volume.
    VolumeStatus string
    (String) The status of 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.
    ConsistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    Crn string
    (String) The CRN of this resource.
    DeleteOnTermination bool
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    GroupId string
    (String) The volume group id to which volume belongs.
    Id string
    The provider-assigned unique ID for this managed resource.
    IoThrottleRate string
    (String) Amount of iops assigned to the volume.
    MasterVolumeName string
    (String) The master volume name.
    MirroringState string
    (String) Mirroring state for replication enabled volume.
    PrimaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    VolumeId string
    (String) The unique identifier of the volume.
    VolumeStatus string
    (String) The status of 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.
    consistencyGroupName String
    (String) The consistency group name if volume is a part of volume group.
    crn String
    (String) The CRN of this resource.
    deleteOnTermination Boolean
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    groupId String
    (String) The volume group id to which volume belongs.
    id String
    The provider-assigned unique ID for this managed resource.
    ioThrottleRate String
    (String) Amount of iops assigned to the volume.
    masterVolumeName String
    (String) The master volume name.
    mirroringState String
    (String) Mirroring state for replication enabled volume.
    primaryRole String
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    volumeId String
    (String) The unique identifier of the volume.
    volumeStatus String
    (String) The status of 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.
    consistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    crn string
    (String) The CRN of this resource.
    deleteOnTermination boolean
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    groupId string
    (String) The volume group id to which volume belongs.
    id string
    The provider-assigned unique ID for this managed resource.
    ioThrottleRate string
    (String) Amount of iops assigned to the volume.
    masterVolumeName string
    (String) The master volume name.
    mirroringState string
    (String) Mirroring state for replication enabled volume.
    primaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    volumeId string
    (String) The unique identifier of the volume.
    volumeStatus string
    (String) The status of 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.
    consistency_group_name str
    (String) The consistency group name if volume is a part of volume group.
    crn str
    (String) The CRN of this resource.
    delete_on_termination bool
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    group_id str
    (String) The volume group id to which volume belongs.
    id str
    The provider-assigned unique ID for this managed resource.
    io_throttle_rate str
    (String) Amount of iops assigned to the volume.
    master_volume_name str
    (String) The master volume name.
    mirroring_state str
    (String) Mirroring state for replication enabled volume.
    primary_role str
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    volume_id str
    (String) The unique identifier of the volume.
    volume_status str
    (String) The status of 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.
    consistencyGroupName String
    (String) The consistency group name if volume is a part of volume group.
    crn String
    (String) The CRN of this resource.
    deleteOnTermination Boolean
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    groupId String
    (String) The volume group id to which volume belongs.
    id String
    The provider-assigned unique ID for this managed resource.
    ioThrottleRate String
    (String) Amount of iops assigned to the volume.
    masterVolumeName String
    (String) The master volume name.
    mirroringState String
    (String) Mirroring state for replication enabled volume.
    primaryRole String
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    volumeId String
    (String) The unique identifier of the volume.
    volumeStatus String
    (String) The status of the volume.
    wwn String
    (String) The world wide name of the volume.

    Look up Existing PiVolume Resource

    Get an existing PiVolume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PiVolumeState, opts?: CustomResourceOptions): PiVolume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auxiliary: Optional[bool] = None,
        auxiliary_volume_name: Optional[str] = None,
        consistency_group_name: Optional[str] = None,
        crn: Optional[str] = None,
        delete_on_termination: Optional[bool] = None,
        group_id: Optional[str] = None,
        io_throttle_rate: Optional[str] = None,
        master_volume_name: Optional[str] = None,
        mirroring_state: Optional[str] = None,
        pi_affinity_instance: Optional[str] = None,
        pi_affinity_policy: Optional[str] = None,
        pi_affinity_volume: Optional[str] = None,
        pi_anti_affinity_instances: Optional[Sequence[str]] = None,
        pi_anti_affinity_volumes: Optional[Sequence[str]] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_replication_enabled: Optional[bool] = None,
        pi_replication_sites: Optional[Sequence[str]] = None,
        pi_user_tags: Optional[Sequence[str]] = None,
        pi_volume_id: Optional[str] = None,
        pi_volume_name: Optional[str] = None,
        pi_volume_pool: Optional[str] = None,
        pi_volume_shareable: Optional[bool] = None,
        pi_volume_size: Optional[float] = None,
        pi_volume_type: Optional[str] = None,
        primary_role: Optional[str] = None,
        replication_sites: Optional[Sequence[str]] = None,
        replication_status: Optional[str] = None,
        replication_type: Optional[str] = None,
        timeouts: Optional[PiVolumeTimeoutsArgs] = None,
        volume_id: Optional[str] = None,
        volume_status: Optional[str] = None,
        wwn: Optional[str] = None) -> PiVolume
    func GetPiVolume(ctx *Context, name string, id IDInput, state *PiVolumeState, opts ...ResourceOption) (*PiVolume, error)
    public static PiVolume Get(string name, Input<string> id, PiVolumeState? state, CustomResourceOptions? opts = null)
    public static PiVolume get(String name, Output<String> id, PiVolumeState state, CustomResourceOptions options)
    resources:  _:    type: ibm:PiVolume    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Auxiliary bool
    (Boolean) Indicates if the volume is auxiliary or not.
    AuxiliaryVolumeName string
    (String) The auxiliary volume name.
    ConsistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    Crn string
    (String) The CRN of this resource.
    DeleteOnTermination bool
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    GroupId string
    (String) The volume group id to which volume belongs.
    IoThrottleRate string
    (String) Amount of iops assigned to the volume.
    MasterVolumeName string
    (String) The master volume name.
    MirroringState string
    (String) Mirroring state for replication enabled volume.
    PiAffinityInstance string
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    PiAffinityVolume string
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances List<string>
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes List<string>
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiReplicationEnabled bool

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    PiReplicationSites List<string>
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    PiUserTags List<string>
    The user tags attached to this resource.
    PiVolumeId string
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    PiVolumeName string
    The name of the volume.
    PiVolumePool string
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    PiVolumeShareable bool
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    PiVolumeSize double
    The size of the volume in GB.
    PiVolumeType string
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    PrimaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    Timeouts PiVolumeTimeouts
    VolumeId string
    (String) The unique identifier of the volume.
    VolumeStatus string
    (String) The status of 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.
    ConsistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    Crn string
    (String) The CRN of this resource.
    DeleteOnTermination bool
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    GroupId string
    (String) The volume group id to which volume belongs.
    IoThrottleRate string
    (String) Amount of iops assigned to the volume.
    MasterVolumeName string
    (String) The master volume name.
    MirroringState string
    (String) Mirroring state for replication enabled volume.
    PiAffinityInstance string
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    PiAffinityVolume string
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances []string
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes []string
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiReplicationEnabled bool

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    PiReplicationSites []string
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    PiUserTags []string
    The user tags attached to this resource.
    PiVolumeId string
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    PiVolumeName string
    The name of the volume.
    PiVolumePool string
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    PiVolumeShareable bool
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    PiVolumeSize float64
    The size of the volume in GB.
    PiVolumeType string
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    PrimaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    Timeouts PiVolumeTimeoutsArgs
    VolumeId string
    (String) The unique identifier of the volume.
    VolumeStatus string
    (String) The status of 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.
    consistencyGroupName String
    (String) The consistency group name if volume is a part of volume group.
    crn String
    (String) The CRN of this resource.
    deleteOnTermination Boolean
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    groupId String
    (String) The volume group id to which volume belongs.
    ioThrottleRate String
    (String) Amount of iops assigned to the volume.
    masterVolumeName String
    (String) The master volume name.
    mirroringState String
    (String) Mirroring state for replication enabled volume.
    piAffinityInstance String
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    piAffinityVolume String
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piReplicationEnabled Boolean

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    piReplicationSites List<String>
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    piUserTags List<String>
    The user tags attached to this resource.
    piVolumeId String
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    piVolumeName String
    The name of the volume.
    piVolumePool String
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    piVolumeShareable Boolean
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    piVolumeSize Double
    The size of the volume in GB.
    piVolumeType String
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    primaryRole String
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    timeouts PiVolumeTimeouts
    volumeId String
    (String) The unique identifier of the volume.
    volumeStatus String
    (String) The status of 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.
    consistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    crn string
    (String) The CRN of this resource.
    deleteOnTermination boolean
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    groupId string
    (String) The volume group id to which volume belongs.
    ioThrottleRate string
    (String) Amount of iops assigned to the volume.
    masterVolumeName string
    (String) The master volume name.
    mirroringState string
    (String) Mirroring state for replication enabled volume.
    piAffinityInstance string
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy string
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    piAffinityVolume string
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances string[]
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes string[]
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piReplicationEnabled boolean

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    piReplicationSites string[]
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    piUserTags string[]
    The user tags attached to this resource.
    piVolumeId string
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    piVolumeName string
    The name of the volume.
    piVolumePool string
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    piVolumeShareable boolean
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    piVolumeSize number
    The size of the volume in GB.
    piVolumeType string
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    primaryRole string
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    timeouts PiVolumeTimeouts
    volumeId string
    (String) The unique identifier of the volume.
    volumeStatus string
    (String) The status of 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.
    consistency_group_name str
    (String) The consistency group name if volume is a part of volume group.
    crn str
    (String) The CRN of this resource.
    delete_on_termination bool
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    group_id str
    (String) The volume group id to which volume belongs.
    io_throttle_rate str
    (String) Amount of iops assigned to the volume.
    master_volume_name str
    (String) The master volume name.
    mirroring_state str
    (String) Mirroring state for replication enabled volume.
    pi_affinity_instance str
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    pi_affinity_policy str
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    pi_affinity_volume str
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    pi_anti_affinity_instances Sequence[str]
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    pi_anti_affinity_volumes Sequence[str]
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_replication_enabled bool

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    pi_replication_sites Sequence[str]
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    pi_volume_id str
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    pi_volume_name str
    The name of the volume.
    pi_volume_pool str
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    pi_volume_shareable bool
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    pi_volume_size float
    The size of the volume in GB.
    pi_volume_type str
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    primary_role str
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    timeouts PiVolumeTimeoutsArgs
    volume_id str
    (String) The unique identifier of the volume.
    volume_status str
    (String) The status of 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.
    consistencyGroupName String
    (String) The consistency group name if volume is a part of volume group.
    crn String
    (String) The CRN of this resource.
    deleteOnTermination Boolean
    (Boolean) Indicates if the volume should be deleted when the server terminates.
    groupId String
    (String) The volume group id to which volume belongs.
    ioThrottleRate String
    (String) Amount of iops assigned to the volume.
    masterVolumeName String
    (String) The master volume name.
    mirroringState String
    (String) Mirroring state for replication enabled volume.
    piAffinityInstance String
    PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy 'affinity' requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy 'anti-affinity' requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity.
    piAffinityVolume String
    Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piReplicationEnabled Boolean

    Indicates if the volume should be replication enabled or not.

    Note: replication_sites will be populated automatically with default sites if set to true and sites are not specified.

    piReplicationSites List<String>
    List of replication sites for volume replication. Must set pi_replication_enabled to true to use.
    piUserTags List<String>
    The user tags attached to this resource.
    piVolumeId String
    (String) The unique identifier of the volume. The ID is composed of <cloud_instance_id>/<volume_id>.
    piVolumeName String
    The name of the volume.
    piVolumePool String
    Volume pool where the volume will be created; if provided then pi_affinity_policy values will be ignored.
    piVolumeShareable Boolean
    If set to true, the volume can be shared across Power Systems Virtual Server instances. If set to false, you can attach it only to one instance.
    piVolumeSize Number
    The size of the volume in GB.
    piVolumeType String
    Type of volume, if this field is not provided, it will default to tier3. To get a list of available volume types, please use the ibm.getPiStorageTypesCapacity data source.
    primaryRole String
    (String) Indicates whether master/auxiliary volume is playing the primary role.
    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.
    timeouts Property Map
    volumeId String
    (String) The unique identifier of the volume.
    volumeStatus String
    (String) The status of the volume.
    wwn String
    (String) The world wide name of the volume.

    Supporting Types

    PiVolumeTimeouts, PiVolumeTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    Example

    bash

    $ pulumi import ibm:index/piVolume:PiVolume example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770bbf3ebb

    To learn more about importing existing cloud resources, see Importing resources.

    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