1. Packages
  2. Powerstore Provider
  3. API Docs
  4. Volumegroup
powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell

powerstore.Volumegroup

Explore with Pulumi AI

powerstore logo
powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell

    Import

    #Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

    #Licensed under the Mozilla Public License Version 2.0 (the “License”);

    #you may not use this file except in compliance with the License.

    #You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/

    #Unless required by applicable law or agreed to in writing, software

    #distributed under the License is distributed on an “AS IS” BASIS,

    #WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    #See the License for the specific language governing permissions and

    #limitations under the License.

    Below are the steps to import volume group :

    Step 1 - To import a volume group , we need the id of that volume group

    Step 2 - To check the id of the volume group we can make use of volume group datasource to read required/all volume group ids. Alternatively, we can make GET request to volume group endpoint. eg. https://10.0.0.1/api/rest/volume_group which will return list of all volume group ids.

    Step 3 - Add empty resource block in tf file.

    eg.

    resource “powerstore_volumegroup” “resource_block_name” {

    (resource arguments)

    }

    $ pulumi import powerstore:index/volumegroup:Volumegroup Step 4 - Execute the command: "powerstore_volumegroup.resource_block_name" "id_of_the_volume_group" (resource_block_name must be taken from step 3 and id must be taken from step 2)
    

    Step 5 - After successful execution of the command , check the state file

    Create Volumegroup Resource

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

    Constructor syntax

    new Volumegroup(name: string, args?: VolumegroupArgs, opts?: CustomResourceOptions);
    @overload
    def Volumegroup(resource_name: str,
                    args: Optional[VolumegroupArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Volumegroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    description: Optional[str] = None,
                    is_write_order_consistent: Optional[bool] = None,
                    name: Optional[str] = None,
                    protection_policy_id: Optional[str] = None,
                    protection_policy_name: Optional[str] = None,
                    volume_ids: Optional[Sequence[str]] = None,
                    volume_names: Optional[Sequence[str]] = None)
    func NewVolumegroup(ctx *Context, name string, args *VolumegroupArgs, opts ...ResourceOption) (*Volumegroup, error)
    public Volumegroup(string name, VolumegroupArgs? args = null, CustomResourceOptions? opts = null)
    public Volumegroup(String name, VolumegroupArgs args)
    public Volumegroup(String name, VolumegroupArgs args, CustomResourceOptions options)
    
    type: powerstore:Volumegroup
    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 VolumegroupArgs
    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 VolumegroupArgs
    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 VolumegroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumegroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumegroupArgs
    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 volumegroupResource = new Powerstore.Volumegroup("volumegroupResource", new()
    {
        Description = "string",
        IsWriteOrderConsistent = false,
        Name = "string",
        ProtectionPolicyId = "string",
        ProtectionPolicyName = "string",
        VolumeIds = new[]
        {
            "string",
        },
        VolumeNames = new[]
        {
            "string",
        },
    });
    
    example, err := powerstore.NewVolumegroup(ctx, "volumegroupResource", &powerstore.VolumegroupArgs{
    	Description:            pulumi.String("string"),
    	IsWriteOrderConsistent: pulumi.Bool(false),
    	Name:                   pulumi.String("string"),
    	ProtectionPolicyId:     pulumi.String("string"),
    	ProtectionPolicyName:   pulumi.String("string"),
    	VolumeIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	VolumeNames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var volumegroupResource = new Volumegroup("volumegroupResource", VolumegroupArgs.builder()
        .description("string")
        .isWriteOrderConsistent(false)
        .name("string")
        .protectionPolicyId("string")
        .protectionPolicyName("string")
        .volumeIds("string")
        .volumeNames("string")
        .build());
    
    volumegroup_resource = powerstore.Volumegroup("volumegroupResource",
        description="string",
        is_write_order_consistent=False,
        name="string",
        protection_policy_id="string",
        protection_policy_name="string",
        volume_ids=["string"],
        volume_names=["string"])
    
    const volumegroupResource = new powerstore.Volumegroup("volumegroupResource", {
        description: "string",
        isWriteOrderConsistent: false,
        name: "string",
        protectionPolicyId: "string",
        protectionPolicyName: "string",
        volumeIds: ["string"],
        volumeNames: ["string"],
    });
    
    type: powerstore:Volumegroup
    properties:
        description: string
        isWriteOrderConsistent: false
        name: string
        protectionPolicyId: string
        protectionPolicyName: string
        volumeIds:
            - string
        volumeNames:
            - string
    

    Volumegroup 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 Volumegroup resource accepts the following input properties:

    Description string
    Description for the volume group.
    IsWriteOrderConsistent bool
    Determines whether snapshot sets of the group will be write order consistent.
    Name string
    Name of the volume group.
    ProtectionPolicyId string
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    ProtectionPolicyName string
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    VolumeIds List<string>
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    VolumeNames List<string>
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    Description string
    Description for the volume group.
    IsWriteOrderConsistent bool
    Determines whether snapshot sets of the group will be write order consistent.
    Name string
    Name of the volume group.
    ProtectionPolicyId string
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    ProtectionPolicyName string
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    VolumeIds []string
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    VolumeNames []string
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description String
    Description for the volume group.
    isWriteOrderConsistent Boolean
    Determines whether snapshot sets of the group will be write order consistent.
    name String
    Name of the volume group.
    protectionPolicyId String
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protectionPolicyName String
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volumeIds List<String>
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volumeNames List<String>
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description string
    Description for the volume group.
    isWriteOrderConsistent boolean
    Determines whether snapshot sets of the group will be write order consistent.
    name string
    Name of the volume group.
    protectionPolicyId string
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protectionPolicyName string
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volumeIds string[]
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volumeNames string[]
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description str
    Description for the volume group.
    is_write_order_consistent bool
    Determines whether snapshot sets of the group will be write order consistent.
    name str
    Name of the volume group.
    protection_policy_id str
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protection_policy_name str
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volume_ids Sequence[str]
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volume_names Sequence[str]
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description String
    Description for the volume group.
    isWriteOrderConsistent Boolean
    Determines whether snapshot sets of the group will be write order consistent.
    name String
    Name of the volume group.
    protectionPolicyId String
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protectionPolicyName String
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volumeIds List<String>
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volumeNames List<String>
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Volumegroup Resource

    Get an existing Volumegroup 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?: VolumegroupState, opts?: CustomResourceOptions): Volumegroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            is_write_order_consistent: Optional[bool] = None,
            name: Optional[str] = None,
            protection_policy_id: Optional[str] = None,
            protection_policy_name: Optional[str] = None,
            volume_ids: Optional[Sequence[str]] = None,
            volume_names: Optional[Sequence[str]] = None) -> Volumegroup
    func GetVolumegroup(ctx *Context, name string, id IDInput, state *VolumegroupState, opts ...ResourceOption) (*Volumegroup, error)
    public static Volumegroup Get(string name, Input<string> id, VolumegroupState? state, CustomResourceOptions? opts = null)
    public static Volumegroup get(String name, Output<String> id, VolumegroupState state, CustomResourceOptions options)
    resources:  _:    type: powerstore:Volumegroup    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:
    Description string
    Description for the volume group.
    IsWriteOrderConsistent bool
    Determines whether snapshot sets of the group will be write order consistent.
    Name string
    Name of the volume group.
    ProtectionPolicyId string
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    ProtectionPolicyName string
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    VolumeIds List<string>
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    VolumeNames List<string>
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    Description string
    Description for the volume group.
    IsWriteOrderConsistent bool
    Determines whether snapshot sets of the group will be write order consistent.
    Name string
    Name of the volume group.
    ProtectionPolicyId string
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    ProtectionPolicyName string
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    VolumeIds []string
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    VolumeNames []string
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description String
    Description for the volume group.
    isWriteOrderConsistent Boolean
    Determines whether snapshot sets of the group will be write order consistent.
    name String
    Name of the volume group.
    protectionPolicyId String
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protectionPolicyName String
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volumeIds List<String>
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volumeNames List<String>
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description string
    Description for the volume group.
    isWriteOrderConsistent boolean
    Determines whether snapshot sets of the group will be write order consistent.
    name string
    Name of the volume group.
    protectionPolicyId string
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protectionPolicyName string
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volumeIds string[]
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volumeNames string[]
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description str
    Description for the volume group.
    is_write_order_consistent bool
    Determines whether snapshot sets of the group will be write order consistent.
    name str
    Name of the volume group.
    protection_policy_id str
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protection_policy_name str
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volume_ids Sequence[str]
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volume_names Sequence[str]
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.
    description String
    Description for the volume group.
    isWriteOrderConsistent Boolean
    Determines whether snapshot sets of the group will be write order consistent.
    name String
    Name of the volume group.
    protectionPolicyId String
    Unique identifier of the protection policy assigned to the volume group. Conflicts with protection_policy_name.
    protectionPolicyName String
    Unique name of the protection policy assigned to the volume group. Conflicts with protection_policy_id.
    volumeIds List<String>
    A list of identifiers of existing volumes that should be added to the volume group. Conflicts with volume_names.
    volumeNames List<String>
    A list of names of existing volumes that should be added to the volume group. Conflicts with volume_ids.

    Package Details

    Repository
    powerstore dell/terraform-provider-powerstore
    License
    Notes
    This Pulumi package is based on the powerstore Terraform Provider.
    powerstore logo
    powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell