Dell Technologies – Terraform Providers

V1.9.0: ReadMe

Mon, 01 Jan 0001 00:00:00 +0000

Terraform Provider for Dell Technologies PowerFlex

The Terraform Provider for Dell Technologies (Dell) PowerFlex allows Data Center and IT administrators to use Hashicorp Terraform to automate and orchestrate the provisioning and management of Dell PowerFlex storage systems.

The Terraform Provider can be used to manage SDCs, volumes, snapshots, snapshot-policies, storage pools, SDSs, protection domains, devices, users, MDM cluster, fault sets, firmware repository, peer systems, replication consistency groups, replication pairs, NVMe hosts and NVMe targets.

Support

For any Terraform Provider for Dell PowerFlex issues, questions or feedback, please follow our support process

License

The Terraform Provider for Dell PowerFlex is released and licensed under the MPL-2.0 license. See LICENSE for the full terms.

Prerequisites

Terraform Provider	PowerFlex/VxFlex OS Version	OS	Terraform	Golang
v1.9.0	4.5 4.6 4.6.1 (Appliance) 5.0 5.1 (Gen2)	ubuntu22.04 rhel9.x	1.9.x 1.10.x	1.26.x

List of DataSources in Terraform Provider for Dell PowerFlex

Storage Management

Data Protection

Host and Device

Gen2 (PowerFlex 5.x)

Resource Group Management

Firmware and OS Management

Compliance and Templates

List of Resources in Terraform Provider for Dell PowerFlex

Cluster and System

Storage Management

Data Protection

Host and Device

Gen2 (PowerFlex 5.x)

Resource Group Management

Firmware and OS Management

User Management

User

List of Modules in Terraform Provider for Dell PowerFlex

Installation and execution of Terraform Provider for Dell PowerFlex

The installation and execution steps of Terraform Provider for Dell PowerFlex can be found here.

Releasing, Maintenance and Deprecation

Terraform Provider for Dell Technnologies PowerFlex follows Semantic Versioning.

New versions will be release regularly if significant changes (bug fix or new feature) are made in the provider.

Released code versions are located on tags in the form of “vx.y.z” where x.y.z corresponds to the version number.

Documentation

For more detailed information, please refer to Dell Terraform Providers Documentation.

Terraform PowerFlex Modules

Check the following links for the terraform-modules repository and registry.

V1.9.0: Release Notes

Mon, 01 Jan 0001 00:00:00 +0000

Terraform Provider for Dell PowerFlex

Release Notes 1.9.0

© 2026 Dell Inc. or its subsidiaries. All rights reserved. Dell, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners.

This release note contains supplemental information about Terraform Provider for Dell PowerFlex.

Terraform Provider for Dell PowerFlex Release Notes 1.9.0

Revision History

The table in this section lists the revision history of this document.

Revision	Date	History
01	Jan 2023	Release of Terraform Provider for Dell PowerFlex 1.0.0
02	May 2023	Release of Terraform Provider for Dell PowerFlex 1.0.1
03	June 2023	Release of Terraform Provider for Dell PowerFlex 1.1.0
04	September 2023	Release of Terraform Provider for Dell PowerFlex 1.2.0
05	Dec 2023	Release of Terraform Provider for Dell PowerFlex 1.3.0
06	March 2024	Release of Terraform Provider for Dell PowerFlex 1.4.0
07	Jun 2024	Release of Terraform Provider for Dell PowerFlex 1.5.0
08	Aug 2024	Release of Terraform Provider for Dell PowerFlex 1.6.0
09	Dec 2024	Release of Terraform Provider for Dell PowerFlex 1.7.0
10	March 2026	Release of Terraform Provider for Dell PowerFlex 1.8.0
11	September 2026	Current Release of Terraform Provider for Dell PowerFlex 1.9.0

Product Description

The Terraform Provider for Dell PowerFlex allows Data Center and IT administrators to use Hashicorp Terraform to automate and orchestrate the provisioning and management of Dell PowerFlex storage systems.

New Features & Enhancements

Added Support for PowerFlex Gen2 (5.x) architecture.

Resources

Storage Node - Create, Read, Update, Delete, Import (Gen2)
Device Group - Create, Read, Update, Delete, Import (Gen2)
Device Action - Create, Read (Gen2)
Storage Pool Erasure Coding - Create, Read, Update, Delete (Gen2)
Volume Action - Create, Read (Gen2)

Data Sources

Storage Node Datasource (Gen2)
Device Group Datasource (Gen2)

Enhancements

Added support for configuring the PowerFlex provider using environment variables.
Added Gen2 5.x attributes (storage_node_id, device_group_id, erasure_coding_policy, protection_scheme, compression_method) to the Device and Storage Pool resources, with backward compatible deprecation of sds_id/sds_name.
Added IP address validation for MDM IP list values.
Added a migration guide for moving from PowerFlex 4.x to 5.x.
Marked credential fields as sensitive across PowerFlex resource and data source schemas.
Replaced insecure SSH host key handling with known_hosts based validation.
Fixed powerflex_template and powerflex_node data sources to fall back to Bearer authentication on PFMP 5.1.
Fixed an issue where volumes not managed by Terraform were incorrectly unmapped from the SDC during a terraform destroy of the SDC Volume Mapping resource.

Removal

Deprecations

sds_id and sds_name on the Device resource are deprecated in favor of storage_node_id and device_group_id for PowerFlex 5.x (Gen2) systems.

Known Issues

Limitations

NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore powerflex_nvme_host, powerflex_nvme_target and SDT deployment using Cluster resource are not supported in PowerFlex 3.x.
Due to certain limitations, updating the NVMe host in PowerFlex versions earlier than 4.6 is not supported.
Gen2 resources and data sources (powerflex_storage_node, powerflex_device_group, powerflex_device_action, powerflex_storage_pool_erasure_coding, powerflex_volume_action) require PowerFlex 5.x and are not supported on earlier PowerFlex versions.

Distribution

The software package is available for download from the Official Terraform Registry as well as from the Terraform Provider for PowerFlex GitHub page.

Documentation

Readme

Product Guide

V1.9.0: Migration Guide: PowerFlex 4.x to 5.x (Gen2)

Mon, 01 Jan 0001 00:00:00 +0000

Migration Guide: PowerFlex 4.x to 5.x (Gen2)

This guide helps you migrate your Terraform configurations from PowerFlex 4.x to PowerFlex 5.x (Gen2 architecture).

Overview

PowerFlex 5.x introduces a new Gen2 architecture with updated REST APIs. The Terraform provider supports both 4.x and 5.x through a hybrid approach:

4.x features continue using the goscaleio SDK
5.x Gen2 features use the OpenAPI-generated client (clientgen)

New Resources in 5.x

The following new resources are available for PowerFlex 5.x Gen2 systems:

Storage Management

powerflex_storage_node - Gen2 replacement for SDS
powerflex_device_group - Device group management
powerflex_storage_pool_erasure_coding - Erasure coding configuration

Actions

powerflex_device_action - Device operations (clear errors, activate)
powerflex_volume_action - Volume operations (refresh, restore, map/unmap host)

Datasources

powerflex_storage_node - Query storage nodes
powerflex_device_group - Query device groups

Migration Path

1. Device Resource Changes

4.x (Deprecated):

resource "powerflex_device" "example" {
  device_path         = "/dev/sdc"
  storage_pool_id     = "pool-123"
  sds_id              = "sds-456"  # Deprecated
  # or
  sds_name            = "sds-name"  # Deprecated
}

5.x (Recommended):

resource "powerflex_device" "example" {
  device_path         = "/dev/sdc"
  storage_pool_id     = "pool-123"
  storage_node_id     = "node-789"  # New Gen2 parameter
  # or
  device_group_id     = "dg-012"    # New Gen2 parameter
}

Migration Steps:

Replace sds_id/sds_name with storage_node_id or device_group_id
Run terraform plan to verify the changes
Apply the changes with terraform apply

2. Storage Pool Erasure Coding

New Resource for 5.x:

resource "powerflex_storage_pool_erasure_coding" "example" {
  storage_pool_id       = "pool-123"
  erasure_coding_policy = "rs_2_1"  # none, rs_2_1, rs_4_1
  protection_scheme     = "TwoPlusTwo"  # Optional
}

3. Storage Node (Gen2 SDS)

New Resource for 5.x:

resource "powerflex_storage_node" "example" {
  protection_domain_id = "pd-123"
  ip_list {
    ip   = "192.168.1.1"
    role = "All"  # SdsOnly, SdcOnly, All
  }
  fault_set_id         = "fs-456"  # Optional
  performance_profile  = "HighPerformance"  # Optional
}

4. Device Group

New Resource for 5.x:

resource "powerflex_device_group" "example" {
  name                 = "device-group-1"
  protection_domain_id = "pd-123"
}

5. Volume Actions

New Resource for 5.x:

# Refresh volume metadata
resource "powerflex_volume_action" "refresh" {
  volume_id = "vol-abc123"
  action    = "refresh"
}

# Restore from snapshot
resource "powerflex_volume_action" "restore" {
  volume_id          = "vol-abc123"
  action             = "restore"
  source_snapshot_id = "snap-def456"
}

# Map to host
resource "powerflex_volume_action" "map" {
  volume_id   = "vol-abc123"
  action      = "map_to_host"
  host_id     = "host-ghi789"
  access_mode = "READ_WRITE"  # READ_ONLY, READ_WRITE
}

# Unmap from host
resource "powerflex_volume_action" "unmap" {
  volume_id = "vol-abc123"
  action    = "unmap_from_host"
  host_id   = "host-ghi789"
}

Backward Compatibility

Deprecated Parameters

The following parameters are deprecated for PowerFlex 5.x but still supported:

Resource	Deprecated Parameter	New Parameter
`powerflex_device`	`sds_id`	`storage_node_id`
`powerflex_device`	`sds_name`	`storage_node_id`

Deprecation Warnings:

Using deprecated parameters will emit a warning in Terraform output
The warnings suggest migrating to the new Gen2 parameters
Existing configurations continue to work without breaking changes

Gradual Migration

You can migrate gradually:

Keep existing 4.x configurations working
Add new 5.x resources alongside existing ones
Migrate resources one at a time
Remove deprecated parameters after migration is complete

Compatibility Matrix

Feature	PowerFlex 4.x	PowerFlex 5.x
SDS resource	✅	✅ (via goscaleio)
Storage Node resource	❌	✅ (Gen2)
Device resource (sds_id)	✅	⚠️ Deprecated
Device resource (storage_node_id)	❌	✅ (Gen2)
Storage Pool EC	❌	✅ (Gen2)
Volume actions	❌	✅ (Gen2)

Troubleshooting

Error: “Gen2 API Client Not Available”

Cause: The PowerFlex system does not support Gen2 APIs (version < 5.0).

Solution: Use 4.x resources (SDS, device with sds_id) instead of Gen2 resources.

Error: “sds_id is deprecated”

Cause: Using deprecated parameter in 5.x environment.

Solution: Replace sds_id with storage_node_id or device_group_id.

Validation Error: “value must be one of”

Cause: Invalid value for a Gen2 parameter (e.g., invalid EC policy).

Solution: Check the valid values in the resource documentation.

Additional Resources

V1.9.0:

Mon, 01 Jan 0001 00:00:00 +0000

ESXi SDC End to End Example

Overview

This guide will give the steps in order to install and being to use a PowerFlex SDC in the vSphere context.

It will give examples of the following:

Install the SDC on an ESXi Host
Create and Attach a Volume to an SDCs
Create VMFS Datastoures based on the Attached volumes

Step 1: Install the SDC on ESXi Host

1.1 Setup Provider.tf

Fill in username, password, and endpoint ip/hostname

provider.tf

terraform {
   required_providers {
     powerflex = {
       version = ">=1.6.0"
       source  = "registry.terraform.io/dell/powerflex"
     }
   }
 }


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


// Variables
variable "username" {
  type        = string
  description = "Stores the username of PowerFlex host."
}

variable "password" {
  type        = string
  description = "Stores the password of PowerFlex host."
}

variable "endpoint" {
  type        = string
  description = "Stores the endpoint of PowerFlex host. eg: https://10.1.1.1:443, here 443 is port where API requests are getting accepted"
}

1.2 Download the SDC Packages

Download the SDC Packages from Dell Support.

We support installing SDC on Windows ESXi and Linux Hosts. In this example we will use the ESXi sdc_host terraform resource to do the install of an SDC an ESXi host. For more examples check out (https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/resources/sdc_host/).

1.3 Install the SDC on ESXi Host


# # generate a random guid. This is required only for ESXi hosts.
resource "random_uuid" "sdc_guid" {
}

resource "powerflex_sdc_host" "sdc" {
  ip = "10.10.10.10" // The ESXi Host IP
  remote = {
    user = var.esxi-host-username
    password = var.esxi-host-password
  }
  os_family = "esxi"
  esxi = {
    //We generate one using terraform `random_guid` resource above but it should look something like this: "12345678-90AB-CDEF-1234-567890ABCDEF"
    guid = random_uuid.sdc_guid.result
  }
  name         = var.sdc-name
  package_path = var.sdc-path
  // Always just set this to false
  use_remote_path = false
}

variable "sdc-name" {
  type        = string
  description = "Stores the name of the SDC."
  default = "current-user-sdc-esxi"
}

variable "sdc-path" {
  type        = string
  description = "Stores the path to where you downloaded the sdc ESXi package if in this directory then should looks something like './sdc-4.5.0.263-esx8.x.zip'"
}

variable "esxi-host-username" {
  type        = string
  description = "Stores the username of ESXi host."
}

variable "esxi-host-password" {
  type        = string
  description = "Stores the password of the ESXi host."
}

Step 2: Create and Attach Volume

2.1 Fill in the provider config

Fill in username, password, and endpoint ip/hostname

provider.tf

terraform {
   required_providers {
     powerflex = {
       version = ">=1.6.0"
       source  = "registry.terraform.io/dell/powerflex"
     }
   }
 }


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


// Variables
variable "username" {
  type        = string
  description = "Stores the username of PowerFlex host."
}

variable "password" {
  type        = string
  description = "Stores the password of PowerFlex host."
}

variable "endpoint" {
  type        = string
  description = "Stores the endpoint of PowerFlex host. eg: https://10.1.1.1:443, here 443 is port where API requests are getting accepted"
}

2.2 Create the Volume

resource "powerflex_volume" "volume-create" {
  name = var.name

  # To create / update, either protection_domain_id or protection_domain_name must be provided
  protection_domain_name = var.protection_domain_name

  # To create / update, either storage_pool_id or storage_pool_name must be provided
  storage_pool_name = var.storage_pool_name

  # The unit of size of the volume is defined by capacity_unit whose default value is "GB".
  size          = var.size
  capacity_unit = var.capacity_unit # GB/TB

  use_rm_cache = var.use_rm_cache # true/false
  volume_type  = var.volume_type # ThickProvisioned/ThinProvisioned volume type
  access_mode  = var.access_mode # ReadWrite/ReadOnly volume access mode
  remove_mode  = var.remove_mode # INCLUDING_DESCENDANTS/ONLY_ME remove mode
}

// Variables

variable "name" {
  type        = string
  description = "name of the Powerflex Volume"
}

variable "protection_domain_name" {
  type        = string
  description = "protection_domain name of the Powerflex Volume"
}

variable "storage_pool_name" {
  type        = string
  description = "storage_pool name of the Powerflex Volume"
}

variable "size" {
  type        = number
  description = "size of the Powerflex Volume"
  default = 8
}

variable "capacity_unit" {
  type        = string
  description = "Capacity Unit of the Powerflex Volume Options:(GB/TB)"
  default = "GB"
}

variable "use_rm_cache" {
  type        = bool
  description = "Sets the rm_cache option of the Powerflex Volume"
  default = true
}

variable "volume_type" {
  type        = string
  description = "Volume Type of the Powerflex Volume Options:(ThickProvisioned/ThinProvisioned)"
  default = "ThickProvisioned"
}

variable "access_mode" {
  type        = string
  description = "Access Mode of the Powerflex Volume Options:(ReadWrite/ReadOnly)"
  default = "ReadWrite"
}

variable "remove_mode" {
  type        = string
  description = "Remove Mode of the Powerflex Volume Options:(INCLUDING_DESCENDANTS/ONLY_ME)"
  default = "INCLUDING_DESCENDANTS"
}

2.3 Attach the Volume to the SDC

Grab the SDC ID using the sdc datasource, then map the newly created volume to the SDC

data "powerflex_sdc" "filtered" {
  filter {
    name = [var.sdc_name]
  }
}

resource "powerflex_sdc_volumes_mapping" "mapping-test" {
  # SDC id
  id = data.powerflex_sdc.filtered.sdcs[0].id
  volume_list = [
    {
      # id of the volume which needs to be mapped. 
      # either volume_id or volume_name can be used.
      volume_id = resource.powerflex_volume.volume-create.id

      # Valid values are 0 or integers greater than 10
      limit_iops = var.limit_iops

      # Default value is 0
      limit_bw_in_mbps = var.limit_bw_in_mbps

      access_mode = var.access_mode # ReadOnly/ReadWrite/NoAccess
    }
  ]
}


// Variables
variable "sdc_name" {
  type        = string
  description = "name of the sdc"
}

variable "limit_iops" {
  type        = number
  description = "limit_iops Valid values are 0 or integers greater than 10"
  default = 140
}

variable "limit_bw_in_mbps" {
  type        = number
  description = "limit_bw_in_mbps Default value is 0"
  default = 0
}

variable "access_mode" {
  type        = string
  description = "access_mode Options(ReadOnly/ReadWrite/NoAccess)"
  default = "ReadOnly"
}

Step 3: Create VMFS Datasource

3.1 Setup the vSphere provider

terraform {
  required_providers {
    vsphere = {
      source = "hashicorp/vsphere"
      version = "2.11.1"
    }
  }
}

provider "vsphere" {
  user                 = var.vsphere_user
  password             = var.vsphere_password
  vsphere_server       = var.vsphere_server
  allow_unverified_ssl = var.allow_unverified_ssl
  api_timeout          = 100
}

// Variables
variable "vsphere_user" {
  type        = string
  description = "Stores the username of vsphere_user."
}

variable "vsphere_password" {
  type        = string
  description = "Stores the password of vsphere_password."
}

variable "vsphere_server" {
  type        = string
  description = "Stores the host ip/fqdn of the vsphere_server."
}

variable "allow_unverified_ssl" {
  type        = string
  description = "Allow unverified ssl connection"
  default = true
}

3.2 Rescan and Create the VMFS Datastore

data "vsphere_datacenter" "datacenter" {
  name = "Datacenter"
}

data "vsphere_host" "host" {
  name          = var.host_name // Hosts name in vSphere 
  datacenter_id = data.vsphere_datacenter.datacenter.id
}

data "vsphere_vmfs_disks" "available" {
  host_system_id = data.vsphere_host.host.id
  rescan         = true
  filter = var.vmfs_filter // Should look something like eui.bcc545a72b516e0fa45627070000000e
}

resource "vsphere_vmfs_datastore" "datastore" {
  name           = var.vmfs_datastore_name // name of vmfs datastore to be created
  host_system_id = data.vsphere_host.host.id

  disks = "${data.vsphere_vmfs_disks.available.disks}"
}

// Variables
variable "host_name" {
  type        = string
  description = "Stores the name of the vSphere host."
}

variable "vmfs_filter" {
  type        = string
  description = "The filter which is used to grab the disk name to create the VMFS datasource upon. Starts with `eui.`. If you want a specific disk give full eui value, example: `eui.bcc545a72b516e0fa45627070000000e`. Otherwise the default will grab all disks with the eui path on the Powerflex Storage Adaptor"
  default = "eui."
}

variable "vmfs_datastore_name" {
  type        = string
  description = "The name used when creating the VMFS datastore"
  default = "terraform-vmfs-datastore"
}

V1.9.0:

Mon, 01 Jan 0001 00:00:00 +0000

SDC End to End Example

Overview

This guide will give the steps in order to install and being to use a PowerFlex SDC.

It will give examples of the following:

Deploy the SDC Linux Virtual Machine (vSphere)
Install the SDC
Create and Attach a Volume to an SDCs

Step 1: VM Deployment

There are many way in which you can deploy a Virtual Machine. Below is an approch using the vSphere terraform provider. If your team use a different hypervisor, or has a differnt process for creating the VMs this step can just be skipped. The examples below show how to use the vSphere terraform provider but for more information you can check out there documentaion: https://registry.terraform.io/providers/hashicorp/vsphere/latest

1.1 Use the vSphere provider and Setup provider.tf

Provider Example:

Fill in username, password, vsphere_server ip/hostname

provider.tf

terraform {
  required_providers {
    vsphere = {
      source = "hashicorp/vsphere"
      version = "2.8.2"
    }
  }
}

provider "vsphere" {
  user                 = var.vsphere_user
  password             = var.vsphere_password
  vsphere_server       = var.vsphere_server
  allow_unverified_ssl = var.allow_unverified_ssl
  api_timeout          = 10
}


// Variables
variable "vsphere_user" {
  type        = string
  description = "Stores the username of vsphere_user."
}

variable "vsphere_password" {
  type        = string
  description = "Stores the password of vsphere_password."
}

variable "vsphere_server" {
  type        = string
  description = "Stores the host ip/fqdn of the vsphere_server."
}

variable "allow_unverified_ssl" {
  type        = string
  description = "Allow unverified ssl connection"
  default = true
}

1.2 Gather Needed Data

Using vSphere Terraform Datasources for datacenter, datastore, resource_pool, host and network, we need to gather all of the information needed to create the virtual machine

Example:

datasources.tf

data "vsphere_datacenter" "datacenter" {
  name = var.vsphere_datacenter_name
}

data "vsphere_datastore" "datastore" {
  name = var.vsphere_datastore_name
  datacenter_id = data.vsphere_datacenter.datacenter.id
}

data "vsphere_resource_pool" "pool" {
  name = var.vsphere_resource_pool_name
  datacenter_id = data.vsphere_datacenter.datacenter.id
}

data "vsphere_host" "host" {
  name = var.vsphere_host_name
  datacenter_id = data.vsphere_datacenter.datacenter.id
}

data "vsphere_network" "network" {
  name = var.vsphere_network_name
  datacenter_id = data.vsphere_datacenter.datacenter.id
}


// Variables
variable "vsphere_datacenter_name" {
  type = string
  description = "The name of the datacenter in which to deploy the virtual machines."
}

variable "vsphere_datastore_name" {
  type = string
  description = "The name of the vSphere datastore in which to deploy the virtual machines."
}

variable "vsphere_network_name" {
  type = string
  description = "The name of the vSphere datastore in which to deploy the virtual machines."
}

variable "vsphere_resource_pool_name" {
  type = string
  description = "The name of the vSphere resource pool in which to deploy the virtual machines."
}

variable "vsphere_host_name" {
  type = string
  description = "The name of the vSphere host in which to deploy the virtual machines."
}

1.3 Deploy the Virtual Machine

You can deploy one of two ways using a .ova image or using a vsphere template. Here is an examples of both.

Note: VM should have the following packages installed fio sshpass unzip yum-utils wget

.ova Example:

Note: the vapp properties will need to be filled out based on each usecase as it will be different in each environment

resource "vsphere_virtual_machine" "vm-installer" {
  name = var.vm_name
  datacenter_id = data.vsphere_datacenter.datacenter.id
  datastore_id         = data.vsphere_datastore.datastore.id
  host_system_id       = data.vsphere_host.host.id
  resource_pool_id = data.vsphere_resource_pool.pool.id

  num_cpus = var.num_cpus
  memory = var.memory
  wait_for_guest_net_timeout = 0
  wait_for_guest_ip_timeout  = 0

  network_interface {
    network_id = data.vsphere_network.network.id
    adapter_type = var.adapter_type 
  }

  ovf_deploy {
    allow_unverified_ssl_cert = var.allow_unverified_ssl
    remote_ovf_url = var.vm_ova_path
    disk_provisioning = var.disk_provisioning
    ip_protocol = var.ip_protocol
    ip_allocation_policy = var.ip_allocation_policy

    ovf_network_map = {
      network_id = data.vsphere_network.network.id
    }
  }

  // Depends on the image you need to fill out for your specific case/ova image you are using
  vapp {
    properties = {
      "guestinfo.hostname"     = "remote-foo.example.com",
      "guestinfo.ipaddress"    = "172.16.11.101",
      "guestinfo.netmask"      = "255.255.255.0",
      "guestinfo.gateway"      = "172.16.11.1",
      "guestinfo.dns"          = "172.16.11.4",
      "guestinfo.domain"       = "example.com",
      "guestinfo.ntp"          = "ntp.example.com",
      "guestinfo.password"     = "VMware1!",
      "guestinfo.ssh"          = "True"
    }
  }
}


// Variables

variable "vm_name" {
    type = string
    description = "Name of the PFMP installer VM, default to `new_terraform_vm`"
    default = "new_terraform_sdc_vm"
}

variable "disk_provisioning" {
  type = string
  description = "The disk provisioning type for the virtual machine. Options (thin, flat, think, sameAsSource) defaults to `thin`"
  default = "thin"
}

variable "ip_protocol" {
  type = string
  description = "The IP protocol for the virtual machine. Defaults to `IPV4`"
  default = "IPV4"
}

variable "ip_allocation_policy" {
  type = string
  description = "The IP allocation policy for the virtual machine. Defaults to `STATIC_MANUAL`"
  default = "STATIC_MANUAL"
}

variable "num_cpus" {
  type = number
  description = "Number of CPUs for the virtual machine. Defaults to `1`"
  default = 1
}

variable "memory" {
  type = number
  description = "Memory for the virtual machine. Defaults to `4060`"
  default = 4060
}

variable "adapter_type" {
  type = string
  description = "Network Adapter Type for the virtual machine. Defaults to `vmxnet3` Options can be found here: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-AF9E24A8-2CFA-447B-AC83-35D563119667.html"
  default = "vmxnet3"
}

Template Example:

data "vsphere_virtual_machine" "template_example" {
  name          = "linux-template"
  datacenter_id = data.vsphere_datacenter.datacenter.id
}

