Dell Technologies – Data Sources

V1.8.1: powerscale_accesszone data source

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

powerscale_accesszone (Data Source)

Access Zone Datasource. This datasource is used to query the existing Access Zone from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale Access Zones allow you to isolate data and control who can access data in each zone.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns all of the PowerScale access zones and their details
# PowerScale access zones allow you to isolate data and control who can access data in each zone.
data "powerscale_accesszone" "all" {
}

output "powerscale_accesszone_data_all" {
  value = data.powerscale_accesszone.all
}

# Returns a subset of the PowerScale access zones based on the names provided in the `names` filter block and their details
data "powerscale_accesszone" "test" {
  # Optional list of names to filter upon
  filter {
    names = ["tfaccAccessZone"]
  }
}

output "powerscale_accesszone" {
  value = data.powerscale_accesszone.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.powerscale_accesszone.all

Schema

Optional

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

Read-Only

access_zones_details (Attributes List) List of AccessZones (see below for nested schema)
id (String) Identifier

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `access_zones_details`

Read-Only:

alternate_system_provider (String) Specifies an alternate system provider.
auth_providers (List of String) Specifies the list of authentication providers available on this access zone.
cache_entry_expiry (Number) Specifies amount of time in seconds to cache a user/group.
create_path (Boolean) Determines if a path is created when a path does not exist.
groupnet (String) Groupnet identifier
home_directory_umask (Number) Specifies the permissions set on automatically created user home directories.
id (String) Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method
ifs_restricted (Attributes List) Specifies a list of users and groups that have read and write access to /ifs. (see below for nested schema)
map_untrusted (String) Maps untrusted domains to this NetBIOS domain during authentication.
name (String) Specifies the access zone name.
negative_cache_entry_expiry (Number) Specifies number of seconds the negative cache entry is valid.
netbios_name (String) Specifies the NetBIOS name.
path (String) Specifies the access zone base directory path.
skeleton_directory (String) Specifies the skeleton directory that is used for user home directories.
system (Boolean) True if the access zone is built-in.
system_provider (String) Specifies the system provider for the access zone.
user_mapping_rules (List of String) Specifies the current ID mapping rules.
zone_id (Number) Specifies the access zone ID on the system.

Nested Schema for `access_zones_details.ifs_restricted`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

V1.8.1: powerscale_aclsettings data source

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

powerscale_aclsettings (Data Source)

This datasource is used to query the ACL Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can use ACL Settings to manage file and directory permissions, referred to as access rights.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of the ACL settings from PowerScale array.

# Returns the PowerScale ACL settings on PowerScale array
data "powerscale_aclsettings" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_aclsettings.all
output "powerscale_aclsettings_data_all" {
  value = data.powerscale_aclsettings.all
}

Schema

Read-Only

access (String) Access checks (chmod, chown). Options: unix, windows
calcmode (String) Displayed mode bits. Options: approx, 777
calcmode_group (String) Approximate group mode bits when ACL exists. Options: group_aces, group_only
calcmode_owner (String) Approximate owner mode bits when ACL exists. Options: owner_aces, owner_only
calcmode_traverse (String) Require traverse rights in order to traverse directories with existing ACLs. Options: require, ignore
chmod (String) chmod on files with existing ACLs. Options: remove, replace, replace_users_and_groups, merge_with_ugo_priority, merge, deny, ignore
chmod_007 (String) chmod (007) on files with existing ACLs. Options: default, remove
chmod_inheritable (String) ACLs created on directories by UNIX chmod. Options: yes, no
chown (String) chown/chgrp on files with existing ACLs. Options: owner_group_and_acl, owner_group_only, ignore
create_over_smb (String) ACL creation over SMB. Options: allow, disallow
dos_attr (String) Read only DOS attribute. Options: deny_smb, deny_smb_and_nfs
group_owner_inheritance (String) Group owner inheritance. Options: native, parent, creator
rwx (String) Treatment of ‘rwx’ permissions. Options: retain, full_control
synthetic_denies (String) Synthetic ‘deny’ ACEs. Options: none, remove
utimes (String) Access check (utimes). Options: only_owner, owner_and_write

V1.8.1: powerscale_adsprovider data source

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

powerscale_adsprovider (Data Source)

This datasource is used to query the existing ADS providers from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. Joining your cluster to an AD domain allows you to perform user and group authentication.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing ADS providers from PowerScale array.

# Returns a list of PowerScale ADS providers based on names and scope specified in the filter block.
data "powerscale_adsprovider" "test" {
  filter {
    names = ["PIE.LAB.EMC.COM"]
    scope = "effective"
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_adsprovider.test
output "powerscale_adsprovider" {
  value = data.powerscale_adsprovider.test
}

# Returns all PowerScale ADS providers on PowerScale array
data "powerscale_adsprovider" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_adsprovider.all
output "powerscale_adsprovider_data_all" {
  value = data.powerscale_adsprovider.all
}

Schema

Optional

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

Read-Only

ads_providers_details (Attributes List) List of AdsProviders. (see below for nested schema)
id (String) Unique identifier of the ads provider instance.

Nested Schema for `filter`

Optional:

names (Set of String) Filter ads providers by names.
scope (String) Filter ads providers by scope.

Nested Schema for `ads_providers_details`

Read-Only:

allocate_gids (Boolean) Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one.
allocate_uids (Boolean) Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.
assume_default_domain (Boolean) Enables lookup of unqualified user names in the primary domain.
authentication (Boolean) Enables authentication and identity management through the authentication provider.
check_online_interval (Number) Specifies the time in seconds between provider online checks.
controller_time (Number) Specifies the current time for the domain controllers.
create_home_directory (Boolean) Automatically creates a home directory on the first login.
domain_offline_alerts (Boolean) Sends an alert if the domain goes offline.
dup_spns (List of String) Get duplicate SPNs in the provider domain.
extra_expected_spns (List of String) List of additional SPNs to expect beyond what automatic checking routines might find.
findable_groups (List of String) Sets list of groups that can be resolved.
findable_users (List of String) Sets list of users that can be resolved.
forest (String) Specifies the Active Directory forest.
groupnet (String) Groupnet identifier.
home_directory_template (String) Specifies the path to the home directory template.
hostname (String) Specifies the fully qualified hostname stored in the machine account.
id (String) Specifies the ID of the Active Directory provider instance.
ignore_all_trusts (Boolean) If set to true, ignores all trusted domains.
ignored_trusted_domains (List of String) Includes trusted domains when ‘ignore_all_trusts’ is set to false.
include_trusted_domains (List of String) Includes trusted domains when ‘ignore_all_trusts’ is set to true.
instance (String) Specifies Active Directory provider instance.
ldap_sign_and_seal (Boolean) Enables encryption and signing on LDAP requests.
login_shell (String) Specifies the login shell path.
lookup_domains (List of String) Limits user and group lookups to the specified domains.
lookup_groups (Boolean) Looks up AD groups in other providers before allocating a group ID.
lookup_normalize_groups (Boolean) Normalizes AD group names to lowercase before look up.
lookup_normalize_users (Boolean) Normalize AD user names to lowercase before look up.
lookup_users (Boolean) Looks up AD users in other providers before allocating a user ID.
machine_account (String) Specifies the machine account name when creating a SAM account with Active Directory.
machine_password_changes (Boolean) Enables periodic changes of the machine password for security.
machine_password_lifespan (Number) Sets maximum age of a password in seconds.
name (String) Specifies the Active Directory provider name.
netbios_domain (String) Specifies the NetBIOS domain name associated with the machine account.
node_dc_affinity (String) Specifies the domain controller for which the node has affinity.
node_dc_affinity_timeout (Number) Specifies the timeout for the domain controller for which the local node has affinity.
nss_enumeration (Boolean) Enables the Active Directory provider to respond to ‘getpwent’ and ‘getgrent’ requests.
primary_domain (String) Specifies the AD domain to which the provider is joined.
restrict_findable (Boolean) Check the provider for filtered lists of findable and unfindable users and groups.
rpc_call_timeout (Number) The maximum amount of time (in seconds) an RPC call to Active Directory is allowed to take.
server_retry_limit (Number) The number of retries attempted when a call to Active Directory fails due to network error.
sfu_support (String) Specifies whether to support RFC 2307 attributes on ADS domain controllers.
site (String) Specifies the site for the Active Directory.
status (String) Specifies the status of the provider.
store_sfu_mappings (Boolean) Stores SFU mappings permanently in the ID mapper.
system (Boolean) If set to true, indicates that this provider instance was created by OneFS and cannot be removed.
unfindable_groups (List of String) Specifies groups that cannot be resolved by the provider.
unfindable_users (List of String) Specifies users that cannot be resolved by the provider.
zone_name (String) Specifies the name of the access zone in which this provider was created.

V1.8.1: powerscale_cluster data source

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

powerscale_cluster (Data Source)

This datasource is used to query the existing cluster from PowerScale array. The information fetched from this data source can be used for getting the details, including config, identity, nodes, internal_networks and acs.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
data "powerscale_cluster" "test" {
}

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

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

Schema

Read-Only

acs (Attributes) Cluster ACS status. (see below for nested schema)
config (Attributes) The configuration information of cluster. (see below for nested schema)
id (String) Unique identifier of the cluster.
identity (Attributes) Unprivileged cluster information for display when logging in. (see below for nested schema)
internal_networks (Attributes) Configuration fields for internal networks. (see below for nested schema)
nodes (Attributes) Cluster node information (see below for nested schema)

Nested Schema for `acs`

Read-Only:

failed_nodes_sn (List of String) list of failed nodes serial number.
joined_nodes (Number) the number of joined nodes.
license_status (String) the status of license activation.
srs_status (String) the status of SRS enablement.
total_nodes (Number) total nodes number of the cluster.
unresponsive_sn (List of String) list of unresponsive nodes serial number.

Nested Schema for `config`

Read-Only:

description (String) Customer configurable description.
devices (Attributes List) device (see below for nested schema)
guid (String) Cluster GUID.
join_mode (String) Node join mode: ‘manual’ or ‘secure’.
local_devid (Number) Device ID of the queried node.
local_lnn (Number) Device logical node number of the queried node.
local_serial (String) Device serial number of the queried node.
name (String) Cluster name.
onefs_version (Attributes) version (see below for nested schema)
timezone (Attributes) version (see below for nested schema)

Nested Schema for `config.devices`

Read-Only:

devid (Number) Device ID.
guid (String) Device GUID.
is_up (Boolean) If true, this node is online and communicating with the local node and every other node with the is_up property normally
lnn (Number) Device logical node number.

Nested Schema for `config.onefs_version`

Read-Only:

build (String) OneFS build string.
release (String) Kernel release number.
revision (String) OneFS build number.
type (String) Kernel release type.
version (String) Kernel full version information.

Nested Schema for `config.timezone`

Read-Only:

abbreviation (String) Timezone abbreviation.
custom (String) Customer timezone information.
name (String) Timezone full name.
path (String) Timezone hierarchical name.

Nested Schema for `identity`

Read-Only:

description (String) A description of the cluster.
logon (Attributes) // (see below for nested schema)
name (String) The name of the cluster.

Nested Schema for `identity.logon`

Read-Only:

motd (String) The message of the day.
motd_header (String) The header to the message of the day.

Nested Schema for `internal_networks`

Read-Only:

failover_ip_addresses (Attributes List) Array of IP address ranges to be used to configure the internal failover network of the OneFS cluster. (see below for nested schema)
failover_status (String) Status of failover network.
int_a_fabric (String) Network fabric used for the primary network int-a.
int_a_ip_addresses (Attributes List) Array of IP address ranges to be used to configure the internal int-a network of the OneFS cluster. (see below for nested schema)
int_a_mtu (Number) Maximum Transfer Unit (MTU) of the primary network int-a.
int_a_prefix_length (Number) Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.
int_a_status (String) Status of the primary network int-a.
int_b_fabric (String) Network fabric used for the failover network.
int_b_ip_addresses (Attributes List) Array of IP address ranges to be used to configure the internal int-b network of the OneFS cluster. (see below for nested schema)
int_b_mtu (Number) Maximum Transfer Unit (MTU) of the failover network int-b.
int_b_prefix_length (Number) Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.

Nested Schema for `internal_networks.failover_ip_addresses`

Read-Only:

high (String) IPv4 address in the format: xxx.xxx.xxx.xxx
low (String) IPv4 address in the format: xxx.xxx.xxx.xxx

Nested Schema for `internal_networks.int_a_ip_addresses`

Read-Only:

high (String) IPv4 address in the format: xxx.xxx.xxx.xxx
low (String) IPv4 address in the format: xxx.xxx.xxx.xxx

Nested Schema for `internal_networks.int_b_ip_addresses`

Read-Only:

high (String) IPv4 address in the format: xxx.xxx.xxx.xxx
low (String) IPv4 address in the format: xxx.xxx.xxx.xxx

Nested Schema for `nodes`

Read-Only:

errors (Attributes List) A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors. (see below for nested schema)
nodes (Attributes List) The responses from the individual nodes involved in this request. (see below for nested schema)
total (Number) The total number of nodes responding.

Nested Schema for `nodes.errors`

Read-Only:

code (String) The error code.
field (String) The field with the error if applicable.
id (Number) Node ID (Device Number) of a node.
lnn (Number) Logical Node Number (LNN) of a node.
message (String) The error message.
status (Number) HTTP Status code returned by this node.

Nested Schema for `nodes.nodes`

Read-Only:

drives (Attributes List) List of the drives in this node. (see below for nested schema)
error (String) Error message, if the HTTP status returned from this node was not 200.
hardware (Attributes) // (see below for nested schema)
id (Number) Node ID (Device Number) of a node.
lnn (Number) Logical Node Number (LNN) of a node.
partitions (Attributes) // (see below for nested schema)
sensors (Attributes) // (see below for nested schema)
state (Attributes) // (see below for nested schema)
status (Attributes) // (see below for nested schema)

Nested Schema for `nodes.nodes.drives`

Read-Only:

baynum (Number) Numerical representation of this drive’s bay.
blocks (Number) Number of blocks on this drive.
chassis (Number) The chassis number which contains this drive.
devname (String) This drive’s device name.
firmware (Attributes) Drive firmware information (see below for nested schema)
handle (Number) Drive_d’s handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1
interface_type (String) String representation of this drive’s interface type.
lnum (Number) This drive’s logical drive number in IFS.
locnstr (String) String representation of this drive’s physical location.
logical_block_length (Number) Size of a logical block on this drive.
media_type (String) String representation of this drive’s media type.
model (String) This drive’s manufacturer and model.
physical_block_length (Number) Size of a physical block on this drive.
present (Boolean) Indicates whether this drive is physically present in the node.
purpose (String) This drive’s purpose in the DRV state machine.
purpose_description (String) Description of this drive’s purpose.
serial (String) Serial number for this drive.
ui_state (String) This drive’s state as presented to the UI.
wwn (String) The drive’s ‘worldwide name’ from its NAA identifiers.
x_loc (Number) This drive’s x-axis grid location.
y_loc (Number) This drive’s y-axis grid location.

Nested Schema for `nodes.nodes.drives.y_loc`

Read-Only:

current_firmware (String) This drive’s current firmware revision
desired_firmware (String) This drive’s desired firmware revision.

Nested Schema for `nodes.nodes.hardware`

Read-Only:

chassis (String) Name of this node’s chassis.
chassis_code (String) Chassis code of this node (1U, 2U, etc.).
chassis_count (String) Number of chassis making up this node.
class (String) Class of this node (storage, accelerator, etc.).
configuration_id (String) Node configuration ID.
cpu (String) Manufacturer and model of this node’s CPU.
disk_controller (String) Manufacturer and model of this node’s disk controller.
disk_expander (String) Manufacturer and model of this node’s disk expander.
family_code (String) Family code of this node (X, S, NL, etc.).
flash_drive (String) Manufacturer, model, and device id of this node’s flash drive.
generation_code (String) Generation code of this node.
hwgen (String) PowerScale hardware generation name.
imb_version (String) Version of this node’s PowerScale Management Board.
infiniband (String) Infiniband card type.
lcd_version (String) Version of the LCD panel.
motherboard (String) Manufacturer and model of this node’s motherboard.
net_interfaces (String) Description of all this node’s network interfaces.
nvram (String) Manufacturer and model of this node’s NVRAM board.
powersupplies (List of String) Description strings for each power supply on this node.
processor (String) Number of processors and cores on this node.
product (String) PowerScale product name.
ram (Number) Size of RAM in bytes.
serial_number (String) Serial number of this node.
series (String) Series of this node (X, I, NL, etc.).
storage_class (String) Storage class of this node (storage or diskless).

Nested Schema for `nodes.nodes.partitions`

Read-Only:

count (Number) Count of how many partitions are included.
partitions (Attributes List) Partition information. (see below for nested schema)

Nested Schema for `nodes.nodes.partitions.partitions`

Read-Only:

block_size (Number) The block size used for the reported partition information.
capacity (Number) Total blocks on this file system partition.
component_devices (String) Comma separated list of devices used for this file system partition.
mount_point (String) Directory on which this partition is mounted.
percent_used (String) Used blocks on this file system partition, expressed as a percentage.
statfs (Attributes) // (see below for nested schema)
used (Number) Used blocks on this file system partition.

Nested Schema for `nodes.nodes.partitions.partitions.statfs`

Read-Only:

f_bavail (Number) Free blocks available to non-superuser on this partition.
f_bfree (Number) Free blocks on this partition.
f_blocks (Number) Total data blocks on this partition.
f_bsize (Number) Filesystem fragment size; block size in OneFS.
f_ffree (Number) Free file nodes avail to non-superuser.
f_files (Number) Total file nodes in filesystem.
f_flags (Number) Mount exported flags.
f_fstypename (String) File system type name.
f_iosize (Number) Optimal transfer block size.
f_mntfromname (String) Names of devices this partition is mounted from.
f_mntonname (String) Directory this partition is mounted to.
f_namemax (Number) Maximum filename length.
f_owner (Number) UID of user that mounted the filesystem.
f_type (Number) Type of filesystem.
f_version (Number) statfs() structure version number.

Nested Schema for `nodes.nodes.sensors`

Read-Only:

sensors (Attributes List) This node’s sensor information. (see below for nested schema)

Nested Schema for `nodes.nodes.sensors.sensors`

Read-Only:

count (Number) The count of values in this sensor group.
name (String) The name of this sensor group.
values (Attributes List) The list of specific sensor value info in this sensor group. (see below for nested schema)

Nested Schema for `nodes.nodes.sensors.sensors.values`

Read-Only:

desc (String) The descriptive name of this sensor.
name (String) The identifier name of this sensor.
units (String) The units of this sensor.
value (String) The value of this sensor.

Nested Schema for `nodes.nodes.state`

Read-Only:

readonly (Attributes) // (see below for nested schema)
servicelight (Attributes) // (see below for nested schema)
smartfail (Attributes) // (see below for nested schema)

Nested Schema for `nodes.nodes.state.smartfail`

Read-Only:

allowed (Boolean) The current read-only mode allowed status for the node.
enabled (Boolean) The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared.
mode (Boolean) The current read-only mode status for the node.
status (String) The current read-only mode status description for the node.
valid (Boolean) The read-only state values are valid (False = Error).
value (Number) The current read-only value (enumerated bitfield) for the node.

Nested Schema for `nodes.nodes.state.smartfail`

Read-Only:

enabled (Boolean) The node service light state (True = on).

Nested Schema for `nodes.nodes.state.smartfail`

Read-Only:

smartfailed (Boolean) This node is smartfailed (soft_devs).

Nested Schema for `nodes.nodes.status`

Read-Only:

batterystatus (Attributes) // (see below for nested schema)
capacity (Attributes List) Storage capacity of this node. (see below for nested schema)
cpu (Attributes) // (see below for nested schema)
nvram (Attributes) // (see below for nested schema)
powersupplies (Attributes) // (see below for nested schema)
release (String) OneFS release.
uptime (Number) Seconds this node has been online.
version (String) OneFS version.

Nested Schema for `nodes.nodes.status.version`

Read-Only:

last_test_time1 (String) The last battery test time for battery 1.
last_test_time2 (String) The last battery test time for battery 2.
next_test_time1 (String) The next checkup for battery 1.
next_test_time2 (String) The next checkup for battery 2.
present (Boolean) Node has battery status.
result1 (String) The result of the last battery test for battery 1.
result2 (String) The result of the last battery test for battery 2.
status1 (String) The status of battery 1.
status2 (String) The status of battery 2.
supported (Boolean) Node supports battery status.

Nested Schema for `nodes.nodes.status.version`

Read-Only:

bytes (Number) Total device storage bytes.
count (Number) Total device count.
type (String) Device type.

Nested Schema for `nodes.nodes.status.version`

Read-Only:

model (String) Manufacturer model description of this CPU.
overtemp (String) CPU overtemp state.
proc (String) Type of processor and core of this CPU.
speed_limit (String) CPU throttling (expressed as a percentage).

Nested Schema for `nodes.nodes.status.version`

Read-Only:

batteries (Attributes List) This node’s NVRAM battery status information. (see below for nested schema)
battery_count (Number) This node’s NVRAM battery count. On failure: -1, otherwise 1 or 2.
charge_status (String) This node’s NVRAM battery charge status, as a color.
charge_status_number (Number) This node’s NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3.
device (String) This node’s NVRAM device name with path.
present (Boolean) This node has NVRAM.
present_flash (Boolean) This node has NVRAM with flash storage.
present_size (Number) The size of the NVRAM, in bytes.
present_type (String) This node’s NVRAM type.
ship_mode (Number) This node’s current ship mode state for NVRAM batteries. If not supported or on failure: -1. Disabled: 0. Enabled: 1.
supported (Boolean) This node supports NVRAM.
supported_flash (Boolean) This node supports NVRAM with flash storage.
supported_size (Number) The maximum size of the NVRAM, in bytes.
supported_type (String) This node’s supported NVRAM type.

Nested Schema for `nodes.nodes.status.version.batteries`

Read-Only:

color (String) The current status color of the NVRAM battery.
id (Number) Identifying index for the NVRAM battery.
status (String) The current status message of the NVRAM battery.
voltage (String) The current voltage of the NVRAM battery.

Nested Schema for `nodes.nodes.status.version`

Read-Only:

count (Number) Count of how many power supplies are supported.
failures (Number) Count of how many power supplies have failed.
has_cff (Boolean) Does this node have a CFF power supply.
status (String) A descriptive status string for this node’s power supplies.
supplies (Attributes List) List of this node’s power supplies. (see below for nested schema)
supports_cff (Boolean) Does this node support CFF power supplies.

Nested Schema for `nodes.nodes.status.version.supplies`

Read-Only:

chassis (Number) Which node chassis is this power supply in.
firmware (String) The current firmware revision of this power supply.
good (String) Is this power supply in a failure state.
id (Number) Identifying index for this power supply.
name (String) Complete identifying string for this power supply.
status (String) A descriptive status string for this power supply.
type (String) The type of this power supply.

V1.8.1: powerscale_cluster_email data source

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

powerscale_cluster_email (Data Source)

This datasource is used to query the Cluster Email Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns PowerScale cluster email settings detail
data "powerscale_cluster_email" "test" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_cluster_email.example
output "powerscale_cluster_email_output" {
  value = data.powerscale_cluster_email.test
}

Schema

Read-Only

id (String) Unique identifier.
settings (Attributes) Cluster email notification settings. (see below for nested schema)

Nested Schema for `settings`

Read-Only:

batch_mode (String) This setting determines how notifications will be batched together to be sent by email. ’none’ means each notification will be sent separately. ‘severity’ means notifications of the same severity will be sent together. ‘category’ means notifications of the same category will be sent together. ‘all’ means all notifications will be batched together and sent in a single email.
mail_relay (String) The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
mail_sender (String) The full email address that will appear as the sender of notification messages.
mail_subject (String) The subject line for notification messages from this cluster.
smtp_auth_passwd_set (Boolean) Indicates if an SMTP authentication password is set.
smtp_auth_security (String) The type of secure communication protocol to use if SMTP is being used. If ’none’, plain text will be used, if ‘starttls’, the encrypted STARTTLS protocol will be used.
smtp_auth_username (String) Username to authenticate with if SMTP authentication is being used.
smtp_port (Number) The port on the SMTP server to be used for relaying the notification messages.
use_smtp_auth (Boolean) If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
user_template (String) Location of a custom template file that can be used to specify the layout of the notification emails.

V1.8.1: powerscale_filepool_policy data source

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

powerscale_filepool_policy (Data Source)

This datasource is used to query the existing File Pool Policies from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale File Pool Policy can identify logical groups of files and specify storage operations for these files.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale File Pool Policy can identify logical groups of files and specify storage operations for these files.
# Returns a list of PowerScale File Pool Policies based on names filter block. 
data "powerscale_filepool_policy" "example_filepool_policy" {
  filter {
    # Optional list of names to filter upon
    names = ["filePoolPolicySample", "Default policy"]
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_filepool_policy.example_filepool_policy
output "powerscale_filepool_policy_filter" {
  value = data.powerscale_filepool_policy.example_filepool_policy
}


# Returns all of the PowerScale File Pool Policies including Default Policy.
data "powerscale_filepool_policy" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_filepool_policy.all
output "powerscale_filepool_policy_all" {
  value = data.powerscale_filepool_policy.all
}

Schema

Optional

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

Read-Only

file_pool_policies (Attributes List) List of file pool policies. (see below for nested schema)
id (String) Unique identifier of the file pool policy instance.

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `file_pool_policies`

Read-Only:

actions (Attributes List) A list of actions to be taken for matching files. (see below for nested schema)
apply_order (Number) The order in which this policy should be applied (relative to other policies).
birth_cluster_id (String) The guid assigned to the cluster on which the policy was created.
description (String) A description for this File Pool Policy.
file_matching_pattern (Attributes) Specifies the file matching rules for determining which files will be managed by this policy. (see below for nested schema)
id (String) A unique name for this File Pool Policy.
name (String) A unique name for this File Pool Policy.
state (String) Indicates whether this policy is in a good state (“OK”) or disabled (“disabled”).
state_details (String) Gives further information to describe the state of this policy.

Nested Schema for `file_pool_policies.actions`

Read-Only:

action_type (String) action_type Acceptable values: set_requested_protection, set_data_access_pattern, enable_coalescer, apply_data_storage_policy, apply_snapshot_storage_policy, set_cloudpool_policy, enable_packing.
cloudpool_policy_action (Attributes) Action for set_cloudpool_policy type. (see below for nested schema)
data_access_pattern_action (String) Action for set_data_access_pattern type. Set data access pattern optimization. Acceptable values: random, concurrency, streaming.
data_storage_policy_action (Attributes) Action for apply_data_storage_policy. (see below for nested schema)
enable_coalescer_action (Boolean) Action for enable_coalescer type. Set write performance optimization. True to enable SmartCache action.
enable_packing_action (Boolean) Action for enable_packing type. True to enable enable_packing action.
requested_protection_action (String) Action for set_requested_protection type. Acceptable values: default, +1n, +2d:1n, +2n, +3d:1n, +3d:1n1d, +3n, +4d:1n, +4d:2n, +4n, 2x, 3x, 4x, 5x, 6x, 7x, 8x.
snapshot_storage_policy_action (Attributes) Action for apply_snapshot_storage_policy. (see below for nested schema)

Nested Schema for `file_pool_policies.actions.cloudpool_policy_action`

Read-Only:

archive_snapshot_files (Boolean) Specifies if files with snapshots should be archived.
cache (Attributes) Specifies default cloudpool cache settings for new filepool policies. (see below for nested schema)
compression (Boolean) Specifies if files should be compressed.
data_retention (Number) Specifies the minimum amount of time archived data will be retained in the cloud after deletion.
encryption (Boolean) Specifies if files should be encrypted.
full_backup_retention (Number) The minimum amount of time cloud files will be retained after the creation of a full NDMP backup. (Used with NDMP backups only. Not applicable to SyncIQ.)
incremental_backup_retention (Number) The minimum amount of time cloud files will be retained after the creation of a SyncIQ backup or an incremental NDMP backup. (Used with SyncIQ and NDMP backups.)
pool (String) Specifies the cloudPool storage target.
writeback_frequency (Number) The minimum amount of time to wait before updating cloud data with local changes.

Nested Schema for `file_pool_policies.actions.cloudpool_policy_action.writeback_frequency`

Read-Only:

expiration (Number) Specifies cache expiration.
read_ahead (String) Specifies cache read ahead type. Acceptable values: partial, full.
type (String) Specifies cache type. Acceptable values: cached, no-cache.

Nested Schema for `file_pool_policies.actions.data_storage_policy_action`

Read-Only:

ssd_strategy (String) Specifies the SSD strategy. Acceptable values: metadata, metadata-write, data, avoid.
storagepool (String) Specifies the storage target.

Nested Schema for `file_pool_policies.actions.snapshot_storage_policy_action`

Read-Only:

ssd_strategy (String) Specifies the SSD strategy. Acceptable values: metadata, metadata-write, data, avoid.
storagepool (String) Specifies the snapshot storage target.

Nested Schema for `file_pool_policies.file_matching_pattern`

Read-Only:

or_criteria (Attributes List) List of or_criteria file matching rules for this policy. (see below for nested schema)

Nested Schema for `file_pool_policies.file_matching_pattern.or_criteria`

Read-Only:

and_criteria (Attributes List) List of and_criteria file matching rules for this policy. (see below for nested schema)

Nested Schema for `file_pool_policies.file_matching_pattern.or_criteria.and_criteria`

Read-Only:

attribute_exists (Boolean) Indicates whether the existence of an attribute indicates a match (valid only with ’type’ = ‘custom_attribute’).
begins_with (Boolean) True to match the path exactly, False to match any subtree. (valid only with ’type’ = ‘path’).
case_sensitive (Boolean) True to indicate case sensitivity when comparing file attributes (valid only with ’type’ = ’name’ or ’type’ = ‘path’).
field (String) File attribute field name to be compared in a custom comparison (valid only with ’type’ = ‘custom_attribute’).
operator (String) The comparison operator to use while comparing an attribute with its value.
type (String) The file attribute to be compared to a given value.
units (String) Size unit value. One of ‘B’,‘KB’,‘MB’,‘GB’,‘TB’,‘PB’,‘EB’ (valid only with ’type’ = ‘size’).
use_relative_time (Boolean) Whether time units refer to a calendar date and time (e.g., Jun 3, 2009) or a relative duration (e.g., 2 weeks) (valid only with ’type’ in {accessed_time, birth_time, changed_time or metadata_changed_time}.
value (String) The value to be compared against a file attribute.

V1.8.1: powerscale_filesystem data source

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

powerscale_filesystem (Data Source)

This datasource is used to query the existing FileSystem (Namespace Directory) from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.It allows you to get information which includes all metadata , access control , quotas and snapshots related information for the directory.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This terraform DataSource is used to query the existing FileSystem(Namespace Directory) from PowerScale array.It allows you to get information which includes all metadata , access control , quotas and snapshots related information for the directory.

# Returns the information related to the specified PowerScale FileSystem(Namespace Directory) based on the directory path. If directory path is not set it will give details regarding the default "/ifs" directory.
data "powerscale_filesystem" "system" {
  # Required parameter, path of the directory filesystem datasource, defaults to "/ifs" if not set
  directory_path = "/ifs/tfacc_file_system_test"
}

output "powerscale_filesystem_1" {
  value = data.powerscale_filesystem.system
}
# After the successful execution of above block, We can see the output value by executing 'terraform output' command.
# Also, we can use the fetched information by the variable data.powerscale_filesystem.system"

Schema

Optional

directory_path (String) FileSystem directory path.This specifies the path to the FileSystem(Namespace directory) which we are trying to query. Default path is /ifs
file_systems_details (Attributes) Details of the Filesystem (see below for nested schema)
id (String) FileSystem identifier. Unique identifier for the FileSystem(Namespace directory)

Nested Schema for `file_systems_details`

Optional:

file_system_attributes (Attributes List) FileSystems Attributes (see below for nested schema)
file_system_namespace_acl (Attributes) Filesystem acl. Shows the access control list for the FileSystem(Namespace directory) (see below for nested schema)
file_system_quotas (Attributes List) Filesystem quotas (see below for nested schema)
file_system_snapshots (Attributes List) Filesystem snapshots (see below for nested schema)

Nested Schema for `file_systems_details.file_system_attributes`

Optional:

name (String) Attribute name
namespace (String) Attribute namespace
value (String) Attribute value

Nested Schema for `file_systems_details.file_system_namespace_acl`

Optional:

acl (Attributes List) Filesystem Access Control List (see below for nested schema)
action (String) Acl action
authoritative (String) Acl authoritative
group (Attributes) ACL group (see below for nested schema)
mode (String) Acl mode
owner (Attributes) ACL owner (see below for nested schema)

Nested Schema for `file_systems_details.file_system_namespace_acl.acl`

Optional:

access_rights (List of String) Access rights
access_type (String) Access type
inherit_flags (List of String) Inherit flags
op (String) Op
trustee (Attributes) Trustee (see below for nested schema)

Nested Schema for `file_systems_details.file_system_namespace_acl.acl.trustee`

Optional:

id (String) Trustee identifier
name (String) Trustee name
type (String) Trustee type

Nested Schema for `file_systems_details.file_system_namespace_acl.group`

Optional:

id (String) Group identifier
name (String) Group name
type (String) Group type

Nested Schema for `file_systems_details.file_system_namespace_acl.owner`

Optional:

id (String) Owner identifier
name (String) Owner name
type (String) Owner type

Nested Schema for `file_systems_details.file_system_quotas`

Optional:

container (Boolean) If true, SMB shares using the quota directory see the quota thresholds as share size.
enforced (Boolean) True if the quota provides enforcement, otherwise a accounting quota.
id (String) Quota Id
path (String) The path of quota.
type (String) The type of quota.
usage (Attributes) Usage (see below for nested schema)

Nested Schema for `file_systems_details.file_system_quotas.usage`

Optional:

applogical (Number) Bytes used by governed data apparent to application
applogical_ready (Boolean) True if applogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
fslogical (Number) Bytes used by governed data apparent to filesystem.
fslogical_ready (Boolean) True if fslogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
fsphysical (Number) Bytes used by governed data apparent to filesystem.
fsphysical_ready (Boolean) True if fsphysical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
inodes (Number) Number of inodes (filesystem entities) used by governed data.
inodes_ready (Boolean) True if inodes resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
physical (Number) Bytes used for governed data and filesystem overhead.
physical_data (Number) Number of physical blocks for file data
physical_data_ready (Boolean) True if physical_data resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
physical_protection (Number) Number of physical blocks for file protection
physical_protection_ready (Boolean) True if physical_protection resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
physical_ready (Boolean) True if physical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
shadow_refs (Number) Number of shadow references (cloned, deduplicated or packed filesystem blocks) used by governed data.
shadow_refs_ready (Boolean) True if shadow_refs resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.

Nested Schema for `file_systems_details.file_system_snapshots`

Optional:

alias (String) The name of the alias, none for real snapshots.
created (Number) The Unix Epoch time the snapshot was created.
expires (Number) The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
has_locks (Boolean) True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of locks.
id (Number) The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
name (String) The user or system supplied snapshot name. This will be null for snapshots pending delete.
path (String) The /ifs path snapshotted.
pct_filesystem (Number) Percentage of /ifs used for storing this snapshot.
pct_reserve (Number) Percentage of configured snapshot reserved used for storing this snapshot.
schedule (String) The name of the schedule used to create this snapshot, if applicable.
shadow_bytes (Number) The amount of shadow bytes referred to by this snapshot.
size (Number) The amount of storage in bytes used to store this snapshot.
state (String) Snapshot state.
target_id (Number) The ID of the snapshot pointed to if this is an alias. 18446744073709551615 (max uint64) is returned for an alias to the live filesystem.
target_name (String) The name of the snapshot pointed to if this is an alias.

V1.8.1: powerscale_groupnet data source

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

powerscale_groupnet (Data Source)

This datasource is used to query the existing Groupnets from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale Groupnet sits above subnets and pools and allows separate Access Zones to contain distinct DNS settings.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale Groupnet sits above subnets and pools and allows separate Access Zones to contain distinct DNS settings.

# Returns a list of PowerScale Groupnets based on names filter block. 
data "powerscale_groupnet" "example_groupnet" {
  filter {
    # Optional list of names to filter upon
    names = ["groupnet_name"]
  }
}

# Returns a list of PowerScale Groupnets in order based on the filters in the filter block. 
data "powerscale_groupnet" "example_groupnet" {
  filter {
    sort = "name"
    dir  = "DESC"
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_groupnet.example_groupnet
output "powerscale_groupnet_filter" {
  value = data.powerscale_groupnet.example_groupnet
}


# Returns all of the PowerScale Groupnets
data "powerscale_groupnet" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_groupnet.all
output "powerscale_groupnet_all" {
  value = data.powerscale_groupnet.all
}

Schema

Optional

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

Read-Only

groupnets (Attributes List) List of groupnets. (see below for nested schema)
id (String) Unique identifier of the groupnet instance.

Nested Schema for `filter`

Optional:

dir (String) The direction of the sort.
limit (Number) Return no more than this many results.
names (Set of String) Only list groupnet matching this name.
sort (String) The field that will be used for sorting.

Nested Schema for `groupnets`

Read-Only:

allow_wildcard_subdomains (Boolean) If enabled, SmartConnect treats subdomains of known dns zones as the known dns zone. This is required for S3 Virtual Host domains.
description (String) A description of the groupnet.
dns_cache_enabled (Boolean) DNS caching is enabled or disabled.
dns_resolver_rotate (Boolean) Enable or disable DNS resolver rotate.
dns_search (List of String) List of DNS search suffixes.
dns_servers (List of String) List of Domain Name Server IP addresses.
id (String) Unique Interface ID.
name (String) The name of the groupnet.
server_side_dns_search (Boolean) Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP.
subnets (List of String) Name of the subnets in the groupnet.

V1.8.1: powerscale_ldap_provider data source

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

powerscale_ldap_provider (Data Source)

This datasource is used to query the existing LDAP providers from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale LDAP provider enables you to define, query, and modify directory services and resources.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale LDAP provider enables you to define, query, and modify directory services and resources.

# Returns a list of PowerScale LDAP providers based on names and scope filter block. 
data "powerscale_ldap_provider" "example_ldap_provider" {
  filter {
    # Optional list of names to filter upon
    names = ["ldap_provider_name"]
    # If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
    scope = "effective"
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_ldap_provider.example_ldap_provider
output "powerscale_ldap_provider_filter" {
  value = data.powerscale_ldap_provider.example_ldap_provider
}


# Returns all of the PowerScale LDAP providers
data "powerscale_ldap_provider" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_ldap_provider.all
output "powerscale_ldap_provider_all" {
  value = data.powerscale_ldap_provider.all
}

Schema

Optional

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

Read-Only

id (String) Unique identifier of the LDAP provider instance.
ldap_providers (Attributes List) List of LDAP providers. (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String)
scope (String) If specified as “effective” or not specified, all fields are returned. If specified as “user”, only fields with non-default values are shown. If specified as “default”, the original values are returned.

Nested Schema for `ldap_providers`

Read-Only:

alternate_security_identities_attribute (String) Specifies the attribute name used when searching for alternate security identities.
authentication (Boolean) If true, enables authentication and identity management through the authentication provider.
balance_servers (Boolean) If true, connects the provider to a random server.
base_dn (String) Specifies the root of the tree in which to search identities.
bind_dn (String) Specifies the distinguished name for binding to the LDAP server.
bind_mechanism (String) Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the ‘simple’ value.
bind_timeout (Number) Specifies the timeout in seconds when binding to an LDAP server.
certificate_authority_file (String) Specifies the path to the root certificates file.
check_online_interval (Number) Specifies the time in seconds between provider online checks.
cn_attribute (String) Specifies the canonical name.
create_home_directory (Boolean) Automatically create the home directory on the first login.
crypt_password_attribute (String) Specifies the hashed password value.
email_attribute (String) Specifies the LDAP Email attribute.
enabled (Boolean) If true, enables the LDAP provider.
enumerate_groups (Boolean) If true, allows the provider to enumerate groups.
enumerate_users (Boolean) If true, allows the provider to enumerate users.
findable_groups (List of String) Specifies the list of groups that can be resolved.
findable_users (List of String) Specifies the list of users that can be resolved.
gecos_attribute (String) Specifies the LDAP GECOS attribute.
gid_attribute (String) Specifies the LDAP GID attribute.
group_base_dn (String) Specifies the distinguished name of the entry where LDAP searches for groups are started.
group_domain (String) Specifies the domain for this provider through which groups are qualified.
group_filter (String) Specifies the LDAP filter for group objects.
group_members_attribute (String) Specifies the LDAP Group Members attribute.
group_search_scope (String) Specifies the depth from the base DN to perform LDAP searches. Acceptable values: “default”, “base”, “onelevel”, “subtree”, “children”.
groupnet (String) Groupnet identifier.
home_directory_template (String) Specifies the path to the home directory template.
homedir_attribute (String) Specifies the LDAP Homedir attribute.
id (String) Specifies the ID of the LDAP provider.
ignore_tls_errors (Boolean) If true, continues over secure connections even if identity checks fail.
listable_groups (List of String) Specifies the groups that can be viewed in the provider.
listable_users (List of String) Specifies the users that can be viewed in the provider.
login_shell (String) Specifies the login shell path.
member_lookup_method (String) Sets the method by which group member lookups are performed. Use caution when changing this option directly. Acceptable values: “default”, “rfc2307bis”.
member_of_attribute (String) Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.
name (String) Specifies the name of the LDAP provider.
name_attribute (String) Specifies the LDAP UID attribute, which is used as the login name.
netgroup_base_dn (String) Specifies the distinguished name of the entry where LDAP searches for netgroups are started.
netgroup_filter (String) Specifies the LDAP filter for netgroup objects.
netgroup_members_attribute (String) Specifies the LDAP Netgroup Members attribute.
netgroup_search_scope (String) Specifies the depth from the base DN to perform LDAP searches. Acceptable values: “default”, “base”, “onelevel”, “subtree”, “children”.
netgroup_triple_attribute (String) Specifies the LDAP Netgroup Triple attribute.
normalize_groups (Boolean) Normalizes group names to lowercase before look up.
normalize_users (Boolean) Normalizes user names to lowercase before look up.
nt_password_attribute (String) Specifies the LDAP NT Password attribute.
ntlm_support (String) Specifies which NTLM versions to support for users with NTLM-compatible credentials. Acceptable values: “all”, “v2only”, “none”.
ocsp_server_uris (List of String) Specifies the OCSP server URIs. Only available for PowerScale 9.5 and above.
provider_domain (String) Specifies the provider domain.
require_secure_connection (Boolean) Determines whether to continue over a non-TLS connection.
restrict_findable (Boolean) If true, checks the provider for filtered lists of findable and unfindable users and groups.
restrict_listable (Boolean) If true, checks the provider for filtered lists of listable and unlistable users and groups.
search_scope (String) Specifies the default depth from the base DN to perform LDAP searches. Acceptable values: “default”, “base”, “onelevel”, “subtree”, “children”.
search_timeout (Number) Specifies the search timeout period in seconds.
server_uris (List of String) Specifies the server URIs.
shadow_expire_attribute (String) Sets the attribute name that indicates the absolute date to expire the account.
shadow_flag_attribute (String) Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.
shadow_inactive_attribute (String) Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.
shadow_last_change_attribute (String) Sets the attribute name that indicates the last change of the shadow information.
shadow_max_attribute (String) Sets the attribute name that indicates the maximum number of days a password can be valid.
shadow_min_attribute (String) Sets the attribute name that indicates the minimum number of days between shadow changes.
shadow_user_filter (String) Sets LDAP filter for shadow user objects.
shadow_warning_attribute (String) Sets the attribute name that indicates the number of days before the password expires to warn the user.
shell_attribute (String) Specifies the LDAP Shell attribute.
ssh_public_key_attribute (String) Sets the attribute name that indicates the SSH Public Key for the user.
status (String) Specifies the status of the provider.
system (Boolean) If true, indicates that this provider instance was created by OneFS and cannot be removed.
tls_protocol_min (String) Specifies the minimum TLS protocol version.
tls_revocation_check_level (String) This setting controls the behavior of the certificate revocation checking algorithm when the LDAP provider is presented with a digital certificate by an LDAP server. Acceptable values: “none”, “allowNoData”, “allowNoSrc”, “strict”. Only available for PowerScale 9.5 and above.
uid_attribute (String) Specifies the LDAP UID Number attribute.
unfindable_groups (List of String) Specifies the groups that cannot be resolved by the provider.
unfindable_users (List of String) Specifies users that cannot be resolved by the provider.
unique_group_members_attribute (String) Sets the LDAP Unique Group Members attribute.
unlistable_groups (List of String) Specifies a group that cannot be listed by the provider.
unlistable_users (List of String) Specifies a user that cannot be listed by the provider.
user_base_dn (String) Specifies the distinguished name of the entry at which to start LDAP searches for users.
user_domain (String) Specifies the domain for this provider through which users are qualified.
user_filter (String) Specifies the LDAP filter for user objects.
user_search_scope (String) Specifies the depth from the base DN to perform LDAP searches. Acceptable values: “default”, “base”, “onelevel”, “subtree”, “children”.
zone_name (String) Specifies the name of the access zone in which this provider was created.

V1.8.1: powerscale_namespace_acl data source

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

powerscale_namespace_acl (Data Source)

This datasource is used to query the Namespace ACL from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can use Namespace ACL to manage the access control list for a namespace.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of the Namespace ACL from PowerScale array.

# Returns the PowerScale Namespace ACL on PowerScale array
data "powerscale_namespace_acl" "example" {
  # Note: namespace must be specified
  filter {
    namespace = "ifs/example"
    nsaccess  = true
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_namespace_acl.example
output "powerscale_namespace_acl_example" {
  value = data.powerscale_namespace_acl.example
}

Schema

Optional

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

Read-Only

acl (Attributes List) Array effective configuration of the JSON array of access rights. (see below for nested schema)
authoritative (String) If the directory has access rights set, then this field is returned as acl. If the directory has POSIX permissions set, then this field is returned as mode.
group (Attributes) Provides the JSON object for the group persona of the owner. (see below for nested schema)
mode (String) Provides the POSIX mode.
owner (Attributes) Provides the JSON object for the group persona of the owner. (see below for nested schema)

Nested Schema for `filter`

Required:

namespace (String) Indicate the namespace to set/get acl.

Optional:

nsaccess (Boolean) Indicates that the operation is on the access point instead of the store path.

Nested Schema for `acl`

Read-Only:

accessrights (List of String) Specifies the access control permissions for a specific user or group.
accesstype (String) Grants or denies access control permissions.
inherit_flags (List of String) Grants or denies access control permissions.
op (String) Operations for updating access control permissions. Unnecessary for access right replacing scenario
trustee (Attributes) Provides the JSON object for the group persona of the owner. (see below for nested schema)

Nested Schema for `acl.trustee`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’ or ‘GID:0’
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `group`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `owner`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

V1.8.1: powerscale_network_rule data source

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

powerscale_network_rule (Data Source)

This datasource is used to query the existing network rules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing network rules from PowerScale array.

# Returns a list of PowerScale network rules based on names and query parameters specified in the filter block.
data "powerscale_network_rule" "test" {
  filter {
    #   Optional query parameters
    #   Note: the following filters will be applied with AND logic
    names = ["rule0"]

    # Optional
    groupnet = "groupnet0"
    subnet   = "subnet0"
    pool     = "pool0"
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_network_rule.test
output "powerscale_network_rule" {
  value = data.powerscale_network_rule.test
}

# Returns all PowerScale network rules on PowerScale array
data "powerscale_network_rule" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_network_rule.all
output "powerscale_network_rule_data_all" {
  value = data.powerscale_network_rule.all
}

Schema

Optional

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

Read-Only

id (String) Unique identifier of the network rule.
network_rules (Attributes List) List of Network Rules. (see below for nested schema)

Nested Schema for `filter`

Optional:

groupnet (String) If specified, only rules for this groupnet will be returned.
names (Set of String) Filter network rules by names.
pool (String) If specified, only rules for this pool will be returned.
subnet (String) If specified, only rules for this subnet will be returned.

Nested Schema for `network_rules`

Read-Only:

description (String) Description for the provisioning rule.
groupnet (String) Name of the groupnet this rule belongs to
id (String) Unique rule ID.
iface (String) Interface name the provisioning rule applies to.
name (String) Name of the provisioning rule.
node_type (String) Node type the provisioning rule applies to.
pool (String) Name of the pool this rule belongs to.
subnet (String) Name of the subnet this rule belongs to.

V1.8.1: powerscale_network_settings data source

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

powerscale_network_settings (Data Source)

This datasource is used to query the Network Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale Network Settings provide the ability to configure external network configuration on the cluster.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale Network Settings provide the ability to configure external network configuration on the cluster.

# Returns PowerScale network settings detail
data "powerscale_network_settings" "example" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_network_settings.example
output "powerscale_network_settings_output" {
  value = data.powerscale_network_settings.example
}

Schema

Read-Only

default_groupnet (String) Default client-side DNS settings for non-multitenancy aware programs.
id (String) Network Settings ID.
sc_rebalance_delay (Number) Delay in seconds for IP rebalance.
source_based_routing_enabled (Boolean) Enable or disable Source Based Routing.
tcp_ports (List of Number) List of client TCP ports.

V1.8.1: powerscale_networkpool data source

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

powerscale_networkpool (Data Source)

This datasource is used to query the existing network pools from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can add network interfaces to network pools to associate address ranges with a node or a group of nodes.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing network pools from PowerScale array.

# Returns a list of PowerScale network pools based on names and query parameters specified in the filter block.
data "powerscale_networkpool" "test" {
  filter {
    #   Optional query parameters
    #   Note: the following filters will be applied with AND logic
    names = ["pool0"]
    #     subnet = "subnet0"
    #     groupnet = "groupnet0"
    #     access_zone = "System"
    #     alloc_method = "static"
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_networkpool.test
output "powerscale_networkpool" {
  value = data.powerscale_networkpool.test
}

# Returns all PowerScale network pools on PowerScale array
data "powerscale_networkpool" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_networkpool.all
output "powerscale_networkpool_data_all" {
  value = data.powerscale_networkpool.all
}

Schema

Optional

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

Read-Only

id (String) Unique identifier of the network pool instance.
network_pools_details (Attributes List) List of Network Pools. (see below for nested schema)

Nested Schema for `filter`

Optional:

access_zone (String) If specified, only pools with this zone name will be returned.
alloc_method (String) If specified, only pools with this allocation type will be returned.
groupnet (String) If specified, only pools for this groupnet will be returned.
names (Set of String) Filter network pools by names.
subnet (String) If specified, only pools for this subnet will be returned.

Nested Schema for `network_pools_details`

Read-Only:

access_zone (String) Name of a valid access zone to map IP address pool to the zone.
addr_family (String) IP address format.
aggregation_mode (String) OneFS supports the following NIC aggregation modes.
alloc_method (String) Specifies how IP address allocation is done among pool members.
description (String) A description of the pool.
groupnet (String) Name of the groupnet this pool belongs to.
id (String) Unique Pool ID.
ifaces (Attributes List) List of interface members in this pool. (see below for nested schema)
name (String) The name of the pool. It must be unique throughout the given subnet.It’s a required field with POST method.
nfsv3_rroce_only (Boolean) Indicates that pool contains only RDMA RRoCE capable interfaces.
ranges (Attributes List) List of IP address ranges in this pool. (see below for nested schema)
rebalance_policy (String) Rebalance policy..
rules (List of String) Names of the rules in this pool.
sc_auto_unsuspend_delay (Number) Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.
sc_connect_policy (String) SmartConnect client connection balancing policy.
sc_dns_zone (String) SmartConnect zone name for the pool.
sc_dns_zone_aliases (List of String) List of SmartConnect zone aliases (DNS names) to the pool.
sc_failover_policy (String) SmartConnect IP failover policy.
sc_subnet (String) Name of SmartConnect service subnet for this pool.
sc_suspended_nodes (List of Number) List of LNNs showing currently suspended nodes in SmartConnect.
sc_ttl (Number) Time to live value for SmartConnect DNS query responses in seconds.
static_routes (Attributes List) List of interface members in this pool. (see below for nested schema)
subnet (String) The name of the subnet.

Nested Schema for `network_pools_details.ifaces`

Read-Only:

iface (String) A string that defines an interface name.
lnn (Number) Logical Node Number (LNN) of a node.

Nested Schema for `network_pools_details.ranges`

Read-Only:

high (String) High IP
low (String) Low IP

Nested Schema for `network_pools_details.static_routes`

Read-Only:

gateway (String) Address of the gateway in the format: yyy.yyy.yyy.yyy
prefixlen (Number) Prefix length in the format: nn.
subnet (String) Network address in the format: xxx.xxx.xxx.xxx

V1.8.1: powerscale_nfs_alias data source

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

powerscale_nfs_alias (Data Source)

This datasource is used to query the existing NFS aliases from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale provides an NFS server so you can share files on your cluster

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale provides an NFS server so you can share files on your cluster

# Returns a list of PowerScale NFS exports based on id and path filter block
data "powerscale_nfs_alias" "test" {
  filter {
    # Used for locally filtering id 
    ids = ["/test_alias_3", "/test_alias_3"]

    # Used for query parameter, supported by PowerScale Platform API
    # check = true
    # dir   = "ASC"
    # limit = 10
    # scope = "user"
    # sort  = "id"
    # zone  = "System"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_alias.example_nfs_aliases
output "powerscale_nfs_alias" {
  value = data.powerscale_nfs_export.example_nfs_aliases
}

# Returns all of the PowerScale aliases in default zone
data "powerscale_nfs_alias" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_alias.all
output "powerscale_nfs_alias" {
  value = data.powerscale_nfs_export.all
}

Schema

Optional

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

Read-Only

id (String) Identifier
nfs_aliases (Attributes List) List of nfs aliases (see below for nested schema)

Nested Schema for `filter`

Optional:

check (Boolean) Check for conflicts when listing Aliases.
dir (String) The direction of the sort.
ids (Set of String) IDs to filter nfs Aliases.
limit (Number) Return no more than this many results at once (see resume).
sort (String) The field that will be used for sorting.
zone (String) Specifies which access zone to use.

Nested Schema for `nfs_aliases`

Read-Only:

health (String) Health status of NFS Alias.
id (String) ID of NFS Alias.
name (String) Name of NFS Alias.
path (String) Path of NFS Alias.
zone (String) Zone of NFS Alias.

V1.8.1: powerscale_nfs_export data source

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

powerscale_nfs_export (Data Source)

This datasource is used to query the existing NFS exports from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale provides an NFS server so you can share files on your cluster

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale provides an NFS server so you can share files on your cluster

# Returns a list of PowerScale NFS exports based on id and path filter block
data "powerscale_nfs_export" "test" {
  filter {
    # Used for locally filtering id and path
    ids   = [1, 2, 3]
    paths = ["/ifs/primary", "/ifs/secondary"]

    # Used for query parameter, supported by PowerScale Platform API
    # check = true
    # dir   = "ASC"
    # limit = 10
    # offset= 1
    # path  = "/ifs/primary"
    # resume= "resume_token"
    # scope = "user"
    # sort  = "id"
    # zone  = "System"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_export.example_nfs_exports
output "powerscale_nfs_export" {
  value = data.powerscale_nfs_export.example_nfs_exports
}

# Returns all of the PowerScale SMB shares in default zone
data "powerscale_nfs_export" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_export.all
output "powerscale_nfs_export" {
  value = data.powerscale_nfs_export.all
}

Schema

Optional

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

Read-Only

id (String) Identifier
nfs_exports (Attributes List) List of nfs exports (see below for nested schema)

Nested Schema for `filter`

Optional:

check (Boolean) Check for conflicts when listing exports.
dir (String) The direction of the sort.
ids (Set of Number) IDs to filter nfs exports.
limit (Number) Return no more than this many results at once (see resume).
offset (Number) The position of the first item returned for a paginated query within the full result set.
path (String) If specified, only exports that explicitly reference at least one of the given paths will be returned.
paths (Set of String) Paths to filter nfs exports.
resume (String) Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
scope (String) If specified as “effective” or not specified, all fields are returned. If specified as “user”, only fields with non-default values are shown. If specified as “default”, the original values are returned.
sort (String) The field that will be used for sorting.
zone (String) Specifies which access zone to use.

Nested Schema for `nfs_exports`

Read-Only:

all_dirs (Boolean) True if all directories under the specified paths are mountable.
block_size (Number) Specifies the block size returned by the NFS statfs procedure.
can_set_time (Boolean) True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
case_insensitive (Boolean) True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
case_preserving (Boolean) True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
chown_restricted (Boolean) True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
clients (List of String) Specifies the clients with root access to the export.
commit_asynchronous (Boolean) True if NFS commit requests execute asynchronously.
conflicting_paths (List of String) Reports the paths that conflict with another export.
description (String) Specifies the user-defined string that is used to identify the export.
directory_transfer_size (Number) Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced.
encoding (String) Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified.
id (Number) Specifies the system-assigned ID for the export. This ID is returned when an export is created through the POST method.
link_max (Number) Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
map_all (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
map_failure (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
map_full (Boolean) True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication.
map_lookup_uid (Boolean) True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations.
map_non_root (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
map_retry (Boolean) Determines whether searches for users specified in ‘map_all’, ‘map_root’ or ‘map_nonroot’ are retried if the search fails.
map_root (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
max_file_size (Number) Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
name_max_size (Number) Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
no_truncate (Boolean) True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
paths (List of String) Specifies the paths under /ifs that are exported.
read_only (Boolean) True if the export is set to read-only.
read_only_clients (List of String) Specifies the clients with read-only access to the export.
read_transfer_max_size (Number) Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
read_transfer_multiple (Number) Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
read_transfer_size (Number) Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
read_write_clients (List of String) Specifies the clients with both read and write access to the export, even when the export is set to read-only.
readdirplus (Boolean) True if ‘readdirplus’ requests are enabled. Enabling this property might improve network performance and is only available for NFSv3.
readdirplus_prefetch (Number) Sets the number of directory entries that are prefetched when a ‘readdirplus’ request is processed. (Deprecated.)
return_32bit_file_ids (Boolean) Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).
root_clients (List of String) Clients that have root access to the export.
security_flavors (List of String) Specifies the authentication types that are supported for this export.
setattr_asynchronous (Boolean) True if set attribute operations execute asynchronously.
snapshot (String) Specifies the snapshot for all mounts.
symlinks (Boolean) True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced.
time_delta (Number) Specifies the resolution of all time values that are returned to the clients
unresolved_clients (List of String) Reports clients that cannot be resolved.
write_datasync_action (String) Specifies the action to be taken when an NFSv3+ datasync write is requested.
write_datasync_reply (String) Specifies the stability disposition returned when an NFSv3+ datasync write is processed.
write_filesync_action (String) Specifies the action to be taken when an NFSv3+ filesync write is requested.
write_filesync_reply (String) Specifies the stability disposition returned when an NFSv3+ filesync write is processed.
write_transfer_max_size (Number) Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
write_transfer_multiple (Number) Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
write_transfer_size (Number) Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
write_unstable_action (String) Specifies the action to be taken when an NFSv3+ unstable write is requested.
write_unstable_reply (String) Specifies the stability disposition returned when an NFSv3+ unstable write is processed.
zone (String) Specifies the zone in which the export is valid.

Nested Schema for `nfs_exports.map_all`

Optional:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_exports.map_all.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_all.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_all.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_failure`

Optional:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_exports.map_failure.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_failure.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_failure.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_non_root`

Optional:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_exports.map_non_root.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_non_root.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_non_root.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_root`

Optional:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_exports.map_root.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_root.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_exports.map_root.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

V1.8.1: powerscale_nfs_export_settings data source

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

powerscale_nfs_export_settings (Data Source)

This datasource is used to query the NFS Export Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns PowerScale NFS export settings based on filter
data "powerscale_nfs_export_settings" "test" {
  filter = {
    # Used for query parameter, supported by PowerScale Platform API
    # scope = "user"
    # zone  = "System"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_export_settings.test
output "powerscale_nfs_export_settings" {
  value = data.powerscale_nfs_export_settings.test
}

# Returns NFS export settings
data "powerscale_nfs_export_settings" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_export_settings.all
output "powerscale_nfs_export_settings" {
  value = data.powerscale_nfs_export_settings.all
}

Schema

Optional

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

Read-Only

id (String) Identifier
nfs_export_settings (Attributes) NFS Export Settings (see below for nested schema)

Nested Schema for `filter`

Optional:

scope (String) If specified as “effective” or not specified, all fields are returned. If specified as “user”, only fields with non-default values are shown. If specified as “default”, the original values are returned.
zone (String) Specifies which access zone to use.

Nested Schema for `nfs_export_settings`

Read-Only:

all_dirs (Boolean) True if all directories under the specified paths are mountable.
block_size (Number) Specifies the block size returned by the NFS statfs procedure.
can_set_time (Boolean) True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
case_insensitive (Boolean) True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
case_preserving (Boolean) True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
chown_restricted (Boolean) True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
commit_asynchronous (Boolean) True if NFS commit requests execute asynchronously.
directory_transfer_size (Number) Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced.
encoding (String) Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified.
link_max (Number) Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
map_all (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
map_failure (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
map_full (Boolean) True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication.
map_lookup_uid (Boolean) True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations.
map_non_root (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
map_retry (Boolean) Determines whether searches for users specified in ‘map_all’, ‘map_root’ or ‘map_nonroot’ are retried if the search fails.
map_root (Attributes) Specifies the users and groups to which non-root and root clients are mapped. (see below for nested schema)
max_file_size (Number) Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
name_max_size (Number) Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
no_truncate (Boolean) True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.
read_only (Boolean) True if the export is set to read-only.
read_transfer_max_size (Number) Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
read_transfer_multiple (Number) Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
read_transfer_size (Number) Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
readdirplus (Boolean) True if ‘readdirplus’ requests are enabled. Enabling this property might improve network performance and is only available for NFSv3.
readdirplus_prefetch (Number) Sets the number of directory entries that are prefetched when a ‘readdirplus’ request is processed. (Deprecated.)
return_32bit_file_ids (Boolean) Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).
security_flavors (List of String) Specifies the authentication types that are supported for this export.
setattr_asynchronous (Boolean) True if set attribute operations execute asynchronously.
snapshot (String) Specifies the snapshot for all mounts.
symlinks (Boolean) True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced.
time_delta (Number) Specifies the resolution of all time values that are returned to the clients
write_datasync_action (String) Specifies the action to be taken when an NFSv3+ datasync write is requested.
write_datasync_reply (String) Specifies the stability disposition returned when an NFSv3+ datasync write is processed.
write_filesync_action (String) Specifies the action to be taken when an NFSv3+ filesync write is requested.
write_filesync_reply (String) Specifies the stability disposition returned when an NFSv3+ filesync write is processed.
write_transfer_max_size (Number) Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
write_transfer_multiple (Number) Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
write_transfer_size (Number) Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.
write_unstable_action (String) Specifies the action to be taken when an NFSv3+ unstable write is requested.
write_unstable_reply (String) Specifies the stability disposition returned when an NFSv3+ unstable write is processed.
zone (String) Specifies the zone in which the export is valid.

Nested Schema for `nfs_export_settings.map_all`

Read-Only:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_export_settings.map_all.primary_group`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_all.secondary_groups`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_all.user`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_failure`

Read-Only:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_export_settings.map_failure.primary_group`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_failure.secondary_groups`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_failure.user`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_non_root`

Read-Only:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_export_settings.map_non_root.primary_group`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_non_root.secondary_groups`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_non_root.user`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_root`

Read-Only:

enabled (Boolean) True if the user mapping is applied.
primary_group (Attributes) Specifies the persona of the file group. (see below for nested schema)
secondary_groups (Attributes List) Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID. (see below for nested schema)
user (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `nfs_export_settings.map_root.primary_group`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_root.secondary_groups`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `nfs_export_settings.map_root.user`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

V1.8.1: powerscale_nfs_global_settings data source

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

powerscale_nfs_global_settings (Data Source)

This datasource is used to query the NFS Global Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns NFS global settings
data "powerscale_nfs_global_settings" "test" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_global_settings.test
output "powerscale_nfs_global_settings" {
  value = data.powerscale_nfs_global_settings.test
}

Schema

Read-Only

id (String) Id of NFS Global settings. Readonly.
nfsv3_enabled (Boolean) True if NFSv3 is enabled.
nfsv3_rdma_enabled (Boolean) True if the RDMA is enabled for NFSv3.
nfsv4_enabled (Boolean) True if NFSv4 is enabled.
rpc_maxthreads (Number) Specifies the maximum number of threads in the nfsd thread pool.
rpc_minthreads (Number) Specifies the minimum number of threads in the nfsd thread pool.
rquota_enabled (Boolean) True if the rquota protocol is enabled.
service (Boolean) True if the NFS service is enabled. When set to false, the NFS service is disabled.

V1.8.1: powerscale_nfs_zone_settings data source

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

powerscale_nfs_zone_settings (Data Source)

This datasource is used to query the NFS Zone Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns PowerScale NFS Zone Settings based on filter
data "powerscale_nfs_zone_settings" "test" {
  filter {
    # Used for query parameter, supported by PowerScale Platform API
    zone = "System"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_zone_settings.test
output "powerscale_nfs_zone_settings_test" {
  value = data.powerscale_nfs_zone_settings.test
}

# Returns NFS Zone Settings
data "powerscale_nfs_zone_settings" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_nfs_zone_settings.all
output "powerscale_nfs_zone_settings_all" {
  value = data.powerscale_nfs_zone_settings.all
}

Schema

Optional

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

Read-Only

id (String) ID of NFS Zone Settings. Value of ID will be same as the access zone.
nfs_zone_settings (Attributes) NFS Zone Settings (see below for nested schema)

Nested Schema for `filter`

Optional:

zone (String) Access zone

Nested Schema for `nfs_zone_settings`

Read-Only:

nfsv4_allow_numeric_ids (Boolean) If true, sends owners and groups as UIDs and GIDs when look up fails or if the ’nfsv4_no_name’ property is set to 1.
nfsv4_domain (String) Specifies the domain or realm through which users and groups are associated.
nfsv4_no_domain (Boolean) If true, sends owners and groups without a domain name.
nfsv4_no_domain_uids (Boolean) If true, sends UIDs and GIDs without a domain name.
nfsv4_no_names (Boolean) If true, sends owners and groups as UIDs and GIDs.
nfsv4_replace_domain (Boolean) If true, replaces the owner or group domain with an NFS domain name.
zone (String) Specifies the access zones in which these settings apply.

V1.8.1: powerscale_ntpserver data source

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

powerscale_ntpserver (Data Source)

This datasource is used to query the existing NTP Servers from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can use NTP Servers to synchronize the system time

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing NTP servers from PowerScale array.

# Returns a list of PowerScale NTP servers based on names specified in the filter block.
data "powerscale_ntpserver" "test" {
  filter {
    names = ["ntp_server_name_example"]
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_ntpserver.test
output "powerscale_ntpserver" {
  value = data.powerscale_ntpserver.test
}

# Returns all PowerScale NTP servers on PowerScale array
data "powerscale_ntpserver" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_ntpserver.all
output "powerscale_ntpserver_data_all" {
  value = data.powerscale_ntpserver.all
}

Schema

Optional

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

Read-Only

id (String) Unique identifier of the NTP Server instance.
ntp_servers_details (Attributes List) List of NTP Servers. (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String) Filter NTP Servers by names.

Nested Schema for `ntp_servers_details`

Read-Only:

id (String) Field ID.
key (String) Key value from key_file that maps to this server.
name (String) NTP server name.

V1.8.1: powerscale_ntpsettings data source

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

powerscale_ntpsettings (Data Source)

This datasource is used to query the NTP Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can use NTP Settings to change the settings of NTP Servers

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of the NTP settings from PowerScale array.

# Returns the PowerScale NTP settings on PowerScale array
data "powerscale_ntpsettings" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_ntpsettings.all
output "powerscale_ntpsettings_data_all" {
  value = data.powerscale_ntpsettings.all
}

Schema

Read-Only

chimers (Number) Number of nodes that will contact the NTP servers.
excluded (List of String) Node number (LNN) for nodes excluded from chimer duty.
key_file (String) Path to NTP key file within /ifs.

V1.8.1: powerscale_quota data source

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

powerscale_quota (Data Source)

This datasource is used to query the existing quotas from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. Quota module monitors and enforces administrator-defined storage limits

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# The SmartQuotas module is an optional quota-management tool that monitors and enforces administrator-defined storage limits.

# Returns a list of PowerScale quotas based on filter block
data "powerscale_quota" "example_quotas" {
  filter {
    # Used for query parameter, supported by PowerScale Platform API

    # Only list quotas with this enforcement (non-accounting).
    # enforced = false

    # Set to true to only list quotas which have exceeded one or more of their thresholds.
    # exceeded = false

    # Only list quotas with this setting for include_snapshots.
    # include_snapshots = true

    # Only list quotas with this setting for include_snapshots.
    # path = "/ifs/tfacc_file_system_test"

    # Only list user or group quotas matching this persona (must be used with the corresponding type argument).
    # Format is <PERSONA_TYPE>:<string/integer>, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.
    # persona= "SID:0"

    # If used with the path argument, match all quotas at that path or any descendent sub-directory.
    # recurse_path_children = true

    # If used with the path argument, match all quotas at that path or any parent directory.
    # recurse_path_parents  = true

    # Use the named report as a source rather than the live quotas. See the /quota/reports resource for a list of valid reports.
    # report_id  = "id"

    # Only list quotas matching this type.
    # Allowed values: directory, user, group, default-directory, default-user, default-group
    # type = "directory"

    # Optional named zone to use for user and group resolution.
    # zone  = "System"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_quota.example_quotas
output "powerscale_quota" {
  value = data.powerscale_quota.example_quotas
}

# Returns all of the PowerScale Quotas in default zone
data "powerscale_quota" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_quota.all
output "powerscale_quota_all" {
  value = data.powerscale_quota.all
}

Schema

Optional

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

Read-Only

id (String) Identifier
quotas (Attributes List) List of Quotas (see below for nested schema)

Nested Schema for `filter`

Optional:

enforced (Boolean) Only list quotas with this enforcement (non-accounting).
exceeded (Boolean) Set to true to only list quotas which have exceeded one or more of their thresholds.
include_snapshots (Boolean) Only list quotas with this setting for include_snapshots.
path (String) Only list quotas matching this path (see also recurse_path_*).
persona (String) Only list user or group quotas matching this persona (must be used with the corresponding type argument).
recurse_path_children (Boolean) If used with the path argument, match all quotas at that path or any descendent sub-directory.
recurse_path_parents (Boolean) If used with the path argument, match all quotas at that path or any parent directory.
report_id (String) Use the named report as a source rather than the live quotas.
type (String) Only list quotas matching this type.
zone (String) Optional named zone to use for user and group resolution.

Nested Schema for `quotas`

Read-Only:

container (Boolean) If true, SMB shares using the quota directory see the quota thresholds as share size.
efficiency_ratio (Number) Represents the ratio of logical space provided to physical space used. This accounts for protection overhead, metadata, and compression ratios for the data.
enforced (Boolean) True if the quota provides enforcement, otherwise an accounting quota.
id (String) The system ID given to the quota.
include_snapshots (Boolean) If true, quota governs snapshot data as well as head data.
linked (Boolean) For user, group and directory quotas, true if the quota is linked and controlled by a parent default-* quota. Linked quotas cannot be modified until they are unlinked.
notifications (String) Summary of notifications: ‘custom’ indicates one or more notification rules available from the notifications sub-resource; ‘default’ indicates system default rules are used; ‘disabled’ indicates that no notifications will be used for this quota.; ‘badmap’ indicates that notification rule has problem in rule map.
path (String) The ifs path governed.
persona (Attributes) Specifies the persona of the file group. (see below for nested schema)
ready (Boolean) True if the default resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
reduction_ratio (Number) Represents the ratio of logical space provided to physical data space used. This accounts for compression and data deduplication effects.
thresholds (Attributes) The thresholds of quota (see below for nested schema)
thresholds_on (String) Thresholds apply on quota accounting metric.
type (String) The type of quota.
usage (Attributes) The usage of quota (see below for nested schema)

Nested Schema for `quotas.persona`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `quotas.thresholds`

Read-Only:

advisory (Number) Usage bytes at which notifications will be sent but writes will not be denied.
advisory_exceeded (Boolean) True if the advisory threshold has been hit.
advisory_last_exceeded (Number) Time at which advisory threshold was hit.
hard (Number) Usage bytes at which further writes will be denied.
hard_exceeded (Boolean) True if the hard threshold has been hit.
hard_last_exceeded (Number) Time at which hard threshold was hit.
percent_advisory (Number) Advisory threshold as percent of hard threshold. Usage bytes at which notifications will be sent but writes will not be denied.
percent_soft (Number) Soft threshold as percent of hard threshold. Usage bytes at which notifications will be sent and soft grace time will be started.
soft (Number) Usage bytes at which notifications will be sent and soft grace time will be started.
soft_exceeded (Boolean) True if the soft threshold has been hit.
soft_grace (Number) Time in seconds after which the soft threshold has been hit before writes will be denied.
soft_last_exceeded (Number) Time at which soft threshold was hit

Nested Schema for `quotas.usage`

Read-Only:

applogical (Number) Bytes used by governed data apparent to application.
applogical_ready (Boolean) True if applogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
fslogical (Number) Bytes used by governed data apparent to filesystem.
fslogical_ready (Boolean) True if fslogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
fsphysical (Number) Physical data usage adjusted to account for shadow store efficiency
fsphysical_ready (Boolean) True if fsphysical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
inodes (Number) Number of inodes (filesystem entities) used by governed data.
inodes_ready (Boolean) True if inodes resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
physical (Number) Bytes used for governed data and filesystem overhead.
physical_data (Number) Number of physical blocks for file data
physical_data_ready (Boolean) True if physical_data resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
physical_protection (Number) Number of physical blocks for file protection
physical_protection_ready (Boolean) True if physical_protection resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
physical_ready (Boolean) True if physical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.
shadow_refs (Number) Number of shadow references (cloned, deduplicated or packed filesystem blocks) used by governed data.
shadow_refs_ready (Boolean) True if shadow_refs resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.

V1.8.1: powerscale_role data source

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

powerscale_role (Data Source)

This datasource is used to query the existing roles from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can permit and limit access to administrative areas of your cluster on a per-user basis through roles.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing Role from PowerScale array.

# Returns a list of PowerScale Role based on the filters specified in the filter block.
data "powerscale_role" "test" {
  filter {
    names = ["SystemAdmin"]
    zone  = "System"
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_role.test
output "powerscale_role" {
  value = data.powerscale_role.test
}

# Returns all PowerScale Role on PowerScale array
data "powerscale_role" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_role.all
output "powerscale_role_data_all" {
  value = data.powerscale_role.all
}

Schema

Optional

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

Read-Only

id (String) Unique identifier of the network pool instance.
roles_details (Attributes List) List of Roles. (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String) Filter roles by names.
zone (String) Specifies which access zone to use.

Nested Schema for `roles_details`

Read-Only:

description (String) Specifies the description of the role.
id (String) Specifies the ID of the role.
members (Attributes List) Specifies the users or groups that have this role. (see below for nested schema)
name (String) Specifies the name of the role.
privileges (Attributes List) Specifies the privileges granted by this role. (see below for nested schema)

Nested Schema for `roles_details.members`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `roles_details.privileges`

Read-Only:

id (String) Specifies the ID of the privilege.
name (String) Specifies the name of the privilege.
permission (String) permission of the privilege, ‘r’ = read , ‘x’ = read-execute, ‘w’ = read-execute-write, ‘-’ = no permission

V1.8.1: powerscale_roleprivilege data source

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

powerscale_roleprivilege (Data Source)

This datasource is used to query the existing Role Privileges from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can designate certain privileges as no permission, read, execute, or write when adding the privilege to a role.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing role privileges from PowerScale array.

# Returns a list of PowerScale role privileges based on names in the filter block.
data "powerscale_roleprivilege" "test" {
  filter {
    #  Optional query parameters
    #  This will return the role privileges whose name contains the key word (case-insensitive)
    names = ["Shutdown"]
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_roleprivilege.test
output "powerscale_roleprivilege" {
  value = data.powerscale_roleprivilege.test
}

# Returns all PowerScale role privileges on PowerScale array
data "powerscale_roleprivilege" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_roleprivilege.all
output "powerscale_roleprivilege_data_all" {
  value = data.powerscale_roleprivilege.all
}

Schema

Optional

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

Read-Only

id (String) Unique identifier of the Role Privilege instance.
role_privileges_details (Attributes List) List of Role Privileges. (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String) Filter Role Privileges by names.

Nested Schema for `role_privileges_details`

Read-Only:

category (String) Specifies the general categorization of the privilege.
description (String) Specifies a short description of the privilege.
id (String) Specifies the ID of the privilege.
name (String) Specifies the name of the privilege.
parent_id (String) Specifies the parent ID of the privilege.
permission (String) Permissions the privilege has r=read , x=read-execute, w=read-execute-write.
privilegelevel (String) Specifies the level of the privilege.
uri (String) Specifies the associated uri for the privilege.

V1.8.1: powerscale_s3_bucket data source

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

powerscale_s3_bucket (Data Source)

Access S3 Buckets. This datasource is used to query the existing S3 Bucket from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale S3 Bucket map to the PowerScale file system as base directory for Objects.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.

# Returns a list of PowerScale s3 bucket based on filter block
data "powerscale_s3_bucket" "example_s3_buckets" {
  filter {
    # Used for query parameter, supported by PowerScale Platform API

    # Only list s3 bucket in this zone.
    # zone = "System"

    # Only list s3 bucket owned by this.
    # owner = "root"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_s3_bucket.example_s3_buckets
output "powerscale_s3_bucket" {
  value = data.powerscale_s3_bucket.example_s3_buckets
}

# Returns all of the PowerScale S3 Bucket in default zone
data "powerscale_s3_bucket" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_s3_bucket.all
output "powerscale_s3_bucket_all" {
  value = data.powerscale_s3_bucket.all
}

Schema

Optional

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

Read-Only

id (String) Identifier
s3_buckets (Attributes List) List of S3 Buckets (see below for nested schema)

Nested Schema for `filter`

Optional:

owner (String) Specifies the name of the owner.
zone (String) Specifies which access zone to use.

Nested Schema for `s3_buckets`

Read-Only:

acl (Attributes List) Specifies properties for an S3 Access Control Entry. (see below for nested schema)
description (String) Description for this S3 bucket.
id (String) Bucket ID.
name (String) Bucket name.
object_acl_policy (String) Set behavior of modifying object acls
owner (String) Specifies the name of the owner.
path (String) Path of bucket within /ifs.
zid (Number) Zone ID

Nested Schema for `s3_buckets.acl`

Read-Only:

grantee (Attributes) Specifies the persona of the file group. (see below for nested schema)
permission (String) Specifies the S3 rights being allowed.

Nested Schema for `s3_buckets.acl.grantee`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

V1.8.1: powerscale_smartpool_settings data source

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

powerscale_smartpool_settings (Data Source)

This datasource is used to query the SmartPools settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale SmartPools settings provide the ability to configure SmartPools on the cluster.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns SmartPool settings
data "powerscale_smartpool_settings" "settings" {
}

output "powerscale_smartpool_settings" {
  value = data.powerscale_smartpool_settings.settings
}

Schema

Optional

default_transfer_limit_pct (Number) Applies to all storagepools that fall back on the default transfer limit. Stop moving files to this pool when this limit is met. The value must be between 0 and 100. Only available for PowerScale 9.5 and above.
default_transfer_limit_state (String) How the default transfer limit value is applied.Only available for PowerScale 9.5 and above.

Read-Only

global_namespace_acceleration_enabled (Boolean) Enable global namespace acceleration.
global_namespace_acceleration_state (String) Whether or not namespace operation optimizations are currently in effect.
id (String) Id of SmartPools settings. Readonly. Fixed value of “smartpools_settings”
manage_io_optimization (Boolean) Manage I/O optimization settings.
manage_io_optimization_apply_to_files (Boolean) Apply to files with manually-managed I/O optimization settings.
manage_protection (Boolean) Manage protection settings.
manage_protection_apply_to_files (Boolean) Apply to files with manually-managed protection.
protect_directories_one_level_higher (Boolean) Increase directory protection to a higher requested protection than its contents.
spillover_enabled (Boolean) Enable global spillover.
spillover_target (Attributes) Spillover data target. (see below for nested schema)
ssd_l3_cache_default_enabled (Boolean) Use SSDs as L3 cache by default for new node pools.
ssd_qab_mirrors (String) Controls number of mirrors of QAB blocks to place on SSDs.
ssd_system_btree_mirrors (String) Controls number of mirrors of system B-tree blocks to place on SSDs.
ssd_system_delta_mirrors (String) Controls number of mirrors of system delta blocks to place on SSDs.
virtual_hot_spare_deny_writes (Boolean) Deny data writes to reserved disk space
virtual_hot_spare_hide_spare (Boolean) Subtract the space reserved for the virtual hot spare when calculating available free space
virtual_hot_spare_limit_drives (Number) The number of drives to reserve for the virtual hot spare, from 0-4.
virtual_hot_spare_limit_percent (Number) The percent space to reserve for the virtual hot spare, from 0-20.

Nested Schema for `spillover_target`

Read-Only:

id (Number) Target pool ID if target specified, otherwise null.
name (String) Target pool name if target specified, otherwise null.
type (String) Type of target pool.

V1.8.1: powerscale_smb_server_settings data source

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

powerscale_smb_server_settings (Data Source)

This datasource is used to query the SMB Server Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns PowerScale SMB Server Settings based on filter
data "powerscale_smb_server_settings" "test" {
  filter {
    # Used for query parameter, supported by PowerScale Platform API
    scope = "effective"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_server_settings.test
output "powerscale_smb_server_settings_test" {
  value = data.powerscale_smb_server_settings.test
}

# Returns SMB Server Settings
data "powerscale_smb_server_settings" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_server_settings.all
output "powerscale_smb_server_settings_all" {
  value = data.powerscale_smb_server_settings.all
}

Schema

Optional

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

Read-Only

id (String) ID of SMB Server Settings.
smb_server_settings (Attributes) SMB Server Settings (see below for nested schema)

Nested Schema for `filter`

Optional:

scope (String) If specified as “effective” or not specified, all fields are returned. If specified as “user”, only fields with non-default values are shown. If specified as “default”, the original values are returned.

Nested Schema for `smb_server_settings`

Read-Only:

access_based_share_enum (Boolean) Only enumerate files and folders the requesting user has access to.
audit_fileshare (String) Specify level of file share audit events to log.
audit_logon (String) Specify the level of logon audit events to log.
dot_snap_accessible_child (Boolean) Allow access to .snapshot directories in share subdirectories.
dot_snap_accessible_root (Boolean) Allow access to the .snapshot directory in the root of the share.
dot_snap_visible_child (Boolean) Show .snapshot directories in share subdirectories.
dot_snap_visible_root (Boolean) Show the .snapshot directory in the root of a share.
enable_security_signatures (Boolean) Indicates whether the server supports signed SMB packets.
guest_user (String) Specifies the fully-qualified user to use for guest access.
ignore_eas (Boolean) Specify whether to ignore EAs on files.
onefs_cpu_multiplier (Number) Specify the number of OneFS driver worker threads per CPU.
onefs_num_workers (Number) Set the maximum number of OneFS driver worker threads.
reject_unencrypted_access (Boolean) If SMB3 encryption is enabled, reject unencrypted access from clients.
require_security_signatures (Boolean) Indicates whether the server requires signed SMB packets.
server_side_copy (Boolean) Enable Server Side Copy.
server_string (String) Provides a description of the server.
service (Boolean) Specify whether service is enabled.
srv_cpu_multiplier (Number) Specify the number of SRV service worker threads per CPU.
srv_num_workers (Number) Set the maximum number of SRV service worker threads.
support_multichannel (Boolean) Support multichannel.
support_netbios (Boolean) Support NetBIOS.
support_smb2 (Boolean) Support the SMB2 protocol on the server.
support_smb3_encryption (Boolean) Support the SMB3 encryption on the server.

V1.8.1: powerscale_smb_share data source

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

powerscale_smb_share (Data Source)

This datasource is used to query the existing SMB shares from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale SMB shares provide clients network access to file system resources on the cluster.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SMB shares provide clients network access to file system resources on the cluster

# Returns a list of PowerScale SMB shares based on name filter block
data "powerscale_smb_share" "example_smb_shares" {
  filter {
    # Used for specify names of SMB shares
    names = ["tfacc_smb_share"]

    # Used for query parameter, supported by PowerScale Platform API
    # dir = "ASC"
    # limit = 1
    # offset = "0"
    # resume = "resume-token"
    # scope = "default"
    # sort = "id"
    # zone = System
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_share.example_smb_shares
output "powerscale_smb_share" {
  value = data.powerscale_smb_share.example_smb_shares
}

# Returns all of the PowerScale SMB shares in default zone
data "powerscale_smb_share" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_share.all_smb_shares
output "powerscale_smb_share_data_all" {
  value = data.powerscale_smb_share.all_smb_shares
}

Schema

Optional

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

Read-Only

id (String) Identifier
smb_shares (Attributes List) List of smb shares (see below for nested schema)

Nested Schema for `filter`

Optional:

dir (String) The direction of the sort.
limit (Number) Return no more than this many results at once (see resume).
names (Set of String) Names to filter smb shares.
offset (Number) The position of the first item returned for a paginated query within the full result set.
resume (String) Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
scope (String) If specified as “effective” or not specified, all fields are returned. If specified as “user”, only fields with non-default values are shown. If specified as “default”, the original values are returned.
sort (String) The field that will be used for sorting.
zone (String) Specifies which access zone to use.

Nested Schema for `smb_shares`

Read-Only:

access_based_enumeration (Boolean) Only enumerate files and folders the requesting user has access to.
access_based_enumeration_root_only (Boolean) Access-based enumeration on only the root directory of the share.
allow_delete_readonly (Boolean) Allow deletion of read-only files in the share.
allow_execute_always (Boolean) Allows users to execute files they have read rights for.
allow_variable_expansion (Boolean) Allow automatic expansion of variables for home directories.
auto_create_directory (Boolean) Automatically create home directories.
browsable (Boolean) Share is visible in net view and the browse list.
ca_timeout (Number) Persistent open timeout for the share.
ca_write_integrity (String) Specify the level of write-integrity on continuously available shares.
change_notify (String) Level of change notification alerts on the share.
continuously_available (Boolean) Specify if persistent opens are allowed on the share.
create_permissions (String) Create permissions for new files and directories in share.
csc_policy (String) Client-side caching policy for the shares.
description (String) Description for this SMB share.
directory_create_mask (Number) Directory create mask bits.
directory_create_mode (Number) Directory create mode bits.
file_create_mask (Number) File create mask bits.
file_create_mode (Number) File create mode bits.
file_filter_extensions (List of String) Specifies the list of file extensions.
file_filter_type (String) Specifies if filter list is for deny or allow. Default is deny.
file_filtering_enabled (Boolean) Enables file filtering on this zone.
hide_dot_files (Boolean) Hide files and directories that begin with a period ‘.’.
host_acl (List of String) An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
id (String) Share ID.
impersonate_guest (String) Specify the condition in which user access is done as the guest account.
impersonate_user (String) User account to be used as guest account.
inheritable_path_acl (Boolean) Set the inheritable ACL on the share path.
mangle_byte_start (Number) Specifies the wchar_t starting point for automatic byte mangling.
mangle_map (List of String) Character mangle map.
name (String) Share name.
ntfs_acl_support (Boolean) Support NTFS ACLs on files and directories.
oplocks (Boolean) Support oplocks.
path (String) Path of share within /ifs.
permissions (Attributes List) Specifies an ordered list of permission modifications. (see below for nested schema)
run_as_root (Attributes List) Allow account to run as root. (see below for nested schema)
smb3_encryption_enabled (Boolean) Enables SMB3 encryption for the share.
sparse_file (Boolean) Enables sparse file.
strict_ca_lockout (Boolean) Specifies if persistent opens would do strict lockout on the share.
strict_flush (Boolean) Handle SMB flush operations.
strict_locking (Boolean) Specifies whether byte range locks contend against SMB I/O.
zid (Number) Numeric ID of the access zone which contains this SMB share

Nested Schema for `smb_shares.permissions`

Read-Only:

permission (String) Specifies the file system rights that are allowed or denied.
permission_type (String) Determines whether the permission is allowed or denied.
trustee (Attributes) Specifies the persona of the file group. (see below for nested schema)

Nested Schema for `smb_shares.permissions.trustee`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

Nested Schema for `smb_shares.run_as_root`

Read-Only:

id (String) Specifies the serialized form of a persona, which can be ‘UID:0’, ‘USER:name’, ‘GID:0’, ‘GROUP:wheel’, or ‘SID:S-1-1’.
name (String) Specifies the persona name, which must be combined with a type.
type (String) Specifies the type of persona, which must be combined with a name.

V1.8.1: powerscale_smb_share_settings data source

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

powerscale_smb_share_settings (Data Source)

This datasource is used to query the existing SMB shares settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale SMB shares settings provide clients network access to file system resources on the cluster.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SMB shares settings provide clients network access to file system resources on the cluster

# Returns PowerScale SMB shares settings based on scope or zone filter
data "powerscale_smb_share_settings" "test" {
  filter {
    # Used for query parameter, supported by PowerScale Platform API
    scope = "effective"
    zone  = "tfaccAccessZone"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_share_settings.test
output "powerscale_smb_share_settings" {
  value = data.powerscale_smb_share_settings.test
}

# Returns all of the PowerScale SMB shares settings in default zone
data "powerscale_smb_share_settings" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_smb_share_settings.all
output "powerscale_smb_share_settings_data_all" {
  value = data.powerscale_smb_share_settings.all
}

Schema

Optional

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

Read-Only

id (String) Identifier
smb_share_settings (Attributes) (see below for nested schema)

Nested Schema for `filter`

Optional:

scope (String) If specified as “effective” or not specified, all fields are returned. If specified as “user”, only fields with non-default values are shown. If specified as “default”, the original values are returned.
zone (String) Specifies which access zone to use.

Nested Schema for `smb_share_settings`

Read-Only:

access_based_enumeration (Boolean) Only enumerate files and folders the requesting user has access to.
access_based_enumeration_root_only (Boolean) Access-based enumeration on only the root directory of the share.
allow_delete_readonly (Boolean) Allow deletion of read-only files in the share.
allow_execute_always (Boolean) Allows users to execute files they have read rights for.
ca_timeout (Number) Persistent open timeout for the share.
ca_write_integrity (String) Specify the level of write-integrity on continuously available shares. Acceptable values: none, write-read-coherent, full
change_notify (String) Specify level of change notification alerts on the share. Acceptable values: all, norecurse, none
continuously_available (Boolean) Specify if persistent opens are allowed on the share.
create_permissions (String) Set the create permissions for new files and directories in share. Acceptable values: default acl, inherit mode bits, use create mask and mode
csc_policy (String) Client-side caching policy for the shares. Acceptable values: manual, documents, programs, none
directory_create_mask (Number) Unix umask or mode bits.
directory_create_mode (Number) Unix umask or mode bits.
file_create_mask (Number) Unix umask or mode bits.
file_create_mode (Number) Unix umask or mode bits.
file_filter_extensions (List of String) Specifies the list of file extensions.
file_filter_type (String) Specifies if filter list is for deny or allow. Default is deny.
file_filtering_enabled (Boolean) Enables file filtering on the share.
hide_dot_files (Boolean) Hide files and directories that begin with a period ‘.’.
host_acl (List of String) An ACL expressing which hosts are allowed access. A deny clause must be the final entry.
impersonate_guest (String) Specify the condition in which user access is done as the guest account. Acceptable values: always, bad user, never
impersonate_user (String) User account to be used as guest account.
mangle_byte_start (Number) Specifies the wchar_t starting point for automatic byte mangling.
mangle_map (List of String) Character mangle map.
ntfs_acl_support (Boolean) Support NTFS ACLs on files and directories.
oplocks (Boolean) Allow oplock requests.
smb3_encryption_enabled (Boolean) Enables SMB3 encryption for the share.
sparse_file (Boolean) Enables sparse file.
strict_ca_lockout (Boolean) Specifies if persistent opens would do strict lockout on the share.
strict_flush (Boolean) Handle SMB flush operations.
strict_locking (Boolean) Specifies whether byte range locks contend against SMB I/O.
zone (String) Name of the access zone in which to update settings

V1.8.1: powerscale_snapshot data source

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

powerscale_snapshot (Data Source)

This datasource is used to query the existing Snapshots from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale Snapshots is a logical pointer to data that is stored on a cluster at a specific point in time.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns all of the PowerScale snapshots and their details
# PowerScale Snapshots is a logical pointer to data that is stored on a cluster at a specific point in time.
data "powerscale_snapshot" "all" {
}

output "powerscale_snapshot_data_all" {
  value = data.powerscale_snapshot.all
}

# Returns a subset of the PowerScale snapshots in order based on the filters provided in the filter block and their details
data "powerscale_snapshot" "test" {
  filter {
    path = "/ifs"
    sort = "name"
    dir  = "DESC"
  }
}

#Returns the snapshot with the given name
data "powerscale_snapshot" "test" {
  filter {
    name = "name"
  }
}

output "powerscale_snapshot" {
  value = data.powerscale_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.powerscale_snapshot.all

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

dir (String) The direction of the sort.
limit (Number) Return no more than this many results at once (see resume).
name (String)
path (String)
schedule (String) The schedule of the snapshot.
sort (String) The field that will be used for sorting.
state (String) The state of the snapshot.
type (String) The type of the snapshot.

Nested Schema for `snapshots_details`

Optional:

set_expires (String) The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.

Read-Only:

alias (String) The name of the alias, none for real snapshots.
created (Number) The Unix Epoch time the snapshot was created.
expires (Number) The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
has_locks (Boolean) True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of lock.
id (String) The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
name (String) The user or system supplied snapshot name. This will be null for snapshots pending delete.
path (String) The /ifs path snapshotted.
pct_filesystem (Number) Percentage of /ifs used for storing this snapshot.
pct_reserve (Number) Percentage of configured snapshot reserved used for storing this snapshot.
schedule (String) The name of the schedule used to create this snapshot, if applicable.
shadow_bytes (Number) The amount of shadow bytes referred to by this snapshot.
size (Number) The amount of storage in bytes used to store this snapshot.
state (String) Snapshot state.
target_id (Number) The ID of the snapshot pointed to if this is an alias. An alias to the live filesystem is represented by the value -1.
target_name (String) The name of the snapshot pointed to if this is an alias.

V1.8.1: powerscale_snapshot_schedule data source

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

powerscale_snapshot_schedule (Data Source)

This datasource is used to query the existing Snapshot Schedules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. Uses are able to see information like duration, path, schedule, name etc. for the existing snapshot schedules

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SMB shares provide clients network access to file system resources on the cluster

# Returns a list of all the PowerScale Snapshot schedules
data "powerscale_snapshot_schedule" "example_snapshot_schedule_all" {
  filter {

    # Used for query parameter, supported by PowerScale Platform API
    #The direction of the sort.Supported Values:ASC , DESC
    # dir = "ASC"
    # Return no more than this many results at once.
    # limit = 1
    # The field that will be used for sorting. Choices are id, name, path, pattern, schedule, duration, alias, next_run, and next_snapshot. Default is id.
    # sort = "name"
  }
}
output "powerscale_snapshot_schedule_all" {
  value = data.powerscale_snapshot_schedule.example_snapshot_schedule_all
}

# Returns a list of PowerScale Snapshot schedules based on path filter block
data "powerscale_snapshot_schedule" "example_snapshot_schedule" {
  filter {
    # Used to specify names of snapshot schedules
    names = ["Snapshot schedule 370395356"]

    # Used for query parameter, supported by PowerScale Platform API
    #The direction of the sort.Supported Values:ASC , DESC
    # dir = "ASC"
    # Return no more than this many results at once.
    # limit = 1
    # The field that will be used for sorting. Choices are id, name, path, pattern, schedule, duration, alias, next_run, and next_snapshot. Default is id.
    # sort = "name"

  }
}
output "powerscale_snapshot_schedule" {
  value = data.powerscale_snapshot_schedule.example_snapshot_schedule
}

Schema

Optional

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

Read-Only

id (String) Identifier
schedules (Attributes List) List of snapshot schedules (see below for nested schema)

Nested Schema for `filter`

Optional:

dir (String) The direction of the sort.Supported Values:ASC , DESC
limit (Number) Return no more than this many results at once.
names (Set of String) Names to filter snapshot schedules.
sort (String) The field that will be used for sorting. Choices are id, name, path, pattern, schedule, duration, alias, next_run, and next_snapshot. Default is id.

Nested Schema for `schedules`

Optional:

alias (String) Alias name to create for each snapshot.
duration (Number) Time in seconds added to creation time to construction expiration time.
next_run (Number) Unix Epoch time of next snapshot to be created.
next_snapshot (String) Formatted name (see pattern) of next snapshot to be created
pattern (String) Pattern expanded with strftime to create snapshot names.
schedule (String) The isidate compatible natural language description of the schedule.

Read-Only:

id (Number) The system ID given to the schedule.
name (String) The schedule name.
path (String) The /ifs path snapshotted.

V1.8.1: powerscale_storagepool_tier data source

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

powerscale_storagepool_tier (Data Source)

This datasource is used to query the Storagepool tiers from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale Storagepool tiers provide the ability to configure Storagepool tiers on the cluster.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns a list of PowerScale Storage pool tier
data "powerscale_storagepool_tier" "example_storagepool_tier" {

}

output "powerscale_storagepool_tier" {
  value = data.powerscale_storagepool_tier.example_storagepool_tier
}

Schema

Read-Only

id (String) Id of Storagepool tiers. Readonly. Fixed value of “storagepool_tiers”
storagepool_tiers (Attributes List) List of Storagepool tiers (see below for nested schema)

Nested Schema for `storagepool_tiers`

Read-Only:

children (List of String) The names or IDs of the tier’s children.
id (String) Id of storagepool tier.
lnns (List of Number) The nodes that are part of this tier.
name (String) Name of storagepool tier.
transfer_limit_pct (Number) Stop moving files to this tier when this limit is met.
transfer_limit_state (String) How the transfer limit value is being applied.
usage (Attributes) Usage. (see below for nested schema)

Nested Schema for `storagepool_tiers.usage`

Read-Only:

avail_bytes (String) Available free bytes remaining in the pool when virtual hot spare is taken into account.
avail_hdd_bytes (String) Available free bytes remaining in the pool on HDD drives when virtual hot spare is taken into account.
avail_ssd_bytes (String) Available free bytes remaining in the pool on SSD drives when virtual hot spare is taken into account.
balanced (Boolean) Whether or not the pool usage is currently balanced.
free_bytes (String) Free bytes remaining in the pool.
free_hdd_bytes (String) Free bytes remaining in the pool on HDD drives.
free_ssd_bytes (String) Free bytes remaining in the pool on SSD drives.
pct_used (String) Percentage of usable space in the pool which is used.
pct_used_hdd (String) Percentage of usable space on HDD drives in the pool which is used.
pct_used_ssd (String) Percentage of usable space on SSD drives in the pool which is used.
total_bytes (String) Total bytes in the pool.
total_hdd_bytes (String) Total bytes in the pool on HDD drives.
total_ssd_bytes (String) Total bytes in the pool on SSD drives.
usable_bytes (String) Total bytes in the pool drives when virtual hot spare is taken into account.
usable_hdd_bytes (String) Total bytes in the pool on HDD drives when virtual hot spare is taken into account.
usable_ssd_bytes (String) Total bytes in the pool on SSD drives when virtual hot spare is taken into account.
used_bytes (String) Used bytes in the pool.
used_hdd_bytes (String) Used bytes in the pool on HDD drives.
used_ssd_bytes (String) Used bytes in the pool on SSD drives.
virtual_hot_spare_bytes (String) Bytes reserved for virtual hot spare in the pool.

V1.8.1: powerscale_subnet data source

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

powerscale_subnet (Data Source)

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

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns all of the PowerScale subnets and their details
data "powerscale_subnet" "all" {
}

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

# Returns a subset of the PowerScale subnets based on `names` and `groupnet_name`
data "powerscale_subnet" "test" {
  # Optional list  filter upon
  filter {
    names         = ["subnet0"]
    groupnet_name = "groupnet0"
  }
}

output "powerscale_subnet" {
  value = data.powerscale_subnet.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.powerscale_subnet.all

Schema

Optional

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

Read-Only

id (String) Unique identifier
subnets (Attributes List) List of subnets (see below for nested schema)

Nested Schema for `filter`

Optional:

groupnet_name (String) Specifies which groupnet to query.
names (Set of String) List of subnet name.

Nested Schema for `subnets`

Read-Only:

addr_family (String) IP address format.
base_addr (String) The base IP address.
description (String) A description of the subnet.
dsr_addrs (List of String) List of Direct Server Return addresses.
gateway (String) Gateway IP address.
gateway_priority (Number) Gateway priority.
groupnet (String) Name of the groupnet this subnet belongs to.
id (String) Unique Subnet ID.
mtu (Number) MTU of the subnet.
name (String) The name of the subnet.
pools (List of String) Name of the pools in the subnet.
prefixlen (Number) Subnet Prefix Length.
sc_service_addrs (Attributes List) List of IP addresses that SmartConnect listens for DNS requests. (see below for nested schema)
sc_service_name (String) Domain Name corresponding to the SmartConnect Service Address.
vlan_enabled (Boolean) VLAN tagging enabled or disabled.
vlan_id (Number) VLAN ID for all interfaces in the subnet.

Nested Schema for `subnets.sc_service_addrs`

Read-Only:

high (String) High IP
low (String) Low IP

V1.8.1: powerscale_synciq_global_settings data source

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

powerscale_synciq_global_settings (Data Source)

This datasource is used to query the SyncIQ Global Settings from PowerScale array. The information fetched from this datasource can be used for getting the details.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of the SyncIQ Global Settings from PowerScale array.

# Returns the PowerScale SyncIQ Global settings on PowerScale array
data "powerscale_synciq_global_settings" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_synciq_global_settings.all
output "powerscale_synciq_global_settings_all" {
  value = data.powerscale_synciq_global_settings.all
}

Schema

Read-Only

bandwidth_reservation_reserve_absolute (Number) The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidth_reservation_reserve_percentage.
bandwidth_reservation_reserve_percentage (Number) The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
cluster_certificate_id (String) The ID of this cluster’s certificate being used for encryption.
encryption_cipher_list (String) The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.
encryption_required (Boolean) If true, requires all SyncIQ policies to utilize encrypted communications.
force_interface (Boolean) NOTE: This field should not be changed without the help of PowerScale support. Default for the “force_interface” property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the “source_network” field. This option can be useful if there are multiple interfaces for the given source subnet.
max_concurrent_jobs (Number) The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.
ocsp_address (String) The address of the OCSP responder to which to connect.
ocsp_issuer_certificate_id (String) The ID of the certificate authority that issued the certificate whose revocation status is being checked.
password_set (Boolean) Indicates if a password is set for authentication. Password value is not shown with GET.
preferred_rpo_alert (Number) If specified, display as default RPO Alert value for new policy creation via WebUI
renegotiation_period (Number) If specified, the duration to persist encrypted connection before forcing a renegotiation.
report_email (Set of String) Email sync reports to these addresses.
report_max_age (Number) The default length of time (in seconds) a policy report will be stored.
report_max_count (Number) The default maximum number of reports to retain for a policy.
restrict_target_network (Boolean) Default for the “restrict_target_network” property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the “target_host” field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.
rpo_alerts (Boolean) If disabled, no RPO alerts will be generated.
service (String) Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.
service_history_max_age (Number) Maximum age of service information to maintain, in seconds.
service_history_max_count (Number) Maximum number of historical service information records to maintain.
source_network (Attributes) Restricts replication policies on the local cluster to running on the specified subnet and pool. (see below for nested schema)
tw_chkpt_interval (Number) The interval (in seconds) in which treewalk syncs are forced to checkpoint.
use_workers_per_node (Boolean) If enabled, SyncIQ will use the deprecated workers_per_node field with worker pools functionality and limit workers accordingly.

Nested Schema for `source_network`

Read-Only:

pool (String) The pool to restrict replication policies to.
subnet (String) The subnet to restrict replication policies to.

V1.8.1: powerscale_synciq_peer_certificate data source

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

powerscale_synciq_peer_certificate (Data Source)

This datasource is used to query the existing SyncIQ Peer Certificates from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SyncIQ Certificate allows you to get a list of SyncIQ Peer Certificates or a peer certificate by its ID.

# Returns a list of PowerScale SyncIQ Certificates
data "powerscale_synciq_peer_certificate" "all_certificates" {
}

# Returns a the PowerScale SyncIQ Certificate with given ID
data "powerscale_synciq_peer_certificate" "one_certificate" {
  id = "g23j9a1f83h12n5j4"
}

# Returns the PowerScale SyncIQ Certificate with given name
data "powerscale_synciq_peer_certificate" "one_certificate_by_name" {
  filter {
    name = "tfaccTest"
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_synciq_peer_certificate.all_certificates.certificates
output "powerscale_synciq_all_certificates" {
  value = data.powerscale_synciq_peer_certificate.all_certificates.certificates
}

# The user can use the fetched certificate by ID by the variable data.powerscale_synciq_peer_certificate.one_certificate.certificates[0]
output "certificateByID" {
  value = data.powerscale_synciq_peer_certificate.one_certificate.certificates[0]
}

# The user can use the fetched certificate by name by the variable data.powerscale_synciq_peer_certificate.one_certificate_by_name.certificates[0]
output "certificateByName" {
  value = data.powerscale_synciq_peer_certificate.one_certificate_by_name.certificates[0]
}

# Get syncIQ certificate by status
# Step 1: We shall use the datasource to get all the certificates as shown above
# Step 2: We index them by status
output "certificatesByStatus" {
  value = {
    "valid"    = [for certificate in data.powerscale_synciq_peer_certificate.all_certificates.certificates : certificate if certificate.status == "valid"]
    "invalid"  = [for certificate in data.powerscale_synciq_peer_certificate.all_certificates.certificates : certificate if certificate.status == "invalid"]
    "expired"  = [for certificate in data.powerscale_synciq_peer_certificate.all_certificates.certificates : certificate if certificate.status == "expired"]
    "expiring" = [for certificate in data.powerscale_synciq_peer_certificate.all_certificates.certificates : certificate if certificate.status == "expiring"]
  }
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.

Schema

Optional

filter (Block, Optional) Filters for fetching SyncIQ Peer Certificate. (see below for nested schema)
id (String) ID of the SyncIQ Peer Certificate to be fetched. If not provided, all the certificates will be fetched.

Read-Only

certificates (Attributes List) List of certificates fetched. (see below for nested schema)

Nested Schema for `filter`

Optional:

name (String) Name of the SyncIQ Peer Certificate to be fetched.

Nested Schema for `certificates`

Read-Only:

description (String) Description field associated with a certificate provided for administrative convenience.
fingerprints (Attributes List) A list of zero or more certificate fingerprints which can be used for certificate identification. (see below for nested schema)
id (String) Unique server certificate identifier.
issuer (String) Certificate issuer field extracted from the certificate.
name (String) Administrator specified name identifier.
not_after (Number) Certificate notAfter field extracted from the certificate encoded as a UNIX epoch timestamp. The certificate is not valid after this timestamp.
not_before (Number) Certificate notBefore field extracted from the certificate encoded as a UNIX epoch timestamp. The certificate is not valid before this timestamp.
status (String) Certificate validity status
subject (String) Certificate subject field extracted from the certificate.

Nested Schema for `certificates.fingerprints`

Read-Only:

type (String) Fingerprint hash algorithm
value (String) Fingerprint value

V1.8.1: powerscale_synciq_policy data source

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

powerscale_synciq_policy (Data Source)

This datasource is used to query the existing SyncIQ Policies from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SyncIQ Policy allows you to get a list of SyncIQ Policies or a policy by its ID.

# Returns a list of PowerScale SyncIQ Policies 
data "powerscale_synciq_policy" "all_policies" {
}

# Returns a the PowerScale SyncIQ Policy with given ID
data "powerscale_synciq_policy" "one_policy" {
  id = "g23j9a1f83h12n5j4"
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_synciq_policy.all_policies.policies
output "powerscale_synciq_all_policies" {
  value = data.powerscale_synciq_policy.all_policies.policies
}

# The user can use the fetched policy by ID by the variable data.powerscale_synciq_policy.one_policy.policies[0]
output "policyByID" {
  value = data.powerscale_synciq_policy.one_policy.one_policy[0]
}

# Get syncIQ policy by name
# Step 1: We shall use the datasource to get all the policies as shown above
# Step 2: We index them by name
locals {
  policiesByName = { for policy in data.powerscale_synciq_policy.all_policies.policies : policy.name => policy }
}

# Step 3: The user can use the fetched policy by name by the variable local.policiesByName["<name>"]
output "policiesByName" {
  value = {
    "aut" = local.policiesByName["aut_synciq_report_policy_01"]
    "but" = local.policiesByName["but_synciq_report_policy_01"]
    "cut" = local.policiesByName["cut_synciq_report_policy_01"]
  }
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.

Schema

Optional

id (String) ID

Read-Only

policies (Attributes List) Policies (see below for nested schema)

Nested Schema for `policies`

Read-Only:

accelerated_failback (Boolean) Accelerated Failback
action (String) Action
allow_copy_fb (Boolean) Allow Copy Fb
bandwidth_reservation (Number) Bandwidth Reservation
changelist (Boolean) Changelist
check_integrity (Boolean) Check Integrity
cloud_deep_copy (String) Cloud Deep Copy
conflicted (Boolean) Conflicted
database_mirrored (Boolean) Database Mirrored
delete_quotas (Boolean) Delete Quotas
description (String) Description
disable_file_split (Boolean) Disable File Split
disable_fofb (Boolean) Disable Fofb
disable_quota_tmp_dir (Boolean) Disable Quota Tmp Dir
disable_stf (Boolean) Disable Stf
enable_hash_tmpdir (Boolean) Enable Hash Tmpdir
enabled (Boolean) Enabled
encrypted (Boolean) Encrypted
encryption_cipher_list (String) Encryption Cipher List
expected_dataloss (Boolean) Expected Dataloss
file_matching_pattern (Attributes) File Matching Pattern (see below for nested schema)
force_interface (Boolean) Force Interface
has_sync_state (Boolean) Has Sync State
id (String) Id
ignore_recursive_quota (Boolean) Ignore Recursive Quota
job_delay (Number) Job Delay
last_job_state (String) Last Job State
last_started (Number) Last Started
last_success (Number) Last Success
linked_service_policies (List of String) Linked Service Policies
log_level (String) Log Level
log_removed_files (Boolean) Log Removed Files
name (String) Name
next_run (Number) Next Run
ocsp_address (String) Ocsp Address
ocsp_issuer_certificate_id (String) Ocsp Issuer Certificate Id
password_set (Boolean) Password Set
priority (Number) Priority
report_max_age (Number) Report Max Age
report_max_count (Number) Report Max Count
restrict_target_network (Boolean) Restrict Target Network
rpo_alert (Number) Rpo Alert
schedule (String) Schedule
service_policy (Boolean) Service Policy
skip_lookup (Boolean) Skip Lookup
skip_when_source_unmodified (Boolean) Skip When Source Unmodified
snapshot_sync_existing (Boolean) Snapshot Sync Existing
snapshot_sync_pattern (String) Snapshot Sync Pattern
source_certificate_id (String) Source Certificate Id
source_domain_marked (Boolean) Source Domain Marked
source_exclude_directories (List of String) Source Exclude Directories
source_include_directories (List of String) Source Include Directories
source_network (Attributes) Source Network (see below for nested schema)
source_root_path (String) Source Root Path
source_snapshot_archive (Boolean) Source Snapshot Archive
source_snapshot_expiration (Number) Source Snapshot Expiration
source_snapshot_pattern (String) Source Snapshot Pattern
sync_existing_snapshot_expiration (Boolean) Sync Existing Snapshot Expiration
sync_existing_target_snapshot_pattern (String) Sync Existing Target Snapshot Pattern
target_certificate_id (String) Target Certificate Id
target_compare_initial_sync (Boolean) Target Compare Initial Sync
target_detect_modifications (Boolean) Target Detect Modifications
target_host (String) Target Host
target_path (String) Target Path
target_snapshot_alias (String) Target Snapshot Alias
target_snapshot_archive (Boolean) Target Snapshot Archive
target_snapshot_expiration (Number) Target Snapshot Expiration
target_snapshot_pattern (String) Target Snapshot Pattern
workers_per_node (Number) Workers Per Node

Nested Schema for `policies.file_matching_pattern`

Read-Only:

or_criteria (Attributes List) Or Criteria (see below for nested schema)

Nested Schema for `policies.file_matching_pattern.or_criteria`

Read-Only:

and_criteria (Attributes List) And Criteria (see below for nested schema)

Nested Schema for `policies.file_matching_pattern.or_criteria.and_criteria`

Read-Only:

attribute_exists (Boolean) Attribute Exists
case_sensitive (Boolean) Case Sensitive
field (String) Field
operator (String) Operator
type (String) Type
value (String) Value
whole_word (Boolean) Whole Word

Nested Schema for `policies.source_network`

Read-Only:

pool (String) Pool
subnet (String) Subnet

V1.8.1: powerscale_synciq_replication_job data source

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

powerscale_synciq_replication_job (Data Source)

This datasource is used to query the SyncIQ replication jobs from PowerScale array. The information fetched from this datasource can be used for getting the details.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SyncIQ Replication Job datasource allows you to get a list of SyncIQ replication jobs.

# Returns a list of PowerScale SyncIQ Replication Jobs 
data "powerscale_synciq_replication_job" "all_jobs" {
}

# Returns a list of PowerScale SyncIQ Replication Jobs with running state
data "powerscale_synciq_replication_job" "jobByState" {
  filter {
    state = "running"
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_synciq_replication_job.all_jobs.synciq_jobs
output "powerscale_synciq_all_replication_jobs" {
  value = data.powerscale_synciq_replication_job.all_jobs.synciq_jobs
}

# The user can use the fetched information by the variable data.powerscale_synciq_replication_job.all_jobs.synciq_jobs
output "replicationJobByState" {
  value = data.powerscale_synciq_replication_job.jobByState.synciq_jobs
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.

Schema

Optional

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

Read-Only

id (String) Identifier.
synciq_jobs (Attributes List) List of user groups. (see below for nested schema)

Nested Schema for `filter`

Optional:

dir (String) The direction of the sort.
limit (Number) Return no more than this many results.
sort (String) The field that will be used for sorting.
state (String) Only list SyncIQ replication jobs matching this state.

Nested Schema for `synciq_jobs`

Read-Only:

action (String) The action to be taken by this job.
ads_streams_replicated (Number) The number of ads streams replicated by this job.
block_specs_replicated (Number) The number of block specs replicated by this job.
bytes_recoverable (Number) The number of bytes recoverable by this job.
bytes_transferred (Number) The number of bytes that have been transferred by this job.
char_specs_replicated (Number) The number of char specs replicated by this job.
committed_files (Number) The number of WORM committed files.
corrected_lins (Number) The number of LINs corrected by this job.
dead_node (Boolean) This field is true if the node running this job is dead.
directories_replicated (Number) The number of directories replicated.
dirs_changed (Number) The number of directories changed by this job.
dirs_deleted (Number) The number of directories deleted by this job.
dirs_moved (Number) The number of directories moved by this job.
dirs_new (Number) The number of directories created by this job.
duration (Number) The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.
encrypted (Boolean) If true, syncs will be encrypted.
end_time (Number) The time the job ended in unix epoch seconds. The field is null if the job hasn’t ended.
error (String) The primary error message for this job.
error_checksum_files_skipped (Number) The number of files with checksum errors skipped by this job.
error_io_files_skipped (Number) The number of files with io errors skipped by this job.
error_net_files_skipped (Number) The number of files with network errors skipped by this job.
errors (List of String) A list of error messages for this job.
failed_chunks (Number) They number of data chunks that failed transmission.
fifos_replicated (Number) The number of fifos replicated by this job.
file_data_bytes (Number) The number of bytes transferred that belong to files.
files_changed (Number) The number of files changed by this job.
files_linked (Number) The number of files linked by this job.
files_new (Number) The number of files created by this job.
files_selected (Number) The number of files selected by this job.
files_transferred (Number) The number of files transferred by this job.
files_unlinked (Number) The number of files unlinked by this job.
files_with_ads_replicated (Number) The number of files with ads replicated by this job.
flipped_lins (Number) The number of LINs flipped by this job.
hard_links_replicated (Number) The number of hard links replicated by this job.
hash_exceptions_fixed (Number) The number of hash exceptions fixed by this job.
hash_exceptions_found (Number) The number of hash exceptions found by this job.
id (String) A unique identifier for this object.
job_id (Number) The ID of the job.
lins_total (Number) The number of LINs transferred by this job.
network_bytes_to_source (Number) The total number of bytes sent to the source by this job.
network_bytes_to_target (Number) The total number of bytes sent to the target by this job.
new_files_replicated (Number) The number of new files replicated by this job.
num_retransmitted_files (Number) The number of files that have been retransmitted by this job.
phases (Attributes List) Data for each phase of this job. (see below for nested schema)
policy (Attributes) The policy associated with this job, or null if there is currently no policy associated with this job (this can happen if the job is newly created and not yet fully populated in the underlying database). (see below for nested schema)
policy_action (String) This is the action the policy is configured to perform.
policy_id (String) The ID of the policy.
policy_name (String) The name of the policy.
quotas_deleted (Number) The number of quotas removed from the target.
regular_files_replicated (Number) The number of regular files replicated by this job.
resynced_lins (Number) The number of LINs resynched by this job.
retransmitted_files (List of String) The files that have been retransmitted by this job.
retry (Number) The number of times the job has been retried.
running_chunks (Number) The number of data chunks currently being transmitted.
service_report (Attributes List) Data for each component exported as part of service replication. (see below for nested schema)
sockets_replicated (Number) The number of sockets replicated by this job.
source_bytes_recovered (Number) The number of bytes recovered on the source.
source_directories_created (Number) The number of directories created on the source.
source_directories_deleted (Number) The number of directories deleted on the source.
source_directories_linked (Number) The number of directories linked on the source.
source_directories_unlinked (Number) The number of directories unlinked on the source.
source_directories_visited (Number) The number of directories visited on the source.
source_files_deleted (Number) The number of files deleted on the source.
source_files_linked (Number) The number of files linked on the source.
source_files_unlinked (Number) The number of files unlinked on the source.
sparse_data_bytes (Number) The number of sparse data bytes transferred by this job.
start_time (Number) The time the job started in unix epoch seconds. The field is null if the job hasn’t started.
state (String) The state of the job.
succeeded_chunks (Number) The number of data chunks that have been transmitted successfully.
symlinks_replicated (Number) The number of symlinks replicated by this job.
sync_type (String) The type of sync being performed by this job.
target_bytes_recovered (Number) The number of bytes recovered on the target.
target_directories_created (Number) The number of directories created on the target.
target_directories_deleted (Number) The number of directories deleted on the target.
target_directories_linked (Number) The number of directories linked on the target.
target_directories_unlinked (Number) The number of directories unlinked on the target.
target_files_deleted (Number) The number of files deleted on the target.
target_files_linked (Number) The number of files linked on the target.
target_files_unlinked (Number) The number of files unlinked on the target.
target_snapshots (List of String) The target snapshots created by this job.
total_chunks (Number) The total number of data chunks transmitted by this job.
total_data_bytes (Number) The total number of bytes transferred by this job.
total_exported_services (Number) The total number of components exported as part of service replication.
total_files (Number) The number of files affected by this job.
total_network_bytes (Number) The total number of bytes sent over the network by this job.
total_phases (Number) The total number of phases for this job.
unchanged_data_bytes (Number) The number of bytes unchanged by this job.
up_to_date_files_skipped (Number) The number of up-to-date files skipped by this job.
updated_files_replicated (Number) The number of updated files replicated by this job.
user_conflict_files_skipped (Number) The number of files with user conflicts skipped by this job.
warnings (List of String) A list of warning messages for this job.
workers (Attributes List) A list of workers for this job. (see below for nested schema)
worm_committed_file_conflicts (Number) The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.

Nested Schema for `synciq_jobs.phases`

Read-Only:

end_time (Number) The time the job ended this phase.
phase (String) The phase that the job was in.
start_time (Number) The time the job began this phase.

Nested Schema for `synciq_jobs.policy`

Read-Only:

action (String) The action to be taken by the job.
file_matching_pattern (Attributes) A file matching pattern, organized as an OR’ed set of AND’ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type ‘sync’ cannot use ‘path’ or time criteria in their matching patterns, but policies of type ‘copy’ can use all listed criteria. (see below for nested schema)
name (String) User-assigned name of this sync policy.
source_exclude_directories (List of String) Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
source_include_directories (List of String) Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
source_root_path (String) The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
target_host (String) Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
target_path (String) Absolute filesystem path on the target cluster for the sync destination.

Nested Schema for `synciq_jobs.policy.file_matching_pattern`

Read-Only:

or_criteria (Attributes List) An array containing objects with “and_criteria” properties, each set of and_criteria will be logically OR’ed together to create the full file matching pattern. (see below for nested schema)

Nested Schema for `synciq_jobs.policy.file_matching_pattern.or_criteria`

Read-Only:

and_criteria (Attributes List) An array containing individual file criterion objects each describing one criterion. These are logically AND’ed together to form a set of criteria. (see below for nested schema)

Nested Schema for `synciq_jobs.policy.file_matching_pattern.or_criteria.and_criteria`

Read-Only:

attribute_exists (Boolean) For “custom_attribute” type criteria. The file will match as long as the attribute named by “field” exists. Default is true.
case_sensitive (Boolean) If true, the value comparison will be case sensitive. Default is true.
field (String) The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string “”.
operator (String) How to compare the specified attribute of each file to the specified value.
type (String) The type of this criterion, that is, which file attribute to match on.
value (String) The value to compare the specified attribute of each file to.
whole_word (Boolean) If true, the attribute must match the entire word. Default is true.

Nested Schema for `synciq_jobs.service_report`

Read-Only:

component (String) The component that was processed.
directory (String) The directory of the service export.
end_time (Number) The time the job ended this component.
error_msg (List of String) A list of error messages generated while exporting components.
filter (List of String) A list of path-based filters for exporting components.
handlers_failed (Number) The number of handlers failed during export.
handlers_skipped (Number) The number of handlers skipped during export.
handlers_transferred (Number) The number of handlers exported.
records_failed (Number) The number of records failed during export.
records_skipped (Number) The number of records skipped during export.
records_transferred (Number) The number of records exported.
start_time (Number) The time the job began this component.
status (String) The current status of export for this component.

Nested Schema for `synciq_jobs.workers`

Read-Only:

connected (Boolean) Whether there is a connection between the source and target.
last_split (Number) The last time a network split occurred.
last_work (Number) The last time the worker performed work.
lin (Number) The LIN being worked on.
lnn (Number) The lnn the worker is assigned to run on.
process_id (Number) The process ID of the worker.
source_host (String) The source host for this worker.
target_host (String) The target host for this worker.
worker_id (Number) The ID of the worker.

V1.8.1: powerscale_synciq_replication_report data source

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

powerscale_synciq_replication_report (Data Source)

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing Replication Report from PowerScale array.

# Returns the entire list of PowerScale replication report.
data "powerscale_synciq_replication_report" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_synciq_replication_report.all
output "powerscale_synciq_replication_report" {
  value = data.powerscale_synciq_replication_report.all
}

# Returns a list of PowerScale Replication Report based on the filters specified in the filter block.
data "powerscale_synciq_replication_report" "filtering" {
  filter {
    policy_name        = "Policy"
    reports_per_policy = 2
    sort               = "policy_name"
    dir                = "ASC"
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_synciq_replication_report.filtering
output "powerscale_replication_report_filter" {
  value = data.powerscale_synciq_replication_report.filtering
}

Schema

Optional

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

Read-Only

id (String) Unique identifier of the network pool instance.
replication_reports (Attributes List) (see below for nested schema)

Nested Schema for `filter`

Optional:

dir (String) The direction of the sort.
limit (Number) Return no more than this many results at once (see resume).
newer_than (Number) Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.
policy_name (String) Filter the returned reports to include only those with this policy name.
reports_per_policy (Number) If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1.
sort (String) The field that will be used for sorting.
state (String) Filter the returned reports to include only those whose jobs are in this state.
summary (Boolean) Return a summary rather than entire objects

Nested Schema for `replication_reports`

Read-Only:

action (String) The action to be taken by this job.
ads_streams_replicated (Number) The number of ads streams replicated by this job.
block_specs_replicated (Number) The number of block specs replicated by this job.
bytes_recoverable (Number) The number of bytes recoverable by this job.
bytes_transferred (Number) The number of bytes that have been transferred by this job.
char_specs_replicated (Number) The number of char specs replicated by this job.
committed_files (Number) The number of WORM committed files.
corrected_lins (Number) The number of LINs corrected by this job.
dead_node (Boolean) This field is true if the node running this job is dead.
directories_replicated (Number) The number of directories replicated.
dirs_changed (Number) The number of directories changed by this job.
dirs_deleted (Number) The number of directories deleted by this job.
dirs_moved (Number) The number of directories moved by this job.
dirs_new (Number) The number of directories created by this job.
duration (Number) The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.
encrypted (Boolean) If true, syncs will be encrypted.
end_time (Number) The time the job ended in unix epoch seconds. The field is null if the job hasn’t ended.
error (String) The primary error message for this job.
error_checksum_files_skipped (Number) The number of files with checksum errors skipped by this job.
error_io_files_skipped (Number) The number of files with io errors skipped by this job.
error_net_files_skipped (Number) The number of files with network errors skipped by this job.
errors (List of String) A list of error messages for this job.
failed_chunks (Number) Tyhe number of data chunks that failed transmission.
fifos_replicated (Number) The number of fifos replicated by this job.
file_data_bytes (Number) The number of bytes transferred that belong to files.
files_changed (Number) The number of files changed by this job.
files_linked (Number) The number of files linked by this job.
files_new (Number) The number of files created by this job.
files_selected (Number) The number of files selected by this job.
files_transferred (Number) The number of files transferred by this job.
files_unlinked (Number) The number of files unlinked by this job.
files_with_ads_replicated (Number) The number of files with ads replicated by this job.
flipped_lins (Number) The number of LINs flipped by this job.
hard_links_replicated (Number) The number of hard links replicated by this job.
hash_exceptions_fixed (Number) The number of hash exceptions fixed by this job.
hash_exceptions_found (Number) The number of hash exceptions found by this job.
id (String) A unique identifier for this object.
job_id (Number) The ID of the job.
lins_total (Number) The number of LINs transferred by this job.
network_bytes_to_source (Number) The total number of bytes sent to the source by this job.
network_bytes_to_target (Number) The total number of bytes sent to the target by this job.
new_files_replicated (Number) The number of new files replicated by this job.
num_retransmitted_files (Number) The number of files that have been retransmitted by this job.
phases (Attributes List) Data for each phase of this job. (see below for nested schema)
policy (Attributes) The policy associated with this job, or null if there is currently no policy associated with this job (this can happen if the job is newly created and not yet fully populated in the underlying database). (see below for nested schema)
policy_action (String) This is the action the policy is configured to perform.
policy_id (String) The ID of the policy.
policy_name (String) The name of the policy.
quotas_deleted (Number) The number of quotas removed from the target.
regular_files_replicated (Number) The number of regular files replicated by this job.
resynced_lins (Number) The number of LINs resynched by this job.
retransmitted_files (List of String) The files that have been retransmitted by this job.
retry (Number) The number of times the job has been retried.
running_chunks (Number) The number of data chunks currently being transmitted.
sockets_replicated (Number) The number of sockets replicated by this job.
source_bytes_recovered (Number) The number of bytes recovered on the source.
source_directories_created (Number) The number of directories created on the source.
source_directories_deleted (Number) The number of directories deleted on the source.
source_directories_linked (Number) The number of directories linked on the source.
source_directories_unlinked (Number) The number of directories unlinked on the source.
source_directories_visited (Number) The number of directories visited on the source.
source_files_deleted (Number) The number of files deleted on the source.
source_files_linked (Number) The number of files linked on the source.
source_files_unlinked (Number) The number of files unlinked on the source.
sparse_data_bytes (Number) The number of sparse data bytes transferred by this job.
start_time (Number) The time the job started in unix epoch seconds. The field is null if the job hasn’t started.
state (String) The state of the job.
subreport_count (Number) The number of subreports that are available for this job report.
succeeded_chunks (Number) The number of data chunks that have been transmitted successfully.
symlinks_replicated (Number) The number of symlinks replicated by this job.
sync_type (String) The type of sync being performed by this job.
target_bytes_recovered (Number) The number of bytes recovered on the target.
target_directories_created (Number) The number of directories created on the target.
target_directories_deleted (Number) The number of directories deleted on the target.
target_directories_linked (Number) The number of directories linked on the target.
target_directories_unlinked (Number) The number of directories unlinked on the target.
target_files_deleted (Number) The number of files deleted on the target.
target_files_linked (Number) The number of files linked on the target.
target_files_unlinked (Number) The number of files unlinked on the target.
target_snapshots (List of String) The target snapshots created by this job.
throughput (String) Throughput of a job
total_chunks (Number) The total number of data chunks transmitted by this job.
total_data_bytes (Number) The total number of bytes transferred by this job.
total_files (Number) The number of files affected by this job.
total_network_bytes (Number) The total number of bytes sent over the network by this job.
total_phases (Number) The total number of phases for this job.
unchanged_data_bytes (Number) The number of bytes unchanged by this job.
up_to_date_files_skipped (Number) The number of up-to-date files skipped by this job.
updated_files_replicated (Number) The number of updated files replicated by this job.
user_conflict_files_skipped (Number) The number of files with user conflicts skipped by this job.
warnings (List of String) A list of warning messages for this job.
worm_committed_file_conflicts (Number) The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.

Nested Schema for `replication_reports.phases`

Read-Only:

end_time (Number) The time the job ended this phase.
phase (String) The phase that the job was in.
start_time (Number) The time the job began this phase.
statistics (Attributes) Statistics for each phase of this job. (see below for nested schema)

Nested Schema for `replication_reports.phases.statistics`

Read-Only:

compliance_dir_links (String) Compliance Dir Links
corrected_lins (String) Corrected LINs
deleted_dirs (String) Deleted Dirs
dirs (String) Dirs
files (String) Files
flipped_lins (String) Flipped LINs
hash_exceptions (String) Hash Exceptions
linked_dirs (String) Linked Dirs
linked_files (String) Linked Files
marked_directories (String) Marked Directories
marked_files (String) Marked Files
modified_dirs (String) Modified Dirs
modified_files (String) Modified Files
modified_lins (String) Modified LINs
new_compliance_dirs (String) New Compliance Dirs
new_dirs (String) New Dirs
new_files (String) New Files
new_resynced_files (String) New Resynced Files
resynced_file_links (String) Resynced File Links
resynced_lins (String) Resynced LINs
unlinked_files (String) Unlinked Files

Nested Schema for `replication_reports.policy`

Read-Only:

action (String) The action to be taken by the job.
file_matching_pattern (Attributes) A file matching pattern, organized as an OR’ed set of AND’ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type ‘sync’ cannot use ‘path’ or time criteria in their matching patterns, but policies of type ‘copy’ can use all listed criteria. (see below for nested schema)
name (String) User-assigned name of this sync policy.
source_exclude_directories (List of String) Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
source_include_directories (List of String) Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
source_root_path (String) The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
target_host (String) Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
target_path (String) Absolute filesystem path on the target cluster for the sync destination.

Nested Schema for `replication_reports.policy.file_matching_pattern`

Read-Only:

or_criteria (Attributes List) An array containing objects with “and_criteria” properties, each set of and_criteria will be logically OR’ed together to create the full file matching pattern. (see below for nested schema)

Nested Schema for `replication_reports.policy.file_matching_pattern.or_criteria`

Read-Only:

and_criteria (Attributes List) An array containing individual file criterion objects each describing one criterion. These are logically AND’ed together to form a set of criteria. (see below for nested schema)

Nested Schema for `replication_reports.policy.file_matching_pattern.or_criteria.and_criteria`

Read-Only:

attribute_exists (Boolean) For “custom_attribute” type criteria. The file will match as long as the attribute named by “field” exists. Default is true.
case_sensitive (Boolean) If true, the value comparison will be case sensitive. Default is true.
field (String) The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string “”.
operator (String) How to compare the specified attribute of each file to the specified value.
type (String) The type of this criterion, that is, which file attribute to match on.
value (String) The value to compare the specified attribute of each file to.
whole_word (Boolean) If true, the attribute must match the entire word. Default is true.

V1.8.1: powerscale_synciq_rule data source

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

powerscale_synciq_rule (Data Source)

This datasource is used to query the existing SyncIQ Replication Rules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale SyncIQ Rule allows you to get a list of SyncIQ Rules or a rule by its ID.

# Returns a list of PowerScale SyncIQ Rules 
data "powerscale_synciq_rule" "all_rules" {
}

# Returns a the PowerScale SyncIQ Rule with given ID
data "powerscale_synciq_rule" "all_rules" {
  id = "bw-0"
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_synciq_rule.all_rules.rules
output "powerscale_synciq_rules" {
  value = data.powerscale_synciq_rule.all_rules.rules
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.

Schema

Optional

id (String) Unique identifier of the performance rule.

Read-Only

rules (Attributes List) (see below for nested schema)

Nested Schema for `rules`

Read-Only:

description (String) User-entered description of this performance rule.
enabled (Boolean) Whether this performance rule is currently in effect during its specified intervals.
id (String) The system ID given to this performance rule.
limit (Number) Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.
schedule (Attributes) A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect. (see below for nested schema)
type (String) The type of system resource this rule limits.

Nested Schema for `rules.schedule`

Read-Only:

begin (String) Start time (inclusive) for this schedule, during its specified days. Format is “hh:mm” (24h format hour, and minute). A null value indicates the beginning of the day (“00:00”).
end (String) End time (inclusive) for this schedule, during its specified days. Format is “hh:mm” (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day (“23:59”).
friday (Boolean) If true, this rule is in effect on Friday. If false, or unspecified, it is not.
monday (Boolean) If true, this rule is in effect on Monday. If false, or unspecified, it is not.
saturday (Boolean) If true, this rule is in effect on Saturday. If false, or unspecified, it is not.
sunday (Boolean) If true, this rule is in effect on Sunday. If false, or unspecified, it is not.
thursday (Boolean) If true, this rule is in effect on Thursday. If false, or unspecified, it is not.
tuesday (Boolean) If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.
wednesday (Boolean) If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.

V1.8.1: powerscale_user data source

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

powerscale_user (Data Source)

This datasource is used to query the existing Users from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.

# Returns a list of PowerScale Users based on uid or name in names filter block. 
data "powerscale_user" "test_user" {
  filter {
    # Optional list of names to filter upon
    names = [
      # {
      #   uid = 0
      # },
      # {
      #   name = "admin"
      # },
      #{
      #     sid = "S-1-5-21-3219966720-1480896164-796802738-501"
      #},
      #{
      #    name = "admin"
      #    sid = "S-1-5-21-3219966720-1480896164-796802738-501"
      #},
      {
        name = "tfaccUserDatasource"
        uid  = 10000
      }
    ]

    # Optional query parameters.
    cached      = false
    name_prefix = "tfacc"
    member_of   = false
    # domain = "testDomain"
    # zone = "testZone"
    # provider = "testProvider"
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_user.test_user
output "powerscale_user_filter" {
  value = data.powerscale_user.test_user
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.

Schema

Optional

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

Read-Only

id (String) Unique identifier of the user instance.
users (Attributes List) List of users. (see below for nested schema)

Nested Schema for `filter`

Optional:

cached (Boolean) If true, only return cached objects.
domain (String) Filter users by domain.
member_of (Boolean) Enumerate all users that a group is a member of.
name_prefix (String) Filter users by name prefix.
names (Attributes List) List of user identity. (see below for nested schema)
provider (String) Filter users by provider.
zone (String) Filter users by zone.

Nested Schema for `filter.names`

Optional:

name (String) Specifies a user name.
sid (String) Specifies a numeric security identifier.
uid (Number) Specifies a numeric user identifier.

Nested Schema for `users`

Optional:

dn (String) Specifies a principal name for the user.
dns_domain (String) Specifies the DNS domain.
domain (String) Specifies the domain that the object is part of.
email (String) Specifies an email address.
enabled (Boolean) If true, the authenticated user is enabled.
expired (Boolean) If true, the authenticated user has expired.
expiry (Number) Specifies the Unix Epoch time at which the authenticated user will expire.
gecos (String) Specifies the GECOS value, which is usually the full name.
generated_gid (Boolean) If true, the GID was generated.
generated_uid (Boolean) If true, the UID was generated.
generated_upn (Boolean) If true, the UPN was generated.
gid (String) Specifies a group identifier.
home_directory (String) Specifies a home directory for the user.
id (String) Specifies the user ID.
locked (Boolean) If true, indicates that the account is locked.
max_password_age (Number) Specifies the maximum time in seconds allowed before the password expires.
name (String) Specifies a user name.
password_expired (Boolean) If true, the password has expired.
password_expires (Boolean) If true, the password is allowed to expire.
password_expiry (Number) Specifies the time in Unix Epoch seconds that the password will expire.
password_last_set (Number) Specifies the last time the password was set.
primary_group_sid (String) Specifies the persona of the primary group.
prompt_password_change (Boolean) If true, Prompts the user to change their password at the next login.
provider (String) Specifies the authentication provider that the object belongs to.
sam_account_name (String) Specifies a user name.
shell (String) Specifies a path to the shell for the user.
sid (String) Specifies a security identifier.
type (String) Specifies the object type.
uid (String) Specifies a user identifier.
upn (String) Specifies a principal name for the user.
user_can_change_password (Boolean) Specifies whether the password for the user can be changed.

Read-Only:

roles (List of String) List of roles.

V1.8.1: powerscale_user_group data source

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

powerscale_user_group (Data Source)

This datasource is used to query the existing User Groups from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.

# Returns a list of PowerScale User Groups based on gid or name in names filter block. 
data "powerscale_user_group" "test_user_group" {
  filter {
    # Optional list of names to filter upon
    names = [
      # {
      #   gid = 0
      # },
      # {
      #   name = "Administrators"
      # },
      {
        name = "tfaccUserGroupDatasource"
        gid  = 10000
      }
    ]

    # Optional query parameters.
    cached      = false
    name_prefix = "tfacc"
    # domain = "testDomain"
    # zone = "testZone"
    # provider = "testProvider"
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_user_group.test_user_group
output "powerscale_user_group_filter" {
  value = data.powerscale_user_group.test_user_group
}

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.

Schema

Optional

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

Read-Only

id (String) Unique identifier of the user group instance.
user_groups (Attributes List) List of user groups. (see below for nested schema)

Nested Schema for `filter`

Optional:

cached (Boolean) If true, only return cached objects.
domain (String) Filter user groups by domain.
name_prefix (String) Filter user groups by name prefix.
names (Attributes List) List of user group identity. (see below for nested schema)
provider (String) Filter user groups by provider.
zone (String) Filter user groups by zone.

Nested Schema for `filter.names`

Optional:

gid (Number) Specifies a numeric user group identifier.
name (String) Specifies a user group name.

Nested Schema for `user_groups`

Read-Only:

dn (String) Specifies the distinguished name for the user group.
dns_domain (String) Specifies the DNS domain.
domain (String) Specifies the domain that the object is part of.
generated_gid (Boolean) If true, the GID was generated.
gid (String) Specifies a user group identifier.
id (String) Specifies the user group ID.
members (Attributes List) List of members of group. Group Member can be user or group. (see below for nested schema)
name (String) Specifies a user group name.
provider (String) Specifies the authentication provider that the object belongs to.
roles (List of String) List of roles.
sam_account_name (String) Specifies a user group name.
sid (String) Specifies a security identifier.
type (String) Specifies the object type.

Nested Schema for `user_groups.members`

Read-Only:

id (String) Specifies a user or group id.
name (String) Specifies a user or group name.
type (String) Specifies the object type.

V1.8.1: powerscale_user_mapping_rules data source

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

powerscale_user_mapping_rules (Data Source)

This datasource is used to query the User Mapping Rules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale User Mapping Rules combines user identities from different directory services into a single access token and then modifies it according to configured rules.

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale User Mapping Rules combines user identities from different directory services into a single access token and then modifies it according to configured rules.

# Returns a list of PowerScale User Mapping Rules based on names and zone filter block. 
data "powerscale_user_mapping_rules" "testUserMappingRules" {
  filter {
    # Optional Names filter for source user name or target user name.
    names = ["admin", "Guest"]
    # Optional Operators filter for user mapping rules.
    operators = ["append", "union"]
    # Optional zone filter. The zone to which the user mapping applies. Defaults to System.
    zone = "System"
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_user_mapping_rules.testUserMappingRules
output "powerscale_user_mapping_rules_filter" {
  value = data.powerscale_user_mapping_rules.testUserMappingRules
}


# Returns all of the PowerScale User Mapping Rules.
data "powerscale_user_mapping_rules" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_user_mapping_rules.all
output "powerscale_user_mapping_rules_all" {
  value = data.powerscale_user_mapping_rules.all
}

Schema

Optional

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

Read-Only

id (String) User Mapping Rules ID.
user_mapping_rules (Attributes List) Specifies the list of user mapping rules. (see below for nested schema)
user_mapping_rules_parameters (Attributes) Specifies the parameters for user mapping rules. (see below for nested schema)

Nested Schema for `filter`

Optional:

names (Set of String) Names filter for source user name or target user name.
operators (Set of String) Operators filter for user mapping rules.
zone (String) The zone to which the user mapping applies. Defaults to System.

Nested Schema for `user_mapping_rules`

Read-Only:

operator (String) Specifies the operator to make rules on specified users or groups.
options (Attributes) Specifies the mapping options for this user mapping rule. (see below for nested schema)
source_user (Attributes) Specifies the source user information that the rule can be applied from. (see below for nested schema)
target_user (Attributes) Specifies the target user information that the rule can be applied to. (see below for nested schema)

Nested Schema for `user_mapping_rules.options`

Read-Only:

break (Boolean) If true, and the rule was applied successfully, stop processing further.
default_user (Attributes) Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information. (see below for nested schema)
group (Boolean) If true, the primary GID and primary group SID should be copied to the existing credential.
groups (Boolean) If true, all additional identifiers should be copied to the existing credential.
user (Boolean) If true, the primary UID and primary user SID should be copied to the existing credential.

Nested Schema for `user_mapping_rules.options.default_user`

Read-Only:

domain (String) Specifies the domain of the user that is being mapped.
user (String) Specifies the name of the user that is being mapped.

Nested Schema for `user_mapping_rules.source_user`

Read-Only:

domain (String) Specifies the domain of the user that is being mapped.
user (String) Specifies the name of the user that is being mapped.

Nested Schema for `user_mapping_rules.target_user`

Read-Only:

domain (String) Specifies the domain of the user that is being mapped.
user (String) Specifies the name of the user that is being mapped.

Nested Schema for `user_mapping_rules_parameters`

Read-Only:

default_unix_user (Attributes) Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information. (see below for nested schema)

Nested Schema for `user_mapping_rules_parameters.default_unix_user`

Read-Only:

domain (String) Specifies the domain of the user that is being mapped.
user (String) Specifies the name of the user that is being mapped.

V1.8.1: powerscale_writable_snapshot data source

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

powerscale_writable_snapshot (Data Source)

Example Usage

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

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# PowerScale Writable Snapshots allows you to get a list of Writable Snapshots or a Writable Snapshot by its Path which can be added in filters.

# Returns a list of PowerScale Writable Snapshots 
data "powerscale_writable_snapshot" "all_snaps" {
}

# Returns a the PowerScale Writable Snapshot with given Path
data "powerscale_writable_snapshot" "test" {
  filter {
    path  = "/ifs/writable_snap"
    limit = 5
  }
}

# Output value of above block by executing 'terraform output' command.
# The user can use the fetched information by the variable data.powerscale_writable_snapshot.all_snaps.writable
# output "powerscale_writable_snapshot" {
#   value = data.powerscale_writable_snapshot.all_snaps.writable
# }

# After the successful execution of above said block, We can see the output value by executing 'terraform output' command.

Schema

Optional

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

Read-Only

id (String) Identifier
writable (Attributes List) (see below for nested schema)

Nested Schema for `filter`

Optional:

dir (String) The direction of the sort.
limit (Number) Return no more than this many results at once (see resume).
path (String) Only list writable snapshots matching this path.
resume (String) Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
sort (String) The field that will be used for sorting. Choices are path, src name, src path, created, size and state. Default is created.
state (String) Only list writable snapshots matching this state.

Nested Schema for `writable`

Read-Only:

created (Number) The Unix Epoch time the writable snapshot was created.
dst_path (String) The user supplied /ifs path of writable snapshot.
id (Number) The system ID given to the writable snapshot. This is useful for debugging.
log_size (Number) The sum in bytes of logical size of files in this writable snapshot.
phys_size (Number) The amount of storage in bytes used to store this writable snapshot.
src_id (Number) The system ID of the user supplied source snapshot. This is useful for debugging.
src_path (String) The /ifs path of user supplied source snapshot. This will be null for writable snapshots pending delete.
src_snap (String) The user supplied source snapshot name or ID. This will be null for writable snapshots pending delete.
state (String) Writable Snapshot state.

Dell Technologies – Data Sources

V1.8.1: powerscale_accesszone data source

powerscale_accesszone (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for access_zones_details

Nested Schema for access_zones_details.ifs_restricted

V1.8.1: powerscale_aclsettings data source

powerscale_aclsettings (Data Source)

Example Usage

Schema

Read-Only

V1.8.1: powerscale_adsprovider data source

powerscale_adsprovider (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for ads_providers_details

V1.8.1: powerscale_cluster data source

powerscale_cluster (Data Source)

Example Usage

Schema

Read-Only

Nested Schema for acs

Nested Schema for config

Nested Schema for config.devices

Nested Schema for config.onefs_version

Nested Schema for config.timezone

Nested Schema for identity

Nested Schema for identity.logon

Nested Schema for internal_networks

Nested Schema for internal_networks.failover_ip_addresses

Nested Schema for internal_networks.int_a_ip_addresses

Nested Schema for internal_networks.int_b_ip_addresses

Nested Schema for nodes

Nested Schema for nodes.errors

Nested Schema for nodes.nodes

Nested Schema for nodes.nodes.drives

Nested Schema for nodes.nodes.drives.y_loc

Nested Schema for nodes.nodes.hardware

Nested Schema for nodes.nodes.partitions

Nested Schema for nodes.nodes.partitions.partitions

Nested Schema for nodes.nodes.partitions.partitions.statfs

Nested Schema for nodes.nodes.sensors

Nested Schema for nodes.nodes.sensors.sensors

Nested Schema for nodes.nodes.sensors.sensors.values

Nested Schema for nodes.nodes.state

Nested Schema for nodes.nodes.state.smartfail

Nested Schema for nodes.nodes.state.smartfail

Nested Schema for nodes.nodes.state.smartfail

Nested Schema for nodes.nodes.status

Nested Schema for nodes.nodes.status.version

Nested Schema for nodes.nodes.status.version

Nested Schema for nodes.nodes.status.version

Nested Schema for nodes.nodes.status.version

Nested Schema for nodes.nodes.status.version.batteries

Nested Schema for nodes.nodes.status.version

Nested Schema for nodes.nodes.status.version.supplies

V1.8.1: powerscale_cluster_email data source

powerscale_cluster_email (Data Source)

Example Usage

Schema

Read-Only

Nested Schema for settings

V1.8.1: powerscale_filepool_policy data source

powerscale_filepool_policy (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for file_pool_policies

Nested Schema for file_pool_policies.actions

Nested Schema for file_pool_policies.actions.cloudpool_policy_action

Nested Schema for file_pool_policies.actions.cloudpool_policy_action.writeback_frequency

Nested Schema for `filter`

Nested Schema for `access_zones_details`

Nested Schema for `access_zones_details.ifs_restricted`

Nested Schema for `filter`

Nested Schema for `ads_providers_details`

Nested Schema for `acs`

Nested Schema for `config`

Nested Schema for `config.devices`

Nested Schema for `config.onefs_version`

Nested Schema for `config.timezone`

Nested Schema for `identity`

Nested Schema for `identity.logon`

Nested Schema for `internal_networks`

Nested Schema for `internal_networks.failover_ip_addresses`

Nested Schema for `internal_networks.int_a_ip_addresses`

Nested Schema for `internal_networks.int_b_ip_addresses`

Nested Schema for `nodes`

Nested Schema for `nodes.errors`

Nested Schema for `nodes.nodes`

Nested Schema for `nodes.nodes.drives`

Nested Schema for `nodes.nodes.drives.y_loc`

Nested Schema for `nodes.nodes.hardware`

Nested Schema for `nodes.nodes.partitions`

Nested Schema for `nodes.nodes.partitions.partitions`

Nested Schema for `nodes.nodes.partitions.partitions.statfs`

Nested Schema for `nodes.nodes.sensors`

Nested Schema for `nodes.nodes.sensors.sensors`

Nested Schema for `nodes.nodes.sensors.sensors.values`

Nested Schema for `nodes.nodes.state`

Nested Schema for `nodes.nodes.state.smartfail`

Nested Schema for `nodes.nodes.state.smartfail`

Nested Schema for `nodes.nodes.state.smartfail`

Nested Schema for `nodes.nodes.status`

Nested Schema for `nodes.nodes.status.version`

Nested Schema for `nodes.nodes.status.version`

Nested Schema for `nodes.nodes.status.version`

Nested Schema for `nodes.nodes.status.version`

Nested Schema for `nodes.nodes.status.version.batteries`

Nested Schema for `nodes.nodes.status.version`

Nested Schema for `nodes.nodes.status.version.supplies`

Nested Schema for `settings`

Nested Schema for `filter`

Nested Schema for `file_pool_policies`

Nested Schema for `file_pool_policies.actions`

Nested Schema for `file_pool_policies.actions.cloudpool_policy_action`

Nested Schema for `file_pool_policies.actions.cloudpool_policy_action.writeback_frequency`

Nested Schema for `file_pool_policies.actions.data_storage_policy_action`

Nested Schema for `file_pool_policies.actions.snapshot_storage_policy_action`

Nested Schema for `file_pool_policies.file_matching_pattern`

Nested Schema for `file_pool_policies.file_matching_pattern.or_criteria`

Nested Schema for `file_pool_policies.file_matching_pattern.or_criteria.and_criteria`

Nested Schema for `file_systems_details`

Nested Schema for `file_systems_details.file_system_attributes`

Nested Schema for `file_systems_details.file_system_namespace_acl`

Nested Schema for `file_systems_details.file_system_namespace_acl.acl`

Nested Schema for `file_systems_details.file_system_namespace_acl.acl.trustee`

Nested Schema for `file_systems_details.file_system_namespace_acl.group`

Nested Schema for `file_systems_details.file_system_namespace_acl.owner`

Nested Schema for `file_systems_details.file_system_quotas`

Nested Schema for `file_systems_details.file_system_quotas.usage`

Nested Schema for `file_systems_details.file_system_snapshots`

Nested Schema for `filter`

Nested Schema for `groupnets`

Nested Schema for `filter`

Nested Schema for `ldap_providers`

Nested Schema for `filter`

Nested Schema for `acl`

Nested Schema for `acl.trustee`

Nested Schema for `group`

Nested Schema for `owner`

Nested Schema for `filter`

Nested Schema for `network_rules`

Nested Schema for `filter`

Nested Schema for `network_pools_details`

Nested Schema for `network_pools_details.ifaces`

Nested Schema for `network_pools_details.ranges`