Dell Technologies – Data Sources

V1.0.4: powermax_host data source

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

powermax_host (Data Source)

Data source for reading Hosts 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.
*/

# This terraform DataSource is used to query the existing host from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.


# Returns all of the PowerMax hosts and their details
data "powermax_host" "HostDsAll" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "hostDsResultAll" {
  value = data.powermax_host.HostDsAll
}

# # Returns a subset of the PowerMax hosts based on the names provided in the `names` filter block and their details
# data "powermax_host" "HostDsFiltered" {
#   # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
#   # If unset defaults to 2 minute timeout
#   # timeouts = {
#   #   read = "3m"
#   # }
#   filter {
#     # Optional list of names to filter upon
#     names = [
#       "Host124",
#       "Host173",
#     ]
#   }
# }

# output "hostDsResult" {
#   value = data.powermax_host.HostDsFiltered
# }

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_host.example

Schema

Optional

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

Read-Only

hosts (Attributes List) List of host attributes (see below for nested schema)
id (String) Unique identifier of the host instance.

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `hosts`

Required:

host_flags (Attributes) Flags set for the host. When host_flags = {} then default flags will be considered. (see below for nested schema)
initiator (List of String) The initiators associated with the host.
name (String) The name of the host.

Optional:

consistent_lun (Boolean) It enables the rejection of any masking operation involving this host that would result in inconsistent LUN values.

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 `hosts.host_flags`

Optional:

