ibm.PiVolumeGroup
Explore with Pulumi AI
Create, update, or delete a volume group. For more information, about managing volume groups, see getting started with IBM Power Systems Virtual Servers.
Example Usage
The following example creates a volume group.
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const testaccVolumeGroup = new ibm.PiVolumeGroup("testaccVolumeGroup", {
piCloudInstanceId: "<value of the cloud_instance_id>",
piVolumeGroupName: "test-volume-group",
piVolumeIds: ["<Volume ID>"],
});
import pulumi
import pulumi_ibm as ibm
testacc_volume_group = ibm.PiVolumeGroup("testaccVolumeGroup",
pi_cloud_instance_id="<value of the cloud_instance_id>",
pi_volume_group_name="test-volume-group",
pi_volume_ids=["<Volume ID>"])
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.NewPiVolumeGroup(ctx, "testaccVolumeGroup", &ibm.PiVolumeGroupArgs{
PiCloudInstanceId: pulumi.String("<value of the cloud_instance_id>"),
PiVolumeGroupName: pulumi.String("test-volume-group"),
PiVolumeIds: pulumi.StringArray{
pulumi.String("<Volume ID>"),
},
})
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 testaccVolumeGroup = new Ibm.PiVolumeGroup("testaccVolumeGroup", new()
{
PiCloudInstanceId = "<value of the cloud_instance_id>",
PiVolumeGroupName = "test-volume-group",
PiVolumeIds = new[]
{
"<Volume ID>",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiVolumeGroup;
import com.pulumi.ibm.PiVolumeGroupArgs;
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 testaccVolumeGroup = new PiVolumeGroup("testaccVolumeGroup", PiVolumeGroupArgs.builder()
.piCloudInstanceId("<value of the cloud_instance_id>")
.piVolumeGroupName("test-volume-group")
.piVolumeIds("<Volume ID>")
.build());
}
}
resources:
testaccVolumeGroup:
type: ibm:PiVolumeGroup
properties:
piCloudInstanceId: <value of the cloud_instance_id>
piVolumeGroupName: test-volume-group
piVolumeIds:
- <Volume ID>
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 PiVolumeGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PiVolumeGroup(name: string, args: PiVolumeGroupArgs, opts?: CustomResourceOptions);
@overload def PiVolumeGroup(resource_name: str, args: PiVolumeGroupArgs, opts: Optional[ResourceOptions] = None) @overload def PiVolumeGroup(resource_name: str, opts: Optional[ResourceOptions] = None, pi_cloud_instance_id: Optional[str] = None, pi_volume_ids: Optional[Sequence[str]] = None, pi_consistency_group_name: Optional[str] = None, pi_volume_group_id: Optional[str] = None, pi_volume_group_name: Optional[str] = None, timeouts: Optional[PiVolumeGroupTimeoutsArgs] = None)
func NewPiVolumeGroup(ctx *Context, name string, args PiVolumeGroupArgs, opts ...ResourceOption) (*PiVolumeGroup, error)
public PiVolumeGroup(string name, PiVolumeGroupArgs args, CustomResourceOptions? opts = null)
public PiVolumeGroup(String name, PiVolumeGroupArgs args) public PiVolumeGroup(String name, PiVolumeGroupArgs args, CustomResourceOptions options)
type: ibm:PiVolumeGroup 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 PiVolumeGroupArgs
- 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 PiVolumeGroupArgs
- 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 PiVolumeGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PiVolumeGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PiVolumeGroupArgs
- 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 piVolumeGroupResource = new Ibm.PiVolumeGroup("piVolumeGroupResource", new() { PiCloudInstanceId = "string", PiVolumeIds = new[] { "string", }, PiConsistencyGroupName = "string", PiVolumeGroupId = "string", PiVolumeGroupName = "string", Timeouts = new Ibm.Inputs.PiVolumeGroupTimeoutsArgs { Create = "string", Delete = "string", Update = "string", }, });
example, err := ibm.NewPiVolumeGroup(ctx, "piVolumeGroupResource", &ibm.PiVolumeGroupArgs{ PiCloudInstanceId: pulumi.String("string"), PiVolumeIds: pulumi.StringArray{ pulumi.String("string"), }, PiConsistencyGroupName: pulumi.String("string"), PiVolumeGroupId: pulumi.String("string"), PiVolumeGroupName: pulumi.String("string"), Timeouts: &ibm.PiVolumeGroupTimeoutsArgs{ Create: pulumi.String("string"), Delete: pulumi.String("string"), Update: pulumi.String("string"), }, })
var piVolumeGroupResource = new PiVolumeGroup("piVolumeGroupResource", PiVolumeGroupArgs.builder() .piCloudInstanceId("string") .piVolumeIds("string") .piConsistencyGroupName("string") .piVolumeGroupId("string") .piVolumeGroupName("string") .timeouts(PiVolumeGroupTimeoutsArgs.builder() .create("string") .delete("string") .update("string") .build()) .build());
pi_volume_group_resource = ibm.PiVolumeGroup("piVolumeGroupResource", pi_cloud_instance_id="string", pi_volume_ids=["string"], pi_consistency_group_name="string", pi_volume_group_id="string", pi_volume_group_name="string", timeouts={ "create": "string", "delete": "string", "update": "string", })
const piVolumeGroupResource = new ibm.PiVolumeGroup("piVolumeGroupResource", { piCloudInstanceId: "string", piVolumeIds: ["string"], piConsistencyGroupName: "string", piVolumeGroupId: "string", piVolumeGroupName: "string", timeouts: { create: "string", "delete": "string", update: "string", }, });
type: ibm:PiVolumeGroup properties: piCloudInstanceId: string piConsistencyGroupName: string piVolumeGroupId: string piVolumeGroupName: string piVolumeIds: - string timeouts: create: string delete: string update: string
PiVolumeGroup 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 PiVolumeGroup resource accepts the following input properties:
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Volume List<string>Ids - List of volume IDs to add in volume group.
- Pi
Consistency stringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - Pi
Volume stringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - Pi
Volume stringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - Timeouts
Pi
Volume Group Timeouts
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Volume []stringIds - List of volume IDs to add in volume group.
- Pi
Consistency stringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - Pi
Volume stringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - Pi
Volume stringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - Timeouts
Pi
Volume Group Timeouts Args
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Volume List<String>Ids - List of volume IDs to add in volume group.
- pi
Consistency StringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi
Volume StringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi
Volume StringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - timeouts
Pi
Volume Group Timeouts
- pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- pi
Volume string[]Ids - List of volume IDs to add in volume group.
- pi
Consistency stringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi
Volume stringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi
Volume stringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - timeouts
Pi
Volume Group Timeouts
- pi_
cloud_ strinstance_ id - The GUID of the service instance associated with an account.
- pi_
volume_ Sequence[str]ids - List of volume IDs to add in volume group.
- pi_
consistency_ strgroup_ name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi_
volume_ strgroup_ id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi_
volume_ strgroup_ name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - timeouts
Pi
Volume Group Timeouts Args
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Volume List<String>Ids - List of volume IDs to add in volume group.
- pi
Consistency StringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi
Volume StringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi
Volume StringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the PiVolumeGroup resource produces the following output properties:
- Consistency
Group stringName - (String) The consistency Group Name if volume is a part of volume group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Replication
Sites List<string> - (List) Indicates the replication sites of the volume group.
- Replication
Status string - (String) The replication status of volume group.
- Status
Description List<PiErrors Volume Group Status Description Error> - (Set) The status details of the volume group.
- Volume
Group stringId - (String) The unique identifier of the volume group.
- Volume
Group stringStatus - (String) The status of the volume group.
- Consistency
Group stringName - (String) The consistency Group Name if volume is a part of volume group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Replication
Sites []string - (List) Indicates the replication sites of the volume group.
- Replication
Status string - (String) The replication status of volume group.
- Status
Description []PiErrors Volume Group Status Description Error - (Set) The status details of the volume group.
- Volume
Group stringId - (String) The unique identifier of the volume group.
- Volume
Group stringStatus - (String) The status of the volume group.
- consistency
Group StringName - (String) The consistency Group Name if volume is a part of volume group.
- id String
- The provider-assigned unique ID for this managed resource.
- replication
Sites List<String> - (List) Indicates the replication sites of the volume group.
- replication
Status String - (String) The replication status of volume group.
- status
Description List<PiErrors Volume Group Status Description Error> - (Set) The status details of the volume group.
- volume
Group StringId - (String) The unique identifier of the volume group.
- volume
Group StringStatus - (String) The status of the volume group.
- consistency
Group stringName - (String) The consistency Group Name if volume is a part of volume group.
- id string
- The provider-assigned unique ID for this managed resource.
- replication
Sites string[] - (List) Indicates the replication sites of the volume group.
- replication
Status string - (String) The replication status of volume group.
- status
Description PiErrors Volume Group Status Description Error[] - (Set) The status details of the volume group.
- volume
Group stringId - (String) The unique identifier of the volume group.
- volume
Group stringStatus - (String) The status of the volume group.
- consistency_
group_ strname - (String) The consistency Group Name if volume is a part of volume group.
- id str
- The provider-assigned unique ID for this managed resource.
- replication_
sites Sequence[str] - (List) Indicates the replication sites of the volume group.
- replication_
status str - (String) The replication status of volume group.
- status_
description_ Sequence[Pierrors Volume Group Status Description Error] - (Set) The status details of the volume group.
- volume_
group_ strid - (String) The unique identifier of the volume group.
- volume_
group_ strstatus - (String) The status of the volume group.
- consistency
Group StringName - (String) The consistency Group Name if volume is a part of volume group.
- id String
- The provider-assigned unique ID for this managed resource.
- replication
Sites List<String> - (List) Indicates the replication sites of the volume group.
- replication
Status String - (String) The replication status of volume group.
- status
Description List<Property Map>Errors - (Set) The status details of the volume group.
- volume
Group StringId - (String) The unique identifier of the volume group.
- volume
Group StringStatus - (String) The status of the volume group.
Look up Existing PiVolumeGroup Resource
Get an existing PiVolumeGroup 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?: PiVolumeGroupState, opts?: CustomResourceOptions): PiVolumeGroup
@staticmethod def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, consistency_group_name: Optional[str] = None, pi_cloud_instance_id: Optional[str] = None, pi_consistency_group_name: Optional[str] = None, pi_volume_group_id: Optional[str] = None, pi_volume_group_name: Optional[str] = None, pi_volume_ids: Optional[Sequence[str]] = None, replication_sites: Optional[Sequence[str]] = None, replication_status: Optional[str] = None, status_description_errors: Optional[Sequence[PiVolumeGroupStatusDescriptionErrorArgs]] = None, timeouts: Optional[PiVolumeGroupTimeoutsArgs] = None, volume_group_id: Optional[str] = None, volume_group_status: Optional[str] = None) -> PiVolumeGroup
func GetPiVolumeGroup(ctx *Context, name string, id IDInput, state *PiVolumeGroupState, opts ...ResourceOption) (*PiVolumeGroup, error)
public static PiVolumeGroup Get(string name, Input<string> id, PiVolumeGroupState? state, CustomResourceOptions? opts = null)
public static PiVolumeGroup get(String name, Output<String> id, PiVolumeGroupState state, CustomResourceOptions options)
resources: _: type: ibm:PiVolumeGroup 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: - Consistency
Group stringName - (String) The consistency Group Name if volume is a part of volume group.
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Consistency stringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - Pi
Volume stringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - Pi
Volume stringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - Pi
Volume List<string>Ids - List of volume IDs to add in volume group.
- Replication
Sites List<string> - (List) Indicates the replication sites of the volume group.
- Replication
Status string - (String) The replication status of volume group.
- Status
Description List<PiErrors Volume Group Status Description Error> - (Set) The status details of the volume group.
- Timeouts
Pi
Volume Group Timeouts - Volume
Group stringId - (String) The unique identifier of the volume group.
- Volume
Group stringStatus - (String) The status of the volume group.
- Consistency
Group stringName - (String) The consistency Group Name if volume is a part of volume group.
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Consistency stringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - Pi
Volume stringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - Pi
Volume stringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - Pi
Volume []stringIds - List of volume IDs to add in volume group.
- Replication
Sites []string - (List) Indicates the replication sites of the volume group.
- Replication
Status string - (String) The replication status of volume group.
- Status
Description []PiErrors Volume Group Status Description Error Args - (Set) The status details of the volume group.
- Timeouts
Pi
Volume Group Timeouts Args - Volume
Group stringId - (String) The unique identifier of the volume group.
- Volume
Group stringStatus - (String) The status of the volume group.
- consistency
Group StringName - (String) The consistency Group Name if volume is a part of volume group.
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Consistency StringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi
Volume StringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi
Volume StringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - pi
Volume List<String>Ids - List of volume IDs to add in volume group.
- replication
Sites List<String> - (List) Indicates the replication sites of the volume group.
- replication
Status String - (String) The replication status of volume group.
- status
Description List<PiErrors Volume Group Status Description Error> - (Set) The status details of the volume group.
- timeouts
Pi
Volume Group Timeouts - volume
Group StringId - (String) The unique identifier of the volume group.
- volume
Group StringStatus - (String) The status of the volume group.
- consistency
Group stringName - (String) The consistency Group Name if volume is a part of volume group.
- pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- pi
Consistency stringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi
Volume stringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi
Volume stringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - pi
Volume string[]Ids - List of volume IDs to add in volume group.
- replication
Sites string[] - (List) Indicates the replication sites of the volume group.
- replication
Status string - (String) The replication status of volume group.
- status
Description PiErrors Volume Group Status Description Error[] - (Set) The status details of the volume group.
- timeouts
Pi
Volume Group Timeouts - volume
Group stringId - (String) The unique identifier of the volume group.
- volume
Group stringStatus - (String) The status of the volume group.
- consistency_
group_ strname - (String) The consistency Group Name if volume is a part of volume group.
- pi_
cloud_ strinstance_ id - The GUID of the service instance associated with an account.
- pi_
consistency_ strgroup_ name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi_
volume_ strgroup_ id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi_
volume_ strgroup_ name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - pi_
volume_ Sequence[str]ids - List of volume IDs to add in volume group.
- replication_
sites Sequence[str] - (List) Indicates the replication sites of the volume group.
- replication_
status str - (String) The replication status of volume group.
- status_
description_ Sequence[Pierrors Volume Group Status Description Error Args] - (Set) The status details of the volume group.
- timeouts
Pi
Volume Group Timeouts Args - volume_
group_ strid - (String) The unique identifier of the volume group.
- volume_
group_ strstatus - (String) The status of the volume group.
- consistency
Group StringName - (String) The consistency Group Name if volume is a part of volume group.
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Consistency StringGroup Name - The name of consistency group at storage controller level, required if
pi_volume_group_name
is not provided. - pi
Volume StringGroup Id - (String) The unique identifier of the volume group. The ID is composed of
<pi_cloud_instance_id>/<volume_group_id>
. - pi
Volume StringGroup Name - The name of the volume group, required if
pi_consistency_group_name
is not provided. - pi
Volume List<String>Ids - List of volume IDs to add in volume group.
- replication
Sites List<String> - (List) Indicates the replication sites of the volume group.
- replication
Status String - (String) The replication status of volume group.
- status
Description List<Property Map>Errors - (Set) The status details of the volume group.
- timeouts Property Map
- volume
Group StringId - (String) The unique identifier of the volume group.
- volume
Group StringStatus - (String) The status of the volume group.
Supporting Types
Pi
Volume Group Status Description Error , Pi Volume Group Status Description Error Args - key str
- (String) The volume group error key.
- message str
- (String) The failure message providing more details about the error key.
- volume_
ids Sequence[str] - (List of String) List of volume IDs, which failed to be added to or removed from the volume group, with the given error.
Pi
Volume Group Timeouts , Pi Volume Group Timeouts Args Import
Example
bash
$ pulumi import ibm:index/piVolumeGroup:PiVolumeGroup 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.