Product Guide

Terraform Provider for Dell PowerFlex

Contents

• Provider
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• Volume Resource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• SDC Resource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• Storage Pool Resource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• Snapshot Resource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• SDS Resource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• SDC Datasource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• Protection Domain Datasource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• SDS Datasource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• Storage Pool Datasource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• Snapshot Policy Datasource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note
• Volume Datasource
  • Synopsis
  • List Of Parameters
  • Examples
  • Note

Provider

Configure the provider on Dell Powerflex

Synopsis

To create any resource / datasource , we need to provide authentication details to connect to the PowerFlex

List Of Parameters

Examples

    
        provider "powerflex" {
            username = "username"
            password = "password"
            endpoint = "10.10.10.1"
            insecure = true
            timeout = 120
        }
    

Note

• Provider details must be provided to authenticate and connect to the PowerFlex Storage system before creating any resource / datasource
• If timeout value is not mentioned then the value for timeout becomes 0 which means indefinite time
• If we don't set the insecure attribute in provider block, the authentication will require SSL verification
• In order to execute all resource/datasource operations, the user role should be either 'Configure' or 'Administrator'.

Volume Resource

Manage volumes on Dell PowerFlex

Synopsis

Managing volumes on PowerFlex storage system includes creating new volume, mapping/unmapping volume to/from SDC, modifying attributes of volume and deleting volume.

List Of Parameters

Examples

        resource "powerflex_volume" "avengers-volume-create"{
        name = "avengers-volume-create"
        protection_domain_name = "domain1"
        storage_pool_name = "pool1" 
        size = 8
        use_rm_cache = true 
        volume_type = "ThickProvisioned" 
        access_mode = "ReadWrite"
        sdc_list = [
        {
                sdc_name = "sdc_name"
                limit_iops = 11
                limit_bw_in_mbps = 11
                access_mode = "ReadOnly"
                },
            ]   
        }

Create Volume using Meta-Argument ‘count’

Sample code where 10 volume resources (with name vol-create-0 to vol-create-9 ) will be created using ‘count’ Meta-Argument

    resource "powerflex_volume" "avengers-volume-create"{
	count = 10
	name = "vol-create-${count.index}"
	protection_domain_name = "domain1"
	storage_pool_name = "pool1" #pool1 have medium granularity
	size = 8
	use_rm_cache = true 
	volume_type = "ThickProvisioned" 
	access_mode = "ReadWrite"
	sdc_list = [
	  {
			   sdc_name = "Block_S34"
			   limit_iops = 119
			   limit_bw_in_mbps = 19
			   access_mode = "ReadOnly"
		   },
	]
  }

Note

• Volume creation or update is not atomic. In case of partially completed operations, Terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). Warning: If the taint is not removed, Terraform will destroy and recreate the resource.
• Volume name is unique across the PowerFlex array.
• Either name or the id of the storage pool is required for creating / modifying a volume.
• Either name or the id of the protection domain is required for creating / modifying a volume.
• Size of the volume should be a multiple of 8.
• specify 0 for unlimited IOPS.
• To set no limit over bandwidth, 0 is to be passed.
• Specify either sdc_name or sdc_id, if sdc_list is specified
• User cannot provide empty value to any of these : name, storage_pool_id, storage_pool_name, protection_domain_id, protection_domain_name
• IOPS limit value should be specified greater than 10. if not specified unlimited IOPS with value 0
• Steps to import volume resource
• To update the imported resource , mandatory fields need to be present in the resource block

SDC Resource

Manage SDCs on Dell PowerFlex

Synopsis

Managing SDCs on PowerFlex storage system includes importing details of SDC and renaming SDC

List Of Parameters

Examples

    
        resource "powerflex_sdc" "sdc" {
            id = "c423b09800000003"
            name = "powerflex_sdc26"
        }
    

Note

• name can't be empty
• Steps to import SDC resource
• To update the imported resource , mandatory fields need to be present in the resource block

Storage Pool Resource

Manage storage pools on Dell PowerFlex

Synopsis

Managing storage pools on PowerFlex storage system includes creating a new storage pool, and modifying the attributes of a storage pool and deleting a storage pool.

List Of Parameters