resource "vsphere_virtual_machine" "template" {

  name             = var.vm_name
  resource_pool_id = data.vsphere_resource_pool.pool.id
  datastore_id     = data.vsphere_datastore.primary_datastore.id
  num_cpus         = var.num_cpus
  memory           = var.memory
  folder           = var.vmfolder
  guest_id         = data.vsphere_virtual_machine.template_example.guest_id
  scsi_type        = data.vsphere_virtual_machine.template_example.scsi_type
  scsi_controller_count = 4
  firmware         = "efi"

  network_interface {
    network_id   = data.vsphere_network.VM_Network.id
    adapter_type = data.vsphere_virtual_machine.template_example.network_interface_types[0]
  }

  wait_for_guest_net_timeout  = 10000000000000000
  wait_for_guest_net_routable = false
  wait_for_guest_ip_timeout   = 10000000000000000
  shutdown_wait_timeout       = 10
  migrate_wait_timeout        = 10000000000000000
  force_power_off             = false

  disk {
    label            = "OS"
    size             = 40
    thin_provisioned = data.vsphere_virtual_machine.template_example.disks.0.thin_provisioned
    unit_number      = 0
  }

  clone {
    template_uuid = data.vsphere_virtual_machine.template_example.id
    customize {
      linux_options {
        host_name = var.hostname
        domain    = var.dns[0]
      }
      network_interface {
        ipv4_address = var.mgmt_ip
        ipv4_netmask = 22
      }
      ipv4_gateway = var.gw
      dns_server_list = var.dns
      dns_suffix_list = var.search_domains
    }
  }


// Variables
variable "vm_name" {
    type = string
    description = "Name of the PFMP installer VM, default to `new_terraform_vm`"
    default = "new_terraform_sdc_vm"
}

variable "num_cpus" {
  type = number
  description = "Number of CPUs for the virtual machine. Defaults to `1`"
  default = 1
}

variable "memory" {
  type = number
  description = "Memory for the virtual machine. Defaults to `4060`"
  default = 4060
}

variable "search_domains" {
  type        = list(string)
  description = "List of DNS search domains"
}

variable "dns" {
  type = list(string)
}

variable "gw" {
  type = string
}

variable "vmfolder" {
  description = "Name of Folder to Deploy VM to"
}

variable "mgmt_ip" {
  description = "IP on Management Network"
  type        = string
}

Step 2: SDC Install

We support installing SDC on Windows EXSi and Linux Hosts. In this example we will use the linux sdc terraform module to do the install on the linux VM you have created above. For more examples including EXSi and Windows look here.

2.1 Download the SDC Packages

Download the SDC Packages from Dell Support. Once downloaded add the sdc package to an http or ftp site for easy access when deploying sdcs

2.2 Install the SDC

Fill in username, password, and endpoint ip/hostname

provider.tf

terraform {
   required_providers {
     powerflex = {
       version = ">=1.6.0"
       source  = "registry.terraform.io/dell/powerflex"
     }
   }
 }


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


// Variables
variable "username" {
  type        = string
  description = "Stores the username of PowerFlex host."
}

variable "password" {
  type        = string
  description = "Stores the password of PowerFlex host."
}

variable "endpoint" {
  type        = string
  description = "Stores the endpoint of PowerFlex host. eg: https://10.1.1.1:443, here 443 is port where API requests are getting accepted"
}

Example Module:

module "modules_example_sdc_host_linux" {
  source  = "dell/modules/powerflex//examples/sdc_host_linux"
  version = "1.2.0"

  remote_host = {
    user = var.remote_user
    password = var.remote_password
    // If you have a ssh key and certificate.
    // You are able to use those instead of user/pass
    //private_key = ""
    //certificate = ""
  }

  ip = var.ip

  versions = versions={
    pflex =  var.sdc_pflex_version  //"4.5.3000.118"
    kernel = var.linux_kernal_version //"5.15.0-1-generic"
  }
  
  scini = {
    linux_distro = "RHEL9" #"Ubuntu"
    autobuild_scini = true
    // If autobuild is equal to false, give the path to your scini.ko or scini.rpm else this is not needed
    //url = "http://example.com/release/5.15.0-1-generic"
  }

  sdc_pkg = {
    url = var.package_url
    // Do not change this value
    remote_pkg_name = var.remote_pkg_name
    remote_file = var.package_name
    use_remote_path = true
    skip_download_sdc = true
  }
  mdm_ips = var.mdm_ips
}


// Variables
variable "ip" {
  type        = string
  description = "Stores the IP address of the remote Linux host."
}

variable "package_url" {
  type        = string
  description = "URL to where the SDC Package is located for download. This package will be downloaded directly onto the virtual machine. Example: http://example.com/EMC-ScaleIO-sdc-3.6-700.103.Ubuntu.22.04.x86_64.tar, ftp://username:password@ftpserver/path/to/file"
}

variable "remote_pkg_name" {
  type        = string
  description = "The name of the package. Example: emc-sdc-package.tar (for Ubuntu) emc-sdc-package.rpm (for RHEL)"
  default = "emc-sdc-package.tar"
}

variable "package_name" {
  type        = string
  description = "The name of the package. Example: EMC-ScaleIO-sdc-4.5-3000.118.Ubuntu.22.04.x86_64.tar (for Ubuntu) EMC-ScaleIO-sdc-4.5-3000.118.Ubuntu.22.04.x86_64.rpm (for RHEL)"
}

variable "remote_user" {
  type        = string
  description = "Stores the username of the remote Linux host."
}

variable "remote_password" {
  type        = string
  description = "Stores the password of the remote Linux host."
}

variable "sdc_pflex_version" {
  type        = string
  description = "The version of the powerflex sdc you are installing, this can be grabbed from the sdc package name i.e: PowerFlex_4.5.2100.105_Ubuntu18.04_SDC.tar the version would be 4.5.2100.105"
}

variable "linux_kernal_version" {
  type        = string
  description = "The version of linux we are using"
}

variable "mdm_ips" {
  description = "all the mdms (either primary,secondary or virtual ips) in a comma separated list by cluster. If sdc is only being connected to one powerflex leave this unset and it will use the mdms of the cluster set of the provider by default"
  type        = list(string)
  default = []
}

Step 3: Create and Attach Volume

3.1 Fill in the provider config

Fill in username, password, and endpoint ip/hostname

provider.tf

terraform {
   required_providers {
     powerflex = {
       version = ">=1.6.0"
       source  = "registry.terraform.io/dell/powerflex"
     }
   }
 }


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


// Variables
variable "username" {
  type        = string
  description = "Stores the username of PowerFlex host."
}

variable "password" {
  type        = string
  description = "Stores the password of PowerFlex host."
}

variable "endpoint" {
  type        = string
  description = "Stores the endpoint of PowerFlex host. eg: https://10.1.1.1:443, here 443 is port where API requests are getting accepted"
}

3.2 Create the Volume

resource "powerflex_volume" "volume-create" {
  name = var.name

  # To create / update, either protection_domain_id or protection_domain_name must be provided
  protection_domain_name = var.protection_domain_name

  # To create / update, either storage_pool_id or storage_pool_name must be provided
  storage_pool_name = var.storage_pool_name

  # The unit of size of the volume is defined by capacity_unit whose default value is "GB".
  size          = var.size
  capacity_unit = var.capacity_unit # GB/TB

  use_rm_cache = var.use_rm_cache # true/false
  volume_type  = var.volume_type # ThickProvisioned/ThinProvisioned volume type
  access_mode  = var.access_mode # ReadWrite/ReadOnly volume access mode
  remove_mode  = var.remove_mode # INCLUDING_DESCENDANTS/ONLY_ME remove mode
}

// Variables

variable "name" {
  type        = string
  description = "name of the Powerflex Volume"
}

variable "protection_domain_name" {
  type        = string
  description = "protection_domain name of the Powerflex Volume"
}

variable "storage_pool_name" {
  type        = string
  description = "storage_pool name of the Powerflex Volume"
}

variable "size" {
  type        = number
  description = "size of the Powerflex Volume"
  default = 8
}

variable "capacity_unit" {
  type        = string
  description = "Capacity Unit of the Powerflex Volume Options:(GB/TB)"
  default = "GB"
}

variable "use_rm_cache" {
  type        = bool
  description = "Sets the rm_cache option of the Powerflex Volume"
  default = true
}

variable "volume_type" {
  type        = string
  description = "Volume Type of the Powerflex Volume Options:(ThickProvisioned/ThinProvisioned)"
  default = "ThickProvisioned"
}

variable "access_mode" {
  type        = string
  description = "Access Mode of the Powerflex Volume Options:(ReadWrite/ReadOnly)"
  default = "ReadWrite"
}

variable "remove_mode" {
  type        = string
  description = "Remove Mode of the Powerflex Volume Options:(INCLUDING_DESCENDANTS/ONLY_ME)"
  default = "INCLUDING_DESCENDANTS"
}

3.3 Attach the Volume to the SDC

Grab the SDC ID using the sdc datasource, then map the newly created volume to the SDC

data "powerflex_sdc" "filtered" {
  filter {
    name = [var.sdc_name]
  }
}

resource "powerflex_sdc_volumes_mapping" "mapping-test" {
  # SDC id
  id = data.powerflex_sdc.filtered.sdcs[0].id
  volume_list = [
    {
      # id of the volume which needs to be mapped. 
      # either volume_id or volume_name can be used.
      volume_id = resource.powerflex_volume.volume-create.id

      # Valid values are 0 or integers greater than 10
      limit_iops = var.limit_iops

      # Default value is 0
      limit_bw_in_mbps = var.limit_bw_in_mbps

      access_mode = var.access_mode # ReadOnly/ReadWrite/NoAccess
    }
  ]
}


// Variables
variable "sdc_name" {
  type        = string
  description = "name of the sdc"
}

variable "limit_iops" {
  type        = number
  description = "limit_iops Valid values are 0 or integers greater than 10"
  default = 140
}

variable "limit_bw_in_mbps" {
  type        = number
  description = "limit_bw_in_mbps Default value is 0"
  default = 0
}

variable "access_mode" {
  type        = string
  description = "access_mode Options(ReadOnly/ReadWrite/NoAccess)"
  default = "ReadOnly"
}

V1.9.0: Creating Multiple Volumes with Count

Mon, 01 Jan 0001 00:00:00 +0000

You can use the count meta-argument to create multiple volumes.

Example

To create 7 different volumes using the following configuration:

resource "powerflex_volume" "volumes" {
  count                  = 7
  name                   = "security-footage-${count.index}"
  protection_domain_name = "domain1"
  storage_pool_name      = "pool1"
  size                   = 8
  use_rm_cache           = true
  volume_type            = "ThinProvisioned"
  access_mode            = "ReadWrite"
}

V1.9.0: Creating Multiple Volumes with For Each

Mon, 01 Jan 0001 00:00:00 +0000

You can use the for_each meta-argument to create multiple volumes.

Example

To create 3 different volumes use the following configuration:

resource "powerflex_volume" "volume_example" {
  for_each = toset( ["Volume1", "Volume2", "Volume3"] )
  name = each.key
  protection_domain_name = "domain1"
  storage_pool_name = "pool1"
  size          = 8
  capacity_unit = "GB"
}

V1.9.0: Datasource Filtering

Mon, 01 Jan 0001 00:00:00 +0000

Datasource Filtering Overview

This describes how filtering works in the Powerflex Provider with a datasource filter block

The input below will be used showcase different scenarios and how they will work in our provider:

[
  {
   id = "id-1"
   field = false
   count = 1
  },
  {
   id = "id-2"
   field = true
   count = 2
  },
  {
   id = "id-3"
   field = true
   count = 3
  }
]

1. If a single filter field is set, filter and only return those values

Config:

data "powerflex_example_datasource" "exampleFilter" {
  filter {
   id = ["id-1", "id-2"]
  }
}

Output:

[
  {
   id = "id-1"
   field = false
   count = 1
  },
  {
   id = "id-2"
   field = true
   count = 2
  }
]

2. If multiple filters are set then it is the intersection of those filters:

Config:

data "powerflex_example_datasource" "exampleFilter" {
  filter {
   id = ["id-1", "id-2"]
   count = [2]
  }
}

Output:

[
  {
   id = "id-2"
   field = true
   count = 2
  }
]

3. If there are no intersection then the output will be empty:

Config:

data "powerflex_example_datasource" "exampleFilter" {
  filter {
   id = ["id-1", "id-2"]
   count = [3]
  }
}

Output:

[]

4. If the filter value is invalid then the output will be empty:

Config:

data "powerflex_example_datasource" "exampleFilter" {
  filter {
   id = ["invaid-id"]
  }
}

Output:

[]

5. If the filter value is using regular expressions:

Config:

data "powerflex_example_datasource" "exampleFilter" {
  filter {
   id = ["^id-[1-2]$"]
  }
}

Output:

[
   {
   id = "id-1"
   field = false
   count = 1
  },
  {
   id = "id-2"
   field = true
   count = 2
  }
]

V1.9.0: Deploying a PowerFlex cluster using a CSV Topology File

Mon, 01 Jan 0001 00:00:00 +0000

Deploying a PowerFlex cluster using a CSV Topology File

This guide explains how to use CSV file(s) for managing PowerFlex cluster via Terraform’s Cluster Resource.

Example

Note: It is recommended to use 2 separate csv files for cluster node related information and storage pool related information. Refer the following examples for more information. The first row will be treated as header.

cluster_node.csv

IPs,Username,Password,Operating System,Is MDM/TB,Is SDS,SDS Storage Device List,Is SDC,Is SDT
10.76.60.1,root,Password1,linux,Primary,Yes,/dev/sdb,Yes,Yes
10.76.60.2,root,Password1,linux,Secondary,Yes,/dev/sdb,Yes,Yes
10.76.60.3,root,Password1,linux,TB,Yes,/dev/sdb,Yes,Yes
10.76.60.4,root,Password1,linux,,Yes,/dev/sdb,Yes,Yes

sp_data.csv

ProtectionDomain,StoragePool,Media Type,Replication journal capacity percentage
domain_1,pool1,HDD,50

To perform SDC operations with a CSV file, use the following configuration:


locals {
  cluster_node_data = csvdecode(file("cluster_node.csv"))
  sp_data = csvdecode(file("sp_data.csv"))
}

resource "powerflex_cluster" "test" {
  # Security Related Fields
  mdm_password = "Password"
  lia_password = "Password"

  # Advance Security Configuration
  allow_non_secure_communication_with_lia = false
  allow_non_secure_communication_with_mdm = false
  disable_non_mgmt_components_auth = false

  # Cluster Configuration related fields
  cluster = [
    for row in local.cluster_node_data : {
      ips                  = row.IPs
      username             = row.Username
      password             = row.Password
      operating_system     = row["Operating System"]
      is_mdm_or_tb         = row["Is MDM/TB"]
      is_sds               = row["Is SDS"]
      sdc_name             = row["SDS Name"]
      perf_profile_for_sdc = row.perfProfileForSDC
      is_rfcache           = row["RFcache"]
      is_sdr               = row["Is SDR"]
      is_sdt               = row["Is SDT"]
    }
    if row["Is MDM/TB"] != "" # Validates if MDM role is not empty string
  ]

  storage_pools = [
    for row in local.sp_data : {
      media_type                              = row["Media Type"]
      protection_domain                       = row.ProtectionDomain
      storage_pool                            = row.StoragePool
      replication_journal_capacity_percentage = tonumber(row["Replication journal capacity percentage"])
    }
  ]
}

This Terraform configuration sets up a PowerFlex cluster by defining its configuration, including security settings, node information, and storage pool details. The data for this configuration is read from two CSV files using the csvdecode function and organized into the required format for the resource.

Proposed: Two Terraform local variables are getting declared here (cluster_node_data and sp_data) by using Terraform’s built-in ‘csvdecode’ function.

locals: The scope of the variable is within the configuration file. These variables are used to store data or perform calculations within this configuration.

cluster_node_data: Reads and decodes the CSV file “cluster_node.csv” into a list of maps. This file contains information about cluster nodes.

sp_data: Reads and decodes the CSV file “sp_data.csv” into a list of maps. This file contains information about storage pools.

cluster: A list variable which is getting created using a for loop which iterates over each element in the ‘cluster_node_data’ (local list variable).

storage_pools: A list variable which is getting created using a for loop which iterates over each element in the ‘sp_data’ (local list variable defined earlier).

The fields inside the object (e.g., ip, password, operating_system, etc.) are populated with values from the CSV file. You can also apply some conditions in the if statement to filter out rows where IPs and Password are not empty and not equal to “null.”

V1.9.0: Deploying a PowerFlex cluster using multiple values for mdm_ips

Mon, 01 Jan 0001 00:00:00 +0000

Deploying a PowerFlex cluster having multiple values for mdm_ips

This guide explains how to deploy a cluster which has multiple values for mdm_ips.

Example


resource "powerflex_cluster" "test" {
  mdm_password = "Password"
  lia_password = "Password"

  # Advance Security Configuration
  allow_non_secure_communication_with_lia = false
  allow_non_secure_communication_with_mdm = false
  disable_non_mgmt_components_auth        = false

  # Cluster Configuration related fields
  cluster = [
    {
      # MDM Configuration Fields
      username                 = "user",
      password                 = "password",
      operating_system         = "linux",
      is_mdm_or_tb             = "Primary",
      mdm_ips                  = "10.10.10.1,10.10.10.2,10.10.10.3",
      mdm_mgmt_ip              = "10.10.10.1",
      mdm_name                 = "mdm1",
      perf_profile_for_mdm     = "HighPerformance",
      virtual_ips              = "10.10.10.4,10.10.10.5",
      virtual_ip_nics          = "eth1,eth2",
      is_sds                   = "Yes",
      sds_name                 = "sds1",
      sds_all_ips              = "10.10.10.2,10.10.10.3",
      protection_domain        = "domain_1",
      sds_storage_device_list  = "/dev/sdb",
      sds_storage_device_names = "sdb",
      storage_pool_list        = "pool1",
      perf_profile_for_sds     = "HighPerformance",
      is_sdc                   = "Yes",
      sdc_name                 = "sdc1",
      perf_profile_for_sdc     = "HighPerformance"
      is_sdt                   = "Yes",
      sdt_name                 = "sdt1",
      sdt_all_ips              = "10.10.10.2,10.10.10.3",
    },
    {
      username                 = "user",
      password                 = "password",
      operating_system         = "linux",
      is_mdm_or_tb             = "Secondary",
      mdm_name                 = "mdm2",
      mdm_ips                  = "10.10.10.6,10.10.10.7,10.10.10.8",
      mdm_mgmt_ip              = "10.10.10.6",
      perf_profile_for_mdm     = "HighPerformance",
      virtual_ips              = "10.10.10.4,10.10.10.5",
      virtual_ip_nics          = "eth1,eth2",
      is_sds                   = "Yes",
      sds_name                 = "sds2",
      sds_all_ips              = "10.10.10.7,10.10.10.8",
      sds_storage_device_list  = "/dev/sdb",
      sds_storage_device_names = "sdb",
      protection_domain        = "domain_1",
      storage_pool_list        = "pool1",
      perf_profile_for_sds     = "HighPerformance",
      is_sdc                   = "Yes",
      sdc_name                 = "sdc2",
      perf_profile_for_sdc     = "HighPerformance"
      perf_profile_for_sdc     = "HighPerformance",
      is_sdt                   = "Yes",
      sdt_name                 = "sdt2",
      sdt_all_ips              = "10.10.10.7,10.10.10.8",
    },
    {
      username                 = "user",
      password                 = "password",
      operating_system         = "linux",
      is_mdm_or_tb             = "TB",
      mdm_name                 = "tb1",
      mdm_ips                  = "10.10.10.9,10.10.10.10,10.01.10.11",
      mdm_mgmt_ip              = "10.10.10.9",
      perf_profile_for_mdm     = "HighPerformance",
      is_sds                   = "Yes",
      sds_name                 = "sds3",
      sds_all_ips              = "10.10.10.10,10.01.10.11",
      sds_storage_device_list  = "/dev/sdb",
      sds_storage_device_names = "sdb",
      protection_domain        = "domain_1",
      storage_pool_list        = "pool1",
      perf_profile_for_sds     = "HighPerformance",
      is_sdc                   = "Yes",
      sdc_name                 = "sdc3",
      perf_profile_for_sdc     = "HighPerformance"
      is_sdt                   = "Yes",
      sdt_name                 = "sdt3",
      sdt_all_ips              = "10.10.10.10,10.01.10.11",
    }
  ]

    storage_pools = [
    {
      media_type        = "SSD"
      protection_domain = "domain_1"
      storage_pool      = "pool1"
      daya_layout       = "MG"
      zero_padding      = "true"
    }
  ]
}

This Terraform configuration sets up a PowerFlex cluster having multiple values.

V1.9.0: Deploying a PowerFlex cluster using ssh key

Mon, 01 Jan 0001 00:00:00 +0000

Deploying a PowerFlex cluster using ssh key for passwordless authentication

This guide explains how to use ssh keys for deploying a cluster using passwordless authentication

Steps for configuring ssh key

On one of the ScaleIO cluster machine:
- Go to ~/.ssh
- ssh-keygen -t rsa
cat id_rsa.pub > authorized_keys
If the RSA key was created in OpenSSH key format convert to pem format:
- ssh-keygen -p -m PEM -f ~/.ssh/id_rsa
Copy the id_rsa, id_rsa.pub and authorized_keys to ~/.ssh on the rest of the cluster machines
Replace the key text in block-legacy-gateway-sshkey.yaml (attached below) with the content of id_rsa
Delete the secret before setting it:
- kubectl delete -n powerflex secret platform-nodes-credentials
run on the M&O:
- kubectl apply -n powerflex -f
delete block-legacy-gateway pod
- legacy_gw=$(kubectl get pods -n powerflex|grep -i legacy-gateway |grep -v mds |awk ‘{print $1}’); kubectl delete pods -n powerflex $legacy_gw
Remove the value (leave empty) from all the “password” fields in the csv file

Example of block-legacy-gateway-sshkey.yaml file content

apiVersion: v1 kind: Secret metadata: name: platform-nodes-credentials type: Opaque stringData: id_rsa: | —–BEGIN RSA PRIVATE KEY—– PASTE THE RSA KEY HERE —–END RSA PRIVATE KEY—–

Example of cluster resource in case of passwordless authentication

In this case just remove the password attribute from the cluster resource .


resource "powerflex_cluster" "test" {
  mdm_password = "Password"
  lia_password = "Password"

  # Advance Security Configuration
  allow_non_secure_communication_with_lia = false
  allow_non_secure_communication_with_mdm = false
  disable_non_mgmt_components_auth        = false

  # Cluster Configuration related fields
  cluster = [
    {
      # MDM Configuration Fields
      username                 = "user",
      operating_system         = "linux",
      is_mdm_or_tb             = "Primary",
      mdm_ips                  = "10.10.10.1",
      mdm_mgmt_ip              = "10.10.10.1",
      mdm_name                 = "mdm1",
      perf_profile_for_mdm     = "HighPerformance",
      is_sds                   = "Yes",
      sds_name                 = "sds1",
      sds_all_ips              = "10.10.10.1",
      protection_domain        = "domain_1",
      sds_storage_device_list  = "/dev/sdb",
      sds_storage_device_names = "sdb",
      storage_pool_list        = "pool1",
      perf_profile_for_sds     = "HighPerformance",
      is_sdc                   = "Yes",
      sdc_name                 = "sdc1",
      perf_profile_for_sdc     = "HighPerformance"

    },
    {
      username                 = "user",
      password                 = "password",
      operating_system         = "linux",
      is_mdm_or_tb             = "Secondary",
      mdm_name                 = "mdm2",
      mdm_ips                  = "10.10.10.2",
      mdm_mgmt_ip              = "10.10.10.2",
      perf_profile_for_mdm     = "HighPerformance",
      is_sds                   = "Yes",
      sds_name                 = "sds2",
      sds_all_ips              = "10.10.10.2",
      sds_storage_device_list  = "/dev/sdb",
      sds_storage_device_names = "sdb",
      protection_domain        = "domain_1",
      storage_pool_list        = "pool1",
      perf_profile_for_sds     = "HighPerformance",
      is_sdc                   = "Yes",
      sdc_name                 = "sdc2",
      perf_profile_for_sdc     = "HighPerformance"
    },
    {
      username                 = "user",
      password                 = "password",
      operating_system         = "linux",
      is_mdm_or_tb             = "TB",
      mdm_name                 = "tb1",
      mdm_ips                  = "10.10.10.3",
      mdm_mgmt_ip              = "10.10.10.3",
      perf_profile_for_mdm     = "HighPerformance",
      is_sds                   = "Yes",
      sds_name                 = "sds3",
      sds_all_ips              = "10.10.10.3",
      sds_storage_device_list  = "/dev/sdb",
      sds_storage_device_names = "sdb",
      protection_domain        = "domain_1",
      storage_pool_list        = "pool1",
      perf_profile_for_sds     = "HighPerformance",
      is_sdc                   = "Yes",
      sdc_name                 = "sdc3",
      perf_profile_for_sdc     = "HighPerformance"
    }
  ]

    storage_pools = [
    {
      media_type        = "SSD"
      protection_domain = "domain_1"
      storage_pool      = "pool1"
      daya_layout       = "MG"
      zero_padding      = "true"
    }
  ]
}

This Terraform configuration sets up a PowerFlex cluster without using password.

V1.9.0: Deploying a PowerFlex SDC using a CSV Topology File

Mon, 01 Jan 0001 00:00:00 +0000

Deploying a PowerFlex SDC using a CSV Topology File

This guide explains how to use a CSV file as input for an SDC Resource.

Example

Note: In the CSV file, provide only Cluster Node-related details as shown in the example below:

sdc_input.csv

IPs,Password,Operating System,Is MDM/TB,Is SDC,perfProfileForSDC,SDC Name
10.10.10.10,password,linux,Primary,Yes,HighPerformance,SDC1
10.10.10.11,password,linux,Secondary,Yes,HighPerformance,SDC2
10.10.10.12,password,linux,TB,Yes,Compact,SDC3
10.10.10.13,password,linux,Standby,Yes,Compact,SDC4

To perform SDC operations via CSV file(s), use the following configuration:


locals {
  csv_data = csvdecode(file("data/sdc_input.csv"))
}

resource "powerflex_sdc" "sdc_rs" {
  mdm_password = "MDM_Password"
  lia_password = "LIA_Password"

  sdc_details = [
    for row in local.csv_data : {
      ip                  = row.IPs # if using complere config use row["MDM IPs"]
      password            = row.Password
      operating_system    = row["Operating System"]
      is_mdm_or_tb        = row["Is MDM/TB"]
      is_sdc              = row["Is SDC"]
      name                = row["SDC Name"]
      performance_profile = row.perfProfileForSDC
    }
    if row.IPs != "" && row.IPs != "null" && row.Password != "null"
  ]
}

This code demonstrates how you can use data from the CSV file to dynamically configure the powerflex_sdc resource.

locals: This section defines local variables within the Terraform configuration. These variables are used to store data or perform calculations within your configuration.

csv_data: This is a local variable that is being assigned the result of csvdecode(file(“sdc_input.csv”)). It decodes the content of the “sdc_input.csv” file into a data structure that can be used in the Terraform configuration.

file("sdc_input.csv"): This part of the code specifies the path to the CSV file. In this example, it assumes that “sdc_input.csv” is located in the same directory as your Terraform configuration file. If the CSV file is in a different directory, you can provide the relative or absolute path to that file. For example, if the CSV file is in a subdirectory named “data,” you can specify the path as file(“data/sdc_input.csv”).

sdc_details: This is an attribute of the powerflex_sdc resource. You are using a list comprehension (the for loop) to create a list of objects based on the data from the CSV file (local.csv_data). Each object represents a configuration for an SDC (Storage Data Client).

The fields inside the object (e.g., ip, password, operating_system, etc.) are populated with values from the CSV file. You are also applying some conditions in the if statement to filter out rows where IPs and Password are not empty and not equal to “null.”

V1.9.0: Environment Variables

Mon, 01 Jan 0001 00:00:00 +0000

Environment Variables Overview

This Guide will describe two common ways on how to use environment variables with terraform. For more information you may check out the terraform docs directly.

Export or Directly Set During Terraform Command

This section will desribe how to pass in environment variables directly during the terraform command.

main.tf

// Create a variable which will be assigned during the command
variable "foo" {
  type = string
}

data "example_datasource" "all" {
  filter {
    // Reference that variable how you would normally in terraform 
    name = [var.foo]
  }
}

Using the above example, to set the environment variable for foo you must use the prefix of TF_VAR_ + the name of the variable i.e: TF_VAR_foo. This will translate to setting the variable during the command.

Example Command: TF_VAR_foo="example-name" terraform plan

Export and then run the terraform command

export TF_VAR_foo="example-name"

This will execute terraform plan with the value of example-name for the variable foo.

Using the External Terraform Provider

This section will describe how to use environment variables using the external terraform provider

env.sh

cat << EOF
{
 "foo": "test"
}
EOF

main.tf

terraform {
  required_providers {
    external = {
      source = "hashicorp/external"
      version = "2.3.4"
    }
  }
}

# Run the script to get the environment variables of interest.
# This is a datasource, so it will run at plan time.
data "external" "env" {
  program = ["bash", "env.sh"]
}

# Show the results of running the datasource. This is a map of environment
# variable names to their values.
output "env" {
  value = data.external.env.result
}

data "example_datasource" "all" {
  filter {
    name = [data.external.env.result["foo"]]
  }
}

In this example there are 2 files.

env.sh This creates the input for the environment variables you would like to pass into and use in the terraform configuration main.tf
main.tf this defines the external datasource which takes in the output from the external datasource and then it can be used in the example_datasource filter i.e data.external.env.result["foo"]

V1.9.0: Import existing volume mappings of SDC

Mon, 01 Jan 0001 00:00:00 +0000

Importing existing volume mappings of SDC using sdc_volumes_mapping resource

This guide explains how to import volumes mapped to SDC using sdc_volumes_mapping_resource. Below steps are taken from this article.

Step 1: Add the import block

    import {
        to = powerflex_sdc_volumes_mapping.test
        id = "sdc_id"
    }

Step 2: Plan and generate configuration

    terraform plan -generate-config-out=test.tf

Step 3: Review generated configuration in test.tf

Step 4: Run terraform apply to import the volumes mapped to SDC. Choose only one argument from mutually exclusive arguments.

For example, choose either volume_id or volume_name from sdc_volumes_mapping resource.

V1.9.0: Installing a SDC on a PowerFlex cluster using multiple values for IP

Mon, 01 Jan 0001 00:00:00 +0000

Installing a SDC on a PowerFlex cluster using multiple values for IP

This guide explains how to install a SDC in case of multiple values for IP.

Example

resource "powerflex_sdc" "sdc-example" {
  mdm_password = "Password
  lia_password = "Password"
  sdc_details = [
    {
      ip                  = "10.10.10.1,10.10.10.2,10.10.10.3" 
      username            = "user"
      password            = "password"
      operating_system    = "linux"
      is_mdm_or_tb        = "Primary"
      is_sdc              = "Yes"
      name                = "SDC_PRIMARY"
      performance_profile = "HighPerformance"
      virtual_ips         = "10.10.10.4,10.10.10.5"
      virtual_ip_nics     = "eth1,eth2"
      data_network_ip     = "10.10.10.2,10.10.10.3"
    },
    {
      ip                  = "10.10.10.6,10.10.10.7,10.10.10.8" 
      username            = "user"
      password            = "password"
      operating_system    = "linux"
      is_mdm_or_tb        = "Secondary"
      is_sdc              = "Yes"
      name                = "SDC_SECONDARY"
      performance_profile = "HighPerformance"
      virtual_ips         = "10.10.10.4,10.10.10.5"
      virtual_ip_nics     = "eth1,eth2"
      data_network_ip     = "10.10.10.7,10.10.10.8"
    },
    {
      ip                  = "10.10.10.9,10.10.10.10,10.10.10.11" 
      username            = "user"
      password            = "password"
      operating_system    = "linux"
      is_mdm_or_tb        = "TB"
      is_sdc              = "Yes"
      name                = "SDC_TB"
      performance_profile = "Compact"
      data_network_ip     = "10.10.10.10,10.10.10.11"
    },
    {
      ip               = "10.10.10.12"
      username         = "user"
      password         = "password"
      operating_system = "linux"
      is_mdm_or_tb     = "Standby"
      is_sdc           = "Yes"
    }
  ]
}

V1.9.0: powerflex_cluster resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_cluster (Resource)

This terraform resource is used to deploy the PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of the PowerFlex.

Please consider the following points before using cluster resource.

For PowerFlex 4.x, the PowerFlex Manager must be installed as a prerequisite. The required packages should be uploaded to the PowerFlex Manager.
For PowerFlex 3.x, a Gateway server is a prerequisite. The required packages should be uploaded to the gateway. The Package resource can be used for uploading packages to the gateway.
Support is provided for creating, importing, and deleting operations for this resource.
In multi-node cluster deployments, when some of the component installations fail, the partial deployment will not be rolled back.
If you’ve separately installed any SDR, SDS, or SDC and connected it to the cluster and if you face any security certificate issues during the destroy process, you’ll have to manually accept the security certificate to resolve them.
During the destroy process, the entire cluster will be destroyed, not just specific individual resources. After destroy need to follow cleanup process.
ips attribute is used in minimal csv configuration whereas mdm_ips attribute is used in complete csv configuration.
For PowerFlex 4.x, there’s no need to mention allow_non_secure_communication_with_lia, allow_non_secure_communication_with_mdm, and disable_non_mgmt_components_auth. And, Rfcache is not supported.
To follow the installation process, you can refer to the Deployment Guide 3.x & Deployment Guide 4.x
NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore SDT deployment is not supported in PowerFlex 3.x.

Example Usage

/*
Copyright (c) 2023-2026 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.
*/

# Command to run this tf file : terraform init && terraform plan && terraform apply.
# Create, Read, Delete and Import operations are supported for this resource.

# Example for deploying cluster. After successful execution, 3 node MDM cluster will be deployed with 3 SDCs and 2 SDS.
resource "powerflex_package" "upload-test" {
  file_path = ["/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-lia-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-mdm-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sds-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sdc-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sdr-3.6-700.103.el7.x86_64.rpm",
  "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sdt-3.6-700.103.el7.x86_64.rpm"]
}

resource "powerflex_cluster" "test" {

  depends_on = [powerflex_package.upload-test]

  # Security Related Field
  mdm_password = "Password"
  lia_password = "Password"

  # Advance Security Configuration
  allow_non_secure_communication_with_lia = false
  allow_non_secure_communication_with_mdm = false
  disable_non_mgmt_components_auth        = false

  # Cluster Configuration related fields 
  cluster = [
    {
      # MDM Configuration Fields 
      ips                  = "10.10.10.1",
      username             = "root",
      password             = "Password",
      operating_system     = "linux",
      is_mdm_or_tb         = "primary",
      mdm_ips              = "10.10.10.1",
      mdm_mgmt_ip          = "10.10.10.1",
      mdm_name             = "MDM_1",
      perf_profile_for_mdm = "HighPerformance",
      virtual_ips          = "10.30.30.1",
      virtual_ip_nics      = "ens192",

      # SDS Configuration Fields
      is_sds      = "yes",
      sds_name    = "sds1",
      sds_all_ips = "10.20.20.3", # conflict with sds_to_sds_only_ips,sds_to_sdc_only_ips
      # sds_to_sdc_only_ips      = "10.20.20.2", 
      # sds_to_sds_only_ips      = "10.20.20.1",
      fault_set                = "fs1",
      protection_domain        = "domain_1"
      sds_storage_device_list  = "/dev/sdb"
      sds_storage_device_names = "device1"
      storage_pool_list        = "pool1"
      perf_profile_for_sds     = "HighPerformance"

      # SDC Configuration Fields
      is_sdc               = "yes",
      sdc_name             = "sdc1",
      perf_profile_for_sdc = "HighPerformance",

      # Rfcache Configuration Fields
      is_rfcache               = "No",
      rf_cache_ssd_device_list = "/dev/sdd"

      # SDR Configuration Fields
      is_sdr   = "Yes",
      sdr_name = "SDR_1"
      sdr_port = "2000"
      # sdr_application_ips  = "10.20.30.1"
      # sdr_storage_ips      = "10.20.30.2"
      # sdr_external_ips     = "10.20.30.3" 
      sdr_all_ips          = "10.10.20.1" # conflict with sdr_application_ips, sdr_storage_ips, sdr_external_ips
      perf_profile_for_sdr = "Compact"

      # SDT Configuration Fields
      is_sdt      = "Yes"
      sdt_name    = "SDT_1"
      sdt_all_ips = "10.20.40.1"
    },
    {
      ips                     = "10.10.10.2",
      username                = "root",
      password                = "Password",
      operating_system        = "linux",
      is_mdm_or_tb            = "Secondary",
      protection_domain       = "domain_1"
      sds_storage_device_list = "/dev/sdb"
      storage_pool_list       = "pool1"
      is_sds                  = "yes",
      sds_name                = "sds2",
      is_sdc                  = "yes",
      sdc_name                = "sdc2",
      perf_profile_for_sdc    = "compact",
      is_rfcache              = "No",
      is_sdr                  = "No",
      is_sdt                  = "Yes"
      sdt_name                = "SDT_2"
      sdt_all_ips             = "10.20.40.2"
    },
    {
      ips                  = "10.10.10.3",
      username             = "root",
      password             = "Password",
      operating_system     = "linux",
      is_mdm_or_tb         = "TB",
      is_sds               = "No",
      is_sdc               = "yes",
      sdc_name             = "sdc3",
      perf_profile_for_sdc = "compact",
      is_rfcache           = "No",
      is_sdr               = "No",
      is_sdt               = "No"
    },
  ]
  # Storage Pool Configuration Fields
  storage_pools = [
    {
      media_type                              = "HDD"
      protection_domain                       = "domain_1"
      storage_pool                            = "pool1"
      replication_journal_capacity_percentage = "50"
    }
  ]
}

After the execution of above resource block, Cluster would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

cluster (Attributes List) Cluster Installation Details (see below for nested schema)
lia_password (String, Sensitive) Lia Password
mdm_password (String, Sensitive) MDM Password

Optional

allow_non_secure_communication_with_lia (Boolean) Allow Non Secure Communication With lia
allow_non_secure_communication_with_mdm (Boolean) Allow Non Secure Communication With MDM
disable_non_mgmt_components_auth (Boolean) Disable Non Mgmt Components Auth
id (String) ID
storage_pools (Attributes List) Storage Pool Details (see below for nested schema)

Read-Only

mdm_list (Attributes Set) Cluster MDM Details (see below for nested schema)
protection_domains (Attributes List) Cluster Protection Domain Details (see below for nested schema)
sdc_list (Attributes Set) Cluster SDC Details (see below for nested schema)
sdr_list (Attributes Set) Cluster SDR Details (see below for nested schema)
sds_list (Attributes Set) Cluster SDS Details (see below for nested schema)
sdt_list (Attributes Set) Cluster SDT Details (see below for nested schema)

Nested Schema for `cluster`

Required:

is_mdm_or_tb (String) Is Mdm Or Tb
operating_system (String) Operating System

Optional:

fault_set (String) Fault Set
ips (String) Use this field to assign a single IP address for all the MDM IP, MDM Mgmt IP, and SDS All IP. This option is useful when separate networks for data and management are not required.
is_rfcache (String) Is RFCache. The acceptable values are Yes and No. Default value is No.
is_sdc (String) Is Sdc. The acceptable values are Yes and No. Default value is No.
is_sdr (String) Is SDR. The acceptable values are Yes and No. Default value is No.
is_sds (String) Is Sds. The acceptable values are Yes and No. Default value is No.
is_sdt (String) Is Sdt. The acceptable values are Yes and No. Default value is No.
mdm_ips (String) MDM IP addresses used to communicate with other PowerFlex components in the storage network. This is required for all MDMs, Tiebreakers and Standbys.Leave this field blank for hosts that are not part of the MDM cluster.
mdm_mgmt_ip (String) This IP address is for the management-only network. The management ip is not required for Tiebreaker MDM, Standby Tiebreaker MDM and any host that is not an MDM.
mdm_name (String) MDMName
password (String, Sensitive) Password used to log in to the node.
perf_profile_for_mdm (String) Performance Profile For MDM
perf_profile_for_sdc (String) Performance Profile For SDC
perf_profile_for_sdr (String) Performance Profile For SDR
perf_profile_for_sds (String) Performance Profile For SDS
protection_domain (String) Protection Domain
rf_cache_ssd_device_list (String) List of SSD devices to provide RFcache acceleration for Medium Granularity data layout Storage Pools.
sdc_name (String) SDC Name
sdr_all_ips (String) SDR IP addresses to be used for communication among all nodes (including all three roles)
sdr_application_ips (String) The IP addresses through which the SDC communicates with the SDR.
sdr_external_ips (String) The IP addresses through which the SDR communicates with peer systems SDRs
sdr_name (String) SDR Name
sdr_port (String) SDR Port
sdr_storage_ips (String) The IP addresses through which the SDR communicates with the MDM for server side control communications.
sds_all_ips (String) SDS IP addresses to be used for communication among all nodes.
sds_name (String) SDS Name
sds_storage_device_list (String) Storage devices to be added to an SDS. For more than one device, use a comma separated list, with no spaces.
sds_storage_device_names (String) Sets names for devices.
sds_to_sdc_only_ips (String) SDS IP addresses to be used for communication among SDS and SDC nodes only.
sds_to_sds_only_ips (String) SDS IP addresses to be used for communication among SDS nodes. When the replication feature is used, these addresses are also used for SDS-SDR communication.
sdt_all_ips (String) SDT IP addresses used for both hosts communication and MDM communication (including both roles).
sdt_name (String) SDT Name
storage_pool_list (String) Sets Storage Pool names
username (String) The value can be either root or any non-root user name with appropriate permissions.
virtual_ip_nics (String) The NIC to which the virtual IP addresses are mapped.
virtual_ips (String) Virtual IPs

Nested Schema for `storage_pools`

Required:

media_type (String) Media Type

Optional:

compression_method (String) Compression Method
data_layout (String) Data Layout
external_acceleration (String) External Acceleration
protection_domain (String) Protection Domain
replication_journal_capacity_percentage (String) Replication Journal Capacity Percentage
storage_pool (String) Storage Pool
zero_padding (String) Zero Padding

Nested Schema for `mdm_list`

Read-Only:

id (String) ID
ip (String) MDM Node IP
mdm_ip (String) MDM IP
mgmt_ip (String) MGMTIP
mode (String) Mode
name (String) Name
role (String) Role
virtual_ip (String) Virtual IP
virtual_ip_nic (String) Virtual IPNIC

Nested Schema for `protection_domains`

Read-Only:

name (String) Name
storage_pool_list (Attributes List) Storage Pools (see below for nested schema)

Nested Schema for `protection_domains.storage_pool_list`

Read-Only:

compression_method (String) Compression Method
data_layout (String) Data Layout
external_acceleration (String) External Acceleration
media_type (String) Media Type
name (String) Name
replication_journal_capacity_percentage (Number) Replication Journal Capacity Percentage
zero_padding (String) Zero Padding

Nested Schema for `sdc_list`

Read-Only:

guid (String) GUID
id (String) ID
ip (String) SDC Node IP
name (String) Name

Nested Schema for `sdr_list`

Read-Only:

all_ips (String) All IP
application_ips (String) Application IP
external_ips (String) External IP
id (String) ID
ip (String) SDR Node IP
name (String) Name
port (Number) Port
storage_ips (String) Storage IP

Nested Schema for `sds_list`

Read-Only:

all_ips (String) All IP
devices (Attributes Set) Devices (see below for nested schema)
fault_set (String) Fault Set
id (String) ID
ip (String) SDS Node IP
name (String) Name
protection_domain_id (String) Protection Domain Name
protection_domain_name (String) Protection Domain Name
sds_only_ips (String) SDSOnly IP
sds_sdc_ips (String) SDSSDCIP

Nested Schema for `sds_list.devices`

Read-Only:

max_capacity_in_kb (Number) Max Capacity
name (String) Name
path (String) Path
storage_pool (String) Storage Pool Name

Nested Schema for `sdt_list`

Read-Only:

all_ips (String) All IP
discovery_port (Number) Discovery Port
host_only_ips (String) Host Only IP
id (String) ID
ip (String) SDT Node IP
name (String) Name
nvme_port (Number) NVMe Port
protection_domain_id (String) Protection Domain Name
protection_domain_name (String) Protection Domain Name
storage_only_ips (String) Storage Only IP
storage_port (Number) Storage Port

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2023-2026 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.
# */

# import existing cluster
terraform import powerflex_cluster.cluster_data "<MDM_IP>,<MDM_Password>,<LIA_Password>"

This will import the cluster instance using specified details into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_compatibility_management data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_compatibility_management (Data Source)

This datasource is used to query the existing compatibility management from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve
# empty block of the powerflex_compatibility_management datasource will give return the compatibility management details

data "powerflex_compatibility_management" "default" {
}

output "default" {
  value = data.powerflex_compatibility_management.default
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_compatibility_management.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

repository_path (String) Repository Path of the Compatibility Management Instance.

Read-Only

available_version (String) Available Version of the Compatibility Management Instance.
compatibility_data (String) Compatibility Data of the Compatibility Management Instance.
compatibility_data_bytes (String) Compatibility Data Bytes of the Compatibility Management Instance.
current_version (String) Current Version of the Compatibility Management Instance.
id (String) Unique identifier of the Compatibility Management Instance.
source (String) Source of the Compatibility Management Instance.

V1.9.0: powerflex_compatibility_management resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_compatibility_management (Resource)

This resource is used to set the compatibility management from the PowerFlex array.

Example Usage

/*
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.
*/

# Command to run this tf file : terraform init && terraform plan && terraform apply.

// Resource to manage lifecycle
resource "terraform_data" "always_run" {
  input = timestamp()
}

# Example for setting compatibility management. After successful execution, device will be added to the specified storage pool
resource "powerflex_compatibility_management" "test" {
  # Required Path on your local machine to your gpg file ie(/example/path/secring.gpg)
  repository_path = "/example/path/example.gpg"

  // This will allow terraform create process to trigger each time we run terraform apply.
  lifecycle {
    replace_triggered_by = [
      terraform_data.always_run
    ]
  }
}

After the execution of above resource block, compatibility management would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

repository_path (String) Repository Path on your local machine to your compatibility gpg file ie: /example/example.gpg.

Read-Only

available_version (String) Available Version of the Compatibility Management Instance.
compatibility_data (String) Compatibility Data of the Compatibility Management Instance.
compatibility_data_bytes (String) Compatibility Data Bytes of the Compatibility Management Instance.
current_version (String) Current Version of the Compatibility Management Instance.
id (String) Unique identifier of the Compatibility Management Instance.
source (String) Source of the Compatibility Management Instance.

V1.9.0: powerflex_compliance_report_resource_group data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_compliance_report_resource_group (Data Source)

This datasource is used to query the compliance report for Resource Group from PowerFlex array.

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve
# Get all Resource Group details present in the PowerFlex
data "powerflex_compliance_report_resource_group" "example1" {
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_compliance_report_resource_group" "compliance_report_resource_group_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     model = ["^Powerflex.*$"]
#   }
# }

# output "complianceReportResourceGroupFilterRegexResult"{
#  value = data.powerflex_compliance_report_resource_group.compliance_report_resource_group_filter_regex.compliance_reports
# }

# this datasource supports multiple filters like ip_address, host_name, service_tag, compliant,etc.
# Note: If both filters are used simultaneously, the results will include any records that match either of the filters.
# data "powerflex_compliance_report_resource_group" "complianceReport" {
#   filter {
#      firmware_repository_name = ["name1", "name2"]
#      device_type  = ["devicetype1", "devicetype2"]
#      model = ["model1", "model2"]
#      service_tag = ["servicetag1", "servicetag2"]
#      compliant = true
#      embedded_report = true
#      can_update = true
#      available = true
#      device_state  = ["devicestate1", "devicestate2"]
#      managed_state = ["managedstate1", "managedstate2"]
#      host_name = ["hostname1", "hostname2"]
#      id = ["id1", "id2"]
#      ip_address = ["ip1", "ip2"]
#   }
# }

output "result" {
  value = data.powerflex_compliance_report_resource_group.example1.compliance_reports
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_compliance_report_resource_group.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

compliance_reports (Attributes List) List of compliance report. (see below for nested schema)
id (String) Unique identifier Of The compliance report Datasource.

Nested Schema for `filter`

Optional:

available (Boolean) Value for available
can_update (Boolean) Value for can_update
compliant (Boolean) Value for compliant
device_state (Set of String) List of device_state
device_type (Set of String) List of device_type
embedded_report (Boolean) Value for embedded_report
firmware_repository_name (Set of String) List of firmware_repository_name
host_name (Set of String) List of host_name
id (Set of String) List of id
ip_address (Set of String) List of ip_address
managed_state (Set of String) List of managed_state
model (Set of String) List of model
service_tag (Set of String) List of service_tag

Nested Schema for `compliance_reports`

Read-Only:

available (Boolean) The availability status of the device.
can_update (Boolean) The update capability of the resource group.
compliant (Boolean) The compliance status of the resource.
device_state (String) The state of the device.
device_type (String) The type of the device.
embedded_report (Boolean) The presence of an embedded report.
firmware_compliance_report_components (Attributes List) The list of firmware compliance report components. (see below for nested schema)
firmware_repository_name (String) The name of the firmware repository.
host_name (String) The hostname of the resource group.
id (String) The unique identifier of the resource group.
ip_address (String) The IP address of the resource.
managed_state (String) The managed state of the device.
model (String) The model of the device.
service_tag (String) The service tag of the resource.

Nested Schema for `compliance_reports.firmware_compliance_report_components`

Read-Only:

compliant (Boolean) The compliance status of the component.
current_version (Attributes) The current version of the component. (see below for nested schema)
id (String) The unique identifier of the component.
name (String) The name of the component.
operating_system (String) The operating system of the component.
os_compatible (Boolean)
rpm (Boolean)
software (Boolean)
target_version (Attributes) The target version of the component. (see below for nested schema)
vendor (String) The vendor of the component.

Nested Schema for `compliance_reports.firmware_compliance_report_components.current_version`

Read-Only:

firmware_last_update (String) The last update time of the firmware.
firmware_level (String) The level of the firmware.
firmware_name (String) The name of the firmware.
firmware_type (String) The type of the firmware.
firmware_version (String) The version of the firmware.
id (String) The unique identifier of the version.

Nested Schema for `compliance_reports.firmware_compliance_report_components.target_version`

Read-Only:

firmware_last_update (String) The last update time of the firmware.
firmware_level (String) The level of the firmware.
firmware_name (String) The name of the firmware.
firmware_type (String) The type of the firmware.
firmware_version (String) The version of the firmware.
id (String) The unique identifier of the version.

V1.9.0: powerflex_device data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_device (Data Source)

This datasource is used to query the existing device from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Example Usage

/*
Copyright (c) 2023-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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve
# empty block of the powerflex_device datasource will give list of all device within the system

data "powerflex_device" "all" {
}

output "deviceResult" {
  value = data.powerflex_device.all.device_model
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_device" "device_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     temperature_state = ["^.*Failed$"]
#   }
# }

# output "faultSetFilterRegexResult"{
#  value = data.powerflex_device.device_filter_regex.device_model
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/ 
data "powerflex_device" "filter" {
  filter {
    # fgl_nvdimm_metadata_amortization_x100 = [1,2]
    # logical_sector_size_in_bytes = [1,2]
    # fgl_nvdimm_write_cache_size = [1,2]
    # acceleration_pool_id = ["acceleration_pool_id1", "acceleration_pool_id2"]
    # sds_id = ["sds_id1", "sds_id2"]
    # storage_pool_id = ["storage_pool_id1", "storage_pool_id2"]
    # capacity_limit_in_kb = [1,2]
    # error_state = ["error_state1", "error_state2"]
    # capacity = [1,2]
    # device_type = ["device_type1", "device_type2"]
    # persistent_checksum_state = ["persistent_checksum_state1", "persistent_checksum_state2"]
    # device_state = ["device_state1", "device_state2"]
    # led_setting = ["led_setting1", "led_setting2"]
    # max_capacity_in_kb = [1,2]
    # sp_sds_id = ["sp_sds_id1", "sp_sds_id2"]
    # aggregated_state = ["aggregated_state1", "aggregated_state2"]
    # temperature_state = ["temperature_state1", "temperature_state2"]
    # ssd_end_of_life_state = ["ssd_end_of_life_state1", "ssd_end_of_life_state2"]
    # model_name = ["model_name1", "model_name2"]
    # vendor_name = ["vendor_name1", "vendor_name2"]
    # raid_controller_serial_number = ["raid_controller_serial_number1", "raid_controller_serial_number2"]
    # firmware_version = ["firmware_version1", "firmware_version2"]
    # cache_look_ahead_active = false
    # write_cache_active = false
    # ata_security_active = false
    # physical_sector_size_in_bytes = [1,2]
    # media_failing = false
    # slot_number = ["slot1", "slot2"]
    # external_acceleration_type = ["external_acceleration_type1", "external_acceleration_type2"]
    # auto_detect_media_type = ["auto_detect_media_type1", "auto_detect_media_type2"]
    # device_current_path_name = ["device_current_path_name1", "device_current_path_name2"]
    # device_original_path_name = ["device_original_path_name1", "device_original_path_name2"]
    # rfcache_error_device_does_not_exist = false
    # media_type = ["SSD", "HDD"]
    # serial_number = ["serial_number1", "serial_number2"]
    # name = ["name1", "name2"]
    # id = ["id1", "id2"]
  }
}

output "deviceFilterResult" {
  value = data.powerflex_device.filter.device_model
}

After the successful execution of above said block, We can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_device.dev.attribute_name where attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

device_model (Attributes List) List of devices fetched. (see below for nested schema)
id (String) Placeholder id of device datasource.

Nested Schema for `filter`

Optional:

acceleration_pool_id (Set of String) List of acceleration_pool_id
aggregated_state (Set of String) List of aggregated_state
ata_security_active (Boolean) Value for ata_security_active
auto_detect_media_type (Set of String) List of auto_detect_media_type
cache_look_ahead_active (Boolean) Value for cache_look_ahead_active
capacity (Set of Number) List of capacity
capacity_limit_in_kb (Set of Number) List of capacity_limit_in_kb
device_current_path_name (Set of String) List of device_current_path_name
device_original_path_name (Set of String) List of device_original_path_name
device_state (Set of String) List of device_state
device_type (Set of String) List of device_type
error_state (Set of String) List of error_state
external_acceleration_type (Set of String) List of external_acceleration_type
fgl_nvdimm_metadata_amortization_x100 (Set of Number) List of fgl_nvdimm_metadata_amortization_x100
fgl_nvdimm_write_cache_size (Set of Number) List of fgl_nvdimm_write_cache_size
firmware_version (Set of String) List of firmware_version
id (Set of String) List of id
led_setting (Set of String) List of led_setting
logical_sector_size_in_bytes (Set of Number) List of logical_sector_size_in_bytes
max_capacity_in_kb (Set of Number) List of max_capacity_in_kb
media_failing (Boolean) Value for media_failing
media_type (Set of String) List of media_type
model_name (Set of String) List of model_name
name (Set of String) List of name
persistent_checksum_state (Set of String) List of persistent_checksum_state
physical_sector_size_in_bytes (Set of Number) List of physical_sector_size_in_bytes
raid_controller_serial_number (Set of String) List of raid_controller_serial_number
rfcache_error_device_does_not_exist (Boolean) Value for rfcache_error_device_does_not_exist
sds_id (Set of String) List of sds_id
serial_number (Set of String) List of serial_number
slot_number (Set of String) List of slot_number
sp_sds_id (Set of String) List of sp_sds_id
ssd_end_of_life_state (Set of String) List of ssd_end_of_life_state
storage_pool_id (Set of String) List of storage_pool_id
temperature_state (Set of String) List of temperature_state
vendor_name (Set of String) List of vendor_name
write_cache_active (Boolean) Value for write_cache_active

Nested Schema for `device_model`

Read-Only:

acceleration_pool_id (String) Acceleration Pool_id Of The Device Instance.
acceleration_props (Attributes) Acceleration Props Of The Device Instance. (see below for nested schema)
aggregated_state (String) Aggregated State Of The Device Instance.
ata_security_active (Boolean) Ata Security Active Of The Device Instance.
auto_detect_media_type (String) Auto Detect Media Type Of The Device Instance.
cache_look_ahead_active (Boolean) Cache Look Ahead Active Of The Device Instance.
capacity (Number) Capacity Of The Device Instance.
capacity_limit_in_kb (Number) Capacity Limit In Kb Of The Device Instance.
device_current_path_name (String) Device Current Path Name Of The Device Instance.
device_original_path_name (String) Device Original Path Name Of The Device Instance.
device_state (String) State Of The Device Instance.
device_type (String) Device Type Of The Device Instance.
error_state (String) Error State Of The Device Instance.
external_acceleration_type (String) External Acceleration Type Of The Device Instance.
fgl_nvdimm_metadata_amortization_x100 (Number) Fgl Nvdimm Metadata Amortization X100 Of The Device Instance.
fgl_nvdimm_write_cache_size (Number) Fgl Nvdimm Write Cache Size Of The Device Instance.
firmware_version (String) Firmware Version Of The Device Instance.
id (String) Unique ID Of The Device Instance.
led_setting (String) LED Setting Of The Device Instance.
links (Attributes List) Underlying REST API links. (see below for nested schema)
logical_sector_size_in_bytes (Number) Logical Sector Size In Bytes Of The Device Instance.
long_successful_ios (Attributes) Long Successful Ios Of The Device Instance. (see below for nested schema)
max_capacity_in_kb (Number) Max Capacity In Kb Of The Device Instance.
media_failing (Boolean) Media Failing Of The Device Instance.
media_type (String) Media Type Of The Device Instance.
model_name (String) Model Name Of The Device Instance.
name (String) Name Of The Device Instance.
persistent_checksum_state (String) Persistent Checksum State Of The Device Instance.
physical_sector_size_in_bytes (Number) Physical Sector Size In Bytes Of The Device Instance.
raid_controller_serial_number (String) Raid Controller Serial Number Of The Device Instance.
rfcache_error_device_does_not_exist (Boolean) Rfcache Error Device Does Not Exist Of The Device Instance.
rfcache_props (Attributes) Rfcache Props Of The Device Instance. (see below for nested schema)
sds_id (String) Sds ID Of The Device Instance.
serial_number (String) Serial Number Of The Device Instance.
slot_number (String) Slot Number Of The Device Instance.
sp_sds_id (String) Sp Sds Id Of The Device Instance.
ssd_end_of_life_state (String) Ssd End Of Life State Of The Device Instance.
storage_pool_id (String) Storage Pool ID Of The Device Instance.
storage_props (Attributes) Storage Props Of The Device Instance. (see below for nested schema)
temperature_state (String) Temperature State Of The Device Instance.
vendor_name (String) Vendor Name Of The Device Instance.
write_cache_active (Boolean) Write Cache Active Of The Device Instance.

Nested Schema for `device_model.acceleration_props`

Read-Only:

acc_used_capacity_in_kb (String) Accelerator(ACC) Used Capacity In KB Acceleration Properties Parameters Of The Device Instance.

Nested Schema for `device_model.links`

Read-Only:

href (String) Specifies the exact path to fetch the details.
rel (String) Specifies the relationship with the Protection Domain.

Nested Schema for `device_model.long_successful_ios`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `device_model.long_successful_ios.long_window`

Read-Only:

last_oscillation_count (Number) Last Oscillation Count Window Parameters Of The Device Instance.
last_oscillation_time (Number) Last Oscillation Time Window Parameters Of The Device Instance.
max_failures_count (Number) Max Failures Count Window Parameters Of The Device Instance.
threshold (Number) Threshold Window Parameters Of The Device Instance.
window_size_in_sec (Number) Window Size in seconds Window Parameters Of The Device Instance.

Nested Schema for `device_model.long_successful_ios.medium_window`

Read-Only:

last_oscillation_count (Number) Last Oscillation Count Window Parameters Of The Device Instance.
last_oscillation_time (Number) Last Oscillation Time Window Parameters Of The Device Instance.
max_failures_count (Number) Max Failures Count Window Parameters Of The Device Instance.
threshold (Number) Threshold Window Parameters Of The Device Instance.
window_size_in_sec (Number) Window Size in seconds Window Parameters Of The Device Instance.

Nested Schema for `device_model.long_successful_ios.short_window`

Read-Only:

last_oscillation_count (Number) Last Oscillation Count Window Parameters Of The Device Instance.
last_oscillation_time (Number) Last Oscillation Time Window Parameters Of The Device Instance.
max_failures_count (Number) Max Failures Count Window Parameters Of The Device Instance.
threshold (Number) Threshold Window Parameters Of The Device Instance.
window_size_in_sec (Number) Window Size in seconds Window Parameters Of The Device Instance.

Nested Schema for `device_model.rfcache_props`

Read-Only:

device_uuid (String) Device UUID RfCache Parameters Of The Device Instance.
rfcache_error_card_io_error (Boolean) Rfcache Error Card Io error RfCache Parameters Of The Device Instance.
rfcache_error_heavy_load_cache_skip (Boolean) rfcache_error_heavy_load_cache_skip RfCache Parameters Of The Device Instance.
rfcache_error_stuck_io (Boolean) Rfcache Error Stuck Io RfCache Parameters Of The Device Instance.

Nested Schema for `device_model.storage_props`

Read-Only:

checksum_acc_device_id (String) Checksum Accelerator(ACC) Device ID Storage Properties Parameters Of The Device Instance.
checksum_changelog_acc_device_id (String) Checksum Changelog Accelerator(ACC) Device ID Storage Properties Parameters Of The Device Instance.
checksum_changelog_size_mb (Number) Checksum Changelog Size MB Storage Properties Parameters Of The Device Instance.
checksum_mode (String) Checksum Mode Storage Properties Parameters Of The Device Instance.
checksum_size_mb (Number) Checksum Size MB Storage Properties Parameters Of The Device Instance.
dest_checksum_acc_device_id (String) Destination Checksum Accelerator(ACC) Device ID Storage Properties Parameters Of The Device Instance.
dest_checksum_changelog_acc_device_id (String) Destination Checksum Changelog Accelerator(ACC) Device ID Storage Properties Parameters Of The Device Instance.
dest_checksum_changelog_size_mb (Number) Destination Checksum Changelog Size MB Storage Properties Parameters Of The Device Instance.
dest_checksum_mode (String) Destination Checksum Mode Storage Properties Parameters Of The Device Instance.
dest_fgl_acc_device_id (String) Destination FGL(Fujitsu General Limited) Accelerator(ACC) Device ID Storage Properties Parameters Of The Device Instance.
dest_fgl_nvdimm_size_mb (Number) Destination FGL(Fujitsu General Limited) Non-Volatile Dual In-line Memory Module(NVDIMM) Size In MB Storage Properties Parameters Of The Device Instance.
fgl_acc_device_id (String) FGL(Fujitsu General Limited) Accelerator(ACC) Device Id Storage Properties Parameters Of The Device Instance.
fgl_nvdimm_size_mb (Number) FGL(Fujitsu General Limited) Non-Volatile Dual In-line Memory Module(NVDIMM) Size In MB Storage Properties Parameters Of The Device Instance.
is_checksum_fully_calculated (Boolean) Is Checksum Fully Calculated Storage Properties Parameters Of The Device Instance.

V1.9.0: powerflex_device resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_device (Resource)

This resource is used to manage the Device entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex Devices using this resource. We can also import an existing device from PowerFlex array.

Caution: Device creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). If the taint is not removed, terraform will destroy and recreate the resource.

Note: Either storage_pool_name or storage_pool_id is required. But not both.

Note: Either sds_name or sds_id is required. But not both.

Note: If storage_pool_name is mentioned, we must specify either protection_domain_id or protection_domain_name but not both.

Example Usage

/*
Copyright (c) 2023-2026 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.
*/

# Command to run this tf file : terraform init && terraform plan && terraform apply.

# Example for adding device. After successful execution, device will be added to the specified storage pool
resource "powerflex_device" "test-device" {
  device_path            = "/dev/sdc"
  storage_pool_name      = "pool1"
  protection_domain_name = "domain1"
  sds_name               = "SDS_2"
  media_type             = "HDD" # HDD/SSD
}

After the execution of above resource block, device would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

device_path (String) The current path of the device. Cannot be updated.

Optional

device_capacity (Number) Capacity of the device in GB.
device_group_id (String) Device Group ID (Gen2 5.x only). Replaces storage_pool_id for Gen2 systems.
external_acceleration_type (String) External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
media_type (String) Media type of the device. Valid values are HDD, SSD.
name (String) The name of the device.
protection_domain_id (String) ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
protection_domain_name (String) Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
sds_id (String) ID of the SDS. Conflicts with sds_name. Cannot be updated. Deprecated in Gen2 5.x — use storage_node_id instead.
sds_name (String) Name of the SDS. Conflicts with sds_id. Cannot be updated. Deprecated in Gen2 5.x — use storage_node_id instead.
storage_node_id (String) Storage Node ID (Gen2 5.x only). Replaces sds_id for Gen2 systems.
storage_pool_id (String) ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
storage_pool_name (String) Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.

Read-Only

device_capacity_in_kb (Number) Capacity of the device in KB.
device_original_path (String) Original path of the device.
device_state (String) State of the device.
id (String) The ID of the device.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2023-2026 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.
# */

# import Protection Device by it's id
terraform import powerflex_device.device_data "<id>"

This will import the device instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_device_action_v2 resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_device_action_v2 (Resource)

This resource is used to perform Gen2 device actions on PowerFlex systems (5.0+). Supported actions: activate, clear_error, set_capacity_limit.

Example Usage

/*
Copyright (c) 2024-2026 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.
*/

# Commands to run this tf file : terraform init && terraform plan && terraform apply
# This resource performs actions on devices (Gen2 systems 5.0+)
# Supported actions: activate, clear_error, set_capacity_limit
# device_id and action are required
# capacity_limit_in_kb is required when action is set_capacity_limit

# Example: Activate a device
resource "powerflex_device_action_v2" "activate" {
  device_id = "0123456789abcdef"
  action    = "activate"
}

# Example: Clear device error
resource "powerflex_device_action_v2" "clear_error" {
  device_id = "0123456789abcdef"
  action    = "clear_error"
}

# Example: Set device capacity limit
resource "powerflex_device_action_v2" "set_capacity" {
  device_id            = "0123456789abcdef"
  action               = "set_capacity_limit"
  capacity_limit_in_kb = "10737418240" # 10TB in KB
}

output "device_action" {
  value = powerflex_device_action_v2.activate
}

Schema

Required

action (String) The action to perform. Valid values: activate, clear_error, set_capacity_limit.
device_id (String) The ID of the device to perform the action on.

Optional

capacity_limit_in_kb (String) Capacity limit in KB. Required when action is set_capacity_limit.

Read-Only

id (String) The identifier for this action resource.

V1.9.0: powerflex_device_group_v2 data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_device_group_v2 (Data Source)

This datasource is used to query Device Groups from a PowerFlex Gen2 system (5.0+).

Example Usage

# Copyright (c) 2024-2026 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.

# List all device groups
data "powerflex_device_group_v2" "all" {
}

output "all_device_groups" {
  value = data.powerflex_device_group_v2.all.device_groups
}

# Get device group by ID
data "powerflex_device_group_v2" "by_id" {
  id = "abc123def456"
}

# Filter by name
data "powerflex_device_group_v2" "by_name" {
  name = "device-group-1"
}

# Filter by protection domain
data "powerflex_device_group_v2" "by_pd" {
  protection_domain_id = "pd-123456"
}

Schema

Optional

id (String) Device Group ID to query. Mutually exclusive with name.
name (String) Device Group name to query. Mutually exclusive with id.
protection_domain_id (String) Filter device groups by protection domain ID.

Read-Only

device_groups (Attributes List) List of device groups. (see below for nested schema)

Nested Schema for `device_groups`

Read-Only:

id (String) Device Group ID.
name (String) Device Group name.
num_of_devices (Number) Number of devices in the group.
protection_domain_id (String) Protection Domain ID.
status (String) Status of the device group.
usable_capacity_in_kb (Number) Usable capacity in KB.
used_capacity_in_kb (Number) Used capacity in KB.

Argument Reference

The following arguments are supported:

id - (Optional) The ID of the device group to query. If not specified, all device groups are returned.
name - (Optional) The name of the device group to query.
protection_domain_id - (Optional) The protection domain ID to filter device groups.

Attribute Reference

In addition to all arguments above, the following attributes are exported:

device_groups - List of device groups with the following attributes:
- id - The ID of the device group.
- name - The name of the device group.
- protection_domain_id - The protection domain ID.
- media_type - The media type (SSD, PMEM).
- spare_node_count - The number of spare nodes.
- spare_device_count - The number of spare devices.
- health - The health status.
- state - The state.
- num_of_devices - The number of devices.
- usable_capacity_in_kb - The usable capacity in KB.
- used_capacity_in_kb - The used capacity in KB.

V1.9.0: powerflex_device_group_v2 resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_device_group_v2 (Resource)

This resource is used to manage Device Groups on PowerFlex Gen2 systems (5.0+). Device Groups allow logical grouping of devices for management.

Example Usage

/*
Copyright (c) 2024-2026 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.
*/

# Commands to run this tf file : terraform init && terraform plan && terraform apply
# Create, Update, Delete is supported for this resource
# To import, check import.tf for more info
# protection_domain_id is required
# name is optional
# This resource is for PowerFlex Gen2 systems (5.0+)

# Example for creating a Device Group
resource "powerflex_device_group_v2" "create" {
  name                 = "demo-device-group-01"
  protection_domain_id = "202a046600000000"
}

output "device_group" {
  value = powerflex_device_group_v2.create
}

Schema

Required

protection_domain_id (String) The ID of the protection domain.

Optional

name (String) The name of the device group.

Read-Only

id (String) The unique identifier of the device group.
num_of_devices (Number) The number of devices in the device group.
status (String) The status of the device group.
usable_capacity_in_kb (Number) The usable capacity in KB.
used_capacity_in_kb (Number) The used capacity in KB.

V1.9.0: powerflex_fault_set data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_fault_set (Data Source)

This datasource is used to query the existing fault set from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Example Usage

/*
Copyright (c) 2023-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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve

# Get all fault set details present on the cluster
data "powerflex_fault_set" "all" {
}

output "fault_set_result_all" {
  value = data.powerflex_fault_set.all.fault_set_details
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_fault_set" "fault_set_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     id = ["^.*0f$"]
#   }
# }

# output "faultSetFilterRegexResult"{
#  value = data.powerflex_fault_set.fault_set_filter_regex.fault_set_details
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/
data "powerflex_fault_set" "filtered" {
  filter {
    # protection_domain_id = ["protection_domain_id", "protection_domain_id2"]
    # name = ["name", "name2"]
    # id = ["id", "id2"]
  }
}

output "fault_set_result_filtered" {
  value = data.powerflex_fault_set.filtered.fault_set_details
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_fault_set.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

fault_set_details (Attributes Set) Fault set details (see below for nested schema)
id (String) Placeholder for fault set datasource attribute.

Nested Schema for `filter`

Optional:

id (Set of String) List of id
name (Set of String) List of name
protection_domain_id (Set of String) List of protection_domain_id

Nested Schema for `fault_set_details`

Read-Only:

id (String) Fault set ID
links (Attributes List) Specifies the links associated with fault set (see below for nested schema)
name (String) Fault set name
protection_domain_id (String) Protection Domain ID
sds_details (Attributes List) List of fetched SDS. (see below for nested schema)

Nested Schema for `fault_set_details.links`

Read-Only:

href (String) Specifies the exact path to fetch the details
rel (String) Specifies the relationship with the fault set

Nested Schema for `fault_set_details.sds_details`

Read-Only:

authentication_error (String) Authentication error.
certificate_info (Attributes) Certificate Information. (see below for nested schema)
configured_drl_mode (String) Configured DRL mode.
drl_mode (String) DRL mode.
fault_set_id (String) Fault set ID.
fgl_metadata_cache_size (Number) FGL metadata cache size.
fgl_metadata_cache_state (String) FGL metadata cache state.
fgl_num_concurrent_writes (Number) FGL concurrent writes.
id (String) SDS ID.
ip_list (Attributes List) List of IPs associated with SDS. (see below for nested schema)
last_upgrade_time (Number) Last time SDS was upgraded.
links (Attributes List) Specifies the links associated with SDS. (see below for nested schema)
maintenance_state (String) Maintenance state.
maintenance_type (String) Maintenance type.
mdm_connection_state (String) MDM connection state.
membership_state (String) Membership state.
name (String) SDS name.
num_io_buffers (Number) Number of IO buffers.
num_restarts (Number) Number of restarts.
on_vmware (Boolean) Presence on VMware.
performance_profile (String) Performance profile.
port (Number) SDS port.
raid_controllers (Attributes List) RAID controllers information. (see below for nested schema)
rfcache_enabled (Boolean) Whether RF cache is enabled or not.
rfcache_error_api_version_mismatch (Boolean) RF cache error for API version mismatch.
rfcache_error_device_does_not_exist (Boolean) RF cache error for device does not exist.
rfcache_error_inconsistent_cache_configuration (Boolean) RF cache error for inconsistent cache configuration.
rfcache_error_inconsistent_source_configuration (Boolean) RF cache error for inconsistent source configuration.
rfcache_error_invalid_driver_path (Boolean) RF cache error for invalid driver path.
rfcache_error_low_resources (Boolean) RF cache error for low resources.
rmcache_enabled (Boolean) Whether RM cache is enabled or not.
rmcache_frozen (Boolean) Indicates whether the Read RAM Cache is currently temporarily not in use.
rmcache_memory_allocation_state (String) Indicates the state of the memory allocation process. Can be one of in progress and done.
rmcache_size (Number) Indicates the size of Read RAM Cache on the specified SDS in KB.
sds_configuration_failure (Attributes) SDS configuration failure windows. (see below for nested schema)
sds_decoupled (Attributes) SDS decoupled windows. (see below for nested schema)
sds_receive_buffer_allocation_failures (Attributes) SDS receive buffer allocation failure windows. (see below for nested schema)
sds_state (String) SDS state.
software_version_info (String) Software version information.

Nested Schema for `fault_set_details.sds_details.certificate_info`

Read-Only:

issuer (String) Certificate issuer.
subject (String) Certificate subject.
thumbprint (String) Certificate thumbprint.
valid_from (String) The start date of the certificate validity.
valid_from_asn1_format (String) The start date of the Asn1 format.
valid_to (String) The end date of the certificate validity.
valid_to_asn1_format (String) The end date of the Asn1 format.

Nested Schema for `fault_set_details.sds_details.ip_list`

Read-Only:

ip (String) SDS IP.
role (String) SDS IP role.

Nested Schema for `fault_set_details.sds_details.links`

Read-Only:

href (String) Specifies the exact path to fetch the details.
rel (String) Specifies the relationship with the SDS.

Nested Schema for `fault_set_details.sds_details.raid_controllers`

Read-Only:

battery_status (String) Battery status
driver_name (String) Driver name.
driver_version (String) Driver version.
firmware_version (String) Firmware version.
model_name (String) Model name.
pci_address (String) PCI address.
serial_number (String) Serial number.
status (String) RAID status.
vendor_name (String) Vendor name.

Nested Schema for `fault_set_details.sds_details.sds_configuration_failure`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `fault_set_details.sds_details.sds_configuration_failure.long_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_configuration_failure.medium_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_configuration_failure.short_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_decoupled`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `fault_set_details.sds_details.sds_decoupled.long_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_decoupled.medium_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_decoupled.short_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_receive_buffer_allocation_failures`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `fault_set_details.sds_details.sds_receive_buffer_allocation_failures.long_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_receive_buffer_allocation_failures.medium_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `fault_set_details.sds_details.sds_receive_buffer_allocation_failures.short_window`

Read-Only:

last_oscillation_count (Number) Last oscillation count.
last_oscillation_time (Number) Last oscillation time.
max_failures_count (Number) Maximum failures count.
threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

V1.9.0: powerflex_fault_set resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_fault_set (Resource)

This resource is used to manage the Fault Set entity of the PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from the PowerFlex array.

Example Usage

/*
Copyright (c) 2023-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.
*/

# Command to run this tf file : terraform init && terraform plan && terraform apply
# Create, Update, Delete is supported for this resource
# To import , check import.sh for more info
# name and protection_domain_id is the required parameter to create or update 
# To check which attributes of the fault set can be updated, please refer Product Guide in the documentation


resource "powerflex_fault_set" "avengers-fs-create" {
  # Name of the fault set
  name = "avengers-fs-create2"

  # To create / update, protection_domain_id is required
  protection_domain_id = "202a046600000000"
}

After the execution of above resource block, fault set would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

name (String) Name of the Fault set
protection_domain_id (String) ID of the Protection Domain under which the fault set will be created. Cannot be updated.

Read-Only

id (String) ID of the Fault Set

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2023-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.
# */

# import fault set by it's id
terraform import powerflex_fault_set.fs_import_by_id "<id>"

This will import the fault set instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_firmware_repository data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_firmware_repository (Data Source)

This datasource is used to query the existing firmware repository from the PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository.

Example Usage

/*
Copyright (c) 2024-2026 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.
*/

# Example for fetching details of the firmware repository using names
data "powerflex_firmware_repository" "all" {

}

output "powerflex_firmware_repository_all_result" {
  value = data.powerflex_firmware_repository.all.firmware_repository_details
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_firmware_repository" "firmware_repository_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     disk_location = ["^https://powerflex.*$"]
#   }
# }

# output "firmwareRepositoryFilterRegexResult"{
#  value = data.powerflex_firmware_repository.firmware_repository_filter_regex.firmware_repository_details
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/ 
data "powerflex_firmware_repository" "filter" {
  filter {
    #id = ["ID1", "ID2"]
    # name = ["Name1", "Name2"]
    # source_location = ["SourceLocation1", "SourceLocation2"]
    # source_type = ["SourceType1", "SourceType2"]
    # disk_location = ["DiskLocation1", "DiskLocation2"]
    # filename = ["Filename1", "Filename2"]
    # username = ["Username1", "Username2"]
    # download_status = ["DownloadStatus1", "DownloadStatus2"]
    # created_date = ["CreatedDate1", "CreatedDate2"]
    # created_by = ["CreatedBy1", "CreatedBy2"]
    # updated_date = ["UpdatedDate1", "UpdatedDate2"]
    # updated_by = ["UpdatedBy1", "UpdatedBy2"]
    # default_catalog = false
    # embedded = false
    # state = ["state1", "state2"]
    # bundle_count = [10, 11]
    # component_count = [1, 2]
    # user_bundle_count = [1, 2]
    # minimal = false
    # download_progress = [1, 2]
    # extract_progress = [1, 2]
    # signature = ["Signature1", "Signature2"]
    # custom = false
    # needs_attention = false
    # job_id = ["JobID1", "JobID2"]
    # rcmapproved = false
  }
}

output "powerflex_firmware_repository_filtered_result" {
  value = data.powerflex_firmware_repository.filter.firmware_repository_details
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_firmware_repository.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

firmware_repository_details (Attributes List) Firmware Repository details (see below for nested schema)
id (String) Placeholder firmware repository datasource id.

Nested Schema for `filter`

Optional:

bundle_count (Set of Number) List of bundle_count
component_count (Set of Number) List of component_count
created_by (Set of String) List of created_by
created_date (Set of String) List of created_date
custom (Boolean) Value for custom
default_catalog (Boolean) Value for default_catalog
disk_location (Set of String) List of disk_location
download_progress (Set of Number) List of download_progress
download_status (Set of String) List of download_status
embedded (Boolean) Value for embedded
extract_progress (Set of Number) List of extract_progress
filename (Set of String) List of filename
id (Set of String) List of id
job_id (Set of String) List of job_id
minimal (Boolean) Value for minimal
name (Set of String) List of name
needs_attention (Boolean) Value for needs_attention
rcmapproved (Boolean) Value for rcmapproved
signature (Set of String) List of signature
source_location (Set of String) List of source_location
source_type (Set of String) List of source_type
state (Set of String) List of state
updated_by (Set of String) List of updated_by
updated_date (Set of String) List of updated_date
user_bundle_count (Set of Number) List of user_bundle_count
username (Set of String) List of username

Nested Schema for `firmware_repository_details`

Read-Only:

bundle_count (Number) Bundle Count
component_count (Number) Component Count
created_by (String) Created By
created_date (String) Created Date
custom (Boolean) Custom
default_catalog (Boolean) Default Catalog
disk_location (String) Disk Location
download_progress (Number) Download Progress
download_status (String) Download Status
embedded (Boolean) Embedded
extract_progress (Number) Extract Progress
file_size_in_gigabytes (Number) File Size In Gigabytes
filename (String) Filename
id (String) ID of the Firmware Repository
job_id (String) Job ID
minimal (Boolean) Minimal
name (String) Firmware Repository name
needs_attention (Boolean) Needs Attention
password (String, Sensitive) Password
rcmapproved (Boolean) Rcmapproved
signature (String) Signature
software_bundles (Attributes List) Software Bundles (see below for nested schema)
software_components (Attributes List) Software Components (see below for nested schema)
source_location (String) Source Location
source_type (String) Source Type
state (String) State
updated_by (String) Updated By
updated_date (String) Updated Date
user_bundle_count (Number) User Bundle Count
username (String) Username

Nested Schema for `firmware_repository_details.software_bundles`

Read-Only:

bundle_date (String) Bundle Date
bundle_type (String) Bundle Type
created_by (String) Created By
created_date (String) Created Date
custom (Boolean) Custom
description (String) Description
device_model (String) Device Model
device_type (String) Device Type
fw_repository_id (String) Fw Repository ID
id (String) ID
name (String) Name
needs_attention (Boolean) Needs Attention
software_components (Attributes List) Software Components (see below for nested schema)
updated_by (String) Updated By
updated_date (String) Updated Date
user_bundle (Boolean) User Bundle
user_bundle_path (String) User Bundle Path
version (String) Version

Nested Schema for `firmware_repository_details.software_bundles.software_components`

Read-Only:

category (String) Category
component_id (String) Component ID
component_type (String) Component Type
created_by (String) Created By
created_date (String) Created Date
custom (Boolean) Custom
dell_version (String) Dell Version
device_id (String) Device ID
firmware_repo_name (String) Firmware Repo Name
hash_md5 (String) Hash Md5
id (String) ID
ignore (Boolean) Ignore
name (String) Name
needs_attention (Boolean) Needs Attention
operating_system (String) Operating System
original_component_id (String) Original Component ID
package_id (String) Package ID
path (String) Path
sub_device_id (String) Sub Device ID
sub_vendor_id (String) Sub Vendor ID
system_ids (List of String) System IDs
updated_by (String) Updated By
updated_date (String) Updated Date
vendor_id (String) Vendor ID
vendor_version (String) Vendor Version

Nested Schema for `firmware_repository_details.software_components`

Read-Only:

category (String) Category
component_id (String) Component ID
component_type (String) Component Type
created_by (String) Created By
created_date (String) Created Date
custom (Boolean) Custom
dell_version (String) Dell Version
device_id (String) Device ID
firmware_repo_name (String) Firmware Repo Name
hash_md5 (String) Hash Md5
id (String) ID
ignore (Boolean) Ignore
name (String) Name
needs_attention (Boolean) Needs Attention
operating_system (String) Operating System
original_component_id (String) Original Component ID
package_id (String) Package ID
path (String) Path
sub_device_id (String) Sub Device ID
sub_vendor_id (String) Sub Vendor ID
system_ids (List of String) System IDs
updated_by (String) Updated By
updated_date (String) Updated Date
vendor_id (String) Vendor ID
vendor_version (String) Vendor Version

V1.9.0: powerflex_firmware_repository resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_firmware_repository (Resource)

This resource is used to manage the Firmware Repository entity of the PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from the PowerFlex array.

Example Usage

/*
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.
*/

# Example for uploading compliance file. After successful execution, compliance file will be uploaded to the manager.
resource "powerflex_firmware_repository" "upload-test" {
  source_location = "https://10.10.10.1/artifactory/Denver/RCMs/SoftwareOnly/PowerFlex_Software_4.5.0.0_287_r1.zip"
  username        = "user"     # To be provided in case of CIFS share
  password        = "password" # To be provided in case of CIFS share
  approve         = true       # To be used to approve the unsigned file
  timeout         = 45         #controls that till what time the upload compliance will run
}

After the execution of above resource block, firmware_repository would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

source_location (String) Specfies the path from where it will download the compliance file. Cannot be updated.

Optional

approve (Boolean) Whether to approve the unsigned file or not.
password (String, Sensitive) Password is only used if specifying a CIFS share Cannot be updated.
timeout (Number) Describes the time in minutes to timeout the job.
username (String) Username is only used if specifying a CIFS share Cannot be updated.

Read-Only

default_catalog (Boolean) Whether this Firmware Repository is set to default or not.
disk_location (String) Disk location of the Firmware Repository
file_name (String) File Name
id (String) ID of the Firmware Repository
name (String) Name of the Firmware Repository

Import

Import is supported using the following syntax:

# /*
# 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.
# */

# import firmware respository by it's id
terraform import powerflex_firmware_repository.fr_import_by_id "<id>"

# After Import, username and password is not needed for approving the unsigned file in case of CIFS share. For approving the file in case of import, please refer the below config(change the value as per your use-case):
resource "powerflex_firmware_repository" "fr_import_by_id" {
  source_location = "https://10.10.10.1/artifactory/Denver/RCMs/SoftwareOnly/PowerFlex_Software_4.5.0.0_287_r1.zip"
  approve = true
  timeout = 45
}

This will import the firmware_repository instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_mdm_cluster resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_mdm_cluster (Resource)

This resource can be used to manage MDM cluster on the PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs.

Caution: MDM cluster creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). If the taint is not removed, terraform will destroy and recreate the resource.

Note: Use of MDM cluster resource requires the presence of the MDM cluster. The purpose of this resource is to update MDM cluster, not create or delete. Import operation is not supported for MDM cluster.

Example Usage

/*
Copyright (c) 2023-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.
*/

# Command to run this tf file : terraform init && terraform plan && terraform apply.
# Create, Update, Read, and Delete operations are supported for this resource.
# For this resource, primary_mdm, secondary_mdm, tiebreaker_mdm and cluster_mode are mandatory parameters.
# While specifying primary_mdm, secondary_mdm and tiebreaker_mdm, id or ips is mandatory.
# For adding standby mdm, ips and role parameters are mandatory.
# To check which attributes of the MDM cluster resource can be updated, please refer Product Guide in the documentation

# Example for adding standby MDMs. Before adding standby MDMs, MDM package must be installed on VM with respective role. 
resource "powerflex_mdm_cluster" "test-mdm-cluster" {
  cluster_mode = "ThreeNodes" # ThreeNodes/FiveNodes
  primary_mdm = {
    id = "7f328d0b71711801"
  }
  secondary_mdm = [{
    id = "10912d8a5d412800"
  }]
  tiebreaker_mdm = [{
    id = "0e4f0a2f5978ae02"
  }]
  standby_mdm = [
    {
      ips  = ["10.xxx.xx.xxx"]
      role = "Manager" # Manager/TieBreaker
    },
    {
      ips  = ["10.yyy.yy.yyy"]
      role = "TieBreaker"
    },
  ]
}

# Example for changing MDM ownership. In this case, the id of the primary and secondary MDM will be swapped.
resource "powerflex_mdm_cluster" "test-mdm-cluster" {
  cluster_mode = "ThreeNodes"
  primary_mdm = {
    id = "10912d8a5d412800"
  }
  secondary_mdm = [{
    id = "7f328d0b71711801"
  }]
  tiebreaker_mdm = [{
    id = "0e4f0a2f5978ae02"
  }]
  standby_mdm = [
    {
      ips  = ["10.xxx.xx.xxx"]
      role = "Manager"
    },
    {
      ips  = ["10.yyy.yy.yyy"]
      role = "TieBreaker"
    },
  ]
}

# Example for switching cluster mode to 5 nodes from 3 nodes. The cluster mode will be FiveNodes. Previously added standby MDMs will be added as Secondary/TieBreaker MDM.
resource "powerflex_mdm_cluster" "test-mdm-cluster" {
  cluster_mode = "FiveNodes"
  primary_mdm = {
    id = "10912d8a5d412800"
  }
  secondary_mdm = [
    {
      id = "7f328d0b71711801"
    },
    {
      ips  = ["10.xxx.xx.xxx"]
      role = "Manager"
    },
  ]
  tiebreaker_mdm = [
    {
      id = "0e4f0a2f5978ae02"
    },
    {
      ips  = ["10.yyy.yy.yyy"]
      role = "TieBreaker"
    },
  ]
  standby_mdm = [
  ]
}

# Example for switching cluster mode to 3 nodes from 5 nodes. The cluster mode will be ThreeNodes. One of the active Secondary/TieBreaker MDM will be moved to standby MDMs.
resource "powerflex_mdm_cluster" "test-mdm-cluster" {
  cluster_mode = "ThreeNodes"
  primary_mdm = {
    id = "10912d8a5d412800"
  }
  secondary_mdm = [
    {
      id = "7f328d0b71711801"
    }
  ]
  tiebreaker_mdm = [
    {
      id = "0e4f0a2f5978ae02"
    }
  ]
  standby_mdm = [
    {
      ips  = ["10.xxx.xx.xxx"]
      role = "Manager"
    },
    {
      ips  = ["10.yyy.yy.yyy"]
      role = "TieBreaker"
    },
  ]
}

# Example for removing standby MDMs. In this case, standby_mdm will be empty list.
resource "powerflex_mdm_cluster" "test-mdm-cluster" {
  cluster_mode = "ThreeNodes"
  primary_mdm = {
    id = "10912d8a5d412800"
  }
  secondary_mdm = [
    {
      id = "7f328d0b71711801"
    }
  ]
  tiebreaker_mdm = [
    {
      id = "0e4f0a2f5978ae02"
    }
  ]
  standby_mdm = []
}

After the execution of the above resource block, the MDM cluster would become a 3-node cluster. For more information, please check the state file.

Schema

Required

cluster_mode (String) Mode of the MDM cluster. Accepted values are ThreeNodes and FiveNodes.
primary_mdm (Attributes) Primary MDM details. (see below for nested schema)
secondary_mdm (Attributes List) Secondary MDM details. (see below for nested schema)
tiebreaker_mdm (Attributes List) TieBreaker MDM details. (see below for nested schema)

Optional

performance_profile (String) Performance profile of the MDM cluster. Accepted values are Compact and HighPerformance.
standby_mdm (Attributes List) StandBy MDM details. StandBy MDM can be added/removed/promoted to manager/tiebreaker role. (see below for nested schema)

Read-Only

id (String) Unique identifier of the MDM cluster.

Nested Schema for `primary_mdm`

Optional:

id (String) ID of the primary MDM.
ips (Set of String) The Ips of the primary MDM.
name (String) Name of the the primary MDM.

Read-Only:

management_ips (Set of String) The management ips of the primary MDM.
port (Number) Port of the primary MDM.

Nested Schema for `secondary_mdm`

Optional:

id (String) ID of the secondary MDM.
ips (Set of String) The Ips of the secondary MDM.
name (String) Name of the the secondary MDM.

Read-Only:

management_ips (Set of String) The management ips of the secondary MDM.
port (Number) Port of the secondary MDM.

Nested Schema for `tiebreaker_mdm`

Optional:

id (String) ID of the tiebreaker MDM.
ips (Set of String) The Ips of the tiebreaker MDM.
name (String) Name of the the tiebreaker MDM.

Read-Only:

management_ips (Set of String) The management ips of the tiebreaker MDM.
port (Number) Port of the tiebreaker MDM.

Nested Schema for `standby_mdm`

Required:

ips (Set of String) The Ips of the standby MDM. Cannot be updated.
role (String) Role of the standby mdm. Accepted values are Manager and TieBreaker. Cannot be updated.

Optional:

allow_asymmetric_ips (Boolean) Allow the added MDM to have a different number of IPs from the primary MDM. Cannot be updated.
management_ips (Set of String) The management ips of the standby MDM. Cannot be updated.
name (String) Name of the the standby MDM.
port (Number) Port of the standby MDM. Cannot be updated.

Read-Only:

id (String) ID of the standby MDM.

V1.9.0: powerflex_node data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_node (Data Source)

This datasource is used to query the existing nodes from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve

# Get all node details present on the cluster
data "powerflex_node" "example1" {
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_node" "node_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     manufacturer = ["^.*Corp.*$"]
#   }
# }

# output "nodeFilterRegexResult"{
#  value = data.powerflex_node.node_filter_regex.node_details
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/ 
data "powerflex_node" "node" {
  # filter{
  #   ref_id  = ["id1", "id2"]
  #   state = ["READY"]
  #   ip_address = ["ip1", "ip2"]
  #   service_tag = ["serviceTag1", "serviceTag2"]
  #   current_ip_address = ["currentIp1", "currentIp2"]
  #   model = ["model1", "model2"]
  #   device_type = ["deviceType1", "deviceType2"]
  #   discover_device_type = ["discoverDeviceType1", "discoverDeviceType2"]
  #   display_name = ["displayName1", "displayName2"]
  #   managed_state = ["managedState1", "managedState2"]
  #   state = ["state1", "state2"]
  #   in_use = true
  #   custom_firmware = true
  #   needs_attention = true
  #   manufacturer = ["manufacturer1", "manufacturer2"]
  #   system_id = ["systemId1", "systemId2"]
  #   health = ["health1", "health2"]
  #   health_message = ["healthMessage1", "healthMessage2"]
  #   operating_system = ["operatingSystem1", "operatingSystem2"]
  #   number_of_cpus = [3, 2]
  #   nics = [3, 5]
  #   memory_in_gb = [3, 5]
  #   compliance_check_date = ["complianceCheckDate1", "complianceCheckDate2"]
  #   discovered_date = ["discoveredDate1", "discoveredDate2"]
  #   cred_id = ["credId1", "credId2"]
  #   compliance = ["compliance1", "compliance2"]
  #   puppet_cert_name = ["puppet_cert_name1","puppet_cert_name2"]
  #   failures_count = [3, 5]
  #   flex_os_maint_mode=[0]
  #   esxi_maint_mode=[0]
  # }
}

output "node_result" {
  value = data.powerflex_node.example1.node_details
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_node.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) Placeholder attribute.
node_details (Attributes Set) Node details (see below for nested schema)

Nested Schema for `filter`

Optional:

compliance (Set of String) List of compliance
compliance_check_date (Set of String) List of compliance_check_date
cred_id (Set of String) List of cred_id
current_ip_address (Set of String) List of current_ip_address
custom_firmware (Boolean) Value for custom_firmware
device_type (Set of String) List of device_type
discover_device_type (Set of String) List of discover_device_type
discovered_date (Set of String) List of discovered_date
display_name (Set of String) List of display_name
esxi_maint_mode (Set of Number) List of esxi_maint_mode
failures_count (Set of Number) List of failures_count
flex_os_maint_mode (Set of Number) List of flex_os_maint_mode
health (Set of String) List of health
health_message (Set of String) List of health_message
in_use (Boolean) Value for in_use
ip_address (Set of String) List of ip_address
managed_state (Set of String) List of managed_state
manufacturer (Set of String) List of manufacturer
memory_in_gb (Set of Number) List of memory_in_gb
model (Set of String) List of model
needs_attention (Boolean) Value for needs_attention
nics (Set of Number) List of nics
number_of_cpus (Set of Number) List of number_of_cpus
operating_system (Set of String) List of operating_system
puppet_cert_name (Set of String) List of puppet_cert_name
ref_id (Set of String) List of ref_id
service_tag (Set of String) List of service_tag
state (Set of String) List of state
system_id (Set of String) List of system_id

Nested Schema for `node_details`

Read-Only:

compliance (String) Node compliance.
compliance_check_date (String) Compliance check date.
cred_id (String) Cred ID.
current_ip_address (String) Current IP address of the node.
custom_firmware (Boolean) Custom firmware of the node.
device_group_list (Attributes) Device group list. (see below for nested schema)
device_type (String) Device type of the node.
discover_device_type (String) Discover device type of the node.
discovered_date (String) Discovered date of the node.
display_name (String) Display name of the node.
esxi_maint_mode (Number) ESXi maintenance mode.
facts (String) Facts of the node.
failures_count (Number) Failures count.
flex_os_maint_mode (Number) FLEX OS maintenance mode.
health (String) Health of the node.
health_message (String) Health message.
in_use (Boolean) Flag specifying if node is in use.
ip_address (String) IP address of the node.
managed_state (String) Managed state of the node.
manufacturer (String) Manufacturer of the node.
memory_in_gb (Number) Memory in GB.
model (String) Model of the node.
needs_attention (Boolean) Flag specifying if node needs attention.
nics (Number) NICs of the node.
number_of_cpus (Number) Number of CPUs of the node.
operating_system (String) Operating system of the node.
puppet_cert_name (String) Puppet cert name of the node.
ref_id (String) Reference ID of the node.
service_tag (String) Service tag of the node.
state (String) State of the node.
system_id (String) System ID.

Nested Schema for `node_details.device_group_list`

Read-Only:

device_group (Attributes List) Device group information. (see below for nested schema)

Nested Schema for `node_details.device_group_list.device_group`

Read-Only:

created_by (String) User who created the group.
created_date (String) Creation date.
group_description (String) Group description.
group_name (String) Group name.
group_seq_id (Number) Group Sequence ID.
group_user_list (Attributes) Group user list. (see below for nested schema)
updated_by (String) User who updated the group.
updated_date (String) Updated date.

Nested Schema for `node_details.device_group_list.device_group.group_user_list`

Read-Only:

group_users (Attributes List) Group user information. (see below for nested schema)
total_records (Number) Total number of records.

Nested Schema for `node_details.device_group_list.device_group.group_user_list.group_users`

Read-Only:

enabled (Boolean) Enabled flag.
first_name (String) First name of the user.
last_name (String) Last name of the user.
user_name (String) User name.
user_seq_id (Number) User sequence ID.

V1.9.0: powerflex_nvme_host data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_nvme_host (Data Source)

This datasource is used to query the existing NVMe hosts from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Note: NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this datasource is not supported in PowerFlex 3.x.

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve

# Get all NVMe host details present on the cluster
data "powerflex_nvme_host" "example1" {
}


# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_nvme_host" "nvme_host_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     system_id = ["^.*0f$"]
#   }
# }

# output "nvmeHostFilterRegexResult"{
#  value = data.powerflex_nvme_host.nvme_host_filter_regex.nvme_host_details
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/ 
// Please note that NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this datasource is not supported in PowerFlex 3.x.

data "powerflex_nvme_host" "example2" {
  filter {
    name = ["name1", "name2"]
    # id                = ["ID1", "ID2"]
    # nqn               = ["NQN1", "NQN2"]
    # max_num_paths     = [2]
    # max_num_sys_ports = [10]
    # system_id         = ["systemID"]
  }
}

output "nvme_host_result" {
  value = data.powerflex_nvme_host.example1.nvme_host_details
}

After the successful execution of above said block, We can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_nvme_host.example1.datasource_block_name.attribute_name where attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) ID of the NVMe hosts Datasource
nvme_host_details (Attributes List) List of NVMe hosts (see below for nested schema)

Nested Schema for `filter`

Optional:

id (Set of String) List of id
max_num_paths (Set of Number) List of max_num_paths
max_num_sys_ports (Set of Number) List of max_num_sys_ports
name (Set of String) List of name
nqn (Set of String) List of nqn
system_id (Set of String) List of system_id

Nested Schema for `nvme_host_details`

Read-Only:

id (String) ID of the NVMe host
links (Attributes List) Specifies the links associated with NVMe host. (see below for nested schema)
max_num_paths (Number) Number of Paths Per Volume.
max_num_sys_ports (Number) Number of System Ports per Protection Domain.
name (String) Name of the NVMe host
nqn (String) NQN of the NVMe host.
system_id (String) The ID of the system.

Nested Schema for `nvme_host_details.links`

Read-Only:

href (String) Specifies the exact path to fetch the details.
rel (String) Specifies the relationship with the NVMe host.

V1.9.0: powerflex_nvme_host resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_nvme_host (Resource)

This resource is used to manage NVMe host from the PowerFlex array. We can Create, Update and Delete the PowerFlex NVMe host using this resource. We can also import an existing NVMe host from PowerFlex array.

Note:

NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this resource is not supported in PowerFlex 3.x.

Due to certain limitations, updating the NVMe host in PowerFlex versions earlier than 4.6 is not supported

Example Usage

/*
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.
*/

# Command to run this tf file : terraform init && terraform plan && terraform apply.
# Create, Update, Read, and Delete operations are supported for this resource.
# To import , check import.sh for more info
# nqn is the required parameter to create
# To check which attributes can be updated, please refer Product Guide in the documentation
# Please note that 
# 1. NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this resource is not supported in PowerFlex 3.x.
# 2. Due to certain limitations, updating the NVMe host in PowerFlex versions earlier than 4.6 is not supported

# Example for adding NVMe host.
resource "powerflex_nvme_host" "test-nvme-host" {
  name              = "nvme_host_name"
  nqn               = "nqn.2014-08.org.nvmexpress:uuid:a10e4d56-a2c0-4cab-9a0a-9a7a4ebb8c0e"
  max_num_paths     = 4
  max_num_sys_ports = 10
}

After the execution of above resource block, NVMe host would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

nqn (String) NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.

Optional

max_num_paths (Number) Number of Paths Per Volume.
max_num_sys_ports (Number) Number of System Ports per Protection Domain.
name (String) Name of the NVMe host

Read-Only

id (String) ID of the NVMe host
system_id (String) The ID of the system.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2023-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.
# */

# import NVMe host by its id
terraform import powerflex_nvme_host.nvme_host_import_by_id "<id>"

This will import the NVMe host instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_nvme_target data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_nvme_target (Data Source)

This datasource is used to query the existing NVMe targets from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Note: NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this datasource is not supported in PowerFlex 3.x.

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve

# Get all NVMe target details present on the cluster
data "powerflex_nvme_target" "example1" {
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_nvme_target" "nvme_target_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     software_version_info = ["^R4_5.*$"]
#   }
# }

# output "nvmeTargetFilterRegexResult"{
#  value = data.powerflex_nvme_target.nvme_target_filter_regex.nvme_target_details
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/ 
// Please note that NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this datasource is not supported in PowerFlex 3.x.

data "powerflex_nvme_target" "example" {
  filter {
    name = ["name1", "name2"]
    # id                                   = ["ID1", "ID2"]
    # protection_domain_id                 = ["PD1", "PD2"]
    # storage_port                         = [12200]
    # nvme_port                            = [4420]
    # discovery_port                       = [8009]
    # sdt_state                            = ["Normal"]
    # mdm_connection_state                 = ["Connected"]
    # membership_state                     = ["Joined"]
    # fault_set_id                         = ["FS1"]
    # software_version_info                = ["Version"]
    # maintenance_state                    = ["NoMaintenance"]
    # authentication_error                 = ["None"]
    # system_id                            = ["systemID"]
  }
}

output "nvme_target_result" {
  value = data.powerflex_nvme_target.example.nvme_target_details
}

After the successful execution of above said block, We can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_nvme_target.example1.datasource_block_name.attribute_name where attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) ID of the NVMe targets Datasource
nvme_target_details (Attributes List) List of NVMe targets (see below for nested schema)

Nested Schema for `filter`

Optional:

authentication_error (Set of String) List of authentication_error
discovery_port (Set of Number) List of discovery_port
fault_set_id (Set of String) List of fault_set_id
id (Set of String) List of id
maintenance_state (Set of String) List of maintenance_state
mdm_connection_state (Set of String) List of mdm_connection_state
membership_state (Set of String) List of membership_state
name (Set of String) List of name
nvme_port (Set of Number) List of nvme_port
protection_domain_id (Set of String) List of protection_domain_id
sdt_state (Set of String) List of sdt_state
software_version_info (Set of String) List of software_version_info
storage_port (Set of Number) List of storage_port
system_id (Set of String) List of system_id

Nested Schema for `nvme_target_details`

Read-Only:

authentication_error (String) The authentication error of the NVMe target.
certificate_info (Attributes) Certificate Information. (see below for nested schema)
discovery_port (Number) The discovery port of the NVMe target.
fault_set_id (String) The fault set ID of the NVMe target.
host_list (Attributes List) Hosts attached to the NVMe target. (see below for nested schema)
id (String) ID of the NVMe target
ip_list (Attributes List) List of IPs associated with the NVMe target. (see below for nested schema)
links (Attributes List) Specifies the links associated with NVMe target. (see below for nested schema)
maintenance_state (String) The maintenance state of the NVMe target.
mdm_connection_state (String) The MDM connection state of the NVMe target.
membership_state (String) The membership state of the NVMe target.
name (String) Name of the NVMe target
nvme_port (Number) The NVMe port of the NVMe target.
protection_domain_id (String) Protection Domain ID of the replicatio of the NVMe target.
sdt_state (String) The state of the NVMe target.
software_version_info (String) The software version information of the NVMe target.
storage_port (Number) The storage port of the NVMe target.
system_id (String) The ID of the system.

Nested Schema for `nvme_target_details.certificate_info`

Read-Only:

issuer (String) Certificate issuer.
subject (String) Certificate subject.
thumbprint (String) Certificate thumbprint.
valid_from (String) The start date of the certificate validity.
valid_from_asn1_format (String) The start date of the Asn1 format.
valid_to (String) The end date of the certificate validity.
valid_to_asn1_format (String) The end date of the Asn1 format.

Nested Schema for `nvme_target_details.host_list`

Read-Only:

host_id (String) Host ID.
host_ip (String) Host IP address.
host_name (String) Host name.
is_connected (Boolean) Specifies whether the host is connected to the NVMe target.
sys_port_ip (String) Specifies the target IP address of the NVMe controller.

Nested Schema for `nvme_target_details.ip_list`

Read-Only:

ip (String) NVMe Target IP.
role (String) NVMe Target IP role.

Nested Schema for `nvme_target_details.links`

Read-Only:

href (String) Specifies the exact path to fetch the details.
rel (String) Specifies the relationship with the NVMe target.

V1.9.0: powerflex_nvme_target resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_nvme_target (Resource)

This resource is used to manage NVMe target from the PowerFlex array. We can Create, Update and Delete the PowerFlex NVMe target using this resource. We can also import an existing NVMe target from PowerFlex array.
Note: Either protection_domain_id or protection_domain_name must be specified.

Caution: NVMe target creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). If the taint is not removed, terraform will destroy and recreate the resource.

Note:

Either protection_domain_name and protection_domain_id is required. But not both.

NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this resource is not supported in PowerFlex 3.x.

To avoid potential issues, it is recommended to operate NVMe targets using the default ports.

Example Usage

/*
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.
*/

# Command to run this tf file : terraform init && terraform plan && terraform apply.
# Create, Update, Read, and Delete operations are supported for this resource.
# To import , check import.sh for more info.
# name and ip_list attributes are required, and either protection_domain_name or protection_domain_id must be specified.
# To check which attributes can be updated, please refer Product Guide in the documentation
# Please note that NVMe over TCP is supported in PowerFlex 4.0 and later versions, therefore this resource is not supported in PowerFlex 3.x.
# To avoid potential issues, it is recommended to operate NVMe targets using the default ports.

# Example for adding NVMe target.
resource "powerflex_nvme_target" "test-nvme-target" {
  name                   = "nvme_target_name"
  protection_domain_name = "demo-pd"
  ip_list = [
    {
      ip   = "10.10.10.13"
      role = "StorageAndHost" #StorageAndHost, StorageOnly, HostOnly
    },
    {
      ip   = "10.10.10.14"
      role = "StorageAndHost" #StorageAndHost, StorageOnly, HostOnly
    }
  ]
}

After the execution of above resource block, NVMe target would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

ip_list (Attributes Set) List of IPs associated with the NVMe target. (see below for nested schema)
name (String) Name of the NVMe target

Optional

discovery_port (Number) The discovery port of the NVMe target (default: 8009).
maintenance_state (String) The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
nvme_port (Number) The NVMe port of the NVMe target (default: 4420).
protection_domain_id (String) ID of the Protection Domain under which the NVMe target will be created. Conflicts with ‘protection_domain_name’. Cannot be updated.Note: Either protection_domain_id or protection_domain_name must be specified.
protection_domain_name (String) Name of the Protection Domain under which the NVMe target will be created. Conflicts with ‘protection_domain_id’. Cannot be updated.Note: Either protection_domain_id or protection_domain_name must be specified.
storage_port (Number) The storage port of the NVMe target (default: 12200).

Read-Only

authentication_error (String) The authentication error of the NVMe target.
fault_set_id (String) The fault set ID of the NVMe target.
id (String) ID of the NVMe target
mdm_connection_state (String) The MDM connection state of the NVMe target.
membership_state (String) The membership state of the NVMe target.
sdt_state (String) The state of the NVMe target.
software_version_info (String) The software version information of the NVMe target.
system_id (String) The ID of the system.

Nested Schema for `ip_list`

Required:

ip (String) NVMe Target IP.
role (String) NVMe Target IP role.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2023-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.
# */

# import NVMe target by its id
terraform import powerflex_nvme_target.nvme_target_import_by_id "<id>"

This will import the NVMe target instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_os_repository data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_os_repository (Data Source)

This datasource is used to query the existing OS Repository from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Example Usage

/*
Copyright (c) 2024-2026 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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve

# Get all OS Repositories
data "powerflex_os_repository" "example1" {
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_os_repository" "os_repository_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     source_path = ["^c://.*$"]
#   }
# }

# output "osRepositoryFilterRegexResult"{
#  value = data.powerflex_os_repository.os_repository_filter_regex.os_repositories
# }

# # Get OS Repository details by ID
# data "powerflex_os_repository" "example2" {
#   # this datasource supports filters like os repository id, name, source path, etc.
#   # Note: If both filters are used simultaneously, the results will include any records that match either of the filters.
#   filter {
#     id = ["1234","5678"]
#   }
# }

# # Get OS Repository details by all fields
# data "powerflex_os_repository" "example3" {
#   # this datasource supports filters like os repository id, name, source path, etc.
#   # Note: If both filters are used simultaneously, the results will include any records that match either of the filters.
#   filter {
#     base_url = ["http://195.0.0.0:8080"]
#     created_by = ["system"]
#     created_date = ["20XX-XX-XXT13:58:13.978+00:00"]
#     from_web = false
#     id = ["1234","5678"]
#     image_type = ["vmwar_esxi"]
#     in_use = false
#     name   = ["Dell EMC PowerFlex Embedded OS"]
#     razor_name = ["DellEMCPowerFlexEmbeddedOS"]
#     rcm_path = ["c:\\..."]
#     repo_type  = ["ISO"]
#     source_path = ["z:\\ESXi\\ESXi-x.x.x-xxxxxx-x_Dell.zip"]
#     state = ["available"]
#     username = ["User"]
#   }
# }

output "os_repository_result" {
  value = data.powerflex_os_repository.example1.os_repositories
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_os_repository.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) ID of the OS Repository Datasource
os_repositories (Attributes List) List of OS Repository Models (see below for nested schema)

Nested Schema for `filter`

Optional:

base_url (Set of String) List of base_url
created_by (Set of String) List of created_by
created_date (Set of String) List of created_date
from_web (Boolean) Value for from_web
id (Set of String) List of id
image_type (Set of String) List of image_type
in_use (Boolean) Value for in_use
name (Set of String) List of name
razor_name (Set of String) List of razor_name
rcm_path (Set of String) List of rcm_path
repo_type (Set of String) List of repo_type
source_path (Set of String) List of source_path
state (Set of String) List of state
username (Set of String) List of username

Nested Schema for `os_repositories`

Read-Only:

base_url (String) Base URL of the OS repository
created_by (String) User who created the OS repository
created_date (String) Date of creation of the OS Repository
from_web (Boolean) Whether the OS repository is from the web or not
id (String) ID of the OS Repository
image_type (String) Type of the OS image. Supported types are redhat7, vmware_esxi, sles, windows2016, windows2019
in_use (Boolean) Whether the OS repository is in use or not
metadata (Attributes) Metadata of the OS Repository (see below for nested schema)
name (String) Name of the OS repository
password (String, Sensitive) Password of the OS repository
razor_name (String) Name of the Razor
rcm_path (String) Path of the RCM
repo_type (String) Type of the OS repository. Default is ISO
source_path (String) Source path of the OS image
state (String) State of the OS repository
username (String) Username of the OS repository

Nested Schema for `os_repositories.metadata`

Read-Only:

repos (Attributes List) List of OS Repository Metadata Repos (see below for nested schema)

Nested Schema for `os_repositories.metadata.repos`

Read-Only:

base_path (String) Base path of the OS Repository Metadata Repo
description (String) Description of the OS Repository Metadata Repo
gpg_key (String) GPG key of the OS Repository Metadata Repo
name (String) Name of the OS Repository Metadata Repo
os_packages (Boolean) Whether the OS Repository Metadata Repo has OS packages or not

V1.9.0: powerflex_os_repository resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_os_repository (Resource)

This resource is used to manage the OS Repository entity of the PowerFlex Array. We can Create ,Read and Delete the os image repository using this resource.

Example Usage

/*
Copyright (c) 2024-2026 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.
*/

# Command to run this tf file : terraform plan && terraform apply.

// Resource to manage lifecycle
resource "terraform_data" "always_run" {
  input = timestamp()
}

# Example for creating OS repository. After successful execution, OS Repository will be created.
resource "powerflex_os_repository" "test" {
  # Required Fields

  # Name of the OS repository
  name = "TestOsRepo"
  # Source path of the OS image
  source_path = "https://pathtoimage.iso"
  # Supported image types are redhat7, vmware_esxi, sles, windows2016, windows2019
  image_type = "vmware_esxi"

  // This will allow terraform create process to trigger each time we run terraform apply.
  lifecycle {
    replace_triggered_by = [
      terraform_data.always_run
    ]
  }
}

After the execution of above resource block, OS Repository would have been created. For more information, please check the terraform state file.

Schema

Required

image_type (String) Type of the OS image. Supported types are redhat7, vmware_esxi, sles, windows2016, windows2019
name (String) Name of the OS repository
source_path (String) Source path of the OS image

Optional

password (String, Sensitive) Password of the OS repository
repo_type (String) Type of the OS repository. Default is ISO
timeout (Number) Describes the time in minutes to timeout the job.
username (String) Username of the OS repository

Read-Only

base_url (String) Base URL of the OS repository
created_by (String) User who created the OS repository
created_date (String) Date of creation of the OS Repository
from_web (Boolean) Whether the OS repository is from the web or not
id (String) ID of the OS Repository
in_use (Boolean) Whether the OS repository is in use or not
razor_name (String) Name of the Razor
rcm_path (String) Path of the RCM
state (String) State of the OS repository

V1.9.0: powerflex_package resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_package (Resource)

This resource can be used to upload packages on a PowerFlex Gateway. We can add or remove packages from PowerFlex Gateway. Import functionality is not supported.

Note: This resource can be used to upload packages to a PowerFlex Manager (4.x) or Gateway Server (3.x). We can add or remove packages from PowerFlex Manager or Gateway. Import functionality is not supported.

Example Usage

/*
Copyright (c) 2023-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.
*/

# Example for uploading packages. After successful execution, packages will be uploaded to the gateway.
resource "powerflex_package" "upload-test" {
  file_path = ["/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-lia-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-mdm-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sds-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sdc-3.6-700.103.el7.x86_64.rpm",
    "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sdr-3.6-700.103.el7.x86_64.rpm",
  "/root/powerflex_packages/PowerFlex_3.6.700.103_RHEL_OEL7/EMC-ScaleIO-sdt-3.6-700.103.el7.x86_64.rpm"]
}

After the execution of above resource block, package would have been uploaded on the PowerFlex Gateway. For more information, please check the terraform state file.

Schema

Required

file_path (List of String) The list of path of packages

Read-Only

id (String) The ID of the package.
package_details (Attributes Set) Uploaded Packages details. (see below for nested schema)

Nested Schema for `package_details`

Read-Only:

file_name (String) The Name of package.
label (String) Uploaded Package Minor Version with OS Combination.
latest (Boolean) Package Version is latest or not
linux_flavour (String) Type of Linux OS
operating_system (String) Supported OS.
sio_patch_number (Number) Package Patch Number.
size (Number) Size of Package.
type (String) Type of Package. Like. MDM, LIA, SDS, SDC, etc.
version (String) Uploaded Package Version.

V1.9.0: powerflex_peer_system data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_peer_system (Data Source)

This datasource is used to read the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve
# This feature is only supported for PowerFlex 4.5 and above.

# Get all Peer System details present on the cluster
data "powerflex_peer_system" "example1" {
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_peer_system" "peer_system_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     perf_profile = ["^.*Performance$"]
#   }
# }

# output "peerSystemFilterRegexResult"{
#  value = data.powerflex_peer_system.peer_system_filter_regex.peer_system_details
# }

# Get Peer System details using filter with all values
# If there is no intersection between the filters then an empty datasource will be returned
# For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples
# data "powerflex_peer_system" "example2" {
#   filter {
#     id = ["b27112300000000"]
#     coupling_rc = ["SUCCESS"]
#     membership_state = ["Joined"]
#     name = ["10654"]
#     peer_system_id = ["89980fe50ff2243f"]
#     perf_profile = ["HighPerformance"]
#     network_type = ["External"]
#     port = [9091]
#     software_version_info = ["R4_6.2134.0"]
#     system_id = ["7d2f6023117d93f0"]
#   }
# }

output "peer_system_result" {
  value = data.powerflex_peer_system.example1.peer_system_details
}

After the successful execution of above said block, We can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_peer_system.example1.attribute_name where attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) default datasource id
peer_system_details (Attributes List) List of Peer MDMs (see below for nested schema)

Nested Schema for `filter`

Optional:

coupling_rc (Set of String) List of coupling_rc
id (Set of String) List of id
membership_state (Set of String) List of membership_state
name (Set of String) List of name
network_type (Set of String) List of network_type
peer_system_id (Set of String) List of peer_system_id
perf_profile (Set of String) List of perf_profile
port (Set of Number) List of port
software_version_info (Set of String) List of software_version_info
system_id (Set of String) List of system_id

Nested Schema for `peer_system_details`

Read-Only:

coupling_rc (String) Coupling return code number of the peer mdm system.
id (String) Unique identifier of the peer mdm instance.
ip_list (Attributes List) List of ips for the peer mdm system. (see below for nested schema)
membership_state (String) membership state of the peer mdm instance.
name (String) Name of the peer mdm instance.
network_type (String) Network type of the peer mdm system.
peer_system_id (String) Unique identifier of the peer mdm system.
perf_profile (String) Performance profile of the peer mdm instance.
port (Number) Port of the peer mdm instance.
software_version_info (String) Software version details of the peer mdm instance.
system_id (String) Unique identifier of the peer mdm system.

Nested Schema for `peer_system_details.ip_list`

Read-Only:

ip (String) Specifies the ip.

V1.9.0: powerflex_peer_system resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_peer_system (Resource)

This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array. Peer system refers to the setup where multiple MDM nodes work together as peers to provide redundancy and high availability. This means that if one MDM node fails, other peer MDM nodes can take over its responsibilities, ensuring continuous operation without disruptions

Known Limitations

Certificate Exchange on PFMP 5.1

The add_certificate = true parameter is not supported on PowerFlex Management Platform (PFMP) 5.1. The certificate exchange functionality requires SSH/scli commands which are incompatible with PFMP 5.1. Additionally, the REST API certificate trust endpoints (/api/trustHostCertificate/Mdm) return HTTP 500 errors on PFMP 5.1 and are not functional.

Workaround: Set add_certificate = false when using PFMP 5.1. The peer system can still be created and managed without certificate exchange. Certificate exchange must be performed manually via the PFMP UI or alternative methods.

Affected Versions: PFMP 5.1 (PowerFlex Gen2 with Core 5.1) Working Versions: PFMP 4.5, PFMP 4.6, PFMP 5.0 (PowerFlex Gen1)

Example Usage

/*
Copyright (c) 2024-2026 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.
*/

terraform {
  required_providers {
    powerflex = {
      source                = "registry.terraform.io/dell/powerflex"
      configuration_aliases = [powerflex.system_1, powerflex.system_2]
    }
  }
}

provider "powerflex" {
  alias    = "system_1"
  username = var.username_system_1
  password = var.password_system_1
  endpoint = "https://${var.endpoint_system_1}"
  insecure = true
  timeout  = 120
}

provider "powerflex" {
  alias    = "system_2"
  username = var.username_system_2
  password = var.password_system_2
  endpoint = "https://${var.endpoint_system_2}"
  insecure = true
  timeout  = 120
}

data "powerflex_protection_domain" "protection_domain_system_2" {
  provider = powerflex.system_2
  name     = var.protection_domain_name_system_2
}

data "powerflex_protection_domain" "protection_domain_system_1" {
  provider = powerflex.system_1
  name     = var.protection_domain_name_system_1
}


resource "powerflex_peer_system" "system_1" {
  provider = powerflex.system_1

  // This should be done in order to avoid a confict while sshing
  depends_on = [resource.powerflex_peer_system.system_1]
  ### Required Values

  # New name of the Peer System
  name = var.name
  # Peer System (System 2) ID
  peer_system_id = data.powerflex_protection_domain.protection_domain_system_2.protection_domains[0].system_id
  # List of Peer MDM Ips at the destination
  ip_list = var.mdm_ips_system_2

  ### Optional with defaults if unset


  # Add certificate flag, default: false. 
  # If true source_primary_mdm_information and destination_primary_mdm_information must be filled out in order to get and set the certificate
  #add_certificate = true

  # source_primary_mdm_information = {
  #   # Required fields
  #   ip = "1.2.3.4"
  #   ssh_username = "user"
  #   ssh_password = "pass"
  #   management_ip = var.endpoint_system_1
  #   management_username = var.username_system_1
  #   management_password = var.password_system_1
  #   # Optional field defaults to 22
  #   #ssh_port = "22"
  # }

  # destination_primary_mdm_information = {
  #   # Required fields
  #   ip = "1.2.3.4"
  #   ssh_username = "user"
  #   ssh_password = "pass"
  #   management_ip = var.endpoint_system_2
  #   management_username = var.username_system_2
  #   management_password = var.password_system_2
  #   # Optional field defaults to 22
  #   #ssh_port = "22"
  # }

  # Port of the Peer System Default: 7611
  #port = 7611
  # Sets the Performance Profile, Options (Compact, HighPerformance) Default: HighPerformance
  #perf_profile = "HighPerformance"
}

resource "powerflex_peer_system" "system_2" {
  provider = powerflex.system_2
  ### Required Values

  # New name of the Peer System
  name = var.name
  # Peer System (System 1) ID
  peer_system_id = data.powerflex_protection_domain.protection_domain_system_1.protection_domains[0].system_id
  # List of Peer MDM Ips at the destination
  ip_list = var.mdm_ips_system_1

  ### Optional with defaults if unset


  # Add certificate flag, default: false. 
  # If true source_primary_mdm_information and destination_primary_mdm_information must be filled out in order to get and set the certificate
  # add_certificate = true

  # source_primary_mdm_information = {
  #   # Required fields
  #   ip = "1.2.3.4"
  #   ssh_username = "user"
  #   ssh_password = "pass"
  #   management_ip = var.endpoint_system_2
  #   management_username = var.username_system_2
  #   management_password = var.password_system_2
  #   # Optional field defaults to 22
  #   #ssh_port = "22"
  # }

  # destination_primary_mdm_information = {
  #   # Required fields
  #   ip = "1.2.3.4"
  #   ssh_username = "user"
  #   ssh_password = "pass"
  #   management_ip = var.endpoint_system_1
  #   management_username = var.username_system_1
  #   management_password = var.password_system_1
  #   # Optional field defaults to 22
  #   #ssh_port = "22"
  # }

  # Port of the Peer System Default: 7611
  #port = 7611
  # Sets the Performance Profile, Options (Compact, HighPerformance) Default: HighPerformance
  #perf_profile = "HighPerformance"
}

After the execution of above resource block, the two PowerFlex Peer Systems will be connected. The user can then setup Replication Groups and Pairs in order to replicate volumes across powerflex systems. For more information, please check the terraform state file.

Schema

Required

ip_list (Set of String) List of ips for the peer mdm system.
name (String) Name of the peer mdm instance.
peer_system_id (String) Unique identifier of the peer mdm system.

Optional

add_certificate (Boolean) Flag that if set to true will attempt to add certificate of the peer mdm destination to source. This flag is only used during create.
destination_primary_mdm_information (Attributes) Only used if add_certificate is set to true during create. The destination primary mdm information to get the root certificate. (see below for nested schema)
perf_profile (String) Performance profile of the peer mdm instance.
port (Number) Port of the peer mdm instance.
source_primary_mdm_information (Attributes) Only used if add_certificate is set to true during create. The source primary mdm information to get the root certificate. (see below for nested schema)

Read-Only

coupling_rc (String) Coupling return code number of the peer mdm system.
id (String) Unique identifier of the peer mdm instance.
membership_state (String) membership state of the peer mdm instance.
network_type (String) Network type of the peer mdm system.
software_version_info (String) Software version details of the peer mdm instance.
system_id (String) Unique identifier of the peer mdm system.

Nested Schema for `destination_primary_mdm_information`

Optional:

ip (String) ip of the primary destination mdm instance.
management_ip (String) ip of the destination management instance.
management_password (String, Sensitive) password of the management instance.
management_username (String) ssh username of the destination management instance.
ssh_password (String, Sensitive) ssh password of the primary destination mdm instance.
ssh_port (String) port of the primary destination mdm instance.
ssh_username (String) ssh username of the destination primary mdm instance.

Nested Schema for `source_primary_mdm_information`

Optional:

ip (String) ip of the primary source mdm instance.
management_ip (String) ip of the source management instance.
management_password (String, Sensitive) password of the source instance.
management_username (String) ssh username of the source management instance.
ssh_password (String, Sensitive) ssh password of the source primary mdm instance.
ssh_port (String) port of the primary source mdm instance.
ssh_username (String) ssh username of the source primary mdm instance.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2024-2026 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.
# */

# import Peer System by its id
terraform import powerflex_peer_system.example "<id>"

This will import the resource instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_protection_domain data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_protection_domain (Data Source)

This datasource is used to query the existing protection domain from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Note: Only one of name and id can be provided at a time.

Example Usage

/*
Copyright (c) 2023-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.
*/
# commands to run this tf file : terraform init && terraform apply --auto-approve
data "powerflex_protection_domain" "all" {
}

output "inputAll" {
  value = data.powerflex_protection_domain.all.protection_domains
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_protection_domain" "protection_domain_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     rf_cache_opertional_mode = ["^.*Write.*$"]
#   }
# }

# output "protectionDomainFilterRegexResult"{
#  value = data.powerflex_protection_domain.protection_domain_filter_regex.protection_domains
# }


# Get Peer System details using filter with all values
# If there is no intersection between the filters then an empty datasource will be returned
# For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples
data "powerflex_protection_domain" "filter" {
  filter {
    # system_id = ["systemID1", "systemID2"]
    # replication_capacity_max_ratio = [1,2]
    # rebuild_network_throttling_in_kbps = [1,2]
    # rebalance_network_throttling_in_kbps = [1,2]
    # overall_io_network_throttling_in_kbps = [1,2]
    # vtree_migration_network_throttling_in_kbps = [1,2]
    # protected_maintenance_mode_network_throttling_in_kbps = [1,2]
    # overall_io_network_throttling_enabled = false
    # rebuild_network_throttling_enabled = false
    # rebalance_network_throttling_enabled = false
    # vtree_migration_network_throttling_enabled = false
    # protected_maintenance_mode_network_throttling_enabled = false
    # fgl_default_num_concurrent_writes = [1,2]
    # fgl_metadata_cache_enabled = false
    # fgl_default_metadata_cache_size = [1,2]
    # rf_cache_enabled = false
    # rf_cache_accp_id = ["rfcache_accp_id1", "rfcache_accp_id2"]
    # rf_cache_opertional_mode = ["rfcache_opertional_mode1", "rfcache_opertional_mode2"]
    # rf_cache_page_size_kb = [1,2]
    # rf_cache_max_io_size_kb = [1,2]
    # state = ["state1", "state2"]
    # name = ["name1", "name2"]
    # id = ["id1", "id2"]
  }
}

output "inputAll" {
  value = data.powerflex_protection_domain.filter.protection_domains
}

After the successful execution of above said block, We can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_protection_domain.pd.attribute_name where attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)
id (String) Unique identifier of the protection domain instance. Conflicts with name.

Read-Only

protection_domains (Attributes List) List of protection domains fetched. (see below for nested schema)

Nested Schema for `filter`

Optional:

fgl_default_metadata_cache_size (Set of Number) List of fgl_default_metadata_cache_size
fgl_default_num_concurrent_writes (Set of Number) List of fgl_default_num_concurrent_writes
fgl_metadata_cache_enabled (Boolean) Value for fgl_metadata_cache_enabled
id (Set of String) List of id
name (Set of String) List of name
overall_io_network_throttling_enabled (Boolean) Value for overall_io_network_throttling_enabled
overall_io_network_throttling_in_kbps (Set of Number) List of overall_io_network_throttling_in_kbps
protected_maintenance_mode_network_throttling_enabled (Boolean) Value for protected_maintenance_mode_network_throttling_enabled
protected_maintenance_mode_network_throttling_in_kbps (Set of Number) List of protected_maintenance_mode_network_throttling_in_kbps
rebalance_network_throttling_enabled (Boolean) Value for rebalance_network_throttling_enabled
rebalance_network_throttling_in_kbps (Set of Number) List of rebalance_network_throttling_in_kbps
rebuild_network_throttling_enabled (Boolean) Value for rebuild_network_throttling_enabled
rebuild_network_throttling_in_kbps (Set of Number) List of rebuild_network_throttling_in_kbps
replication_capacity_max_ratio (Set of Number) List of replication_capacity_max_ratio
rf_cache_accp_id (Set of String) List of rf_cache_accp_id
rf_cache_enabled (Boolean) Value for rf_cache_enabled
rf_cache_max_io_size_kb (Set of Number) List of rf_cache_max_io_size_kb
rf_cache_opertional_mode (Set of String) List of rf_cache_opertional_mode
rf_cache_page_size_kb (Set of Number) List of rf_cache_page_size_kb
state (Set of String) List of state
system_id (Set of String) List of system_id
vtree_migration_network_throttling_enabled (Boolean) Value for vtree_migration_network_throttling_enabled
vtree_migration_network_throttling_in_kbps (Set of Number) List of vtree_migration_network_throttling_in_kbps

Nested Schema for `protection_domains`

Read-Only:

fgl_default_metadata_cache_size (Number) Fine Granularity Metadata Cache size.
fgl_default_num_concurrent_writes (Number) Fine Granularity default number of concurrent writes.
fgl_metadata_cache_enabled (Boolean) Whether Fine Granularity Metadata Cache is enabled or not.
id (String) Unique identifier of the protection domain instance.
links (Attributes List) Underlying REST API links. (see below for nested schema)
mdm_sds_network_disconnections_counter (Attributes) MDM-SDS Network Disconnection Counter windows. (see below for nested schema)
name (String) Unique name of the protection domain instance.
overall_io_network_throttling_enabled (Boolean) Whether network throttling is enabled for overall io.
overall_io_network_throttling_in_kbps (Number) Maximum allowed io for protected maintenance mode in KBps. Must be greater than any other network throttling parameter.
protected_maintenance_mode_network_throttling_enabled (Boolean) Whether network throttling is enabled for protected maintenance mode.
protected_maintenance_mode_network_throttling_in_kbps (Number) Maximum allowed io for protected maintenance mode in KBps.
rebalance_network_throttling_enabled (Boolean) Whether network throttling is enabled for rebalancing.
rebalance_network_throttling_in_kbps (Number) Maximum allowed io for rebalancing in KBps.
rebuild_network_throttling_enabled (Boolean) Whether network throttling is enabled for rebuilding.
rebuild_network_throttling_in_kbps (Number) Maximum allowed io for rebuilding in KBps.
replication_capacity_max_ratio (Number) Maximum Replication Capacity Ratio.
rf_cache_accp_id (String) ID of the Rf Cache Acceleration Pool attached to the PD.
rf_cache_enabled (Boolean) Whether SDS Rf Cache is enabled or not.
rf_cache_max_io_size_kb (Number) Maximum io of the SDS RF Cache in KB.
rf_cache_opertional_mode (String) Operational Mode of the SDS RF Cache.
rf_cache_page_size_kb (Number) Page size of the SDS RF Cache in KB.
sdr_sds_connectivity (Attributes) SDR-SDS Connectivity information. (see below for nested schema)
sds_configuration_failure_counter (Attributes) SDS Configuration Failure Counter windows. (see below for nested schema)
sds_decoupled_counter (Attributes) SDS Decoupled Counter windows. (see below for nested schema)
sds_receive_buffer_allocation_failures_counter (Attributes) SDS receive Buffer Allocation Failure Counter windows. (see below for nested schema)
sds_sds_network_disconnections_counter (Attributes) SDS-SDS Network Disconnection Counter windows. (see below for nested schema)
state (String) State of a PD. Valid values are Active, ActivePending, Inactive or InactivePending.
system_id (String) System ID of the PD.
vtree_migration_network_throttling_enabled (Boolean) Whether network throttling is enabled for vtree migration.
vtree_migration_network_throttling_in_kbps (Number) Maximum allowed io for vtree migration in KBps.

Nested Schema for `protection_domains.links`

Read-Only:

href (String) Specifies the exact path to fetch the details.
rel (String) Specifies the relationship with the Protection Domain.

Nested Schema for `protection_domains.mdm_sds_network_disconnections_counter`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `protection_domains.mdm_sds_network_disconnections_counter.long_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.mdm_sds_network_disconnections_counter.medium_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.mdm_sds_network_disconnections_counter.short_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sdr_sds_connectivity`

Read-Only:

client_server_conn_status (String) Connectivity Status.
disconnected_client_id (String) ID of the disconnected client.
disconnected_client_name (String) Name of the disconnected client.
disconnected_server_id (String) ID of the disconnected server.
disconnected_server_ip (String) IP address of the disconnected server.
disconnected_server_name (String) Name of the disconnected server.

Nested Schema for `protection_domains.sds_configuration_failure_counter`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `protection_domains.sds_configuration_failure_counter.long_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_configuration_failure_counter.medium_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_configuration_failure_counter.short_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_decoupled_counter`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `protection_domains.sds_decoupled_counter.long_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_decoupled_counter.medium_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_decoupled_counter.short_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_receive_buffer_allocation_failures_counter`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `protection_domains.sds_receive_buffer_allocation_failures_counter.long_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_receive_buffer_allocation_failures_counter.medium_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_receive_buffer_allocation_failures_counter.short_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_sds_network_disconnections_counter`

Read-Only:

long_window (Attributes) Long Window Parameters. (see below for nested schema)
medium_window (Attributes) Medium Window Parameters. (see below for nested schema)
short_window (Attributes) Short Window Parameters. (see below for nested schema)

Nested Schema for `protection_domains.sds_sds_network_disconnections_counter.long_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_sds_network_disconnections_counter.medium_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

Nested Schema for `protection_domains.sds_sds_network_disconnections_counter.short_window`

Read-Only:

threshold (Number) Threshold.
window_size_in_sec (Number) Window Size in seconds.

V1.9.0: powerflex_protection_domain resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_protection_domain (Resource)

This resource is used to manage the Protection Domain entity of the PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from the PowerFlex array.

Caution: Protection Domain creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). If the taint is not removed, terraform will destroy and recreate the resource.

Example Usage

/*
Copyright (c) 2023-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.
*/

# Example for creating protection domain. After successful execution, protection domain will be created on the cluster.
resource "powerflex_protection_domain" "pd" {
  # required paramaters  ======

  name = "domain_1"

  # optional parameters  ======

  active = true

  # SDS IOPS throttling
  # overall_io_network_throttling_in_kbps must be greater than the rest of the parameters
  # 0 indicates unlimited IOPS
  protected_maintenance_mode_network_throttling_in_kbps = 10 * 1024
  rebuild_network_throttling_in_kbps                    = 10 * 1024
  rebalance_network_throttling_in_kbps                  = 10 * 1024
  vtree_migration_network_throttling_in_kbps            = 10 * 1024
  overall_io_network_throttling_in_kbps                 = 20 * 1024

  # Fine granularity metadata caching
  fgl_metadata_cache_enabled      = true
  fgl_default_metadata_cache_size = 1024

  # Read Flash cache
  rf_cache_enabled          = true
  rf_cache_operational_mode = "ReadAndWrite" # Read/Write/ReadAndWrite/WriteMiss
  rf_cache_page_size_kb     = 16
  rf_cache_max_io_size_kb   = 32
}

After the execution of above resource block, protection domain would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

name (String) Unique name of the protection domain instance.

Optional

active (Boolean) Whether the PD should be in Active state. Default value is true.
fgl_default_metadata_cache_size (Number) Fine Granularity Metadata Cache size. Can be set only when fgl_metadata_cache_enabled is set to true.
fgl_metadata_cache_enabled (Boolean) Whether Fine Granularity Metadata Cache is enabled or not.
overall_io_network_throttling_in_kbps (Number) Maximum allowed IO for protected maintenance mode in KBps. Must be greater than any other network throttling parameter. The value 0 represents unlimited bandwidth. The default value is 0.
protected_maintenance_mode_network_throttling_in_kbps (Number) Maximum allowed IO for protected maintenance mode in KBps. The value 0 represents unlimited bandwidth. The default value is 0.
rebalance_network_throttling_in_kbps (Number) Maximum allowed IO for rebalancing in KBps. The value 0 represents unlimited bandwidth. The default value is 0.
rebuild_network_throttling_in_kbps (Number) Maximum allowed IO for rebuilding in KBps. The value 0 represents unlimited bandwidth. The default value is 0.
rf_cache_enabled (Boolean) Whether SDS Rf Cache is enabled or not. Default value is true.
rf_cache_max_io_size_kb (Number) Maximum IO of the SDS RF Cache in KB. Can be set only when rf_cache_enabled is set to true.
rf_cache_operational_mode (String) Operational Mode of the SDS RF Cache. Accepted values are Read, Write, ReadAndWrite and WriteMiss. Can be set only when rf_cache_enabled is set to true.
rf_cache_page_size_kb (Number) Page size of the SDS RF Cache in KB. Can be set only when rf_cache_enabled is set to true.
vtree_migration_network_throttling_in_kbps (Number) Maximum allowed IO for vtree migration in KBps. The value 0 represents unlimited bandwidth. The default value is 0.

Read-Only

fgl_default_num_concurrent_writes (Number) Fine Granularity default number of concurrent writes.
id (String) Unique identifier of the protection domain instance.
links (Attributes List) Underlying REST API links. (see below for nested schema)
replication_capacity_max_ratio (Number) Maximum Replication Capacity Ratio.
rf_cache_accp_id (String) ID of the RF Cache Acceleration Pool attached to the PD.
state (String) State of the PD.

Nested Schema for `links`

Read-Only:

href (String) Specifies the exact path to fetch the details.
rel (String) Specifies the relationship with the Protection Domain.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2023-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.
# */

# import Protection Domain by it's id
terraform import powerflex_protection_domain.pd_data "<id>"

This will import the protection domain instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_replication_consistency_group data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_replication_consistency_group (Data Source)

This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply
# This feature is only supported for PowerFlex 4.5 and above.

// Empty filter block will return all the replication conistancy group
data "powerflex_replication_consistency_group" "rcg" {}
output "rcgResult" {
  value = data.powerflex_replication_consistency_group.rcg
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_replication_consistency_group" "rcg_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     target_volume_access_mode = ["^.*Access$"]
#   }
# }

# output "rcgFilterRegexResult"{
#  value = data.powerflex_replication_consistency_group.rcg_filter_regex.rcg_filter
# }


// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/ 
data "powerflex_replication_consistency_group" "rcg_filter" {
  filter {
    # id = ["id", "id2"]
    # name = ["name-1", "name-2"]
    # remote_id = ["remote_id-1", "remote_id-2"]
    # rpo_in_seconds = [15]
    # protection_domain_id = ["protection_domain_id-1", "protection_domain_id-2"]
    # remote_protection_domain_id = ["remote_protection_domain_id-1", "remote_protection_domain_id-2"]
    # destination_system_id = ["destination_system_id-1", "destination_system_id-2"]
    # peer_mdm_id = ["peer_mdm_id-1", "peer_mdm_id-2"]
    # remote_mdm_id = ["remote_mdm_id-1", "remote_mdm_id-2"]
    # replication_direction = ["replication_direction-1", "replication_direction-2"]
    # curr_consist_mode = ["curr_consist_mode-1", "curr_consist_mode-2"]
    # freeze_state = ["freeze_state-1", "freeze_state-2"]
    # pause_mode = ["pause_mode-1", "pause_mode-2"]
    # lifetime_state = ["lifetime_state-1", "lifetime_state-2"]
    # snap_creation_in_progress = false
    # last_snap_group_id = ["last_snap_group_id-1", "last_snap_group_id-2"]
    # type = ["type-1", "type-2"]
    # disaster_recovery_state = ["disaster_recovery_state-1", "disaster_recovery_state-2"]
    # remote_disaster_recovery_state = ["remote_disaster_recovery_state-1", "remote_disaster_recovery_state-2"]
    # target_volume_access_mode = ["target_volume_access_mode-1", "target_volume_access_mode-2"]
    # failover_type = ["failover_type-1", "failover_type-2"]
    # failover_state = ["failover_state-1", "failover_state-2"]
    # active_local = false
    # active_remote = false
    # abstract_state = ["abstract_state-1", "abstract_state-2"]
    # error = [403]
    # local_activity_state = ["local_activity_state-1", "local_activity_state-2"]
    # remote_activity_state = ["remote_activity_state-1", "remote_activity_state-2"]
    # inactive_reason = [1]
  }
}
output "rcgResultFiltered" {
  value = data.powerflex_replication_consistency_group.rcg_filter
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_replication_conistancy_group.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) default datasource id
replication_consistency_group_details (Attributes List) List of Replication Consistency Group (see below for nested schema)

Nested Schema for `filter`

Optional:

abstract_state (Set of String) List of abstract_state
active_local (Boolean) Value for active_local
active_remote (Boolean) Value for active_remote
curr_consist_mode (Set of String) List of curr_consist_mode
destination_system_id (Set of String) List of destination_system_id
disaster_recovery_state (Set of String) List of disaster_recovery_state
error (Set of Number) List of error
failover_state (Set of String) List of failover_state
failover_type (Set of String) List of failover_type
freeze_state (Set of String) List of freeze_state
id (Set of String) List of id
inactive_reason (Set of Number) List of inactive_reason
last_snap_group_id (Set of String) List of last_snap_group_id
lifetime_state (Set of String) List of lifetime_state
local_activity_state (Set of String) List of local_activity_state
name (Set of String) List of name
pause_mode (Set of String) List of pause_mode
peer_mdm_id (Set of String) List of peer_mdm_id
protection_domain_id (Set of String) List of protection_domain_id
remote_activity_state (Set of String) List of remote_activity_state
remote_disaster_recovery_state (Set of String) List of remote_disaster_recovery_state
remote_id (Set of String) List of remote_id
remote_mdm_id (Set of String) List of remote_mdm_id
remote_protection_domain_id (Set of String) List of remote_protection_domain_id
replication_direction (Set of String) List of replication_direction
rpo_in_seconds (Set of Number) List of rpo_in_seconds
snap_creation_in_progress (Boolean) Value for snap_creation_in_progress
target_volume_access_mode (Set of String) List of target_volume_access_mode
type (Set of String) List of type

Nested Schema for `replication_consistency_group_details`

Read-Only:

abstract_state (String) Abstract State of the replication consistency group instance.
active_local (Boolean) Active Local of the replication consistency group instance.
active_remote (Boolean) Active Remote of the replication consistency group instance.
curr_consist_mode (String) Consistency Mode of the replication consistency group instance.
destination_system_id (String) Destination System ID of the replication consistency group instance.
disaster_recovery_state (String) Disaster Recovery State of the replication consistency group instance.
error (Number) Error of the replication consistency group instance.
failover_state (String) Failover State of the replication consistency group instance.
failover_type (String) Failover Type of the replication consistency group instance.
freeze_state (String) Freeze State of the replication consistency group instance.
id (String) Unique identifier of the replication consistency group instance.
inactive_reason (Number) Inactive Reason of the replication consistency group instance.
last_snap_group_id (String) Last Snap Group ID of the replication consistency group instance.
lifetime_state (String) Lifetime State of the replication consistency group instance.
local_activity_state (String) Local Activity State of the replication consistency group instance.
name (String) Name of the replication consistency group instance.
pause_mode (String) Pause Mode of the replication consistency group instance.
peer_mdm_id (String) Peer MDM ID of the replication consistency group instance.
protection_domain_id (String) Protection Domain ID of the replication consistency group instance.
remote_activity_state (String) Remote Activity State of the replication consistency group instance.
remote_disaster_recovery_state (String) Remote Disaster Recovery State of the replication consistency group instance.
remote_id (String) Remote ID of the replication consistency group instance.
remote_mdm_id (String) Remote MDM ID of the replication consistency group instance.
remote_protection_domain_id (String) Remote Protection Domain ID of the replication consistency group instance.
replication_direction (String) Replication Direction of the replication consistency group instance.
rpo_in_seconds (Number) rpoInSeconds of the replication consistency group instance.
snap_creation_in_progress (Boolean) Snap Creation In Progress of the replication consistency group instance.
target_volume_access_mode (String) Target Volume Access Mode of the replication consistency group instance.
type (String) Type of the replication consistency group instance.

V1.9.0: powerflex_replication_consistency_group resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_replication_consistency_group (Resource)

This resource is used to manage the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.

Example Usage

/*
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.
*/

terraform {
  required_providers {
    powerflex = {
      source                = "registry.terraform.io/dell/powerflex"
      configuration_aliases = [powerflex.source, powerflex.destination]
    }
  }
}

provider "powerflex" {
  alias    = "source"
  username = var.username_source
  password = var.password_source
  endpoint = var.endpoint_source
  insecure = true
  timeout  = 120
}

provider "powerflex" {
  alias    = "destination"
  username = var.username_destination
  password = var.password_destination
  endpoint = var.endpoint_destination
  insecure = true
  timeout  = 120
}

data "powerflex_protection_domain" "source_protection_domain" {
  provider = powerflex.source
  name     = var.source_protection_domain_name
}

data "powerflex_protection_domain" "destination_protection_domain" {
  provider = powerflex.destination
  name     = var.destination_protection_domain_name
}

resource "powerflex_replication_consistency_group" "example" {
  provider = powerflex.source
  ### Required Values

  # New name of the Replication Consistency Group
  name = var.name
  # Protection domain on the source machine
  protection_domain_id = data.powerflex_protection_domain.source_protection_domain.protection_domains[0].id
  # Protection domain on the destination machine
  remote_protection_domain_id = data.powerflex_protection_domain.destination_protection_domain.protection_domains[0].id
  # Destination System ID
  destination_system_id = data.powerflex_protection_domain.destination_protection_domain.protection_domains[0].system_id

  ### Optional with defaults if unset

  # Must be greater the 15 or less then 3600 (seconds) Default: 15
  #rpo_in_seconds = 15
  # Sets the Active state, Options (Active, Terminated) Default: Active
  #local_activity_state = "Active"
  # Sets the Volume Access Mode, Options (NoAccess, ReadOnly) Default: NoAccess
  #target_volume_access_mode = "NoAccess"
  # Pause Mode, Options (Resume, Pause) Default: Resume
  #pause_mode = "Resume"
  # Freeze State, Options (Unfrozen, Frozen) Default: Unfrozen
  #freeze_state = "Unfrozen"
  # Current Consistency Mode, Options (Consistent, Inconsistent) Default: Consistent
  #curr_consist_mode = "Consistent"
}

After the execution of above resource block, the Replication Consistency Group will be created between the two Peer Systems. The user can then add Replication Pairs to the RCGs in order to replicate volumes between systems. For more information, please check the terraform state file.

Schema

Required

destination_system_id (String) Replication Consistency Group Destination System ID
name (String) Replication Consistency Group Name
protection_domain_id (String) Replication Consistency Group Protection Domain ID
remote_protection_domain_id (String) Replication Consistency Group Remote Protection Domain ID

Optional

curr_consist_mode (String) Consistency Mode of the replication consistency group instance.
freeze_state (String) Freeze State of the replication consistency group instance.
local_activity_state (String) Local Activity State of the replication consistency group instance.
pause_mode (String) Pause Mode of the replication consistency group instance.
rpo_in_seconds (Number) Replication Consistency Group RPO in Seconds (min: 15, default 15, max: 3600)
target_volume_access_mode (String) Target Volume Access Mode of the replication consistency group instance.

Read-Only

abstract_state (String) Abstract State of the replication consistency group instance.
active_local (Boolean) Active Local of the replication consistency group instance.
active_remote (Boolean) Active Remote of the replication consistency group instance.
disaster_recovery_state (String) Disaster Recovery State of the replication consistency group instance.
error (Number) Error of the replication consistency group instance.
failover_state (String) Failover State of the replication consistency group instance.
failover_type (String) Failover Type of the replication consistency group instance.
id (String) Unique identifier of the replication consistency group instance.
inactive_reason (Number) Inactive Reason of the replication consistency group instance.
last_snap_group_id (String) Last Snap Group ID of the replication consistency group instance.
lifetime_state (String) Lifetime State of the replication consistency group instance.
peer_mdm_id (String) Replication Consistency Group Peer Mdm ID
remote_activity_state (String) Remote Activity State of the replication consistency group instance.
remote_disaster_recovery_state (String) Remote Disaster Recovery State of the replication consistency group instance.
remote_id (String) Remote ID of the replication consistency group instance.
remote_mdm_id (String) Remote MDM ID of the replication consistency group instance.
replication_direction (String) Replication Direction of the replication consistency group instance.
snap_creation_in_progress (Boolean) Snap Creation In Progress of the replication consistency group instance.
type (String) Type of the replication consistency group instance.

Import

Import is supported using the following syntax:

# /*
# 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.
# */

# import Replication Consistency Group by its id
terraform import powerflex_replication_consistency_group.example "<id>"

This will import the resource instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_replication_consistency_group_action resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_replication_consistency_group_action (Resource)

This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.

Example Usage

/*
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.
*/

terraform {
  required_providers {
    powerflex = {
      source = "registry.terraform.io/dell/powerflex"
    }
  }
}

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

// Resource to manage lifecycle
resource "terraform_data" "always_run" {
  input = timestamp()
}

data "powerflex_replication_consistency_group" "rcg_filter" {
  filter {
    name = [var.replication_consistency_group_name]
  }
}

resource "powerflex_replication_consistency_group_action" "example" {
  # Required

  # Id of the replication consistency group
  id = data.powerflex_replication_consistency_group.rcg_filter.replication_consistency_group_details[0].id

  # Action to be performed on the replication consistency group.
  # Options are Failover, Restore, Sync, Reverse, Switchover and Snapshot (Default is Sync)
  action = var.action

  // This will allow terraform create process to trigger each time we run terraform apply.
  lifecycle {
    replace_triggered_by = [
      terraform_data.always_run
    ]
  }
}

After the execution of above resource block, The selected Action will be preformed on the selected RCG. Each time the RCG Actions resource is run it will preform the action again. For more information, please check the terraform state file.

Schema

Required

id (String) Replication Consistency Group ID

Optional

action (String) Replication Consistency Group Action

V1.9.0: powerflex_replication_pair data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_replication_pair (Data Source)

This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. An RCG is a collection of multiple replication pairs that need to be replicated together in a coordinated and consistent manner. The key purpose is to ensure that all the data within the group is replicated in a consistent state. Applies to a group of data that needs to be kept consistent across the source and target

Example Usage

/*
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.
*/

# commands to run this tf file : terraform init && terraform apply
# This feature is only supported for PowerFlex 4.5 and above.

// Empty filter block will return all the replication pairs
data "powerflex_replication_pair" "rp" {}
output "rpResult" {
  value = data.powerflex_replication_pair.rp
}

# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_replication_pair" "replication_pair_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     peer_system_name = ["^Peer_System_.*$"]
#   }
# }

# output "replicationPairFilterRegexResult"{
#  value = data.powerflex_replication_pair.replication_pair_filter_regex.rp_filter
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/ 
data "powerflex_replication_pair" "rp_filter" {
  filter {
    # id = ["id", "id2"]
    # name = ["name-1", "name-2"]
    # remote_id = ["remote_id-1", "remote_id-2"]
    # user_requested_pause_transmit_init_copy = false
    # remote_capacity_in_mb = [8192]
    # local_volume_id = ["local_volume_id-1", "local_volume_id-2"]
    # remote_volume_id = ["remote_volume_id-1", "remote_volume_id-2"]
    # remote_volume_name = ["remote_volume_name-1", "remote_volume_name-2"]
    # replication_consistency_group_id = ["replication_consistency_group_id-1", "replication_consistency_group_id-2"]
    # copy_type = ["copy_type-1", "copy_type-2"]
    # lifetime_state = ["lifetime_state-1", "lifetime_state-2"]
    # peer_system_name = ["peer_system_name-1", "peer_system_name-2"]
    # initial_copy_state = ["initial_copy_state-1", "initial_copy_state-2"]
    # initial_copy_priority = [0, 1]
  }
}
output "rpResultFiltered" {
  value = data.powerflex_replication_pair.rp_filter
}

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_replication_pair.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) default datasource id
replication_pair_details (Attributes List) List of Replication Pairs (see below for nested schema)

Nested Schema for `filter`

Optional:

copy_type (Set of String) List of copy_type
id (Set of String) List of id
initial_copy_priority (Set of Number) List of initial_copy_priority
initial_copy_state (Set of String) List of initial_copy_state
lifetime_state (Set of String) List of lifetime_state
local_volume_id (Set of String) List of local_volume_id
name (Set of String) List of name
peer_system_name (Set of String) List of peer_system_name
remote_capacity_in_mb (Set of Number) List of remote_capacity_in_mb
remote_id (Set of String) List of remote_id
remote_volume_id (Set of String) List of remote_volume_id
remote_volume_name (Set of String) List of remote_volume_name
replication_consistency_group_id (Set of String) List of replication_consistency_group_id
user_requested_pause_transmit_init_copy (Boolean) Value for user_requested_pause_transmit_init_copy

Nested Schema for `replication_pair_details`

Read-Only:

copy_type (String) Copy Type of the replication pair instance.
id (String) Unique identifier of the replication pair instance.
initial_copy_priority (Number) Initial Copy Priority of the replication pair instance.
initial_copy_state (String) Initial Copy State of the replication pair instance.
lifetime_state (String) Lifetime State of the replication pair instance.
local_volume_id (String) Local Volume ID of the replication pair instance.
name (String) Name of the replication pair instance.
peer_system_name (String) Peer System Name of the replication pair instance.
remote_capacity_in_mb (Number) Remote Capacity in MB of the replication pair instance.
remote_id (String) Remote ID of the replication pair instance.
remote_volume_id (String) Remote Volume ID of the replication pair instance.
remote_volume_name (String) Remote Volume Name of the replication pair instance.
replication_consistency_group_id (String) Replication Consistency Group Id of the replication pair instance.
user_requested_pause_transmit_init_copy (Boolean) User Requested Pause of the replication pair instance.

V1.9.0: powerflex_replication_pair resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_replication_pair (Resource)

This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array. A replication pair involves a set of data on a source system being continuously copied to a target system. This typically applies to individual volumes, files, or objects.

Example Usage

/*
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.
*/

terraform {
  required_providers {
    powerflex = {
      source                = "registry.terraform.io/dell/powerflex"
      configuration_aliases = [powerflex.source, powerflex.destination]
    }
  }
}

provider "powerflex" {
  alias    = "source"
  username = var.username_source
  password = var.password_source
  endpoint = var.endpoint_source
  insecure = true
  timeout  = 120
}

provider "powerflex" {
  alias    = "destination"
  username = var.username_destination
  password = var.password_destination
  endpoint = var.endpoint_destination
  insecure = true
  timeout  = 120
}

# Used to get the id of the source volume
data "powerflex_volume" "source_volume" {
  provider = powerflex.source
  name     = var.volume_name_source
}

# Used to get the id of the destination volume
data "powerflex_volume" "destination_volume" {
  provider = powerflex.destination
  name     = var.volume_name_destination
}

# Used to get the id of the replication consistency group
data "powerflex_replication_consistency_group" "source_replication_consistency_group" {
  provider = powerflex.source
  filter {
    name = [var.replication_consistency_group_name_source]
  }
}

# Commands to run this tf file : terraform init && terraform plan && terraform apply
# Create, Update, Delete is supported for this resource
# name, source_volume_id, destination_volume_id, replication_consistency_group_id are the required parameters to create or update
# Only pause_initial_copy can be updated to true or false

# Create Replication Pair
resource "powerflex_replication_pair" "example" {
  provider = powerflex.source
  # Required values
  name                             = "example-replication-pair"
  source_volume_id                 = data.powerflex_volume.source_volume.volumes[0].id
  destination_volume_id            = data.powerflex_volume.destination_volume.volumes[0].id
  replication_consistency_group_id = data.powerflex_replication_consistency_group.source_replication_consistency_group.replication_consistency_group_details[0].id
  # Optional values
  # pause_initial_copy = true # Pauses the replication pair (This will only work during the initial copy process), defaults to false
}

After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

destination_volume_id (String) Destination Volume ID
name (String) Replication Pair Name
replication_consistency_group_id (String) Replication Consistency Group ID
source_volume_id (String) Source Volume ID

Optional

pause_initial_copy (Boolean) Pause Copy of the replication pair instance.

Read-Only

copy_type (String) Copy Type for Replication Pairs only value is OnlineCopy
id (String) Unique identifier of the replication pair instance.
initial_copy_priority (Number) Initial Copy Priority of the replication pair instance.
initial_copy_state (String) Initial Copy State of the replication pair instance.
lifetime_state (String) Lifetime State of the replication pair instance.
local_volume_id (String) Local Volume ID of the replication pair instance.
peer_system_name (String) Peer System Name of the replication pair instance.
remote_capacity_in_mb (Number) Remote Capacity in MB of the replication pair instance.
remote_id (String) Remote ID of the replication pair instance.
remote_volume_id (String) Remote Volume ID of the replication pair instance.
remote_volume_name (String) Remote Volume Name of the replication pair instance.
user_requested_pause_transmit_init_copy (Boolean) User Requested Pause of the replication pair instance.

Import

Import is supported using the following syntax:

# /*
# 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.
# */

# import Replication Pair by its id
terraform import powerflex_replication_pair.example "<id>"

This will import the resource instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_resource_credential data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_resource_credential (Data Source)

This datasource is used to read the Resource Credential entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.

After the successful execution of above said block, we can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_resource_credential.datasource_block_name.attribute_name where datasource_block_name is the name of the data source block and attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) default datasource id
resource_credential_details (Attributes List) List of Resource Credentials (see below for nested schema)

Nested Schema for `filter`

Optional:

created_by (Set of String) List of created_by
created_date (Set of String) List of created_date
domain (Set of String) List of domain
id (Set of String) List of id
label (Set of String) List of label
type (Set of String) List of type
updated_by (Set of String) List of updated_by
updated_date (Set of String) List of updated_date
username (Set of String) List of username

Nested Schema for `resource_credential_details`

Read-Only:

created_by (String) Who the Resource Credential was created by
created_date (String) Resource Credential created date
domain (String) Resource Credential domain
id (String) Unique identifier of the resource credential instance.
label (String) Resource Credential label
type (String) Resource Credential type
updated_by (String) Who the Resource Credential was last updated by
updated_date (String) Resource Credential updated date
username (String) Resource Credential username

V1.9.0: powerflex_resource_credential resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_resource_credential (Resource)

This resource is used to manage Resource Credential entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Resource Credentials using this resource. We can also Import an existing Resource Credentials from the PowerFlex array.

Example Usage

/*
Copyright (c) 2025-2026 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.
*/

terraform {
  required_providers {
    powerflex = {
      source = "registry.terraform.io/dell/powerflex"
    }
    local = {
      source  = "hashicorp/local"
      version = "2.5.2"
    }
    vault = {
      source  = "hashicorp/vault"
      version = "4.6.0"
    }
  }
}
// Used to grab the password
provider "vault" {
  address = "https://my-vault-server.com"
  token   = "some-token-value"
}

provider "powerflex" {
  username = "user"
  password = "password"
  endpoint = "https://example.com"
  insecure = true
  timeout  = 120
}

// Can grab secret from vault
# data "vault_generic_secret" "secret"{
#  path = "secret/instances"
# }

# Command to run this tf file : terraform init && terraform plan && terraform apply
# Create, Read, Delete and Import operations are supported for this resource

## Optional only needed if using ssh_private_key field
# data "local_file" "ssh_key" {
#   filename = var.ssh_private_key_path
# }

# Create Resource Credential
resource "powerflex_resource_credential" "example" {
  ## Required values for all credential types
  name     = var.name
  type     = var.type // Options: Node, Switch, vCenter, ElementManager, PowerflexGateway, PresentationServer, OSAdmin, OSUser
  username = var.username
  // Grab from variable file
  password = var.password
  ## Grab from vault 
  #password = "${data.vault_generic_secret.secret.data["password"]}"

  ## Required value for vCenter, ElementManager, OSUser
  #domain = var.domain

  ## Required value for PowerflexGateway
  #os_username = var.os_username
  #os_password = var.os_password

  ## Optional values for Node, Switch, ElementManager
  #snmp_v2_community_string = var.snmpv2_community_string

  ## Optional for Node
  #snmp_v3_security_level = var.snmpv3_security_level // Options "Minimal", "Moderate", or "Maximal"
  #snmp_v3_security_name = var.snmpv3_security_name
  #snmp_v3_md5_authentication_password = var.snmpv3_md5_auth_password // required for level "Moderate" and "Maximal"
  #snmp_v3_des_authentication_password = var.snmpv3_des_private_password // required for level "Maximal"

  ## Optional for Node, Switch, OSAdmin, OSUser
  #ssh_private_key = data.local_file.ssh_key.content
  #key_pair_name = var.key_pair_name
}

After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file.

Schema

Required

name (String) Resource Credential name
password (String, Sensitive) Resource Credential password
type (String) Resource Credential type
username (String) Resource Credential username

Optional

domain (String) Resource Credential domain, used by types OSUser, ElementManager and vCenterCredential
key_pair_name (String) Resource Credential key_pair_name, can be used by types Node, Switch, OSAdminCrednetial and OSUserCredential. Is Required if ssh_private_key is set
os_password (String, Sensitive) Resource Credential os_password, used by types PowerflexGateway
os_username (String) Resource Credential os_username, used by types PowerflexGateway
snmp_v2_community_string (String) Resource Credential snmp_v2_community_string, used by types Node, Switch and ElementManager. If unset it will default to public
snmp_v3_des_authentication_password (String, Sensitive) Resource Credential snmp_v3_des_authentication_password, used by types Node when snmp_v3_security_level is set to Maximal
snmp_v3_md5_authentication_password (String, Sensitive) Resource Credential snmp_v3_md5_authentication_password, used by types Node when snmp_v3_security_level is set to Moderate
snmp_v3_security_level (String) Resource Credential snmp_v3_security_level, used by types Node. Minimal requires only snmp_v3_security_name, Moderate requires snmp_v3_security_name and snmp_v3_md5_authentication_password, Maximal requires snmp_v3_security_name, snmp_v3_md5_authentication_password and snmp_v3_des_authentication_password
snmp_v3_security_name (String) Resource Credential snmp_v3_security_name, used by types Node
ssh_private_key (String, Sensitive) Resource Credential ssh_private_key, can be used by types Node, Switch, OSAdminCrednetial and OSUserCredential

Read-Only

created_by (String) Resource Credential created_by
created_date (String) Resource Credential created_date
id (String) Unique identifier of the resource credential instance.
updated_by (String) Resource Credential updated_by
updated_date (String) Resource Credential updated_date

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2025-2026 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.
# */

# import resource credential by its id
terraform import powerflex_resource_credential.example "<id>"

This will import the resource instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute terraform plan to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute terraform apply to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

V1.9.0: powerflex_resource_group data source

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_resource_group (Data Source)

This datasource is used to query the existing ResourceGroup from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.

Example Usage

/*
Copyright (c) 2024-2026 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.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve

# Get all Resource Group details present in the PowerFlex
data "powerflex_resource_group" "example1" {
}


# if a filter is of type string it has the ability to allow regular expressions
# data "powerflex_resource_group" "resource_group_filter_regex" {
#   filter{
#     name = ["^System_.*$"]
#     deployment_finished_date = ["^2024-01-10.*$"]
#   }
# }

# output "resourceGroupFilterRegexResult"{
#  value = data.powerflex_resource_group.resource_group_filter_regex.resource_group_details
# }

// If multiple filter fields are provided then it will show the intersection of all of those fields.
// If there is no intersection between the filters then an empty datasource will be returned
// For more information about how we do our datasource filtering check out our guides: https://dell.github.io/terraform-docs/docs/storage/platforms/powerflex/product_guide/examples/
data "powerflex_resource_group" "resource_group" {
  # filter{
  # id = ["id1","id2"]
  # deployment_name = ["deployment_name1","deployment_name2"]
  # deployment_description = ["deployment_description1","deployment_description2"]
  # retry = true
  # teardown = false
  # teardown_after_cancel = true
  # remove_service = true
  # created_date = ["created_date1","created_date2"]
  # created_by = ["created_by1","created_by2"]
  # updated_date = ["updated_date1","updated_date2"]
  # updated_by = ["updated_by1","updated_by2"]
  # deployment_scheduled_date = ["deployment_scheduled_date1","deployment_scheduled_date2"]
  # deployment_started_date = ["deployment_started_date1","deployment_started_date2"]
  # deployment_finished_date = ["deployment_finished_date1","deployment_finished_date2"]
  # schedule_date = ["scheduled_date1","scheduled_date2"]
  # status = ["status1","status2"]
  # compliant = true
  # update_server_firmware = false
  # use_default_catalog = false
  # firmware_repository_id = ["firmware_repository_id1","firmware_repository_id2"]
  # license_repository_id = ["license_repository_id1","license_repository_id2"]
  # individual_teardown = true
  # deployment_health_status_type = ["deployment_health_status_type1","deployment_health_status_type2"]
  # all_users_allowed = true
  # owner = ["owner1","owner2"]
  # no_op = false
  # firmware_init = true
  # disruptive_firmware = false
  # preconfigure_svm = true
  # preconfigure_svm_and_update = true
  # services_deployed = ["services_deployed1","services_deployed2"]
  # precalculated_device_health = ["precalculated_device_health1","precalculated_device_health2"]
  # number_of_deployments = [0]
  # operation_type = ["operation_type1","operation_type2"]
  # operation_status = ["operation_status1","operation_status2"]
  # operation_data = ["operation_data1","operation_data2"]
  # current_step_count = ["current_step_count1", "current_step_count2"]
  # total_num_of_steps = ["total_num_of_steps1", "total_num_of_steps2"]
  # current_step_message = ["current_step_message1", "current_step_message2"]
  # custom_image = ["custom_image1", "custom_image2"]
  # original_deployment_id = ["original_deployment_id1", "original_deployment_id2"]
  # current_batch_count = ["current_batch_count1", "current_batch_count2"]
  # total_batch_count = ["total_batch_count1", "total_batch_count2"]
  # brownfield = true
  # overall_device_health = ["overall_device_health1","overall_device_health2"]
  # vds = false
  # scale_up = true
  # lifecycle_mode = false
  # can_migratev_clsv_ms = false
  # template_valid = true
  # configuration_change = true
  # detail_message = ["detail_message1", "detail_message2"]
  # timestamp = ["timestamp1","timestamp2"]
  # error = ["error1","error2"]
  # path = ["path1, "path2"]
  # }
}

output "resource_group_result" {
  value = data.powerflex_resource_group.example1.resource_group_details
}

After the successful execution of above said block, We can see the output by executing terraform output command. Also, we can fetch information via the variable: data.powerflex_resource_group.example1.attribute_name where attribute_name is the attribute which user wants to fetch.

Schema

Optional

filter (Block, Optional) (see below for nested schema)

Read-Only

id (String) Placeholder attribute.
resource_group_details (Attributes Set) Resource Group details (see below for nested schema)

Nested Schema for `filter`

Optional:

all_users_allowed (Boolean) Value for all_users_allowed
brownfield (Boolean) Value for brownfield
can_migratev_clsv_ms (Boolean) Value for can_migratev_clsv_ms
compliant (Boolean) Value for compliant
configuration_change (Boolean) Value for configuration_change
created_by (Set of String) List of created_by
created_date (Set of String) List of created_date
current_batch_count (Set of String) List of current_batch_count
current_step_count (Set of String) List of current_step_count
current_step_message (Set of String) List of current_step_message
custom_image (Set of String) List of custom_image
deployment_description (Set of String) List of deployment_description
deployment_finished_date (Set of String) List of deployment_finished_date
deployment_health_status_type (Set of String) List of deployment_health_status_type
deployment_name (Set of String) List of deployment_name
deployment_scheduled_date (Set of String) List of deployment_scheduled_date
deployment_started_date (Set of String) List of deployment_started_date
detail_message (Set of String) List of detail_message
disruptive_firmware (Boolean) Value for disruptive_firmware
error (Set of String) List of error
firmware_init (Boolean) Value for firmware_init
firmware_repository_id (Set of String) List of firmware_repository_id
id (Set of String) List of id
individual_teardown (Boolean) Value for individual_teardown
license_repository_id (Set of String) List of license_repository_id
lifecycle_mode (Boolean) Value for lifecycle_mode
no_op (Boolean) Value for no_op
number_of_deployments (Set of Number) List of number_of_deployments
operation_data (Set of String) List of operation_data
operation_status (Set of String) List of operation_status
operation_type (Set of String) List of operation_type
original_deployment_id (Set of String) List of original_deployment_id
overall_device_health (Set of String) List of overall_device_health
owner (Set of String) List of owner
path (Set of String) List of path
precalculated_device_health (Set of String) List of precalculated_device_health
preconfigure_svm (Boolean) Value for preconfigure_svm
preconfigure_svm_and_update (Boolean) Value for preconfigure_svm_and_update
remove_service (Boolean) Value for remove_service
retry (Boolean) Value for retry
scale_up (Boolean) Value for scale_up
schedule_date (Set of String) List of schedule_date
services_deployed (Set of String) List of services_deployed
status (Set of String) List of status
teardown (Boolean) Value for teardown
teardown_after_cancel (Boolean) Value for teardown_after_cancel
template_valid (Boolean) Value for template_valid
timestamp (Set of String) List of timestamp
total_batch_count (Set of String) List of total_batch_count
total_num_of_steps (Set of String) List of total_num_of_steps
update_server_firmware (Boolean) Value for update_server_firmware
updated_by (Set of String) List of updated_by
updated_date (Set of String) List of updated_date
use_default_catalog (Boolean) Value for use_default_catalog
vds (Boolean) Value for vds

Nested Schema for `resource_group_details`

Read-Only:

all_users_allowed (Boolean) Indicates whether all users are allowed for the deployment.
assigned_users (Attributes List) List of users assigned to the deployment. (see below for nested schema)
brownfield (Boolean) Indicates whether the deployment involves brownfield operations.
can_migratev_clsv_ms (Boolean) Indicates whether migration of cluster virtual machines is allowed.
compliant (Boolean) Indicates whether the deployment is compliant.
configuration_change (Boolean) Specifies whether there has been a change in the deployment configuration.
created_by (String) The user who created the deployment.
created_date (String) The date when the deployment was created.
current_batch_count (String) The current batch count during deployment.
current_step_count (String) The current step count during deployment.
current_step_message (String) The message associated with the current step during deployment.
custom_image (String) The custom image used for deployment.
deployment_description (String) The description of the ResourceGroup
deployment_device (Attributes List) List of devices associated with the deployment. (see below for nested schema)
deployment_finished_date (String) The date when the deployment finished.
deployment_health_status_type (String) The type of health status associated with the deployment.
deployment_name (String) The name of the ResourceGroup
deployment_scheduled_date (String) The scheduled date for the deployment.
deployment_started_date (String) The date when the deployment started.
deployment_valid (Attributes) Details about the validity of the Resource Group (see below for nested schema)
deployment_validation_response (Attributes) Details about the validation response for the deployment. (see below for nested schema)
detail_message (String) Detailed Message
disruptive_firmware (Boolean) Indicates whether disruptive firmware actions are allowed.
error (String) Error
firmware_init (Boolean) Indicates whether firmware initialization is performed during deployment.
firmware_repository (Attributes) Details about the firmware repository used by the template. (see below for nested schema)
firmware_repository_id (String) The ID of the firmware repository associated with the deployment.
id (String) The unique identifier for the Resource Group
individual_teardown (Boolean) Indicates whether to perform individual teardown for the deployment.
job_details (Attributes List) List of job details associated with the deployment. (see below for nested schema)
license_repository (Attributes) Details about the license repository associated with the deployment. (see below for nested schema)
license_repository_id (String) The ID of the license repository associated with the deployment.
lifecycle_mode (Boolean) Indicates whether the deployment is in lifecycle mode.
lifecycle_mode_reasons (List of String) List of reasons for the lifecycle mode of the deployment.
messages (Attributes List) Messages (see below for nested schema)
no_op (Boolean) Indicates whether the deployment is a no-op (no operation).
number_of_deployments (Number) The total number of deployments.
operation_data (String) Additional data associated with the operation.
operation_status (String) The status of the operation associated with the deployment.
operation_type (String) The type of operation associated with the deployment.
original_deployment_id (String) The ID of the original deployment.
overall_device_health (String) The overall health status of the device in the deployment.
owner (String) The owner of the deployment.
path (String) Path
precalculated_device_health (String) The precalculated health of devices associated with the deployment.
preconfigure_svm (Boolean) Indicates whether to preconfigure SVM (Storage Virtual Machine).
preconfigure_svm_and_update (Boolean) Indicates whether to preconfigure SVM and perform an update.
remove_service (Boolean) Indicates whether the associated service should be removed.
retry (Boolean) Indicates whether the deployment should be retried.
scale_up (Boolean) Indicates whether the deployment involves scaling up.
schedule_date (String) The date when the deployment is scheduled.
service_template (Attributes) Template details (see below for nested schema)
services_deployed (String) Details about the services deployed during the deployment.
status (String) The status of the deployment.
teardown (Boolean) teardown
teardown_after_cancel (Boolean) Indicates whether teardown should occur after canceling the deployment.
template_valid (Boolean) Details about the validity of the template.
timestamp (String) The timestamp indicating when the message was generated.
total_batch_count (String) The total number of batches involved in the deployment.
total_num_of_steps (String) The total number of steps involved in the deployment.
update_server_firmware (Boolean) Indicates whether to update server firmware during the deployment.
updated_by (String) The user who last updated the deployment.
updated_date (String) The date when the deployment was last updated.
use_default_catalog (Boolean) Indicates whether to use the default catalog for the deployment.
vds (Boolean) Specifies whether the deployment involves Virtual Desktop Infrastructure (VDI) configuration.
vms (Attributes List) List of virtual machines associated with the deployment. (see below for nested schema)

Nested Schema for `resource_group_details.assigned_users`

Read-Only:

created_by (String) The user who created the assigned user.
created_date (String) The date when the assigned user was created.
domain_name (String) The domain name of the assigned user.
email (String) The email address of the assigned user.
enabled (Boolean) Indicates whether the assigned user is enabled.
first_name (String) The first name of the assigned user.
group_dn (String) The distinguished name (DN) of the group associated with the assigned user.
group_name (String) The name of the group associated with the assigned user.
id (String) The unique identifier of the assigned user.
last_name (String) The last name of the assigned user.
password (String, Sensitive) The password associated with the assigned user.
phone_number (String) The phone number of the assigned user.
role (String) The role associated with the assigned user.
roles (List of String) The roles associated with the assigned user.
system_user (Boolean) Indicates whether the assigned user is a system user.
update_password (Boolean) Indicates whether the user password needs to be updated.
updated_by (String) The user who last updated the assigned user.
updated_date (String) The date when the assigned user was last updated.
user_name (String) The username of the assigned user.
user_preference (String) The preferences of the assigned user.
user_seq_id (Number) The sequential ID of the assigned user.

Nested Schema for `resource_group_details.deployment_device`

Read-Only:

brownfield (Boolean) Indicates whether the deployment device is associated with a brownfield deployment.
brownfield_status (String) The brownfield status of the deployment device.
cloud_link (Boolean) Indicates whether the deployment device has a cloud link.
compliant_state (String) The compliant state of the deployment device.
component_id (String) The component ID associated with the deployment device.
current_ip_address (String) The current IP address of the deployment device.
das_cache (Boolean) Indicates whether the deployment device has Direct-Attached Storage (DAS) cache.
device_group_name (String) The name of the device group associated with the deployment device.
device_health (String) The health status of the deployment device.
device_state (String) The state of the deployment device.
device_type (String) The type of device associated with the deployment device.
health_message (String) The health message associated with the deployment device.
ip_address (String) The IP address of the deployment device.
log_dump (String) The log dump information associated with the deployment device.
model (String) The model of the deployment device.
puppet_cert_name (String) The Puppet certificate name associated with the deployment device.
ref_id (String) The reference ID associated with the deployment device.
ref_type (String) The reference type associated with the deployment device.
service_tag (String) The service tag associated with the deployment device.
status (String) The status of the deployment device.
status_end_time (String) The end time of the status for the deployment device.
status_message (String) The status message associated with the deployment device.
status_start_time (String) The start time of the status for the deployment device.

Nested Schema for `resource_group_details.deployment_valid`

Read-Only:

messages (Attributes List) List of messages related to the deployment. (see below for nested schema)
valid (Boolean) Indicates whether the deployment is valid.

Nested Schema for `resource_group_details.deployment_valid.messages`

Read-Only:

agent_id (String) The identifier of the agent associated with the message.
category (String) The category or type of the message.
correlation_id (String) The identifier used to correlate related messages.
detailed_message (String) A detailed version or description of the message.
display_message (String) The message to be displayed or shown.
id (String) The unique identifier for the message.
message_bundle (String) The bundle or group to which the message belongs.
message_code (String) The code associated with the message.
response_action (String) The action to be taken in response to the message.
sequence_number (Number) The sequence number of the message in a series.
severity (String) The severity level of the message (e.g., INFO, WARNING, ERROR).
time_stamp (String) The timestamp indicating when the message was generated.

Nested Schema for `resource_group_details.deployment_validation_response`

Read-Only:

can_deploy (Boolean) Indicates whether the deployment can be executed.
disk_type_mismatch (Boolean) Indicates whether there is a disk type mismatch in the deployment.
drives_per_storage_pool (Number) The number of drives per storage pool in the deployment.
hostnames (List of String) A list of hostnames associated with the deployment.
max_scalability (Number) The maximum scalability of the deployment.
new_node_disk_types (List of String) The disk types associated with new nodes in the deployment.
no_of_fault_sets (Number) The number of fault sets in the deployment.
nodes (Number) The number of nodes in the deployment.
nodes_per_fault_set (Number) The number of nodes per fault set in the deployment.
number_of_service_volumes (Number) The number of service volumes in the deployment.
protection_domain (String) The protection domain associated with the deployment.
storage_pool_disk_type (List of String) The disk types associated with each storage pool in the deployment.
storage_pools (Number) The number of storage pools in the deployment.
virtual_machines (Number) The number of virtual machines in the deployment.
warning_messages (List of String) A list of warning messages associated with the deployment validation.

Nested Schema for `resource_group_details.firmware_repository`

Read-Only:

bundle_count (Number) The count of software bundles in the firmware repository.
component_count (Number) The count of software components in the firmware repository.
created_by (String) The user who created the firmware repository.
created_date (String) The date when the firmware repository was created.
custom (Boolean) Indicates whether the firmware repository is custom.
default_catalog (Boolean) Indicates whether the firmware repository is the default catalog.
deployments (Attributes List) List of deployments associated with the firmware repository. (see below for nested schema)
disk_location (String) The location on disk where the firmware repository is stored.
download_progress (Number) The progress of the download for the firmware repository.
download_status (String) The download status of the firmware repository.
embedded (Boolean) Indicates whether the firmware repository is embedded.
extract_progress (Number) The progress of the extraction for the firmware repository.
file_size_in_gigabytes (Number) The size of the firmware repository file in gigabytes.
filename (String) The filename of the firmware repository.
id (String) The unique identifier of the firmware repository.
job_id (String) The unique identifier of the job associated with the firmware repository.
md_5_hash (String) The MD5 hash of the firmware repository.
minimal (Boolean) Indicates whether the firmware repository is minimal.
name (String) The name of the firmware repository.
needs_attention (Boolean) Indicates whether the firmware repository needs attention.
password (String, Sensitive) The password associated with the firmware repository.
rcmapproved (Boolean) Indicates whether the firmware repository is RCM approved.
signature (String) The signature of the firmware repository.
signed_key_source_location (String) The source location of the signed key associated with the firmware repository.
software_bundles (Attributes List) List of software bundles associated with the firmware repository. (see below for nested schema)
software_components (Attributes List) List of software components associated with the firmware repository. (see below for nested schema)
source_location (String) The location of the source for the firmware repository.
source_type (String) The type of the source for the firmware repository.
state (String) The state of the firmware repository.
updated_by (String) The user who last updated the firmware repository.
updated_date (String) The date when the firmware repository was last updated.
user_bundle_count (Number) The count of user-specific software bundles in the firmware repository.
username (String) The username associated with the firmware repository.

Nested Schema for `resource_group_details.firmware_repository.deployments`

Read-Only:

all_users_allowed (Boolean) Indicates whether all users are allowed for the deployment.
assigned_users (Attributes List) List of users assigned to the deployment. (see below for nested schema)
brownfield (Boolean) Indicates whether the deployment involves brownfield operations.
can_migratev_clsv_ms (Boolean) Indicates whether migration of cluster virtual machines is allowed.
compliant (Boolean) Indicates whether the deployment is compliant.
configuration_change (Boolean) Specifies whether there has been a change in the deployment configuration.
created_by (String) The user who created the deployment.
created_date (String) The date when the deployment was created.
current_batch_count (String) The current batch count during deployment.
current_step_count (String) The current step count during deployment.
current_step_message (String) The message associated with the current step during deployment.
custom_image (String) The custom image used for deployment.
deployment_description (String) The description of the deployment.
deployment_device (Attributes List) List of devices associated with the deployment. (see below for nested schema)
deployment_finished_date (String) The date when the deployment finished.
deployment_health_status_type (String) The type of health status associated with the deployment.
deployment_name (String) The name of the deployment.
deployment_scheduled_date (String) The scheduled date for the deployment.
deployment_started_date (String) The date when the deployment started.
deployment_valid (Attributes) Details about the validity of the deployment. (see below for nested schema)
deployment_validation_response (Attributes) Details about the validation response for the deployment. (see below for nested schema)
disruptive_firmware (Boolean) Indicates whether disruptive firmware actions are allowed.
firmware_init (Boolean) Indicates whether firmware initialization is performed during deployment.
firmware_repository_id (String) The ID of the firmware repository associated with the deployment.
id (String) The unique identifier of the deployment.
individual_teardown (Boolean) Indicates whether to perform individual teardown for the deployment.
job_details (Attributes List) List of job details associated with the deployment. (see below for nested schema)
license_repository (Attributes) Details about the license repository associated with the deployment. (see below for nested schema)
license_repository_id (String) The ID of the license repository associated with the deployment.
lifecycle_mode (Boolean) Indicates whether the deployment is in lifecycle mode.
lifecycle_mode_reasons (List of String) List of reasons for the lifecycle mode of the deployment.
no_op (Boolean) Indicates whether the deployment is a no-op (no operation).
number_of_deployments (Number) The total number of deployments.
operation_data (String) Additional data associated with the operation.
operation_status (String) The status of the operation associated with the deployment.
operation_type (String) The type of operation associated with the deployment.
original_deployment_id (String) The ID of the original deployment.
overall_device_health (String) The overall health status of the device in the deployment.
owner (String) The owner of the deployment.
precalculated_device_health (String) The precalculated health of devices associated with the deployment.
preconfigure_svm (Boolean) Indicates whether to preconfigure SVM (Storage Virtual Machine).
preconfigure_svm_and_update (Boolean) Indicates whether to preconfigure SVM and perform an update.
remove_service (Boolean) Indicates whether the associated service should be removed.
retry (Boolean) Indicates whether the deployment should be retried.
scale_up (Boolean) Indicates whether the deployment involves scaling up.
schedule_date (String) The date when the deployment is scheduled.
services_deployed (String) Details about the services deployed during the deployment.
status (String) The status of the deployment.
teardown (Boolean) Indicates whether the deployment should be torn down.
teardown_after_cancel (Boolean) Indicates whether teardown should occur after canceling the deployment.
template_valid (Boolean) Indicates if the deployment template is valid.
total_batch_count (String) The total number of batches involved in the deployment.
total_num_of_steps (String) The total number of steps involved in the deployment.
update_server_firmware (Boolean) Indicates whether to update server firmware during the deployment.
updated_by (String) The user who last updated the deployment.
updated_date (String) The date when the deployment was last updated.
use_default_catalog (Boolean) Indicates whether to use the default catalog for the deployment.
vds (Boolean) Specifies whether the deployment involves Virtual Desktop Infrastructure (VDI) configuration.
vms (Attributes List) List of virtual machines associated with the deployment. (see below for nested schema)

Nested Schema for `resource_group_details.firmware_repository.deployments.assigned_users`

Read-Only:

created_by (String) The user who created the assigned user.
created_date (String) The date when the assigned user was created.
domain_name (String) The domain name of the assigned user.
email (String) The email address of the assigned user.
enabled (Boolean) Indicates whether the assigned user is enabled.
first_name (String) The first name of the assigned user.
group_dn (String) The distinguished name (DN) of the group associated with the assigned user.
group_name (String) The name of the group associated with the assigned user.
id (String) The unique identifier of the assigned user.
last_name (String) The last name of the assigned user.
password (String, Sensitive) The password associated with the assigned user.
phone_number (String) The phone number of the assigned user.
role (String) The role associated with the assigned user.
roles (List of String) The roles associated with the assigned user.
system_user (Boolean) Indicates whether the assigned user is a system user.
update_password (Boolean) Indicates whether the user password needs to be updated.
updated_by (String) The user who last updated the assigned user.
updated_date (String) The date when the assigned user was last updated.
user_name (String) The username of the assigned user.
user_preference (String) The preferences of the assigned user.
user_seq_id (Number) The sequential ID of the assigned user.

Nested Schema for `resource_group_details.firmware_repository.deployments.deployment_device`

Read-Only:

brownfield (Boolean) Indicates whether the deployment device is associated with a brownfield deployment.
brownfield_status (String) The brownfield status of the deployment device.
cloud_link (Boolean) Indicates whether the deployment device has a cloud link.
compliant_state (String) The compliant state of the deployment device.
component_id (String) The component ID associated with the deployment device.
current_ip_address (String) The current IP address of the deployment device.
das_cache (Boolean) Indicates whether the deployment device has Direct-Attached Storage (DAS) cache.
device_group_name (String) The name of the device group associated with the deployment device.
device_health (String) The health status of the deployment device.
device_state (String) The state of the deployment device.
device_type (String) The type of device associated with the deployment device.
health_message (String) The health message associated with the deployment device.
ip_address (String) The IP address of the deployment device.
log_dump (String) The log dump information associated with the deployment device.
model (String) The model of the deployment device.
puppet_cert_name (String) The Puppet certificate name associated with the deployment device.
ref_id (String) The reference ID associated with the deployment device.
ref_type (String) The reference type associated with the deployment device.
service_tag (String) The service tag associated with the deployment device.
status (String) The status of the deployment device.
status_end_time (String) The end time of the status for the deployment device.
status_message (String) The status message associated with the deployment device.
status_start_time (String) The start time of the status for the deployment device.

Nested Schema for `resource_group_details.firmware_repository.deployments.deployment_valid`

Read-Only:

messages (Attributes List) List of messages related to the deployment. (see below for nested schema)
valid (Boolean) Indicates whether the deployment is valid.

Nested Schema for `resource_group_details.firmware_repository.deployments.deployment_valid.messages`

Read-Only:

agent_id (String) The identifier of the agent associated with the message.
category (String) The category or type of the message.
correlation_id (String) The identifier used to correlate related messages.
detailed_message (String) A detailed version or description of the message.
display_message (String) The message to be displayed or shown.
id (String) The unique identifier for the message.
message_bundle (String) The bundle or group to which the message belongs.
message_code (String) The code associated with the message.
response_action (String) The action to be taken in response to the message.
sequence_number (Number) The sequence number of the message in a series.
severity (String) The severity level of the message (e.g., INFO, WARNING, ERROR).
time_stamp (String) The timestamp indicating when the message was generated.

Nested Schema for `resource_group_details.firmware_repository.deployments.deployment_validation_response`

Read-Only:

can_deploy (Boolean) Indicates whether the deployment can be executed.
disk_type_mismatch (Boolean) Indicates whether there is a disk type mismatch in the deployment.
drives_per_storage_pool (Number) The number of drives per storage pool in the deployment.
hostnames (List of String) A list of hostnames associated with the deployment.
max_scalability (Number) The maximum scalability of the deployment.
new_node_disk_types (List of String) The disk types associated with new nodes in the deployment.
no_of_fault_sets (Number) The number of fault sets in the deployment.
nodes (Number) The number of nodes in the deployment.
nodes_per_fault_set (Number) The number of nodes per fault set in the deployment.
number_of_service_volumes (Number) The number of service volumes in the deployment.
protection_domain (String) The protection domain associated with the deployment.
storage_pool_disk_type (List of String) The disk types associated with each storage pool in the deployment.
storage_pools (Number) The number of storage pools in the deployment.
virtual_machines (Number) The number of virtual machines in the deployment.
warning_messages (List of String) A list of warning messages associated with the deployment validation.

Nested Schema for `resource_group_details.firmware_repository.deployments.job_details`

Read-Only:

component_id (String) The unique identifier of the component associated with the job.
execution_id (String) The unique identifier of the job execution.
level (String) The log level of the job.
message (String) The log message of the job.
timestamp (String) The timestamp of the job execution.

Nested Schema for `resource_group_details.firmware_repository.deployments.license_repository`

Read-Only:

created_by (String) The user who created the license repository.
created_date (String) The date when the license repository was created.
disk_location (String) The disk location of the license repository.
filename (String) The filename associated with the license repository.
id (String) The unique identifier of the license repository.
license_data (String) The license data associated with the license repository.
name (String) The name of the license repository.
state (String) The state of the license repository.
type (String) The type of the license repository.
updated_by (String) The user who last updated the license repository.
updated_date (String) The date when the license repository was last updated.

Nested Schema for `resource_group_details.firmware_repository.deployments.vms`

Read-Only:

certificate_name (String) The certificate name associated with the virtual machine (VM).
vm_ipaddress (String) The IP address of the virtual machine (VM).
vm_manufacturer (String) The manufacturer of the virtual machine (VM).
vm_model (String) The model of the virtual machine (VM).
vm_service_tag (String) The service tag associated with the virtual machine (VM).

Nested Schema for `resource_group_details.firmware_repository.software_bundles`

Read-Only:

bundle_date (String) The date when the software bundle was created.
bundle_type (String) The type of the software bundle.
created_by (String) The user who initially created the software bundle.
created_date (String) The date when the software bundle was initially created.
criticality (String) The criticality level of the software bundle.
custom (Boolean) Indicates whether the software bundle is custom.
description (String) A brief description of the software bundle.
device_model (String) The model of the device associated with the software bundle.
device_type (String) The type of device associated with the software bundle.
fw_repository_id (String) The identifier of the firmware repository associated with the software bundle.
id (String) The unique identifier for the software bundle.
name (String) The name of the software bundle.
needs_attention (Boolean) Indicates whether the software bundle needs attention.
software_components (Attributes List) List of software components associated with the software bundle. (see below for nested schema)
updated_by (String) The user who last updated the software bundle.
updated_date (String) The date when the software bundle was last updated.
user_bundle (Boolean) Indicates whether the software bundle is a user-specific bundle.
user_bundle_hash_md_5 (String) The MD5 hash value of the user-specific software bundle.
user_bundle_path (String) The path associated with the user-specific software bundle.
version (String) The version of the software bundle.

Nested Schema for `resource_group_details.firmware_repository.software_bundles.software_components`

Read-Only:

category (String) The category to which the component belongs.
component_id (String) The identifier of the component.
component_type (String) The type of the component.
created_by (String) The user who created the component.
created_date (String) The date when the component was created.
custom (Boolean) Indicates whether the component is custom or not.
dell_version (String) The version of the component according to Dell standards.
device_id (String) The identifier of the device associated with the component.
firmware_repo_name (String) The name of the firmware repository associated with the component.
hash_md_5 (String) The MD5 hash value of the component.
id (String) The unique identifier for the software component.
ignore (Boolean) Indicates whether the component should be ignored.
name (String) The name of the software component.
needs_attention (Boolean) Indicates whether the component needs attention.
operating_system (String) The operating system associated with the component.
original_component_id (String) The identifier of the original component.
original_version (String) The original version of the component.
package_id (String) The identifier of the package to which the component belongs.
path (String) The path where the component is stored.
sub_device_id (String) The sub-identifier of the device associated with the component.
sub_vendor_id (String) The sub-identifier of the vendor associated with the component.
system_ids (List of String) List of system IDs associated with the component.
updated_by (String) The user who last updated the component.
updated_date (String) The date when the component was last updated.
vendor_id (String) The identifier of the vendor associated with the component.
vendor_version (String) The version of the component according to the vendor’s standards.

Nested Schema for `resource_group_details.firmware_repository.software_components`

Read-Only:

category (String) The category to which the component belongs.
component_id (String) The identifier of the component.
component_type (String) The type of the component.
created_by (String) The user who created the component.
created_date (String) The date when the component was created.
custom (Boolean) Indicates whether the component is custom or not.
dell_version (String) The version of the component according to Dell standards.
device_id (String) The identifier of the device associated with the component.
firmware_repo_name (String) The name of the firmware repository associated with the component.
hash_md_5 (String) The MD5 hash value of the component.
id (String) The unique identifier for the software component.
ignore (Boolean) Indicates whether the component should be ignored.
name (String) The name of the software component.
needs_attention (Boolean) Indicates whether the component needs attention.
operating_system (String) The operating system associated with the component.
original_component_id (String) The identifier of the original component.
original_version (String) The original version of the component.
package_id (String) The identifier of the package to which the component belongs.
path (String) The path where the component is stored.
sub_device_id (String) The sub-identifier of the device associated with the component.
sub_vendor_id (String) The sub-identifier of the vendor associated with the component.
system_ids (List of String) List of system IDs associated with the component.
updated_by (String) The user who last updated the component.
updated_date (String) The date when the component was last updated.
vendor_id (String) The identifier of the vendor associated with the component.
vendor_version (String) The version of the component according to the vendor’s standards.

Nested Schema for `resource_group_details.job_details`

Read-Only:

component_id (String) The unique identifier of the component associated with the job.
execution_id (String) The unique identifier of the job execution.
level (String) The log level of the job.
message (String) The log message of the job.
timestamp (String) The timestamp of the job execution.

Nested Schema for `resource_group_details.license_repository`

Read-Only:

created_by (String) The user who created the license repository.
created_date (String) The date when the license repository was created.
disk_location (String) The disk location of the license repository.
filename (String) The filename associated with the license repository.
id (String) The unique identifier of the license repository.
license_data (String) The license data associated with the license repository.
name (String) The name of the license repository.
state (String) The state of the license repository.
type (String) The type of the license repository.
updated_by (String) The user who last updated the license repository.
updated_date (String) The date when the license repository was last updated.

Nested Schema for `resource_group_details.messages`

Read-Only:

agent_id (String) The identifier of the agent associated with the message.
category (String) The category or type of the message.
correlation_id (String) The identifier used to correlate related messages.
detailed_message (String) A detailed version or description of the message.
display_message (String) The message to be displayed or shown.
id (String) The unique identifier for the message.
message_bundle (String) The bundle or group to which the message belongs.
message_code (String) The code associated with the message.
response_action (String) The action to be taken in response to the message.
sequence_number (Number) The sequence number of the message in a series.
severity (String) The severity level of the message (e.g., INFO, WARNING, ERROR).
time_stamp (String) The timestamp indicating when the message was generated.

Nested Schema for `resource_group_details.service_template`

Read-Only:

all_users_allowed (Boolean) Indicates whether all users are allowed for the template.
assigned_users (Attributes List) List of users assigned to the template. (see below for nested schema)
brownfield_template_type (String) The type of template for brownfield deployments.
category (String) The category to which the template belongs.
cluster_count (Number) The count of clusters associated with the template.
components (Attributes List) List of components included in the template. (see below for nested schema)
configuration (Attributes) Details about the configuration settings of the template. (see below for nested schema)
created_by (String) The user who created the template.
created_date (String) The date when the template was created.
draft (Boolean) Indicates whether the template is in draft mode.
firmware_repository (Attributes) Details about the firmware repository used by the template. (see below for nested schema)
id (String) The unique identifier for the template.
in_configuration (Boolean) Indicates whether the template is part of the current configuration.
last_deployed_date (String) The date when the template was last deployed.
license_repository (Attributes) Details about the license repository used by the template. (see below for nested schema)
manage_firmware (Boolean) Indicates whether firmware is managed by the template.
networks (Attributes List) List of networks associated with the template. (see below for nested schema)
original_template_id (String) The ID of the original template if this is a derived template.
sdnas_count (Number) The count of software-defined network appliances associated with the template.
server_count (Number) The count of servers associated with the template.
service_count (Number) The count of services associated with the template.
storage_count (Number) The count of storage devices associated with the template.
switch_count (Number) The count of switches associated with the template.
template_description (String) The description of the template.
template_locked (Boolean) Indicates whether the template is locked or not.
template_name (String) The name of the template.
template_type (String) The type/category of the template.
template_valid (Attributes) Details about the validity of the template. (see below for nested schema)
template_version (String) The version of the template.
updated_by (String) The user who last updated the template.
updated_date (String) The date when the template was last updated.
use_default_catalog (Boolean) Indicates whether the default catalog is used for the template.
vm_count (Number) The count of virtual machines associated with the template.

Nested Schema for `resource_group_details.service_template.assigned_users`

Read-Only:

created_by (String) The user who created the assigned user.
created_date (String) The date when the assigned user was created.
domain_name (String) The domain name of the assigned user.
email (String) The email address of the assigned user.
enabled (Boolean) Indicates whether the assigned user is enabled.
first_name (String) The first name of the assigned user.
group_dn (String) The distinguished name (DN) of the group associated with the assigned user.
group_name (String) The name of the group associated with the assigned user.
id (String) The unique identifier of the assigned user.
last_name (String) The last name of the assigned user.
password (String, Sensitive) The password associated with the assigned user.
phone_number (String) The phone number of the assigned user.
role (String) The role associated with the assigned user.
roles (List of String) The roles associated with the assigned user.
system_user (Boolean) Indicates whether the assigned user is a system user.
update_password (Boolean) Indicates whether the user password needs to be updated.
updated_by (String) The user who last updated the assigned user.
updated_date (String) The date when the assigned user was last updated.
user_name (String) The username of the assigned user.
user_preference (String) The preferences of the assigned user.
user_seq_id (Number) The sequential ID of the assigned user.

Nested Schema for `resource_group_details.service_template.components`

Read-Only:

asm_guid (String) The ASM GUID (Global Unique Identifier) associated with the component.
brownfield (Boolean) Indicates whether the component is brownfield.
changed (Boolean) Indicates whether the component has changed.
cloned (Boolean) Indicates whether the component is cloned.
cloned_from_asm_guid (String) The ASM GUID from which the component is cloned.
cloned_from_id (String) The identifier of the component from which this component is cloned.
component_id (String) The identifier for the component.
component_valid (Attributes) Information about the validity of the component. (see below for nested schema)
config_file (String) The configuration file associated with the component.
help_text (String) Help text associated with the component.
id (String) The unique identifier for the component.
identifier (String) The identifier for the component.
instances (Number) The number of instances of the component.
ip (String) The IP address associated with the component.
manage_firmware (Boolean) Indicates whether firmware is managed for the component.
management_ip_address (String) The management IP address of the component.
name (String) The name of the component.
os_puppet_cert_name (String) The OS Puppet certificate name associated with the component.
puppet_cert_name (String) The Puppet certificate name associated with the component.
ref_id (String) The reference identifier associated with the component.
related_components (Map of String) Related components associated with this component.
resources (Attributes List) List of resources associated with the component. (see below for nested schema)
serial_number (String) The serial number of the component.
sub_type (String) The sub-type of the component.
teardown (Boolean) Indicates whether the component should be torn down.
type (String) The type of the component.

Nested Schema for `resource_group_details.service_template.components.component_valid`

Read-Only:

messages (Attributes List) List of messages associated with the component validity. (see below for nested schema)
valid (Boolean) Indicates whether the component is valid.

Nested Schema for `resource_group_details.service_template.components.component_valid.messages`

Read-Only:

agent_id (String) The identifier of the agent associated with the message.
category (String) The category or type of the message.
correlation_id (String) The identifier used to correlate related messages.
detailed_message (String) A detailed version or description of the message.
display_message (String) The message to be displayed or shown.
id (String) The unique identifier for the message.
message_bundle (String) The bundle or group to which the message belongs.
message_code (String) The code associated with the message.
response_action (String) The action to be taken in response to the message.
sequence_number (Number) The sequence number of the message in a series.
severity (String) The severity level of the message (e.g., INFO, WARNING, ERROR).
time_stamp (String) The timestamp indicating when the message was generated.

Nested Schema for `resource_group_details.service_template.components.resources`

Read-Only:

display_name (String) The display name for the resources.
guid (String) The globally unique identifier (GUID) for the resources.
id (String) The identifier for the resources.

Nested Schema for `resource_group_details.service_template.configuration`

Read-Only:

categories (Attributes List) List of categories associated with the configuration. (see below for nested schema)
comparator (String) Comparator used in the configuration.
controller_fqdd (String) Fully Qualified Device Descriptor (FQDD) of the controller in the configuration.
disktype (String) Type of disk in the configuration.
id (String) Unique identifier for the configuration.
numberofdisks (Number) Number of disks in the configuration.
raidlevel (String) RAID level of the configuration.
virtual_disk_fqdd (String) Fully Qualified Device Descriptor (FQDD) of the virtual disk in the configuration.

Nested Schema for `resource_group_details.service_template.configuration.categories`

Read-Only:

device_type (String) The type of device associated with the category.
display_name (String) The display name of the category.
id (String) The unique identifier for the category.

Nested Schema for `resource_group_details.service_template.firmware_repository`

Read-Only:

bundle_count (Number) The count of software bundles in the firmware repository.
component_count (Number) The count of software components in the firmware repository.
created_by (String) The user who created the firmware repository.
created_date (String) The date when the firmware repository was created.
custom (Boolean) Indicates whether the firmware repository is custom.
default_catalog (Boolean) Indicates whether the firmware repository is the default catalog.
deployments (Attributes List) List of deployments associated with the firmware repository. (see below for nested schema)
disk_location (String) The location on disk where the firmware repository is stored.
download_progress (Number) The progress of the download for the firmware repository.
download_status (String) The download status of the firmware repository.
embedded (Boolean) Indicates whether the firmware repository is embedded.
extract_progress (Number) The progress of the extraction for the firmware repository.
file_size_in_gigabytes (Number) The size of the firmware repository file in gigabytes.
filename (String) The filename of the firmware repository.
id (String) The unique identifier of the firmware repository.
job_id (String) The unique identifier of the job associated with the firmware repository.
md_5_hash (String) The MD5 hash of the firmware repository.
minimal (Boolean) Indicates whether the firmware repository is minimal.
name (String) The name of the firmware repository.
needs_attention (Boolean) Indicates whether the firmware repository needs attention.
password (String, Sensitive) The password associated with the firmware repository.
rcmapproved (Boolean) Indicates whether the firmware repository is RCM approved.
signature (String) The signature of the firmware repository.
signed_key_source_location (String) The source location of the signed key associated with the firmware repository.
software_bundles (Attributes List) List of software bundles associated with the firmware repository. (see below for nested schema)
software_components (Attributes List) List of software components associated with the firmware repository. (see below for nested schema)
source_location (String) The location of the source for the firmware repository.
source_type (String) The type of the source for the firmware repository.
state (String) The state of the firmware repository.
updated_by (String) The user who last updated the firmware repository.
updated_date (String) The date when the firmware repository was last updated.
user_bundle_count (Number) The count of user-specific software bundles in the firmware repository.
username (String) The username associated with the firmware repository.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments`

Read-Only:

all_users_allowed (Boolean) Indicates whether all users are allowed for the deployment.
assigned_users (Attributes List) List of users assigned to the deployment. (see below for nested schema)
brownfield (Boolean) Indicates whether the deployment involves brownfield operations.
can_migratev_clsv_ms (Boolean) Indicates whether migration of cluster virtual machines is allowed.
compliant (Boolean) Indicates whether the deployment is compliant.
configuration_change (Boolean) Specifies whether there has been a change in the deployment configuration.
created_by (String) The user who created the deployment.
created_date (String) The date when the deployment was created.
current_batch_count (String) The current batch count during deployment.
current_step_count (String) The current step count during deployment.
current_step_message (String) The message associated with the current step during deployment.
custom_image (String) The custom image used for deployment.
deployment_description (String) The description of the deployment.
deployment_device (Attributes List) List of devices associated with the deployment. (see below for nested schema)
deployment_finished_date (String) The date when the deployment finished.
deployment_health_status_type (String) The type of health status associated with the deployment.
deployment_name (String) The name of the deployment.
deployment_scheduled_date (String) The scheduled date for the deployment.
deployment_started_date (String) The date when the deployment started.
deployment_valid (Attributes) Details about the validity of the deployment. (see below for nested schema)
deployment_validation_response (Attributes) Details about the validation response for the deployment. (see below for nested schema)
disruptive_firmware (Boolean) Indicates whether disruptive firmware actions are allowed.
firmware_init (Boolean) Indicates whether firmware initialization is performed during deployment.
firmware_repository_id (String) The ID of the firmware repository associated with the deployment.
id (String) The unique identifier of the deployment.
individual_teardown (Boolean) Indicates whether to perform individual teardown for the deployment.
job_details (Attributes List) List of job details associated with the deployment. (see below for nested schema)
license_repository (Attributes) Details about the license repository associated with the deployment. (see below for nested schema)
license_repository_id (String) The ID of the license repository associated with the deployment.
lifecycle_mode (Boolean) Indicates whether the deployment is in lifecycle mode.
lifecycle_mode_reasons (List of String) List of reasons for the lifecycle mode of the deployment.
no_op (Boolean) Indicates whether the deployment is a no-op (no operation).
number_of_deployments (Number) The total number of deployments.
operation_data (String) Additional data associated with the operation.
operation_status (String) The status of the operation associated with the deployment.
operation_type (String) The type of operation associated with the deployment.
original_deployment_id (String) The ID of the original deployment.
overall_device_health (String) The overall health status of the device in the deployment.
owner (String) The owner of the deployment.
precalculated_device_health (String) The precalculated health of devices associated with the deployment.
preconfigure_svm (Boolean) Indicates whether to preconfigure SVM (Storage Virtual Machine).
preconfigure_svm_and_update (Boolean) Indicates whether to preconfigure SVM and perform an update.
remove_service (Boolean) Indicates whether the associated service should be removed.
retry (Boolean) Indicates whether the deployment should be retried.
scale_up (Boolean) Indicates whether the deployment involves scaling up.
schedule_date (String) The date when the deployment is scheduled.
services_deployed (String) Details about the services deployed during the deployment.
status (String) The status of the deployment.
teardown (Boolean) Indicates whether the deployment should be torn down.
teardown_after_cancel (Boolean) Indicates whether teardown should occur after canceling the deployment.
template_valid (Boolean) Indicates if the deployment template is valid.
total_batch_count (String) The total number of batches involved in the deployment.
total_num_of_steps (String) The total number of steps involved in the deployment.
update_server_firmware (Boolean) Indicates whether to update server firmware during the deployment.
updated_by (String) The user who last updated the deployment.
updated_date (String) The date when the deployment was last updated.
use_default_catalog (Boolean) Indicates whether to use the default catalog for the deployment.
vds (Boolean) Specifies whether the deployment involves Virtual Desktop Infrastructure (VDI) configuration.
vms (Attributes List) List of virtual machines associated with the deployment. (see below for nested schema)

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.assigned_users`

Read-Only:

created_by (String) The user who created the assigned user.
created_date (String) The date when the assigned user was created.
domain_name (String) The domain name of the assigned user.
email (String) The email address of the assigned user.
enabled (Boolean) Indicates whether the assigned user is enabled.
first_name (String) The first name of the assigned user.
group_dn (String) The distinguished name (DN) of the group associated with the assigned user.
group_name (String) The name of the group associated with the assigned user.
id (String) The unique identifier of the assigned user.
last_name (String) The last name of the assigned user.
password (String, Sensitive) The password associated with the assigned user.
phone_number (String) The phone number of the assigned user.
role (String) The role associated with the assigned user.
roles (List of String) The roles associated with the assigned user.
system_user (Boolean) Indicates whether the assigned user is a system user.
update_password (Boolean) Indicates whether the user password needs to be updated.
updated_by (String) The user who last updated the assigned user.
updated_date (String) The date when the assigned user was last updated.
user_name (String) The username of the assigned user.
user_preference (String) The preferences of the assigned user.
user_seq_id (Number) The sequential ID of the assigned user.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.deployment_device`

Read-Only:

brownfield (Boolean) Indicates whether the deployment device is associated with a brownfield deployment.
brownfield_status (String) The brownfield status of the deployment device.
cloud_link (Boolean) Indicates whether the deployment device has a cloud link.
compliant_state (String) The compliant state of the deployment device.
component_id (String) The component ID associated with the deployment device.
current_ip_address (String) The current IP address of the deployment device.
das_cache (Boolean) Indicates whether the deployment device has Direct-Attached Storage (DAS) cache.
device_group_name (String) The name of the device group associated with the deployment device.
device_health (String) The health status of the deployment device.
device_state (String) The state of the deployment device.
device_type (String) The type of device associated with the deployment device.
health_message (String) The health message associated with the deployment device.
ip_address (String) The IP address of the deployment device.
log_dump (String) The log dump information associated with the deployment device.
model (String) The model of the deployment device.
puppet_cert_name (String) The Puppet certificate name associated with the deployment device.
ref_id (String) The reference ID associated with the deployment device.
ref_type (String) The reference type associated with the deployment device.
service_tag (String) The service tag associated with the deployment device.
status (String) The status of the deployment device.
status_end_time (String) The end time of the status for the deployment device.
status_message (String) The status message associated with the deployment device.
status_start_time (String) The start time of the status for the deployment device.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.deployment_valid`

Read-Only:

messages (Attributes List) List of messages related to the deployment. (see below for nested schema)
valid (Boolean) Indicates whether the deployment is valid.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.deployment_valid.messages`

Read-Only:

agent_id (String) The identifier of the agent associated with the message.
category (String) The category or type of the message.
correlation_id (String) The identifier used to correlate related messages.
detailed_message (String) A detailed version or description of the message.
display_message (String) The message to be displayed or shown.
id (String) The unique identifier for the message.
message_bundle (String) The bundle or group to which the message belongs.
message_code (String) The code associated with the message.
response_action (String) The action to be taken in response to the message.
sequence_number (Number) The sequence number of the message in a series.
severity (String) The severity level of the message (e.g., INFO, WARNING, ERROR).
time_stamp (String) The timestamp indicating when the message was generated.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.deployment_validation_response`

Read-Only:

can_deploy (Boolean) Indicates whether the deployment can be executed.
disk_type_mismatch (Boolean) Indicates whether there is a disk type mismatch in the deployment.
drives_per_storage_pool (Number) The number of drives per storage pool in the deployment.
hostnames (List of String) A list of hostnames associated with the deployment.
max_scalability (Number) The maximum scalability of the deployment.
new_node_disk_types (List of String) The disk types associated with new nodes in the deployment.
no_of_fault_sets (Number) The number of fault sets in the deployment.
nodes (Number) The number of nodes in the deployment.
nodes_per_fault_set (Number) The number of nodes per fault set in the deployment.
number_of_service_volumes (Number) The number of service volumes in the deployment.
protection_domain (String) The protection domain associated with the deployment.
storage_pool_disk_type (List of String) The disk types associated with each storage pool in the deployment.
storage_pools (Number) The number of storage pools in the deployment.
virtual_machines (Number) The number of virtual machines in the deployment.
warning_messages (List of String) A list of warning messages associated with the deployment validation.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.job_details`

Read-Only:

component_id (String) The unique identifier of the component associated with the job.
execution_id (String) The unique identifier of the job execution.
level (String) The log level of the job.
message (String) The log message of the job.
timestamp (String) The timestamp of the job execution.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.license_repository`

Read-Only:

created_by (String) The user who created the license repository.
created_date (String) The date when the license repository was created.
disk_location (String) The disk location of the license repository.
filename (String) The filename associated with the license repository.
id (String) The unique identifier of the license repository.
license_data (String) The license data associated with the license repository.
name (String) The name of the license repository.
state (String) The state of the license repository.
type (String) The type of the license repository.
updated_by (String) The user who last updated the license repository.
updated_date (String) The date when the license repository was last updated.

Nested Schema for `resource_group_details.service_template.firmware_repository.deployments.vms`

Read-Only:

certificate_name (String) The certificate name associated with the virtual machine (VM).
vm_ipaddress (String) The IP address of the virtual machine (VM).
vm_manufacturer (String) The manufacturer of the virtual machine (VM).
vm_model (String) The model of the virtual machine (VM).
vm_service_tag (String) The service tag associated with the virtual machine (VM).

Nested Schema for `resource_group_details.service_template.firmware_repository.software_bundles`

Read-Only:

bundle_date (String) The date when the software bundle was created.
bundle_type (String) The type of the software bundle.
created_by (String) The user who initially created the software bundle.
created_date (String) The date when the software bundle was initially created.
criticality (String) The criticality level of the software bundle.
custom (Boolean) Indicates whether the software bundle is custom.
description (String) A brief description of the software bundle.
device_model (String) The model of the device associated with the software bundle.
device_type (String) The type of device associated with the software bundle.
fw_repository_id (String) The identifier of the firmware repository associated with the software bundle.
id (String) The unique identifier for the software bundle.
name (String) The name of the software bundle.
needs_attention (Boolean) Indicates whether the software bundle needs attention.
software_components (Attributes List) List of software components associated with the software bundle. (see below for nested schema)
updated_by (String) The user who last updated the software bundle.
updated_date (String) The date when the software bundle was last updated.
user_bundle (Boolean) Indicates whether the software bundle is a user-specific bundle.
user_bundle_hash_md_5 (String) The MD5 hash value of the user-specific software bundle.
user_bundle_path (String) The path associated with the user-specific software bundle.
version (String) The version of the software bundle.

Nested Schema for `resource_group_details.service_template.firmware_repository.software_bundles.software_components`

Read-Only:

category (String) The category to which the component belongs.
component_id (String) The identifier of the component.
component_type (String) The type of the component.
created_by (String) The user who created the component.
created_date (String) The date when the component was created.
custom (Boolean) Indicates whether the component is custom or not.
dell_version (String) The version of the component according to Dell standards.
device_id (String) The identifier of the device associated with the component.
firmware_repo_name (String) The name of the firmware repository associated with the component.
hash_md_5 (String) The MD5 hash value of the component.
id (String) The unique identifier for the software component.
ignore (Boolean) Indicates whether the component should be ignored.
name (String) The name of the software component.
needs_attention (Boolean) Indicates whether the component needs attention.
operating_system (String) The operating system associated with the component.
original_component_id (String) The identifier of the original component.
original_version (String) The original version of the component.
package_id (String) The identifier of the package to which the component belongs.
path (String) The path where the component is stored.
sub_device_id (String) The sub-identifier of the device associated with the component.
sub_vendor_id (String) The sub-identifier of the vendor associated with the component.
system_ids (List of String) List of system IDs associated with the component.
updated_by (String) The user who last updated the component.
updated_date (String) The date when the component was last updated.
vendor_id (String) The identifier of the vendor associated with the component.
vendor_version (String) The version of the component according to the vendor’s standards.

Nested Schema for `resource_group_details.service_template.firmware_repository.software_components`

Read-Only:

category (String) The category to which the component belongs.
component_id (String) The identifier of the component.
component_type (String) The type of the component.
created_by (String) The user who created the component.
created_date (String) The date when the component was created.
custom (Boolean) Indicates whether the component is custom or not.
dell_version (String) The version of the component according to Dell standards.
device_id (String) The identifier of the device associated with the component.
firmware_repo_name (String) The name of the firmware repository associated with the component.
hash_md_5 (String) The MD5 hash value of the component.
id (String) The unique identifier for the software component.
ignore (Boolean) Indicates whether the component should be ignored.
name (String) The name of the software component.
needs_attention (Boolean) Indicates whether the component needs attention.
operating_system (String) The operating system associated with the component.
original_component_id (String) The identifier of the original component.
original_version (String) The original version of the component.
package_id (String) The identifier of the package to which the component belongs.
path (String) The path where the component is stored.
sub_device_id (String) The sub-identifier of the device associated with the component.
sub_vendor_id (String) The sub-identifier of the vendor associated with the component.
system_ids (List of String) List of system IDs associated with the component.
updated_by (String) The user who last updated the component.
updated_date (String) The date when the component was last updated.
vendor_id (String) The identifier of the vendor associated with the component.
vendor_version (String) The version of the component according to the vendor’s standards.

Nested Schema for `resource_group_details.service_template.license_repository`

Read-Only:

created_by (String) The user who created the license repository.
created_date (String) The date when the license repository was created.
disk_location (String) The disk location of the license repository.
filename (String) The filename associated with the license repository.
id (String) The unique identifier of the license repository.
license_data (String) The license data associated with the license repository.
name (String) The name of the license repository.
state (String) The state of the license repository.
type (String) The type of the license repository.
updated_by (String) The user who last updated the license repository.
updated_date (String) The date when the license repository was last updated.

Nested Schema for `resource_group_details.service_template.networks`

Read-Only:

description (String) The description of the network.
destination_ip_address (String) The destination IP address for the network.
id (String) The unique identifier for the network.
name (String) The name of the network.
static (Boolean) Boolean indicating if the network is static.
static_network_configuration (Attributes) The static network configuration settings. (see below for nested schema)
type (String) The type of the network.
vlan_id (Number) The VLAN ID associated with the network.

Nested Schema for `resource_group_details.service_template.networks.static_network_configuration`

Read-Only:

dns_suffix (String) The DNS suffix for the static network configuration.
gateway (String) The gateway for the static network configuration.
ip_address (String) The IP address associated with the static network configuration.
ip_range (Attributes List) List of IP ranges associated with the static network configuration. (see below for nested schema)
primary_dns (String) The primary DNS server for the static network configuration.
secondary_dns (String) The secondary DNS server for the static network configuration.
static_route (Attributes List) List of static routes associated with the static network configuration. (see below for nested schema)
subnet (String) The subnet for the static network configuration.

Nested Schema for `resource_group_details.service_template.networks.static_network_configuration.ip_range`

Read-Only:

ending_ip (String) The ending IP address of the range.
id (String) The unique identifier for the IP range.
role (String) The role associated with the IP range.
starting_ip (String) The starting IP address of the range.

Nested Schema for `resource_group_details.service_template.networks.static_network_configuration.static_route`

Read-Only:

destination_ip_address (String) The IP address of the destination for the static route.
static_route_destination_network_id (String) The ID of the destination network for the static route.
static_route_gateway (String) The gateway for the static route.
static_route_source_network_id (String) The ID of the source network for the static route.
subnet_mask (String) The subnet mask for the static route.

Nested Schema for `resource_group_details.service_template.template_valid`

Read-Only:

messages (Attributes List) List of messages associated with the template validity. (see below for nested schema)
valid (Boolean) Indicates whether the template is valid.

Nested Schema for `resource_group_details.service_template.template_valid.messages`

Read-Only:

agent_id (String) The identifier of the agent associated with the message.
category (String) The category or type of the message.
correlation_id (String) The identifier used to correlate related messages.
detailed_message (String) A detailed version or description of the message.
display_message (String) The message to be displayed or shown.
id (String) The unique identifier for the message.
message_bundle (String) The bundle or group to which the message belongs.
message_code (String) The code associated with the message.
response_action (String) The action to be taken in response to the message.
sequence_number (Number) The sequence number of the message in a series.
severity (String) The severity level of the message (e.g., INFO, WARNING, ERROR).
time_stamp (String) The timestamp indicating when the message was generated.

Nested Schema for `resource_group_details.vms`

Read-Only:

certificate_name (String) The certificate name associated with the virtual machine (VM).
vm_ipaddress (String) The IP address of the virtual machine (VM).
vm_manufacturer (String) The manufacturer of the virtual machine (VM).
vm_model (String) The model of the virtual machine (VM).
vm_service_tag (String) The service tag associated with the virtual machine (VM).

V1.9.0: powerflex_resource_group resource

Mon, 01 Jan 0001 00:00:00 +0000

powerflex_resource_group (Resource)

This resource is used to manage the ResourceGroup entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from the PowerFlex array.

Example Usage

/*
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.
*/


# Commands to run this tf file : terraform init && terraform plan && terraform apply
# Create, Update, Delete is supported for this resource
# To create / update, either template_id or firmware_id must be provided
# deployment_name and deployment_description are the required parameters to create or update
# other  atrributes like : nodes, port, deployment_timeout are optional 
# To check which attributes can be updated, please refer Product Guide in the documentation


# example 1: Resource Group Resource
resource "powerflex_resource_group" "Data" {
  deployment_name        = "Test-Create-U1"
  deployment_description = "Test Service-U1"
  template_id            = "453c41eb-d72a-4ed1-ad16-bacdffbdd766"
  firmware_id            = "8aaaee208c8c467e018cd37813250614"
  nodes                  = 0
  clone_from_host        = "pfmc-k8s-20230809-160"
  deployment_timeout     = 0
}


# example 2: Get Template ID and Firmware ID from Template Datasource

data "powerflex_template" "template_data" {
  template_names = ["Teample_Name"]
}

resource "powerflex_resource_group" "Data" {
  deployment_name        = "Test-Create-U1"
  deployment_description = "Test Service-U1"
  template_id            = tolist(data.powerflex_template.template_data.template_details)[0].id
  firmware_id            = tolist(data.powerflex_template.template_data.template_details)[0].firmware_id
  nodes                  = 3
  clone_from_host        = "pfmc-k8s-20230809-160"
  deployment_timeout     = 60
}

After the execution of above resource block, Resource Group would have been deployed on the PowerFlex Gateway. For more information, please check the terraform state file.

Schema

Required

deployment_description (String) Deployment Description
deployment_name (String) Deployment Name
firmware_id (String) Firmware ID
template_id (String) Published Template ID

Optional

clone_from_host (String) Resource to Duplicate From Host
deployment_timeout (Number) Deployment Timeout, It should be in multiples of 5
nodes (Number) Number of Nodes
servers_in_inventory (String) After Delete the Service, Servers in inventory Keep or Remove. Default value is Keep
servers_managed_state (String) After Delete the Service, Servers’s state Managed or Unmanaged. Default value is Unmanaged.

Read-Only

compliant (Boolean) Deployment Compliant Status
id (String) Deployment ID
status (String) Deployment Status
template_name (String) Service Template Name

Import

Import is supported using the following syntax:

# /*
# 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.
# */

# import Resource Group by it's id
terraform import powerflex_resource_group.data "<id>"

Dell Technologies – Terraform Providers

V1.9.0: ReadMe

Terraform Provider for Dell Technologies PowerFlex

Table of contents

Support

License

Prerequisites

List of DataSources in Terraform Provider for Dell PowerFlex

Storage Management

Data Protection

Host and Device

Gen2 (PowerFlex 5.x)

Resource Group Management

Firmware and OS Management

Compliance and Templates

List of Resources in Terraform Provider for Dell PowerFlex

Cluster and System

Storage Management

Data Protection

Host and Device

Gen2 (PowerFlex 5.x)

Resource Group Management

Firmware and OS Management

User Management

List of Modules in Terraform Provider for Dell PowerFlex

Installation and execution of Terraform Provider for Dell PowerFlex

Releasing, Maintenance and Deprecation

Documentation

Terraform PowerFlex Modules

V1.9.0: Release Notes

Terraform Provider for Dell PowerFlex

Release Notes 1.9.0

Contents

Revision History

Product Description

New Features & Enhancements

Resources

Data Sources

Enhancements

Removal

Deprecations

Known Issues

Limitations

Distribution

Documentation

V1.9.0: Migration Guide: PowerFlex 4.x to 5.x (Gen2)

Migration Guide: PowerFlex 4.x to 5.x (Gen2)

Overview

New Resources in 5.x

Storage Management

Actions

Datasources

Migration Path

1. Device Resource Changes

2. Storage Pool Erasure Coding

3. Storage Node (Gen2 SDS)

4. Device Group

5. Volume Actions

Backward Compatibility

Deprecated Parameters

Gradual Migration

Compatibility Matrix

Troubleshooting

Error: “Gen2 API Client Not Available”

Error: “sds_id is deprecated”

Validation Error: “value must be one of”

Additional Resources

V1.9.0:

ESXi SDC End to End Example

Overview

Step 1: Install the SDC on ESXi Host

Step 2: Create and Attach Volume

Step 3: Create VMFS Datasource

V1.9.0:

SDC End to End Example

Overview

Step 1: VM Deployment

Provider Example:

.ova Example:

Template Example:

Nested Schema for `cluster`

Nested Schema for `storage_pools`

Nested Schema for `mdm_list`

Nested Schema for `protection_domains`

Nested Schema for `protection_domains.storage_pool_list`

Nested Schema for `sdc_list`

Nested Schema for `sdr_list`

Nested Schema for `sds_list`

Nested Schema for `sds_list.devices`

Nested Schema for `sdt_list`