Dell Technologies – Resources

V1.0.4: powermax_host resource

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

powermax_host (Resource)

Resource for managing Host in PowerMax array. PowerMax hosts systems are storage hosts that use storage system logical unit number (LUN) resources. A LUN is an identifier that is used for labeling and designating subsystems of physical or virtual storage

Example Usage

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

# Available actions: Create, Update (name, initiator, consistent_lun, host_flags), Delete and Import an existing host from the PowerMax Array.
# After `terraform apply` of this example file it will create a new host with the name set in `name` attribute on the PowerMax

# PowerMax hosts systems are storage hosts that use storage system logical unit number (LUN) resources.
# A LUN is an identifier that is used for labeling and designating subsystems of physical or virtual storage.
resource "powermax_host" "host_1" {

  # Attributes which are able to be modified after create (name, initiator, consistent_lun, host_flags)

  # Required is the name of the host. 
  # Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed
  name = "host_1"

  # Required The initiator(s) associated with the host
  initiator = ["10000000c9fc4b7e"]

  # Optional consistent_lun the lun addresses on the source are consistent across all paths
  consistent_lun = false

  # Optional host flags
  # All flags are optional and have 2 possible values enabled (to enable that flag on the PowerMax) and override (to force that flag to be set on the PowerMax)
  # If a flag is not set then it will have a default value of false
  host_flags = {

    # Optional It enables a SCSI bus reset to only occur to the port that received the reset.
    avoid_reset_broadcast = {
      override = true
      enabled  = true
    }

    # Optional It is used for hosts that do not expect the queue to be flushed on a 0629 sense.
    disable_q_reset_on_ua = {
      override = true
      enabled  = true
    }

    # Optional It enables the environmental error reporting by the storage system to the host on the specific port.
    environ_set = {
      override = true
      enabled  = true
    }

    # Optional This attribute enables an Open VMS fibre connection
    openvms = {
      override = true
      enabled  = true
    }

    # Optional This attribute provides a stricter compliance with SCSI standards
    scsi_support1 = {
      override = true
      enabled  = true
    }

    # Optional SPC2 Protocol flag. When setting this flag, the port must be offline
    spc2_protocol_version = {
      override = true
      enabled  = true
    }

    # Optional Alters the inquiry data to report that the storage system supports the SCSI-3 protocol
    scsi_3 = {
      override = true
      enabled  = true
    }

    # Optional It enables the volume set addressing mode
    volume_set_addressing = {
      override = true
      enabled  = true
    }
  }
}

# After the execution of above resource block, a PowerMax host has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Required

initiator (List of String) The initiators associated with the host. (Update Supported)
name (String) The name of the host. Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed. (Update Supported)

Optional

consistent_lun (Boolean) It enables the rejection of any masking operation involving this host that would result in inconsistent LUN values. (Update Supported)
host_flags (Attributes) Flags set for the host. When host_flags = {} then default flags will be considered. (Update Supported) (see below for nested schema)

Read-Only

bw_limit (Number) Specifies the bandwidth limit for a host.
hostgroup (List of String) The host group associated with the host.
id (String) The ID of the host.
maskingview (List of String) The masking views associated with the host.
num_of_host_groups (Number) The number of hostgroups associated with the host.
num_of_initiators (Number) The number of initiators associated with the host.
num_of_masking_views (Number) The number of masking views associated with the host.
numofpowerpathhosts (Number) The number of powerpath hosts associated with the host.
port_flags_override (Boolean) States whether port flags override is enabled on the host.
powerpathhosts (List of String) The powerpath hosts associated with the host.
type (String) Specifies the type of host.

Nested Schema for `host_flags`

Optional:

avoid_reset_broadcast (Attributes) It enables a SCSI bus reset to only occur to the port that received the reset. (Update Supported) (see below for nested schema)
disable_q_reset_on_ua (Attributes) It is used for hosts that do not expect the queue to be flushed on a 0629 sense. (Update Supported) (see below for nested schema)
environ_set (Attributes) It enables the environmental error reporting by the storage system to the host on the specific port. (Update Supported) (see below for nested schema)
openvms (Attributes) This attribute enables an Open VMS fibre connection. (Update Supported) (see below for nested schema)
scsi_3 (Attributes) Alters the inquiry data to report that the storage system supports the SCSI-3 protocol. (Update Supported) (see below for nested schema)
scsi_support1 (Attributes) This attribute provides a stricter compliance with SCSI standards. (Update Supported) (see below for nested schema)
spc2_protocol_version (Attributes) When setting this flag, the port must be offline. (Update Supported) (see below for nested schema)
volume_set_addressing (Attributes) It enables the volume set addressing mode. (Update Supported) (see below for nested schema)