Examples

    
        resource "powerflex_storagepool" "storagepool" {
            name = "storagepool3"
            protection_domain_id = "4eeb304600000000"
            media_type = "HDD"
            use_rmcache = true
            use_rfcache = false
        }
    

Note

• Either protection_domain_id or protection_domain_name is required in order to create / modify storage pool.
• Transitional media type is supported only during modification.
• Steps to import storage pool resource
• To update the imported resource , mandatory fields need to be present in the resource block

Snapshot Resource

Details about snapshot resource

Synopsis

Managing snapshots on PowerFlex storage system includes creating snapshot for a volume, modifying attributes of snapshot and deleting snapshot.

List Of Parameters

Examples

    
        resource "powerflex_snapshot" "snapshots-create-access-mode-sdc-map" {
            name = "snapshots-create-epsilon"
            volume_id = "4577c84000000120"
            access_mode = "ReadWrite"
            size = 16
            capacity_unit = "GB"
            remove_mode = "INCLUDING_DESCENDANTS"
            sdc_list = [
                {	
                    sdc_id = "c423b09900000004"
                    limit_iops = 150
                    limit_bw_in_mbps = 20
                    access_mode = "ReadWrite"
                },
            ]
        }
    

Note

• Snapshot creation or update is not atomic. In case of partially completed operations, Terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). Warning: If the taint is not removed, Terraform will destroy and recreate the resource.
• Either volume_id or volume_name is required in order to create / modify snapshot.
• Size of the volume should be a multiple of 8.
• specify 0 for unlimited IOPS.
• To set no limit over bandwidth, 0 is to be passed.
• Specify either sdc_name or sdc_id, if sdc_list is specified
• Steps to import snapshot resource
• To update the imported resource , mandatory fields need to be present in the resource block

SDS Resource

Manage SDS on Dell PowerFlex

Synopsis

Managing SDS on PowerFlex storage system includes creating new SDS, adding/removing IP and role to/from SDS, modifying attributes of SDS, and deleting SDS.

List Of Parameters

Examples

    
resource "powerflex_sds" "sds" {
    name = "Tf_SDS_01"
    ip_list = [
        {
            ip = "10.10.10.1"
            role = "all"
        },
        {
            ip = "10.10.10.2"
            role = "sdcOnly"
        }
    ]
    performance_profile = "Compact"
    rmcache_enabled = true
    rmcache_size_in_mb = 156
    rfcache_enabled = true
    drl_mode = "NonVolatile"
    protection_domain_id = "4eeb304600000000"
}
    

Note

• Either protection_domain_id or protection_domain_name is required in order to create / modify SDS.
• SDS creation or update is not atomic. In case of partially completed operations, Terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). Warning: If the taint is not removed, Terraform will destroy and recreate the resource.
• Steps to import SDS resource
• To update the imported resource , mandatory fields need to be present in the resource block

SDC Datasource

Manage SDCs on Dell PowerFlex

Synopsis

Managing SDCs on PowerFlex storage system includes getting details of SDC using id or name of SDC

List Of Parameters

Examples

Get SDC details by id

        data "powerflex_sdc" "selected" {
		id = "c423b09800000003"
	    }

Get SDC details by name

        data "powerflex_sdc" "selected" {
		name = "sdc-1"
	    }

Get all SDC’s

        data "powerflex_sdc" "selected" {
	    }

Note

• id and name are mutually exclusive.
• id cannot be empty.

Protection Domain Datasource

Manage protection domain on Dell PowerFlex

Synopsis

Managing protection domain on PowerFlex storage system includes getting details of protection domain using id or name of protection domain

List Of Parameters

Examples

Get protection domain details by id

data "powerflex_protection_domain" "pd1" {						
    id = "4eeb304600000000"
}

Get protection domain details by name

data "powerflex_protection_domain" "pd2" {			
    name = "domain1"
}

Get all protection domains

data "powerflex_protection_domain" "pd3" {						
}

Note

• id and name are mutually exclusive.

SDS Datasource

Manage SDS on Dell PowerFlex

Synopsis

Managing SDS on PowerFlex storage system includes getting details of SDS using id or name of SDS

List Of Parameters