avoid_reset_broadcast (Attributes) It enables a SCSI bus reset to only occur to the port that received the reset. (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. (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. (see below for nested schema)
openvms (Attributes) This attribute enables an Open VMS fibre connection. (see below for nested schema)
scsi_3 (Attributes) Alters the inquiry data to report that the storage system supports the SCSI-3 protocol. (see below for nested schema)
scsi_support1 (Attributes) This attribute provides a stricter compliance with SCSI standards. (see below for nested schema)
spc2_protocol_version (Attributes) When setting this flag, the port must be offline. (see below for nested schema)
volume_set_addressing (Attributes) It enables the volume set addressing mode. (see below for nested schema)

Nested Schema for `hosts.host_flags.avoid_reset_broadcast`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `hosts.host_flags.disable_q_reset_on_ua`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `hosts.host_flags.environ_set`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `hosts.host_flags.openvms`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `hosts.host_flags.scsi_3`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `hosts.host_flags.scsi_support1`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `hosts.host_flags.spc2_protocol_version`

Optional:

enabled (Boolean)
override (Boolean)

Nested Schema for `hosts.host_flags.volume_set_addressing`

Optional:

enabled (Boolean)
override (Boolean)

V1.0.4: powermax_hostgroup data source

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

powermax_hostgroup (Data Source)

Data source for reading HostGroups in 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.
*/

# This terraform DataSource is used to query the existing hostgroup from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# Returns all of the PowerMax host groups and their details
data "powermax_hostgroup" "all" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "all" {
  value = data.powermax_hostgroup.all
}

# Returns a subset of the PowerMax host groups based on the names provided in the `names` filter block and their details
# data "powermax_hostgroup" "groups" {
#   # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
#   # If unset defaults to 2 minute timeout
#   # timeouts = {
#   #   read = "3m"
#   # }
#   filter {
#     # Optional list of names to filter upon
#     names = ["host_group_example_1", "host_group_example_2"]
#   }
# }

# output "groups" {
#   value = data.powermax_hostgroup.groups
# }

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_hostgroup.example

Schema

Optional

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

Read-Only

host_group_details (Attributes List) List of Hostgroups (see below for nested schema)
id (String) Identifier

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `host_group_details`

Optional:

host (Attributes List) List of related host ids (see below for nested schema)
maskingview (List of String) List of masking views ids related to the host

Read-Only:

consistent_lun (Boolean) Consistent lun flag set
host_group_id (String) Id of a hostgroup
name (String) Name of a hostgroup
num_of_hosts (Number) Number of hosts related to a hostgroup
num_of_initiators (Number) Number of initiators related to a hostgroup
num_of_masking_views (Number) Number of masking views related to a hostgroup
port_flags_override (Boolean) Port flags are overwritten
type (String) The host group type

Nested Schema for `host_group_details.host`

Optional:

initiator (List of String) The host initators associated with the host

Read-Only:

host_id (String) The host id

V1.0.4: powermax_maskingview data source

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

powermax_maskingview (Data Source)

Data source for reading Masking Views 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.
*/

# This terraform DataSource is used to query the existing maskingview from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# Returns all of the PowerMax masking views and their details
data "powermax_maskingview" "allMaskingViews" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "allMaskingViewsResult" {
  value = data.powermax_maskingview.allMaskingViews.masking_views
}

# Returns a subset of the PowerMax masking views based on the names provided in the `names` filter block and their details
data "powermax_maskingview" "maskingViewFilter" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
  filter {
    # Optional list of names to filter upon
    names = ["terraform_mv_1", "terraform_mv_2"]
  }
}

output "maskingViewFilterResult" {
  value = data.powermax_maskingview.maskingViewFilter.masking_views
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_maskingview.example

Schema

Optional

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

Read-Only

id (String) Unique identifier of the masking view instance.
masking_views (Attributes List) List of masking views. (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `masking_views`

Read-Only:

capacity_gb (Number) The capacity of the storage group in the masking view.
host_group_id (String) The host group id of the masking view.
host_id (String) The host id of the masking view.
initiators (List of String) List of initiators.
masking_view_name (String) Unique identifier of the masking view.
port_group_id (String) The port group id of the masking view.
ports (List of String) List of ports.
storage_group_id (String) The storage group id of the masking view.
volumes (List of String) List of Volumes.

V1.0.4: powermax_port data source

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

powermax_port (Data Source)

Data source for reading ports in PowerMax array. A port typically refers to the interface that allows for connections between the PowerMax system and other devices.

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

# This terraform DataSource is used to query the existing port from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# Returns all of the PowerMax ports and their details
data "powermax_port" "all" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "all" {
  value = data.powermax_port.all
}

# Returns a subset of the PowerMax ports based on the names provided in the `names` filter block and their details
# data "powermax_port" "portFilter" {
#   # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
#   # If unset defaults to 2 minute timeout
#   # timeouts = {
#   #   read = "3m"
#   # }
#   # Optional list of names to filter upon
#   filter {
#     # Should be in the format ["directorId:portId"]
#     port_ids = ["OR-1C:2"]
#   }
# }

# output "portFilter" {
#   value = data.powermax_port.portFilter
# }

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_port.example

Schema

Optional

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

Read-Only

id (String) Identifier
port_details (Attributes List) List of Ports (see below for nested schema)

Nested Schema for `filter`

Optional:

port_ids (Set of String) A set of port ids to filter on, should be look like the following [‘directorId:portId’]

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `port_details`

Read-Only:

aclx (Boolean) Has aclx
avoid_reset_broadcast (Boolean) Avoid reset brodcast
capable_protocol (List of String) Capable Protocol
common_serial_number (Boolean) Common Serial Number
director_id (String) Id of the director
director_status (String) Director Status
disable_q_reset_on_ua (Boolean) Disable Q reset on ua
enable_auto_negotiate (Boolean) Enable Auto Negotiate
enabled_protocol (List of String) Enabled Protocol
environ_set (Boolean) Environ Set
hp_3000_mode (Boolean) HP 3000 mode
identifier (String) Port identifier
init_point_to_point (Boolean) Init point to point
ip_addresses (List of String) Ip Addresses
ipv4_address (String) Ipv4 Address
ipv4_default_gateway (String) Ipv4 Default Gateway
ipv4_domain_name (String) Ipv4 Domain Name
ipv4_netmask (String) Ipv4 Netmask
ipv6_address (String) Ipv6 Address
ipv6_prefix (String) Ipv6 Prefix
iscsi_endpoint (Boolean) iScsi Endpoint
iscsi_target (Boolean) iScsi Target
mac_address (String) Mac Address
maskingview (List of String) Masking Views
max_speed (String) Max Speed
negotiate_reset (Boolean) Negotiate reset
negotiated_speed (String) Negotiated speed
network_id (Number) Network Id
no_participating (Boolean) No Participating
num_of_cores (Number) Total number of cors
num_of_hypers (Number) TX Power Level MW
num_of_mapped_vols (Number) Total number of volumes
num_of_masking_views (Number) Total number of masking views
num_of_port_groups (Number) Total number of port groups
nvmetcp_endpoint (Boolean) NVME over TCP Endpoint
port_id (String) Id of the port
port_interface (String) Port Interface
port_status (String) Port Status
portgroup (List of String) Portgroup
power_levels_last_sampled_date_milliseconds (Number) Power Levels Last Sampled Date in Milliseconds
prevent_automatic_rdf_link_recovery (String) Prevent automatic rdf link recovery
prevent_ra_online_on_power_up (String) Prevent RA Online on Power Up
rdf_hardware_compression (String) RDF Hardware Compression
rdf_hardware_compression_supported (String) RDF Hardware Compression Supported
rdf_ra_group_attributes_farpoint (Boolean) RDF RA group attributes farpoint
rdf_software_compression (String) RDF Software Compression
rdf_software_compression_supported (String) RDF Software Compression Suppored
rx_power_level_mw (Number) RX Power Level MW
scsi_3 (Boolean) SCSI 3
scsi_support1 (Boolean) SCSI support 1
siemens (Boolean) Siemens
soft_reset (Boolean) Soft reset
spc2_protocol_version (Boolean) SPC2 Protocol Version
sunapee (Boolean) Sunapee
tcp_port (Number) TPC Port
tx_power_level_mw (Number) TX Power Level MW
type (String) Port Type
unique_wwn (Boolean) Unique WWN
vcm_state (String) VMC State
vnx_attached (Boolean) VNX Attached
volume_set_addressing (Boolean) Volume Set Addressing
wwn_node (String) WWN Node
z_hyperlink_port (Boolean) Z Hyperlink Port

V1.0.4: powermax_portgroups data source

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

powermax_portgroups (Data Source)

Data source for reading 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.
*/

# This terraform DataSource is used to query the existing port group from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# List fibre portgroups.
data "powermax_portgroups" "fibreportgroups" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
  # Optional filter to list specified Portgroups names and/or type
  filter {
    # type for which portgroups to be listed  - fibre or iscsi
    type = "fibre"
    # Optional list of IDs to filter
    names = [
      "tfacc_test1_fibre",
      #"test2_fibre",
    ]
  }
}

data "powermax_portgroups" "scsiportgroups" {
  filter {
    type = "iscsi"
    # Optional filter to list specified Portgroups Names
  }
}

# List all portgroups.
data "powermax_portgroups" "allportgroups" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }

  #filter {
  # Optional list of IDs to filter
  #names = [
  #  "test1",
  #  "test2",
  #]
  #}
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_portgroups.example

Schema

Optional

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

Read-Only

id (String) Identifier
port_groups (Attributes List) List of port group attributes (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String)
type (String) The Type of the portgroup.

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `port_groups`

Required:

name (String) The name of the portgroup.
ports (Attributes List) The list of ports associated with the portgroup. (see below for nested schema)
protocol (String) The portgroup protocol.
type (String) The Type of the portgroup.

Read-Only:

id (String) Identifier
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.

Nested Schema for `port_groups.ports`

Required:

director_id (String)
port_id (String)

V1.0.4: powermax_snapshot data source

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

powermax_snapshot (Data Source)

Data source for a specific StorageGroup 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.
*/

# This terraform DataSource is used to query the existing snapshot from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# Returns all of the PowerMax snapshots related to a particular storage group and their details
data "powermax_snapshot" "test" {
  # The storage group name to which display all of its snapshots
  # Required
  storage_group {
    name = "example_storage_group"
  }

  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "powermax_snapshot" {
  value = data.powermax_snapshot.test
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_snapshot.example

Schema

Optional

storage_group (Block, Optional) (see below for nested schema)
timeouts (Attributes) (see below for nested schema)

Read-Only

id (String) Identifier
snapshots (Attributes List) List of Snapshots (see below for nested schema)

Nested Schema for `storage_group`

Required:

name (String)

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `snapshots`

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
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
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 `snapshots.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 `snapshots.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

V1.0.4: powermax_snapshotpolicy data source

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

powermax_snapshotpolicy (Data Source)

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

# This terraform DataSource is used to query the existing snapshot_policy from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# Returns all of the PowerMax snapshot policies and their details
data "powermax_snapshotpolicy" "SnapshotPolicyAll" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "SnapshotPolicyAll" {
  value = data.powermax_snapshotpolicy.SnapshotPolicyAll
}

# Returns a subset of the PowerMax snapshot policies based on the names provided in the `names` filter block and their details
data "powermax_snapshotpolicy" "SnapshotPolicyFiltered" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
  filter {
    # Optional list of names to filter upon
    names = [
      "tfacc_snapshotPolicy1",
    ]
  }
}

output "SnapshotPolicyFiltered" {
  value = data.powermax_snapshotpolicy.SnapshotPolicyFiltered
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_snapshotpolicy.example

Schema

Optional

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

Read-Only

id (String) Identifier
snapshot_policies (Attributes List) List of Snapshot Policies (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `snapshot_policies`

Read-Only:

compliance_count_critical (Number) The threshold of good snapshots which are not failed/bad for compliance to change from warning to critical
compliance_count_warning (Number) The threshold of good snapshots which are not failed/bad for compliance to change from normal to warning.
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
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
snapshot_count (Number) Number of snapshots that will be taken before the oldest ones are no longer required
snapshot_policy_name (String) Name of the snapshot policy
storage_group_count (Number) The total number of storage groups that this snapshot policy is associated with
suspended (Boolean) Set if the snapshot policy has been suspended
type (String) The type of Snapshots that are created with the policy, local or cloud

V1.0.4: powermax_storagegroup data source

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

powermax_storagegroup (Data Source)

Data Source for reading 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.
*/

# This terraform DataSource is used to query the existing storagegroup from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# Returns all of the PowerMax storage groups and their details
data "powermax_storagegroup" "testall" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "storagegroup_data_all" {
  value = data.powermax_storagegroup.testall
}

# Returns a subset of the PowerMax storage groups based on the names provided in the `names` filter block and their details
data "powermax_storagegroup" "test" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }

  # Optional list of names to filter upon
  filter {
    names = ["example_sg"]
  }
}

output "storagegroup_data" {
  value = data.powermax_storagegroup.test
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_storagegroup.example

Schema

Optional

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

Read-Only

id (String) Placeholder value to run tests
storage_groups (Attributes List) List of storage group attributes (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `storage_groups`

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 (Boolean) States whether compression is enabled on 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
host_io_limit (Object) Host IO limit of the storage group (see below for nested schema)
id (String) The ID of the storage group
maskingview (List of String) The masking views associated with the storage group
name (String) The name of 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
num_of_vols (Number) The number of volumes 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 (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
srp_id (String) The SRP to be associated with the Storage Group. An existing SRP or ’none’ must be specified
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
volume_ids (List of String) The IDs of the volume associated with the storage group.
vp_saved_percent (Number) VP saved percentage figure
workload (String) The workload associated with the storage group

Nested Schema for `storage_groups.host_io_limit`

Read-Only:

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

V1.0.4: powermax_volume data source

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

powermax_volume (Data Source)

Data source for reading 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.
*/

# This terraform DataSource is used to query the existing volume from PowerMax array.
# The information fetched from this data source can be used for getting the details / for further processing in resource block.

# Returns all of the PowerMax volumes and their details
# NOTE: PowerMax can have many volumes, running this command unfiltered can take several minutes
data "powermax_volume" "volume_datasource_all" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
}

output "volume_datasource_output" {
  value = data.powermax_volume.volume_datasource_all
}

# Returns a subset of the PowerMax volumes based on the filtered properties in the block
# All filter values are optional
# If you use more then one filter at a time, it will only show the subset of volumes which both of those filters satisfies 
data "powermax_volume" "volume_datasource_test" {
  # Optional Update the read timeout with (XXm) for minutes or (XXs) for timeout in seconds
  # If unset defaults to 2 minute timeout
  # timeouts = {
  #   read = "3m"
  # }
  filter {

    # Optional Volume ids from a single Storage Group only
    storage_group_name = "terraform_vol_sg"

    # Optional Volume ids that contain the specified volume wwn
    wwn = "wwn_num"

    # Optiona lVolume ids that contain the specified volume encapsulated_wwn
    encapsulated_wwn = "encapsulated_wwn_num"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified symmlun
    symmlun = "0"

    # Optional Volume ids that contain the specified volume status
    status = "Ready"

    # Optional Volume ids that contain the specified volume physical_name
    physical_name = "physical_name"

    # Optional Volume ids that contain the specified volume volume_identifier
    volume_identifier = "test_acc_create_volume"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified cap_tb
    cap_tb = "0"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified cap_gb
    cap_gb = "0"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified cap_mb
    cap_mb = "0"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified cap_cyl
    cap_cyl = "0"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified allocated_percent
    allocated_percent = "0"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified num_of_storage_groups
    num_of_storage_groups = "1"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified num_of_masking_views
    num_of_masking_views = "0"

    # Optional Volume ids that contain greater than(">1"), Less than("<1") or equal to the specified num_of_front_end_paths
    num_of_front_end_paths = "0"

    # Optional Volume ids that are mobility ID enabled (true/false)
    mobility_id_enabled = false

    # Optional Volume ids that are virtual_volumes (true/false)
    virtual_volumes = true

    # Optional Volume ids that are private_volumes (true/false)
    private_volumes = false

    # Optional Volume ids that are tdev (true/false)
    tdev = true

    # Optional Volume ids that are vdev (true/false)
    vdev = false

    # Optional Volume ids that are available_thin_volumes (true/false)
    available_thin_volumes = false

    # Optional Volume ids that are gatekeeper (true/false)
    gatekeeper = false

    # Optional Volume ids that are data_volume (true/false)
    data_volume = false

    # Optional Volume ids that are dld (true/false)
    dld = false

    # Optional Volume ids that are drv (true/false)
    drv = false

    # Optional Volume ids that are encapsulated (true/false)
    encapsulated = false

    # Optional Volume ids that are associated (true/false)
    associated = false

    # Optional Volume ids that are reserved (true/false)
    reserved = false

    # Optional	Volume ids that are pinned (true/false)
    pinned = false

    # Optional Volume ids that are mapped (true/false)
    mapped = false

    # Optional Volume ids that are bound_tdev (true/false)
    bound_tdev = true

    # Optional Volume ids that are of the specified emulation
    emulation = "FBA"

    # Optional Volume ids that are of the specified emulation.
    has_effective_wwn = false

    # Optional Volume ids that contain the specified effective_wwn
    effective_wwn = "effective_wwn"

    # Optional Volume ids that are mapped to CU images associated to the specified FICON split
    split_name = "split_name"

    # Optional Volume ids that contain the specified volume type
    type = "TDEV"

    # Optional Volume ids that contain greater than("unreducible_data_gb=>1"),Less than("unreducible_data_gb=<1") or equal to the unreducible_data_gb
    unreducible_data_gb = "0"

    # Optional Volume ids that are mapped to a CU image with the specified CU image number
    cu_image_num = "0"

    # Optional Volume ids that are mapped to a CU image with the specified CU SSID
    cu_image_ssid = "cu_image_ssid"

    # Optional Volume ids that are part of the specified rdf group
    rdf_group_number = "0"

    # Optional Volume ids that contain the specified Oracle Instance Name
    oracle_instance_name = "oracle_instance_name"

    # Optional Volumes Ids that correspond to Namespace Globally Unique Identifier that uses the EUI64 16-byte designator format. Used in conjunction with NVMe volumes
    nguid = "nguid"
  }
}

output "volume_datasource_output" {
  value = data.powermax_volume.volume_datasource_test
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powermax_volume.example

Schema

Optional

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

Read-Only

id (String) Placeholder for acc testing
volumes (Attributes List) List of volumes. (see below for nested schema)

Nested Schema for `filter`

Optional:

allocated_percent (String) Greater than, Less than or equal to the allocated percent.
associated (Boolean) Volumes that are associated (true/false).
available_thin_volumes (Boolean) Volumes that are available thin volumes (true/false).
bound_tdev (Boolean) Volumes that are bound tdev (true/false).
cap_cyl (String) Greater than, Less than or equal to the cap CYL.
cap_gb (String) Greater than, Less than or equal to the cap gb.
cap_mb (String) Greater than, Less than or equal to the cap mb.
cap_tb (String) Greater than, Less than or equal to the cap tb.
cu_image_num (String) Volumes that are mapped to a CU image with the specified CU image number.
cu_image_ssid (String) Volumes that are mapped to a CU image with the specified CU SSID.
data_volume (Boolean) Volumes that are data volume (true/false).
dld (Boolean) Volumes that are dld (true/false).
drv (Boolean) Volumes that are drv (true/false).
effective_wwn (String) Volumes that contain the specified effective_wwn.
emulation (String) Volumes that are of the specified emulation.
encapsulated (Boolean) Volumes that are encapsulated (true/false).
encapsulated_wwn (String) The specified volume encapsulated_wwn.
gatekeeper (Boolean) Volumes that are gatekeeper (true/false).
has_effective_wwn (Boolean) Volumes that have effective wwns (true/false)
mapped (Boolean) Volumes that are mapped (true/false).
mobility_id_enabled (Boolean) Volumes that are mobility ID enabled (true/false).
nguid (String) Volumes that correspond to Namespace Globally Unique Identifier that uses the EUI64 16-byte designator format.
num_of_front_end_paths (String) Greater than, Less than or equal to the number of front end paths.
num_of_masking_views (String) Greater than, Less than or equal to the number of masking views.
num_of_storage_groups (String) Greater than, Less than or equal to the number of storage groups.
oracle_instance_name (String) Volumes that contain the specified Oracle Instance Name.
physical_name (String) The specified volume physical name.
pinned (Boolean) Volumes that are pinned (true/false).
private_volumes (Boolean) Volumes that are private (true/false).
rdf_group_number (String) Volumes that are part of the specified rdf group.
reserved (Boolean) Volumes that are reserved (true/false).
split_name (String) Volumes that are mapped to CU images associated to the specified FICON split.
status (String) The specified volume status.
storage_group_name (String) The name of the storage group.
symmlun (String) Greater than, Less than or equal to the specified symmlun.
tdev (Boolean) Volumes that are tdev (true/false).
thin_bcv (Boolean) Volumes that are thin bcv (true/false).
type (String) Volumes that contain the specified volume type.
unreducible_data_gb (String) Greater than,Less than or equal to the unreducible data gb.
vdev (Boolean) Volumes that are vdev (true/false).
virtual_volumes (Boolean) Volumes that are virtual volumes (true/false).
volume_identifier (String) The specified volume volume identifier.
wwn (String) The specified volume wwn.

Nested Schema for `timeouts`

Optional:

read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Nested Schema for `volumes`

Optional:

mobility_id_enabled (Boolean) States whether mobility ID is enabled on the volume.
volume_identifier (String) The identifier of the volume.

Read-Only:

allocated_percent (Number) The allocated percentage of the volume.
cap_cyl (Number) The capability of volume in the unit of CYL.
cap_gb (Number) The capability of volume in the unit of GB.
cap_mb (Number) The capability of volume in the unit of MB.
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.
physical_name (String) The physical name of 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 `volumes.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 `volumes.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 `volumes.symmetrix_port_key`

Read-Only:

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

Dell Technologies – Data Sources

V1.0.4: powermax_host data source

powermax_host (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for timeouts

Nested Schema for hosts

Nested Schema for hosts.host_flags

Nested Schema for hosts.host_flags.avoid_reset_broadcast

Nested Schema for hosts.host_flags.disable_q_reset_on_ua

Nested Schema for hosts.host_flags.environ_set

Nested Schema for hosts.host_flags.openvms

Nested Schema for hosts.host_flags.scsi_3

Nested Schema for hosts.host_flags.scsi_support1

Nested Schema for hosts.host_flags.spc2_protocol_version

Nested Schema for hosts.host_flags.volume_set_addressing

V1.0.4: powermax_hostgroup data source

powermax_hostgroup (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for timeouts

Nested Schema for host_group_details

Nested Schema for host_group_details.host

V1.0.4: powermax_maskingview data source

powermax_maskingview (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for timeouts

Nested Schema for masking_views

V1.0.4: powermax_port data source

powermax_port (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for timeouts

Nested Schema for port_details

V1.0.4: powermax_portgroups data source

powermax_portgroups (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for timeouts

Nested Schema for port_groups

Nested Schema for port_groups.ports

V1.0.4: powermax_snapshot data source

powermax_snapshot (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for storage_group

Nested Schema for timeouts

Nested Schema for snapshots

Nested Schema for snapshots.linked_storage_group

Nested Schema for snapshots.source_volume

V1.0.4: powermax_snapshotpolicy data source

powermax_snapshotpolicy (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for timeouts

Nested Schema for snapshot_policies

V1.0.4: powermax_storagegroup data source

powermax_storagegroup (Data Source)

Example Usage

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `hosts`

Nested Schema for `hosts.host_flags`

Nested Schema for `hosts.host_flags.avoid_reset_broadcast`

Nested Schema for `hosts.host_flags.disable_q_reset_on_ua`

Nested Schema for `hosts.host_flags.environ_set`

Nested Schema for `hosts.host_flags.openvms`

Nested Schema for `hosts.host_flags.scsi_3`

Nested Schema for `hosts.host_flags.scsi_support1`

Nested Schema for `hosts.host_flags.spc2_protocol_version`

Nested Schema for `hosts.host_flags.volume_set_addressing`

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `host_group_details`

Nested Schema for `host_group_details.host`

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `masking_views`

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `port_details`

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `port_groups`

Nested Schema for `port_groups.ports`

Nested Schema for `storage_group`

Nested Schema for `timeouts`

Nested Schema for `snapshots`

Nested Schema for `snapshots.linked_storage_group`

Nested Schema for `snapshots.source_volume`

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `snapshot_policies`

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `storage_groups`

Nested Schema for `storage_groups.host_io_limit`

Nested Schema for `filter`

Nested Schema for `timeouts`

Nested Schema for `volumes`

Nested Schema for `volumes.rdf_group_ids`

Nested Schema for `volumes.storage_groups`

Nested Schema for `volumes.symmetrix_port_key`