Nested Schema for `host_flags.avoid_reset_broadcast`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.disable_q_reset_on_ua`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.environ_set`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.openvms`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.scsi_3`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.scsi_support1`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.spc2_protocol_version`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.volume_set_addressing`

Optional:

enabled (Boolean)
override (Boolean)

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_host.host_1 <id>
# Example:
terraform import powermax_host.host_1 host_1
# after running this command, populate the name field in the config file to start managing this resource

V1.0.4: powermax_hostgroup resource

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

powermax_hostgroup (Resource)

Resource for managing HostGroups for a PowerMax Array. PowerMax host groups are groups of PowerMax Hosts. see the host example for more information on hosts.

Example Usage

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

# Available actions: Create, Update (name, host_ids, consistent_lun, host_flags), Delete and Import an existing host group from the PowerMax Array.
# After `terraform apply` of this example file it will create a new host_group with the name set in `name` attribute on the PowerMax

# PowerMax host groups are groups of PowerMax Hosts. see the host example for more information on hosts
resource "powermax_hostgroup" "test_host_group" {

  # Attributes which are able to be modified after create (name, host_ids, consistent_lun, host_flags)

  # Required the name of the new host group
  # Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed
  name = "host_group"

  # Required A list of host ids associated with the hostgroup (should have at least 1) 
  host_ids = ["testHost"]

  # Optional host flags
  # All flags are optional and have 2 possible values enabled (to enable that flag on the PowerMax) and override (to force that flag to be set on the PowerMax)
  # If a flag is not set then it will have a default value of false
  host_flags = {

    # Optional It enables a SCSI bus reset to only occur to the port that received the reset.
    avoid_reset_broadcast = {
      override = true
      enabled  = true
    }

    # Optional It is used for hosts that do not expect the queue to be flushed on a 0629 sense.
    disable_q_reset_on_ua = {
      override = true
      enabled  = true
    }

    # Optional It enables the environmental error reporting by the storage system to the host on the specific port.
    environ_set = {
      override = true
      enabled  = true
    }

    # Optional This attribute enables an Open VMS fibre connection
    openvms = {
      override = true
      enabled  = true
    }

    # Optional This attribute provides a stricter compliance with SCSI standards
    scsi_support1 = {
      override = true
      enabled  = true
    }

    # Optional SPC2 Protocol flag. When setting this flag, the port must be offline
    spc2_protocol_version = {
      override = true
      enabled  = true
    }

    # Optional Alters the inquiry data to report that the storage system supports the SCSI-3 protocol
    scsi_3 = {
      override = true
      enabled  = true
    }

    # Optional It enables the volume set addressing mode
    volume_set_addressing = {
      override = true
      enabled  = true
    }
  }
}

# After the execution of above resource block, a PowerMax host group has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Required

host_ids (Set of String) A list of host ids associated with the hostgroup. (Update Supported)
name (String) The name of the hostgroup. Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed. (Update Supported)

Optional

consistent_lun (Boolean) It enables the rejection of any masking operation involving this hostgroup that would result in inconsistent LUN values. (Update Supported)
host_flags (Attributes) Host Flags set for the hostgroup. When host_flags = {} or not set then default flags will be considered. (Update Supported) (see below for nested schema)

Read-Only

id (String) The ID of the hostgroup.
maskingviews (List of String) The masking views associated with the hostgroup.
numofhosts (Number) The number of hosts associated with the hostgroup.
numofinitiators (Number) The number of initiators associated with the hostgroup.
numofmaskingviews (Number) The number of masking views associated with the hostgroup.
port_flags_override (Boolean) States whether port flags override is enabled on the hostgroup.
type (String) Specifies the type of hostgroup.

Nested Schema for `host_flags`

Optional:

avoid_reset_broadcast (Attributes) It enables a SCSI bus reset to only occur to the port that received the reset. (Update Supported) (see below for nested schema)
disable_q_reset_on_ua (Attributes) It is used for hosts that do not expect the queue to be flushed on a 0629 sense. (Update Supported) (see below for nested schema)
environ_set (Attributes) It enables the environmental error reporting by the storage system to the host on the specific port. (Update Supported) (see below for nested schema)
openvms (Attributes) This attribute enables an Open VMS fibre connection. (Update Supported) (see below for nested schema)
scsi_3 (Attributes) Alters the inquiry data to report that the storage system supports the SCSI-3 protocol. (Update Supported) (see below for nested schema)
scsi_support1 (Attributes) This attribute provides a stricter compliance with SCSI standards. (Update Supported) (see below for nested schema)
spc2_protocol_version (Attributes) When setting this flag, the port must be offline. (Update Supported) (see below for nested schema)
volume_set_addressing (Attributes) It enables the volume set addressing mode. (Update Supported) (see below for nested schema)

Nested Schema for `host_flags.avoid_reset_broadcast`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.disable_q_reset_on_ua`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.environ_set`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.openvms`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.scsi_3`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.scsi_support1`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.spc2_protocol_version`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `host_flags.volume_set_addressing`

Optional:

enabled (Boolean)
override (Boolean)

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_hostgroup.test_host_group <id>
# Example:
terraform import powermax_hostgroup.test_host_group host_group
# after running this command, populate the name field in the config file to start managing this resource

V1.0.4: powermax_maskingview resource

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

powermax_maskingview (Resource)

Resource for managing MaskingViews in PowerMax array. PowerMax masking views are a container of a storage group, a port group, and an initiator group, and makes the storage group visible to the host. Devices are masked and mapped automatically. The groups must contain some device entries.

Example Usage

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

# Available actions: Create, Update (name), Delete and Import an existing maskingview from the PowerMax Array.
# After `terraform apply` of this example file it will create a new masking_view with the name set in `name` attribute on the PowerMax

# PowerMax masking views are a container of a storage group, a port group, and an initiator group, and makes the storage group visible to the host. 
# Devices are masked and mapped automatically. The groups must contain some device entries.
resource "powermax_maskingview" "test" {

  # Attributes which are able to be modified after create (name)

  # Required the name of the new masking view
  # Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed
  name = "terraform_mv"

  # Required the storage group id to be assoiciated with the new masking view
  storage_group_id = "TestnewSG"

  # Required host to be assoiciated with the new masking view
  # NOTE if host_id is set then host_group_id must be empty string ""
  host_id = "Host124"

  # Required host group to be assoiciated with the new masking view
  # NOTE if host_group_id is set then host_id must be an empty string ""
  host_group_id = ""

  # Required the port group to be assoiciated with the new masking view
  port_group_id = "TestnewSG_PG"
}

# After the execution of above resource block, a PowerMax maskingview has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Required

host_group_id (String) The host group id of the masking view.
host_id (String) The host id of the masking view.
name (String) Unique identifier of the masking view. (Update Supported)
port_group_id (String) The port group id of the masking view.
storage_group_id (String) The storage group id of the masking view.

Read-Only

id (String) The ID of the masking view.

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_maskingview.test <id>
# Example:
terraform import powermax_maskingview.test terraform_mv
# after running this command, populate the name field in the config file to start managing this resource

V1.0.4: powermax_portgroup resource

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

powermax_portgroup (Resource)

Resource for managing PortGroups in PowerMax array. PowerMax port groups contain director and port identification and belong to a masking view. Ports can be added to and removed from the port group. Port groups that are no longer associated with a masking view can be deleted. Note the following recommendations: Port groups should contain four or more ports. Each port in a port group should be on a different director. A port can belong to more than one port group. However, for storage systems running HYPERMAX OS 5977 or higher, you cannot mix different types of ports (physical FC ports, virtual ports, and iSCSI virtual ports) within a single port group

Example Usage

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

# Available actions: Create, Update (name, ports), Delete and Import an existing portgroup from the PowerMax Array.
# After `terraform apply` of this example file it will create a new portgroup with the name set in `name` attribute on the PowerMax

# PowerMax port groups contain director and port identification and belong to a masking view. Ports can be added to and removed from the port group. Port groups that are no longer associated with a masking view can be deleted.
# Note the following recommendations:
# Port groups should contain four or more ports.
# Each port in a port group should be on a different director.
# A port can belong to more than one port group. However, for storage systems running HYPERMAX OS 5977 or higher, you cannot mix different types of ports (physical FC ports, virtual ports, and iSCSI virtual ports) within a single port group
resource "powermax_portgroup" "portgroup_1" {

  # Attributes which are able to be modified after create (name, ports)

  # Required The name of the portgroup. Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed.
  name = "tfacc_pg_test_1"

  # Required The portgroup protocol. Protocols: SCSI_FC, iSCSI, NVMe_FC, NVMe_TCP
  protocol = "SCSI_FC"

  # Required The list of ports associated with the portgroup
  # Must include the director and port id in each object below
  ports = [
    {
      director_id = "OR-1C"
      port_id     = "0"
    }
  ]
}

# After the execution of above resource block, a PowerMax port group has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Required

name (String) The name of the portgroup. Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed. (Update Supported)
ports (Attributes List) The list of ports associated with the portgroup. (Update Supported) (see below for nested schema)
protocol (String) The portgroup protocol. Protocols: SCSI_FC, iSCSI, NVMe_FC, NVMe_TCP

Read-Only

id (String) The ID of the portgroup.
maskingview (List of String) The masking views associated with the portgroup.
numofmaskingviews (Number) The number of masking views associated with the portgroup.
numofports (Number) The number of ports associated with the portgroup.
type (String) The type of the portgroup.

Nested Schema for `ports`

Required:

director_id (String)
port_id (String)

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_portgroup.portgroup_1 <id>
# Example:
terraform import powermax_portgroup.portgroup_1 tfacc_pg_test_1
# after running this command, populate the name field in the config file to start managing this resource

V1.0.4: powermax_snapshot resource

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

powermax_snapshot (Resource)

Resource for managing Snapshots in PowerMax array. PowerMax Snaphots is a local replication solution that is designed to nondisruptively create point-in-time copies (snapshots) of critical data.

Example Usage

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

# Available actions: Create, Update (name, secure, time_to_live, link, restore), Delete and Import an existing snapshot from the PowerMax Array.
# After `terraform apply` of this example file it will create a new snapshot with the name set in `name` attribute on the PowerMax for the storage group set in the storage group `name` attribute
# NOTE: that all of the PowerMax `snapshot_actions` are only available during modify of the snapshot after it has been created.

# PowerMax Snaphots is a local replication solution that is designed to nondisruptively create point-in-time copies (snapshots) of critical data.
resource "powermax_snapshot" "snapshot_1" {

  # Attributes which are able to be modified after create (secure, time_to_live, link, restore)

  # Required The storage group that the snapshot will be taken upon 
  storage_group {
    name = "test_sg"
  }

  # The different actions that can be taken on a snapshot ONLY after the snapshot has already been created
  snapshot_actions {

    # Required, name of new snapshot
    # Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed.
    name = "new_test_snapshot"

    # Optional this is only available for modify after the resource is created
    # Secure will make it so the snapshot can not be delete until the time in the `secure` flag runs out.
    # Even if the user changes enabled to false after the secure flag is set
    # The snapshot will remmain secure and cannot be deleted
    secure = {
      # Set to true to it will enable this action
      enable = true
      # If set to true the time_to_live is in hours, otherwise it is in days
      time_in_hours = true
      # How long before the snapshot will no longer be secure
      secure = 3
    }

    # Optional this is only available for modify after the resource is created
    # When this flag is set it will delete the snapshot after the time_to_live expires
    time_to_live = {
      # Set to true to it will enable this action
      enable = true
      # If set to true the time_to_live is in hours, otherwise it is in days
      time_in_hours = false
      # How long before the snapshot is deleted
      time_to_live = 1
    }

    # Optional this is only available for modify after the resource is created
    # When this flag is set it will link the tareget_storage_group with the storage group above
    link = {
      # When set to false it will look through the already linked snapshots, if the one in the target group is currently linked it will remove that storage group
      # When set to true it will look through the already linked snapshots, if the one in the target group is not currently liked it will like that storage group
      enable = false
      # The storage group which will be linked
      target_storage_group = "test_target_sg"
      # The target storage group will not have compression turned on when the SRP is compression capable
      no_compression = true
      # Acknowledges that the data will be propagated to the remote mirror of the SRDF volume. This is not allowed on a nocopy linked target.
      remote = false
      # Sets the link copy mode to perform background copy to the target volume(s).
      copy = false
    }

    # Optional this is only available for modify after the resource is created
    # Will attempt to restore the snapshot to a pervious state
    restore = {
      # When enabled it will attempt to restore the snapshot
      enable = true
      # Acknowledges that the data will be propagated to the remote mirror of the RDF device. This is not allowed on a nocopy link target.
      remote = false
    }
  }
}

# After the execution of above resource block, a PowerMax snapshot has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Optional

generation (Number) Number of generation for the snapshot
linked_storage_group (Attributes List) Linked storage group and volume information. Only populated if the generation is linked (see below for nested schema)
non_shared_tracks (Number) The number of tracks uniquely allocated for this snapshots delta. This is an approximate indication of the number of tracks that will be returned to the SRP if this snapshot is terminated.
num_source_volumes (Number) The number of source volumes in the snapshot generation
persistent (Boolean) Set if this snapshot is persistent. Only applicable to policy based snapshots
secure_expiry_date (String) When the snapshot will expire once it is not linked
snapid (Number) Unique Snap ID for Snapshot
snapshot_actions (Block, Optional) (see below for nested schema)
storage_group (Block, Optional) (see below for nested schema)
time_to_live_expiry_date (String) When the snapshot will expire once it is not linked
tracks (Number) The number of source tracks that have been overwritten by the host

Read-Only

expired (Boolean) Set if this generation secure has expired
id (String) Identifier
linked (Boolean) Set if this generation is SnapVX linked
linked_storage_group_names (List of String) Linked storage group names. Only populated if the generation is linked
name (String) Name of a snapshot
num_storage_group_volumes (Number) The number of non-gatekeeper storage group volumes
restored (Boolean) Set if this generation is SnapVX linked
source_volume (Attributes List) The source volumes of the snapshot generation (see below for nested schema)
state (List of String) The state of the snapshot generation
timestamp (String) Timestamp of the snapshot generation
timestamp_utc (String) The timestamp of the snapshot generation in milliseconds since 1970

Nested Schema for `linked_storage_group`

Optional:

background_define_in_progress (Boolean) When the snapshot link is being defined
defined (Boolean) When the snapshot link has been fully defined

Read-Only:

linked_creation_timestamp (String) The average timestamp of all linked volumes that are linked
linked_volume_name (String) The linked volumes name
name (String) The storage group name
percentage_copied (Number) Percentage of tracks copied
source_volume_name (String) The source volumes name
track_size (Number) Size of the tracks.
tracks (Number) Number of tracks

Nested Schema for `snapshot_actions`

Required:

name (String) Name of the snapshot. (Update Supported)

Optional:

both_sides (Boolean) both_sides defaults to false. Performs the operation on both locally and remotely associated snapshots.
link (Attributes) Link a snapshot generation. (Update Supported) (see below for nested schema)
remote (Boolean) remote defaults to false. If true, The target storage group will not have compression turned on when the SRP is compression capable.
restore (Attributes) Restore a snapshot generation. (Update Supported) (see below for nested schema)
secure (Attributes) Set the number of days or hours for a snapshot generation to be secure before it auto-terminates (provided it is not linked). (Update Supported) (see below for nested schema)
time_to_live (Attributes) Set the number of days or hours for a snapshot generation before it auto-terminates (provided it is not linked). (Update Supported) (see below for nested schema)

Nested Schema for `snapshot_actions.link`

Optional:

copy (Boolean) copy defaults to false. If true Sets the link copy mode to perform background copy to the target volume(s).
enable (Boolean) enable defaults to false. Flag to enable link on the snapshot
no_compression (Boolean) no_compression defaults to false. If true, The target storage group will not have compression turned on when the SRP is compression capable. Option Used in Action Link
remote (Boolean) remote defaults to false. If true, The target storage group will not have compression turned on when the SRP is compression capable. Option Used in Action Link
target_storage_group (String) The target storage group to link the snapshot too

Nested Schema for `snapshot_actions.restore`

Optional:

enable (Boolean) enable defaults to false. Flag to enable restore on the snapshot
remote (Boolean) remote defaults to false. If true, The target storage group will not have compression turned on when the SRP is compression capable. Option Used in Action Link

Nested Schema for `snapshot_actions.secure`

Optional:

enable (Boolean) enable defaults to false. Flag to enable link on the snapshot
secure (Number) secure defaults to 1 day. The time that the snapshot generation is to be secure for.
time_in_hours (Boolean) time_in_hours or Days defaults to Days. False is days, true is hours.

Nested Schema for `snapshot_actions.time_to_live`

Optional:

enable (Boolean) enable defaults to false. Flag to enable link on the snapshot
time_in_hours (Boolean) time_in_hours or Days defaults to Days. False is days, true is hours.
time_to_live (Number) time_to_live defaults to 1 day. Gives the total time before expiry for these actions.

Nested Schema for `storage_group`

Required:

name (String) Name of the storage group you would like to take a snapshot.

Nested Schema for `source_volume`

Read-Only:

capacity (Number) The capacity of the snapshot volume in cylinders
capacity_gb (Number) The capacity of the snapshot volume in GB
name (String) The name of the SnapVX snapshot generation source volume

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_snapshot.snapshot_test storage_group.snapshot_name
# Example: must be storage_group.snapshot_name
terraform import powermax_snapshot.snapshot_test storage_group.snapshot_name
# after running this command, populate the name field in the config file to start managing this resource

V1.0.4: powermax_snapshotpolicy resource

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

powermax_snapshotpolicy (Resource)

Resource for a specific Snapshot Policy in PowerMax array. PowerMax snapshot policy feature provides snapshot orchestration at scale (1,024 snaps per storage group). The resource simplifies snapshot management for standard and cloud snapshots.

Example Usage

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

# Available actions: Create, Update (snapshot_policy_name, storage_groups, interval, snapshot_count, compliance_count_critical, compliance_count_warning, offset_minutes, secure), Delete and Import an existing snapshot policy from the PowerMax Array.
# After `terraform apply` of this example file it will create a new snapshot policy with the name set in `snapshot_policy_name` attribute on the PowerMax

# PowerMax snapshot policy feature provides snapshot orchestration at scale (1,024 snaps per storage group).
# The resource simplifies snapshot management for standard and cloud snapshots.
# This resouce will take snapshots on a periodic basic based on the configuration below.

resource "powermax_snapshotpolicy" "terraform_sp" {

  # Attributes which are able to be modified after create (snapshot_policy_name, storage_groups, interval, snapshot_count, compliance_count_critical, compliance_count_warning, offset_minutes, secure)

  # Required Field will become the name of the snapshot policy
  snapshot_policy_name = "terraform_sp"

  # should only be set for modify/edit operation , not supported during create. 
  # Also the destroy/delete will also unlink any associted storage groups from Snapshot Policy before deleting the snapshot policy.
  # storage_groups =  ["tfacc_sp_sg1", "tfacc_sp_sg2"]

  # Default values are defined below and can be modifed before or after create 

  # The interval between snapshots
  # interval             = "1 Hour"

  # The number of the snapshots that will be maintained by the snapshot policy
  # snapshot_count       = "48"

  # The number of snapshots which are not failed or bad when compliance changes to critical.
  # compliance_count_critical = 46

  # The number of snapshots which are not failed or bad when compliance changes to warning.
  # compliance_count_warning  = 47

  # The number of minutes from 00:00 on a Monday morning when the policy should run. Default is 0 if not specified.
  # offset_minutes            = 420

  # The snapshot policy will create secure snapshots
  # secure = false

}

# After the execution of above resource block, a PowerMax snapshot policy has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Required

snapshot_policy_name (String) Name of the snapshot policy. Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed and max length can be 32 characters. (Update Supported)

Optional

compliance_count_critical (Number) The threshold of good snapshots which are not failed/bad for compliance to change from warning to critical. (Update Supported)
compliance_count_warning (Number) The threshold of good snapshots which are not failed/bad for compliance to change from normal to warning. (Update Supported)
interval (String) The interval between snapshots Enumeration values: 10 Minutes, 12 Minutes, 15 Minutes, 20 Minutes, 30 Minutes, 1 Hour, 2 Hours, 3 Hours, 4 Hours, 6 Hours, 8 Hours, 12 Hours, 1 Day, 7 Days. (Update Supported)
interval_minutes (Number) Number of minutes between each policy execution
last_time_used (String) The last time that the snapshot policy was run
offset_minutes (Number) Number of minutes after 00:00 on Monday morning that the policy will execute. (Update Supported)
provider_name (String) The name of the cloud provider associated with this policy. Only applies to cloud policies
retention_days (Number) The number of days that snapshots will be retained in the cloud for. Only applies to cloud policies
secure (Boolean) Set if the snapshot policy creates secure snapshots. (Update Supported)
snapshot_count (Number) Number of snapshots that will be taken before the oldest ones are no longer required. (Update Supported)
storage_groups (Set of String) The storage groups associated with the snapshot policy. This field cannot be set during create and is only valid for Edit/Update.If user wants to delete the snapshot policy all associated storage groups will also be unlinked from the Snapshot Policy. (Update Supported)
suspended (Boolean) Set if the snapshot policy has been suspended

Read-Only

id (String) Identifier
storage_group_count (Number) The total number of storage groups that this snapshot policy is associated with
type (String) The type of Snapshots that are created with the policy, local or cloud

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_storagegroup.test <id>
# Example:
terraform import powermax_snapshotpolicy.terraform_sp terraform_sp
# after running this command, populate the name field in the config file to start managing this resource

V1.0.4: powermax_storagegroup resource

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

powermax_storagegroup (Resource)

Resource for managing StorageGroups in PowerMax array. PowerMax storage groups are a collection of devices that are stored on the array. An application, a server, or a collection of servers use them.

Example Usage

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

# Available actions: Create, Update (name, compression, host_io_limit, workload, slo, srp_id, volume_ids), Delete and Import an existing storage group from the PowerMax Array.
# After `terraform apply` of this example file it will create a new storage group with the name set in `name` attribute on the PowerMax

# PowerMax storage groups are a collection of devices that are stored on the array.
# An application, a server, or a collection of servers use them.
resource "powermax_storagegroup" "test" {

  # Attributes which are able to be modified after create (name, compression, host_io_limit, workload, slo, srp_id, volume_ids)

  # Required the name of the new storage group
  name = "terraform_sg"

  # Required The Srp to be associated with the Storage Group. If you dont want an SRP the srp_id can be set to 'None'
  srp_id = "SRP_1"

  # Optional the service level of the storage group
  slo = "Gold"

  # Optional enable or disable compression on the storage group (Default to disabled)
  compression = false

  # Optional the workload of the storage group
  workload = "workload"

  # Optional Set Host I/O limits for the specified storage sroup
  host_io_limit = {
    # The MBs per Second Host IO limit for the specified storage group, NOLIMIT means no limits
    host_io_limit_io_sec = "1000"
    # The IOs per Second Host IO limit for the specified storage group , NOLIMIT means no limits
    host_io_limit_mb_sec = "1000"
    # The dynamic distribution type which can be "Never","Always" or "OnFailure"
    dynamic_distribution = "Never"
  }

  # Optional a list of volume ids to be added to the storage groups
  volume_ids = ["0008F"]
}

# After the execution of above resource block, a PowerMax storage group has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Required

name (String) The name of the storage group. Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed. (Update Supported)
srp_id (String) The Srp to be associated with the Storage Group. If you dont want an SRP the srp_id can be set to ‘None’. (Update Supported)

Optional

compression (Boolean) States whether compression is enabled on storage group. (Update Supported)
host_io_limit (Object) Host IO limit of the storage group. (Update Supported) (see below for nested schema)
num_of_vols (Number) The number of volumes associated with the storage group
slo (String) The service level associated with the storage group. (Update Supported)
volume_ids (List of String) The IDs of the volume associated with the storage group. Only pre-existing volumes are considered here. (Update Supported)
workload (String) The workload associated with the storage group. (Update Supported)

Read-Only

cap_gb (Number) The capacity of the storage group
child_storage_group (List of String) The child storage group(s) associated with the storage group
compression_ratio (String) States whether compression is enabled on storage group
compression_ratio_to_one (Number) Compression ratio numeric value of the storage group
device_emulation (String) The emulation of the volumes in the storage group
id (String) The ID of the storage group
maskingview (List of String) The masking views associated with the storage group
num_of_child_sgs (Number) The number of child storage groups associated with the storage group
num_of_masking_views (Number) The number of masking views associated with the storage group
num_of_parent_sgs (Number) The number of parent storage groups associated with the storage group
num_of_snapshot_policies (Number) The number of snapshot policies associated with the storage group
num_of_snapshots (Number) The number of snapshots associated with the storage group
parent_storage_group (List of String) The parent storage group(s) associated with the storage group
service_level (String) The service level associated with the storage group
slo_compliance (String) The service level compliance status of the storage group
snapshot_policies (List of String) The snapshot policies associated with the storage group
tags (String) The tags associated with the storage group
type (String) The storage group type
unprotected (Boolean) States whether the storage group is protected
unreducible_data_gb (Number) The amount of unreducible data in Gb.
uuid (String) Storage Group UUID
vp_saved_percent (Number) VP saved percentage figure

Nested Schema for `host_io_limit`

Optional:

dynamic_distribution (String)
host_io_limit_io_sec (String)
host_io_limit_mb_sec (String)

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_storagegroup.test <id>
# Example:
terraform import powermax_storagegroup.test terraform_sg
# after running this command, populate the name field in the config file to start managing this resource

V1.0.4: powermax_volume resource

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

powermax_volume (Resource)

Resource for managing Volumes in PowerMax array. PowerMax volumes is an identifiable unit of data storage. Storage groups are sets of volumes.

Example Usage

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

# Available actions: Create, Update (vol_name, mobility_id_enabled, size, cap_unit), Delete and Import an existing volume from the PowerMax Array.
# After `terraform apply` of this example file it will create a new volume with the name set in `vol_name` attribute on the PowerMax

# PowerMax volumes is an identifiable unit of data storage. Storage groups are sets of volumes.
resource "powermax_volume" "test" {

  # Attributes which are able to be modified after create (vol_name, mobility_id_enabled, size, cap_unit)

  # Required name of the volume to be created
  vol_name = "terraform_volume"

  # Required size of the volume
  size = 2.45

  # Required name of the storage group which the volume will be created with
  sg_name = "terraform_sg"

  # Optional Default Unit is GB
  # Possible units are MB, GB, TB, and CYL
  cap_unit = "GB"

  # Optional enable the mobility id 
  mobility_id_enabled = false

}

# After the execution of above resource block, a PowerMax volume has been created at PowerMax array.
# For more information about the newly created resource use the `terraform show` command to review the current state

Schema

Required

sg_name (String) The name of the storage group. sg_name is required while creating the volume.
size (Number) The size of the volume. (Update Supported)
vol_name (String) The name of the volume. Only alphanumeric characters, underscores ( _ ). (Update Supported)

Optional

cap_unit (String) The Capacity Unit corresponding to the size. (Update Supported)
mobility_id_enabled (Boolean) States whether mobility ID is enabled on the volume. (Update Supported)

Read-Only

allocated_percent (Number) The allocated percentage of the volume.
effective_wwn (String) Effective WWN of the volume.
emulation (String) The emulation of the volume Enumeration values.
encapsulated (Boolean) States whether the volume is encapsulated.
encapsulated_wwn (String) Encapsulated WWN of the volume.
has_effective_wwn (Boolean) States whether volume has effective WWN.
id (String) The ID of the volume.
nguid (String) The NGUID of the volume.
num_of_front_end_paths (Number) The number of front end paths of the volume.
num_of_storage_groups (Number) The number of storage groups associated with the volume.
oracle_instance_name (String) Oracle instance name associated with the volume.
pinned (Boolean) States whether the volume is pinned.
rdf_group_ids (Attributes List) The RDF groups associated with the volume. (see below for nested schema)
reserved (Boolean) States whether the volume is reserved.
snapvx_source (Boolean) States whether the volume is a snapvx source.
snapvx_target (Boolean) States whether the volume is a snapvx target.
ssid (String) The ssid of the volume.
status (String) The status of the volume.
storage_groups (Attributes List) List of storage groups which are associated with the volume. (see below for nested schema)
symmetrix_port_key (Attributes List) The symmetrix ports associated with the volume. (see below for nested schema)
type (String) The type of the volume.
unreducible_data_gb (Number) The amount of unreducible data in Gb.
wwn (String) The WWN of the volume.

Nested Schema for `rdf_group_ids`

Read-Only:

label (String) The label of the rdf group.
rdf_group_number (Number) The number of rdf group.

Nested Schema for `storage_groups`

Read-Only:

parent_storage_group_name (String) The ID of the storage group parents.
storage_group_name (String) The ID of the storage group.

Nested Schema for `symmetrix_port_key`

Read-Only:

director_id (String) The ID of the director.
port_id (String) The ID of the symmetrix port.

Import

Import is supported using the following syntax:

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

# The command is
# terraform import powermax_volume.test <id>
# Example:
terraform import powermax_volume.test terraform_volume
# after running this command, populate the name field in the config file to start managing this resource

Dell Technologies – Resources

V1.0.4: powermax_host resource

powermax_host (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for host_flags

Nested Schema for host_flags.avoid_reset_broadcast

Nested Schema for host_flags.disable_q_reset_on_ua

Nested Schema for host_flags.environ_set

Nested Schema for host_flags.openvms

Nested Schema for host_flags.scsi_3

Nested Schema for host_flags.scsi_support1

Nested Schema for host_flags.spc2_protocol_version

Nested Schema for host_flags.volume_set_addressing

Import

V1.0.4: powermax_hostgroup resource

powermax_hostgroup (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for host_flags

Nested Schema for host_flags.avoid_reset_broadcast

Nested Schema for host_flags.disable_q_reset_on_ua

Nested Schema for host_flags.environ_set

Nested Schema for host_flags.openvms

Nested Schema for host_flags.scsi_3

Nested Schema for host_flags.scsi_support1

Nested Schema for host_flags.spc2_protocol_version

Nested Schema for host_flags.volume_set_addressing

Import

V1.0.4: powermax_maskingview resource

powermax_maskingview (Resource)

Example Usage

Schema

Required

Read-Only

Import

V1.0.4: powermax_portgroup resource

powermax_portgroup (Resource)

Example Usage

Schema

Required

Read-Only

Nested Schema for ports

Import

V1.0.4: powermax_snapshot resource

powermax_snapshot (Resource)

Example Usage

Schema

Optional

Read-Only

Nested Schema for linked_storage_group

Nested Schema for snapshot_actions

Nested Schema for snapshot_actions.link

Nested Schema for snapshot_actions.restore

Nested Schema for snapshot_actions.secure

Nested Schema for snapshot_actions.time_to_live

Nested Schema for storage_group

Nested Schema for source_volume

Import

V1.0.4: powermax_snapshotpolicy resource

powermax_snapshotpolicy (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Import

V1.0.4: powermax_storagegroup resource

powermax_storagegroup (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for `host_flags`

Nested Schema for `host_flags.avoid_reset_broadcast`

Nested Schema for `host_flags.disable_q_reset_on_ua`

Nested Schema for `host_flags.environ_set`

Nested Schema for `host_flags.openvms`

Nested Schema for `host_flags.scsi_3`

Nested Schema for `host_flags.scsi_support1`

Nested Schema for `host_flags.spc2_protocol_version`

Nested Schema for `host_flags.volume_set_addressing`

Nested Schema for `host_flags`

Nested Schema for `host_flags.avoid_reset_broadcast`

Nested Schema for `host_flags.disable_q_reset_on_ua`

Nested Schema for `host_flags.environ_set`

Nested Schema for `host_flags.openvms`

Nested Schema for `host_flags.scsi_3`

Nested Schema for `host_flags.scsi_support1`

Nested Schema for `host_flags.spc2_protocol_version`

Nested Schema for `host_flags.volume_set_addressing`

Nested Schema for `ports`

Nested Schema for `linked_storage_group`

Nested Schema for `snapshot_actions`

Nested Schema for `snapshot_actions.link`

Nested Schema for `snapshot_actions.restore`

Nested Schema for `snapshot_actions.secure`

Nested Schema for `snapshot_actions.time_to_live`

Nested Schema for `storage_group`

Nested Schema for `source_volume`

Nested Schema for `host_io_limit`

Nested Schema for `rdf_group_ids`

Nested Schema for `storage_groups`

Nested Schema for `symmetrix_port_key`