Examples

Get sds details by sds names and protection domain id

    
        data "powerflex_sds" "example1" {
            protection_domain_id = "4eeb304600000000"
            sds_names = ["SDS_Test_Tf"]
        }

Get sds details by sds ids and protection domain id

        data "powerflex_sds" "example2" {
            protection_domain_id = "4eeb304600000000"
            sds_ids = ["6ae199c500000007"]
        }

Get sds details by sds names and protection domain name

        data "powerflex_sds" "example3" {
            protection_domain_name = "domain1"
            sds_names = ["SDS_Test_Tf"]
        }

Get sds details by sds id and protection domain name

        data "powerflex_sds" "example4" {
            protection_domain_name = "domain1"
            sds_ids = ["6ae199c500000007"]
        }

Get all sds under a protection domain id

        data "powerflex_sds" "example5" {
            protection_domain_id = "4eeb304600000000"
        }

Note

• protection_domain_id and protection_domain_name are mutually exclusive.
• sds_ids and sds_names are mutually exclusive.
• Either protection_domain_id or protection_domain_name must mentioned to fetch the details of an sds.

Storage Pool Datasource

Manage Storage Pool on Dell PowerFlex

Synopsis

Managing storage pool on PowerFlex storage system includes getting details of storage pool using id or name of storage pool

List Of Parameters

Examples

Get storage pool details by storage pool names and protection domain id

        data "powerflex_storagepool" "example1" {
            protection_domain_id = "4eeb304600000000"
            storage_pool_names = ["pool2", "pool1"]
        }

Get storage pool details by storage pool ids and protection domain id

        data "powerflex_storagepool" "example2" {
            protection_domain_id = "4eeb304600000000"
            storage_pool_ids = ["7630a24600000000", "7630a24800000002"]
        }

Get storage pool details by storage pool names and protection domain name

        data "powerflex_storagepool" "example3" {
            protection_domain_name = "domain1"
            storage_pool_names = ["pool2", "pool1"]
        }

Get storage pool details by storage pool id and protection domain name

        data "powerflex_storagepool" "example4" {
            protection_domain_name = "domain1"
            storage_pool_ids = ["7630a24600000000", "7630a24800000002"]
        }

Get all storage pools under a protection domain id

        data "powerflex_storagepool" "example5" {
            protection_domain_name = "domain1"
        }

Note

• protection_domain_id and protection_domain_name are mutually exclusive.
• storage_pool_ids and storage_pool_names are mutually exclusive.
• Either protection_domain_id or protection_domain_name must be mentioned to fetch the details of an sds.

Snapshot Policy Datasource

Manage Snapshot Policy on Dell PowerFlex

Synopsis

Managing snapshot policy on PowerFlex storage system includes getting details of snapshot policy using id or name of snapshot policy

List Of Parameters

Examples

Get snapshot policy details by snapshot policy id

    
        data "powerflex_snapshotpolicy" "sp1" {						
            id = "15ad99b900000001"
        }

Get snapshot policy details by snapshot policy name

        data "powerflex_snapshotpolicy" "sp2" {						
            name = "sample_snap_policy_1"
        }

Get all the snapshot policies

        data "powerflex_snapshotpolicy" "sp3" {						
        }

Note

• id and name are mutually exclusive.
• id and name cannot be empty

Volume Datasource

Manage Volume on Dell PowerFlex

Synopsis

Managing volume on PowerFlex storage system includes getting details of volume using id or name of volume

List Of Parameters

Examples

Get volume details by volume id

    
        data "powerflex_volume" "all" {						
            id = "457752ff000000c7"
        }

Get volume details by volume name

        data "powerflex_volume" "all" {						
            name = "cicd-dbc5a5909d"
        }

Get all the volumes

        data "powerflex_volume" "all" {						
        }

Get all the volumes under a storage pool using storage pool id

        data "powerflex_volume" "all" {						
            storage_pool_id = "7630a24600000000"
        }

Get all the volumes under a storage pool using storage pool name

        data "powerflex_volume" "all" {						
            storage_pool_name = "pool1"
        }               

Note

• id , name , storage_pool_id, storage_pool_name are mutually exclusive and cannot be empty.