Dell Technologies – Resources

V1.8.1: powerscale_accesszone resource

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

powerscale_accesszone (Resource)

This resource is used to manage the Access Zone entity of PowerScale Array. We can Create, Update and Delete the Access Zone using this resource. We can also import an existing Access Zone from PowerScale array. 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.
*/

# Available actions: Create, Update (name, path, custom_auth_providers), Delete and Import
# After `terraform apply` of this example file it will create a new access zone with the name set in `name` attribute on the PowerScale

# PowerScale access zones allow you to isolate data and control who can access data in each zone.
resource "powerscale_accesszone" "zone" {

  # Required name of the new access zone
  name = "testAccessZoneSample"

  # Required Groupnet identifier to be assoicated with this access zone
  # Note can not be changed after the access zone is created
  groupnet = "groupnet0"

  # Required Specifies the access zone base directory path
  path = "/ifs"

  # Optional pecifies the list of authentication providers available on this access zone
  # A provider name should be of the form '[provider-type:]provider-name', the provider-type defaults to 'lsa-local-provider'.
  custom_auth_providers = [
    "localProviderName",
    "lsa-local-provider:testAccessZoneSample",
    "lsa-local-provider:localProviderName",
    "lsa-file-provider:fileProviderName",
    "lsa-activedirectory-provider:adsProviderName",
    "lsa-ldap-provider:testProvider",
  ]
}

# After the execution of above resource block, accesszone would have been created on the PowerScale array. For more information, Please check the terraform state file.

Schema

Required

groupnet (String) Groupnet identifier. Cannot be updated.
name (String) Specifies the access zone name.
path (String) Specifies the access zone base directory path.

Optional

custom_auth_providers (List of String) An optional parameter which adds new auth_providers to the access zone. A provider name should be of the form ‘[provider-type:]provider-name’, the provider-type defaults to ’lsa-local-provider’.

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.
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.
negative_cache_entry_expiry (Number) Specifies number of seconds the negative cache entry is valid.
netbios_name (String) Specifies the NetBIOS name.
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 `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.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_accesszone.zone <id>
# Example:
terraform import powerscale_accesszone.zone access_zone
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_aclsettings resource

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

powerscale_aclsettings (Resource)

This resource is used to manage the ACL Settings entity of PowerScale Array. We can Create, Update and Delete the ACL Settings using this resource. We can also import the existing ACL Settings from PowerScale array. Note that, ACL Settings is the native functionality of PowerScale. When creating the resource, we actually load ACL Settings from PowerScale to the resource state.

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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load ACL Settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load ACL Settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting ACL Settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale ACL Settings allow you to manage file and directory permissions, referred to as access rights.
resource "powerscale_aclsettings" "example_acl_settings" {
  # Optional fields both for creating and updating
  # Please check the acceptable inputs for each setting in the documentation
  #     access                  = "windows"
  #     calcmode                = "approx"
  #     calcmode_group          = "group_aces"
  #     calcmode_owner          = "owner_aces"
  #     calcmode_traverse       = "ignore"
  #     chmod                   = "merge"
  #     chmod_007               = "default"
  #     chmod_inheritable       = "no"
  #     chown                   = "owner_group_and_acl"
  #     create_over_smb         = "allow"
  #     dos_attr                = "deny_smb"
  #     group_owner_inheritance = "creator"
  #     rwx                     = "retain"
  #     synthetic_denies        = "remove"
  #     utimes                  = "only_owner"
}

# After the execution of above resource block, ACL Settings would have been cached in terraform state file, or
# ACL Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_aclsettings.example_acl_settings <anyString>
# Example:
terraform import powerscale_aclsettings.example_acl_settings anyString
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_adsprovider resource

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

powerscale_adsprovider (Resource)

This resource is used to manage the ADS provider entity of PowerScale Array. We can Create, Update and Delete the ADS provider using this resource. We can also import an existing ADS provider from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file for the first time, you will create an ADS provider on the PowerScale

# PowerScale ADS provider allows you to authenticate users and groups
resource "powerscale_adsprovider" "ads_test" {
  #   Required
  #   Name should be a fully qualified domain name of an existing AD
  name = "ADS.PROVIDER.EXAMPLE.COM"
  #   User should have join permission
  user     = "admin"
  password = "password"

  #   Optional query parameters
  #   scope = "effective"
  #   check_duplicates = true

  #   Optional fields ONLY for creating
  #   dns_domain = "testDNSDomain"
  #   groupnet = "testGroupNet"
  #   instance = "testInstance"
  #   kerberos_hdfs_spn = true
  #   kerberos_nfs_spn = true
  #   machine_account = "testMachineAccount"
  #   organizational_unit = "testOrganizationalUnit"

  #   Optional fields ONLY for updating
  #   domain_controller = "testDomainController"
  #   reset_schannel = true
  #   spns = ["testSPN"]

  #   Optional fields both for creating and updating
  #   allocate_gids = true
  #   allocate_uids = true
  #   assume_default_domain = true
  #   authentication = true
  #   check_online_interval = 310
  #   controller_time = 1692087697
  #   create_home_directory = true
  #   domain_offline_alerts = true
  #   extra_expected_spns = ["testExtraExpectedSPN"]
  #   findable_groups = ["testFindableGroup"]
  #   findable_users = ["testFindableUser"]
  #   home_directory_template = "testHomeDirectoryTemplate"
  #   ignore_all_trusts = true
  #   ignored_trusted_domains = ["testIgnoredTrustedDomain"]
  #   include_trusted_domains = ["testIncludeTrustedDomain"]
  #   ldap_sign_and_seal = true
  #   login_shell = "testLoginShell"
  #   lookup_domains = ["testLookupDomains"]
  #   lookup_groups = true
  #   lookup_normalize_groups = true
  #   lookup_normalize_users = true
  #   lookup_users = true
  #   machine_password_changes = true
  #   machine_password_lifespan = 2591000
  #   node_dc_affinity = "testNodeDcAffinity"
  #   node_dc_affinity_timeout = 1000000
  #   nss_enumeration = true
  #   restrict_findable = true
  #   rpc_call_timeout = 70
  #   server_retry_limit = 4
  #   sfu_support = "testSfuSupport"
  #   store_sfu_mappings = true
  #   unfindable_groups = ["testUnfindableGroup"]
  #   unfindable_users = ["testUnfindableUser"]
}

# After the execution of above resource block, ADS Provider would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

name (String) Specifies the Active Directory provider name.
password (String, Sensitive) Specifies the password used during domain join.
user (String) Specifies the user name that has permission to join a machine to the given domain.

Optional

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_duplicates (Boolean) Check for duplicate SPNs registered in Active Directory.
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.
dns_domain (String) Specifies the DNS search domain. Set this parameter if the DNS search domain has a unique name or address.
domain_controller (String) Specifies the domain controller to which the authentication service should send requests
domain_offline_alerts (Boolean) Sends an alert if the domain goes offline.
extra_expected_spns (Set of String) List of additional SPNs to expect beyond what automatic checking routines might find
findable_groups (Set of String) Sets list of groups that can be resolved.
findable_users (Set of String) Sets list of users that can be resolved.
groupnet (String) Groupnet identifier.
home_directory_template (String) Specifies the path to the home directory template.
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 (Set 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.
kerberos_hdfs_spn (Boolean) Determines if connecting through HDFS with Kerberos.
kerberos_nfs_spn (Boolean) Determines if connecting through NFS with Kerberos.
ldap_sign_and_seal (Boolean) Enables encryption and signing on LDAP requests.
login_shell (String) Specifies the login shell path.
lookup_domains (Set 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.
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.
organizational_unit (String) Specifies the organizational unit.
reset_schannel (Boolean) Resets the secure channel to the primary domain.
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.
scope (String) When specified as ’effective’, or not specified, all fields are returned. When specified as ‘user’, only fields with non-default values are shown. When specified as ‘default’, the original values are returned.
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.
spns (Set of String) Currently configured SPNs.
store_sfu_mappings (Boolean) Stores SFU mappings permanently in the ID mapper.
unfindable_groups (Set of String) Specifies groups that cannot be resolved by the provider.
unfindable_users (Set of String) Specifies users that cannot be resolved by the provider.

Read-Only

dup_spns (List of String) Get duplicate SPNs in the provider domain
forest (String) Specifies the Active Directory forest.
hostname (String) Specifies the fully qualified hostname stored in the machine account.
netbios_domain (String) Specifies the NetBIOS domain name associated with the machine account.
primary_domain (String) Specifies the AD domain to which the provider is joined.
recommended_spns (List of String) Configuration recommended SPNs.
site (String) Specifies the site for the Active Directory.
status (String) Specifies the status of the provider.
system (Boolean) If set to true, indicates that this provider instance was created by OneFS and cannot be removed.
zone_name (String) Specifies the name of the access zone in which this provider was created.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_adsprovider.ads_test <name>
# Example:
terraform import powerscale_adsprovider.ads_test ads_id
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_cluster_email resource

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

powerscale_cluster_email (Resource)

This resource is used to manage the Cluster Email Settings entity of PowerScale Array. PowerScale Cluster Email Settings provide the ability to configure email settings on the cluster.We can Create, Update and Delete the Cluster Email Settings using this resource. We can also import existing Cluster Email Settings from PowerScale array. Note that, Cluster Email Settings is the native functionality of PowerScale. When creating the resource, we actually load Cluster Email Settings from PowerScale to the resource state.

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

# Available actions: Create, Update, Delete and Import
# If resource arguments are omitted, `terraform apply` will load SmartPools Settings from PowerScale, and save to
# terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load SmartPools Settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting SmartPools Settings from PowerScale.
# For more information, Please check the terraform state file.

resource "powerscale_cluster_email" "test" {
  settings = {
    # Optional fields when updating.

    # batch_mode = "all"
    # mail_relay = ""
    # mail_sender = ""
    # mail_subject = ""
    # smtp_auth_passwd = ""
    # smtp_auth_security = "none"
    # smtp_auth_username = ""
    # smtp_port = 6225
    # use_smtp_auth = false
    # user_template = ""

  }

}

# After the execution of above resource block, Cluster Email Settings would have been cached in terraform state file, and
# Cluster Email Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Required

settings (Attributes) Cluster email notification settings. (see below for nested schema)

Read-Only

id (String) ID of the Cluster Email Settings.

Nested Schema for `settings`

Optional:

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 (String) Password to authenticate with if SMTP authentication is being used.
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. If this string is empty, the default template will be used.

Read-Only:

smtp_auth_passwd_set (Boolean) Indicates if an SMTP authentication password is set.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_cluster_email.email <anystring>
# Example:
terraform import powerscale_cluster_email.email cluster_email
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_cluster_identity resource

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

powerscale_cluster_identity (Resource)

This resource is used to manage the Cluster Identity settings of PowerScale Array. We can Create, Update and Delete the Cluster Identity using this resource. We can also import the existing Cluster Identity settings from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load Cluster identity Settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load Cluster identity Settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting identity Settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale Cluster identity Settings allow you to change the settings of identity
resource "powerscale_cluster_identity" "example_identity_settings" {
  # Optional fields both for creating and updating

  # The name for this cluster.
  # It must contain only alphanumeric characters, underscores, and hyphens.
  # Spaces are not allowed.
  # The name must be unique within the cluster.
  name = "cluster1"

  # The description of the cluster.
  description = "cluster1 description"

  # The information displayed when a user logs in to the cluster.
  logon = {
    # The message of the day.
    motd = "motd"
    # The header to the message of the day.
    motd_header = "motd header"
  }
}
# After the execution of above resource block, Cluster identity Settings would have been cached in terraform state file, or
# identity Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

description (String) A description of the cluster.
logon (Attributes) The information displayed when a user logs in to the cluster. (see below for nested schema)
name (String) A unique name for this cluster.

Read-Only

id (String) The id for this cluster.

Nested Schema for `logon`

Optional:

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_cluster_identity.example_identity_settings <anyString>
# Example:
terraform import powerscale_cluster_identity.example_identity_settings "cluster_identity"
# after running this command, populate fields as per your requirement in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_cluster_owner resource

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

powerscale_cluster_owner (Resource)

This resource is used to manage the Cluster Owner Settings entity of PowerScale Array. PowerScale Cluster Owner Settings provide the ability to configure owner settings on the cluster.We can Create, Update and Delete the Cluster Owner Settings using this resource. We can also import existing Cluster Owner Settings from PowerScale array. Note that, Cluster Owner Settings is the native functionality of PowerScale. When creating the resource, we actually load Cluster Owner Settings from PowerScale to the resource state.

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

# Available actions: Create, Update, Delete and Import
# If resource arguments are omitted, `terraform apply` will load Cluster Owner Details from PowerScale, and save to
# terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load Cluster Owner Details (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting Cluster Owner Details from PowerScale.
# For more information, Please check the terraform state file.

resource "powerscale_cluster_owner" "test" {
  company          = "company_name"
  location         = "location"
  primary_email    = "primary_email@example.com"
  primary_name     = "primary_name"
  primary_phone1   = "+91-12345-67890"
  primary_phone2   = "+1 123-456-7890" # primary alternate phone number
  secondary_email  = "secondary_email@example.com"
  secondary_name   = "secondary_name"
  secondary_phone1 = "+44 (20) 1234 5678"
  secondary_phone2 = "+1 (800) 555-5555" # secondary alternate phone number
}

# After the execution of above resource block, Cluster Owner Settings would have been cached in terraform state file, and
# Cluster Owner Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

company (String) Company Name of the Cluster Owner Settings.
location (String) Location of the Cluster Owner Settings.
primary_email (String) Primary Email of the Cluster Owner Settings.
primary_name (String) Primary Name of the Cluster Owner Settings.
primary_phone1 (String) Primary Phone of the Cluster Owner Settings.
primary_phone2 (String) Primary Alternate Phone of the Cluster Owner Settings.
secondary_email (String) Secondary Email of the Cluster Owner Settings.
secondary_name (String) Secondary Name of the Cluster Owner Settings.
secondary_phone1 (String) Secondary Phone of the Cluster Owner Settings.
secondary_phone2 (String) Secondary Alternate Phone of the Cluster Owner Settings.

Read-Only

id (String) ID of the Cluster Owner Settings.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_cluster_owner.owner <anystring>
# Example:
terraform import powerscale_cluster_owner.owner cluster_owner
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_cluster_snmp resource

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

powerscale_cluster_snmp (Resource)

This resource is used to manage the Cluster SNMP settings of PowerScale Array. We can Create, Update and Delete the Cluster SNMP using this resource. We can also import the existing Cluster SNMP settings from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load Cluster SNMP Settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load CLuster SNMP Settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting SNMP Settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale Cluster SNMP Settings allow you to change the settings of SNMP
resource "powerscale_cluster_snmp" "example_snmp_settings" {
  # Required field
  enabled = true //enables/disables cluster SNMP Settings

  # Optional fields both for creating and updating

  # read_only_community ="Public"
  # snmp_v1_v2c_access = true
  # snmp_v3_auth_protocol = "SHA"
}
# After the execution of above resource block, Cluster SNMP Settings would have been cached in terraform state file, or
# SNMP Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Required

enabled (Boolean) True if the Cluster SNMP is enabled. If true, either snmp_v1v2_access or snmp_v3_access is required.

Optional

read_only_community (String) The read-only community string for the Cluster SNMP.
snmp_v1_v2c_access (Boolean) The SNMPv1/v2c access for the Cluster SNMP. Also requires read_only_community.
snmp_v3_access (Boolean) The SNMPv3 access for the Cluster SNMP. Also requires snmp_v3_password.
snmp_v3_auth_protocol (String) The SNMPv3 authentication protocol for the Cluster SNMP. Accepted values are MD5and SHA.
snmp_v3_password (String) The SNMPv3 authentication password for the Cluster SNMP.
snmp_v3_priv_password (String) The SNMPv3 privacy protocol password for the Cluster SNMP.
snmp_v3_priv_protocol (String) The SNMPv3 privacy protocol for the Cluster SNMP.
snmp_v3_read_only_user (String) The SNMPv3 read-only user for the Cluster SNMP.
snmp_v3_security_level (String) The SNMPv3 security level for the Cluster SNMP.
system_contact (String) The system contact for the Cluster SNMP.
system_location (String) The system location for the Cluster SNMP.

Read-Only

id (String) ID of the Cluster SNMP.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_cluster_snmp.example_snmp_settings <anyString>
# Example:
terraform import powerscale_cluster_snmp.example_snmp_settings "cluster_snmp"
# after running this command, populate the enabled field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_cluster_time resource

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

powerscale_cluster_time (Resource)

This resource is used to manage the Cluster Time settings of PowerScale Array. We can Create, Update and Delete the Cluster Time using this resource. We can also import an existing Cluster Time from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# If resource arguments are omitted, `terraform apply` will load Cluster Time Details from PowerScale, and save to
# terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load Cluster Time Details (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting Cluster Time Details from PowerScale.
# For more information, Please check the terraform state file.

resource "powerscale_cluster_time" "test" {
  date = "01/12/2024"
  time = "00:32"
  path = "Asia/Kolkata"
}

# After the execution of above resource block, Cluster Time Settings would have been cached in terraform state file, and
# Cluster Time Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

date (String) Date of the Cluster Time Settings, Please follow format MM/dd/yyyy
path (String) Timezone hierarchical name.
time (String) Time of the Cluster Time Settings, Please follow format HH:mm

Read-Only

abbreviation (String) Timezone abbreviation.
id (String) ID of the Cluster Time Settings.
time_millis (Number) Time in Miliseconds of the Cluster

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_cluster_time.time <anystring>
# Example:
terraform import powerscale_cluster_time.time cluster_time
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_filepool_policy resource

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

powerscale_filepool_policy (Resource)

This resource is used to manage the File Pool Policy entity of PowerScale Array. We can Create, Update and Delete the File Pool Policy using this resource. We can also import an existing File Pool Policy from PowerScale array. PowerScale File Pool Policy can identify logical groups of files and specify storage operations for these files.

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

# Available actions: Create, Update, Delete and Import.
# After `terraform apply` of this example file it will create a new file pool policy with the name set in `name` attribute on the PowerScale.

# PowerScale File Pool Policy can identify logical groups of files and specify storage operations for these files.
resource "powerscale_filepool_policy" "example_filepool_policy" {
  # Required name for creating and updating.
  # A unique name for this policy. If the policy is default policy, its name should be "Default policy". (Update Supported)
  name = "filePoolPolicySample"

  # Optional is_default_policy for creating. Specifies if the policy is default policy. 
  # Default policy applies to all files not selected by higher-priority policies.
  is_default_policy = false

  # Optional params for creating and updating.
  # Specifies the file matching rules for determining which files will be managed by this policy. (Update Supported)
  file_matching_pattern = {
    or_criteria = [
      {
        and_criteria = [
          # {
          #   # The file attribute to be compared to a given value. 
          #   # Acceptable values are: name, path, link_count, accessed_time, birth_time, changed_time, metadata_changed_time, size, file_type, custom_attribute.
          #   type = "custom_attribute"
          #   # The comparison operator to use while comparing an attribute with its value.
          #   # Acceptable values are: ==, !=, >, >=, <, <=, !.
          #   operator = "=="
          #   # The value to be compared against a file attribute
          #   value = "high"
          #   # 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}
          #   use_relative_time = true
          #   # Indicates whether the existence of an attribute indicates a match (valid only with 'type' = 'custom_attribute')
          #   attribute_exists = true
          #   # True to match the path exactly, False to match any subtree. (valid only with 'type' = 'path')
          #   begins_with = true
          #   # True to indicate case sensitivity when comparing file attributes (valid only with 'type' = 'name' or 'type' = 'path')
          #   case_sensitive = true
          #   # File attribute field name to be compared in a custom comparison (valid only with 'type' = 'custom_attribute')
          #   field = "importance"
          #   # Size unit value. One of 'B','KB','MB','GB','TB','PB','EB' (valid only with 'type' = 'size')
          #   units = "GB"
          # },
          {
            operator = ">"
            type     = "size"
            units    = "B"
            value    = "1073741824"
          },
          {
            operator          = ">"
            type              = "birth_time"
            use_relative_time = true
            value             = "20"
          },
          {
            operator          = ">"
            type              = "metadata_changed_time"
            use_relative_time = false
            value             = "1704742200"
          },
          {
            operator          = "<"
            type              = "accessed_time"
            use_relative_time = true
            value             = "20"
          }
        ]
      },
      {
        and_criteria = [
          {
            operator          = "<"
            type              = "changed_time"
            use_relative_time = false
            value             = "1704820500"
          },
          {
            attribute_exists = false
            field            = "test"
            type             = "custom_attribute"
            value            = ""
          },
          {
            operator = "!="
            type     = "file_type"
            value    = "directory"
          },
          {
            begins_with    = false
            case_sensitive = true
            operator       = "!="
            type           = "path"
            value          = "test"
          },
          {
            case_sensitive = true
            operator       = "!="
            type           = "name"
            value          = "test"
          }
        ]
      }
    ]
  }
  # A list of actions to be taken for matching files. (Update Supported)
  actions = [
    # {
    #   # Action for set_data_access_pattern type. Set data access pattern optimization. Acceptable values: random, concurrency, streaming.
    #   data_access_pattern_action = "concurrency"
    #   # Action for apply_data_storage_policy.
    #   data_storage_policy_action = {
    #     # Specifies the SSD strategy. Acceptable values: metadata, metadata-write, data, avoid.
    #     ssd_strategy ="metadata"
    #     # Specifies the storage target.
    #     storagepool = "anywhere"
    #   }
    #   # Action for apply_snapshot_storage_policy.
    #   snapshot_storage_policy_action = {
    #     # Specifies the SSD strategy. Acceptable values: metadata, metadata-write, data, avoid.
    #     ssd_strategy ="metadata"
    #     # Specifies the snapshot storage target.
    #     storagepool = "anywhere"
    #   }
    #   # Action for enable_coalescer type. Set write performance optimization. True to enable SmartCache action.
    #   enable_coalescer_action = true
    #   # Action for enable_packing type. True to enable enable_packing action.
    #   enable_packing_action = true
    #   # 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.
    #   requested_protection_action = "default"
    #   # Action for set_cloudpool_policy type.
    #   cloudpool_policy_action = {
    #     # Specifies if files with snapshots should be archived.
    #     archive_snapshot_files = true
    #     # Specifies default cloudpool cache settings for new filepool policies.
    #     cache = {
    #       # Specifies cache expiration.
    #       expiration = 86400
    #       # Specifies cache read ahead type. Acceptable values: partial, full.
    #       read_ahead = "partial"
    #       # Specifies cache type. Acceptable values: cached, no-cache.
    #       type = "cached"
    #     }
    #     # Specifies if files should be compressed.
    #     compression = true
    #     # Specifies the minimum amount of time archived data will be retained in the cloud after deletion.
    #     data_retention = 604800
    #     # Specifies if files should be encrypted.
    #     encryption = true
    #     # 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.)
    #     full_backup_retention = 145152000
    #     # 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.)
    #     incremental_backup_retention = 145152000
    #     pool = "cloudPool_policy"
    #     # The minimum amount of time to wait before updating cloud data with local changes.
    #     writeback_frequency = 32400
    #   },
    #   # 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.
    #   action_type = "action_type_acceptable_value"
    # },
    {
      data_access_pattern_action = "concurrency"
      action_type                = "set_data_access_pattern"
    },
    {
      data_storage_policy_action = {
        ssd_strategy = "metadata"
        storagepool  = "anywhere"
      }
      action_type = "apply_data_storage_policy"
    },
    {
      snapshot_storage_policy_action = {
        ssd_strategy = "metadata"
        storagepool  = "anywhere"
      }
      action_type = "apply_snapshot_storage_policy"
    },
    {
      requested_protection_action = "default"
      action_type                 = "set_requested_protection"
    },
    {
      enable_coalescer_action = true
      action_type             = "enable_coalescer"
    },
    {
      enable_packing_action = true,
      action_type           = "enable_packing"
    },
    {
      action_type = "set_cloudpool_policy"
      cloudpool_policy_action = {
        archive_snapshot_files = true
        cache = {
          expiration = 86400
          read_ahead = "partial"
          type       = "cached"
        }
        compression                  = true
        data_retention               = 604800
        encryption                   = true
        full_backup_retention        = 145152000
        incremental_backup_retention = 145152000
        pool                         = "cloudPool_policy"
        writeback_frequency          = 32400
      }
    }
  ]
  # A description for this policy. (Update Supported)
  description = "filePoolPolicySample description"
  # The order in which this policy should be applied (relative to other policies). (Update Supported)
  apply_order = 1
}
# After the execution of above resource block, file pool policy would have been created on the PowerScale array. 
# For more information, Please check the terraform state file. 


# PowerScale Default File Pool Policy applies to all files not selected by higher-priority and can specify storage operations for these files.
resource "powerscale_filepool_policy" "example_default_policy" {
  # Required name for creating and updating.
  # Default Policy name should be "Default policy". (Update Supported)
  name = "Default policy"

  # Optional is_default_policy for creating. Specifies if the policy is default policy. 
  # Default policy applies to all files not selected by higher-priority policies.
  is_default_policy = true

  # Optional actions when creating and updating.
  # A list of actions to be taken for matching files. (Update Supported)
  actions = [
    # {
    #   # Action for set_data_access_pattern type. Set data access pattern optimization. Acceptable values: random, concurrency, streaming.
    #   data_access_pattern_action = "concurrency"
    #   # Action for apply_data_storage_policy.
    #   data_storage_policy_action = {
    #     # Specifies the SSD strategy. Acceptable values: metadata, metadata-write, data, avoid.
    #     ssd_strategy ="metadata"
    #     # Specifies the storage target.
    #     storagepool = "anywhere"
    #   }
    #   # Action for apply_snapshot_storage_policy.
    #   snapshot_storage_policy_action = {
    #     # Specifies the SSD strategy. Acceptable values: metadata, metadata-write, data, avoid.
    #     ssd_strategy ="metadata"
    #     # Specifies the snapshot storage target.
    #     storagepool = "anywhere"
    #   }
    #   # Action for enable_coalescer type. Set write performance optimization. True to enable SmartCache action.
    #   enable_coalescer_action = true
    #   # Action for enable_packing type. True to enable enable_packing action.
    #   enable_packing_action = true
    #   # 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.
    #   requested_protection_action = "default"
    #   # action_type Acceptable values: set_requested_protection, set_data_access_pattern, enable_coalescer, apply_data_storage_policy, apply_snapshot_storage_policy, enable_packing.
    #   action_type = "action_type_acceptable_value"
    # },
    {
      data_access_pattern_action = "concurrency"
      action_type                = "set_data_access_pattern"
    },
    {
      data_storage_policy_action = {
        ssd_strategy = "metadata"
        storagepool  = "anywhere"
      }
      action_type = "apply_data_storage_policy"
    },
    {
      snapshot_storage_policy_action = {
        ssd_strategy = "metadata"
        storagepool  = "anywhere"
      }
      action_type = "apply_snapshot_storage_policy"
    },
    {
      requested_protection_action = "default"
      action_type                 = "set_requested_protection"
    },
    {
      enable_coalescer_action = true
      action_type             = "enable_coalescer"
    },
    {
      enable_packing_action = true,
      action_type           = "enable_packing"
    }
  ]
}
# After the execution of above resource block, Default File Pool Policy would have been cached in terraform state file, or
# Default File Pool Policy would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Required

name (String) A unique name for this policy. If the policy is default policy, its name should be “Default policy”.

Optional

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).
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)
is_default_policy (Boolean) Specifies if the policy is default policy. Default policy applies to all files not selected by higher-priority policies. Cannot be updated.

Read-Only

birth_cluster_id (String) The guid assigned to the cluster on which the policy was created.
id (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 `actions`

Required:

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.

Optional:

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 `actions.cloudpool_policy_action`

Required:

pool (String) Specifies the cloudPool storage target.

Optional:

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.)
writeback_frequency (Number) The minimum amount of time to wait before updating cloud data with local changes.

Nested Schema for `actions.cloudpool_policy_action.cache`

Optional:

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 `actions.data_storage_policy_action`

Required:

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

Nested Schema for `actions.snapshot_storage_policy_action`

Required:

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_matching_pattern`

Required:

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

Nested Schema for `file_matching_pattern.or_criteria`

Required:

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

Nested Schema for `file_matching_pattern.or_criteria.and_criteria`

Required:

type (String) The file attribute to be compared to a given value.

Optional:

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_filepool_policy.example_filepool_policy <policyID>
# Example1:
terraform import powerscale_filepool_policy.example_filepool_policy filePoolPolicySample
# Example2, for default policy, policyID should be "is_default_policy=true":
terraform import powerscale_filepool_policy.example_filepool_policy is_default_policy=true
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_filesystem resource

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

powerscale_filesystem (Resource)

This resource is used to manage the FileSystem (Namespace directory) entity of PowerScale Array. We can Create, Update and Delete the FileSystem using this resource. We can also import an existing FileSystem from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update (owner, group, access_control), Delete and Import existing FileSystem(Namespace directory) from Powerscale array.
# After `terraform apply` of this example file it will create a new FileSystem(Namespace directory) with the name set in `name` attribute in the directory path provided in `directory_path`on the PowerScale array

# PowerScale FileSystem Resource allows you to manage the Namespace Directory on the Powerscale array
resource "powerscale_filesystem" "file_system_test" {
  # Default set to '/ifs'
  # directory_path         = "/ifs"

  # Required attributes
  name = "DirTf"
  group = {
    id   = "GID:0"
    name = "wheel"
    type = "group"
  }
  owner = {
    id   = "UID:1501",
    name = "Guest",
    type = "user"
  }

  # Optional : query_zone, this will default to the default access zone if unset. However is needed if the user trying to be created is not in the default access zone.connection {
  # This should just be the access zone name. 
  # query_zone = "test_access_zone"

  # Optional attributes. Default values set.
  # Creates intermediate folders recursively, when set to true.
  recursive = true
  # Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS, when set to true.
  overwrite = false


  /* Optional : The ACL value for the directory. Users can either provide access rights input such as 'private_read' , 'private' ,
    'public_read', 'public_read_write', 'public' or permissions in POSIX format as '0550', '0770', '0775','0777' or 0700. The Default value is (0700). 
     Modification of ACL is only supported from POSIX to POSIX mode. 
  */

  # access_control = "0777"
}
# After the execution of above resource block, a PowerScale FileSystem(Namespace directory) would have been created at PowerScale array. You can also verify the changes made in terraform state file.

# Steps to create a file system using the SID.

# First use the user datasource to get the UID using the SID.
data "powerscale_user" "getUserWithSID" {
  filter {
    names = [
      {
        name = "Guest"
        sid  = "S-1-5-21-3219966720-1480896164-796802738-501"
      }
    ]
  }
}

# Once you get the UID using the datasource , use that UID while creating your fileystem.

resource "powerscale_filesystem" "ifs_testdir" {
  access_control = "0770"
  directory_path = "/ifs"
  full_path      = "/ifs/new-fs"
  group = {
    id   = "GID:1800"
    name = "Isilon Users"
    type = "group"
  }
  name      = "new-fs"
  overwrite = false
  owner = {
    id   = data.powerscale_user.getUserWithSID.users[0].uid
    name = "Guest"
    type = "user"
  }
  recursive = true
}

Schema

Required

group (Attributes) The group of the Filesystem.(Update Supported) (see below for nested schema)
name (String) FileSystem directory name
owner (Attributes) The owner of the Filesystem.(Update Supported) (see below for nested schema)

Optional

access_control (String) The ACL value for the directory. Users can either provide access rights input such as ‘private_read’ , ‘private’ , ‘public_read’, ‘public_read_write’, ‘public’ or permissions in POSIX format as ‘0550’, ‘0770’, ‘0775’,‘0777’ or 0700. The Default value is (0700). (Update Supported but Modification of ACL is only supported from POSIX to POSIX mode)
directory_path (String) FileSystem directory path.This specifies the path to the FileSystem(Namespace directory) which we are trying to manage. If no directory path is specified, [/ifs] would be taken by default.
full_path (String) The full path of the FileSystem
id (String) FileSystem identifier. Unique identifier for the FileSystem(Namespace directory)
overwrite (Boolean) Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes if set to true.
query_zone (String) Specifies the zone that the object belongs to. Optional and will default to the default access zone if one is not set.
recursive (Boolean) Creates intermediate folders recursively when set to true.

Read-Only

authoritative (String) If the directory has access rights set, then this field returns acl. Otherwise it returns mode.
creation_time (String) File System Resource Creation time
mode (String) Acl mode
type (String) File System Resource type

Nested Schema for `group`

Optional:

id (String) group identifier
name (String) group name
type (String) group type

Nested Schema for `owner`

Optional:

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_filesystem.file_system_test <name>
# Example:
terraform import powerscale_filesystem.file_system_test ifs/DirTf
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_groupnet resource

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

powerscale_groupnet (Resource)

This resource is used to manage the Groupnet entity of PowerScale Array. We can Create, Update and Delete the Groupnet using this resource. We can also import an existing Groupnet from PowerScale array. 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.
*/

# Available actions: Create, Update, Delete and Import.
# After `terraform apply` of this example file it will create a new groupnet with the name set in `name` attribute on the PowerScale.

# PowerScale Groupnet sits above subnets and pools and allows separate Access Zones to contain distinct DNS settings.
resource "powerscale_groupnet" "example_groupnet" {
  # Required name for creating and updating. (Update Supported)
  name = "testGroupnetResourceSample"

  # Optional fields when creating and updating.

  # A description of the groupnet. (Update Supported)
  # description = "description of the groupnet"

  # DNS caching is enabled or disabled. Defaults to True. (Update Supported)
  # dns_cache_enabled = true

  # If enabled, SmartConnect treats subdomains of known dns zones as the known dns zone. This is required for S3 Virtual Host domains. Defaults to True. (Update Supported)
  # allow_wildcard_subdomains = true

  # Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP. Defaults to True. (Update Supported)
  # server_side_dns_search = true

  # Enable or disable DNS resolver rotate. Defaults to False. (Update Supported)
  # dns_resolver_rotate = false

  # List of DNS search suffixes. (Update Supported)
  # dns_search = ["DNS search suffixes"]

  # List of Domain Name Server IP addresses. (Update Supported)
  # dns_servers = ["10.230.44.169"]
}

# After the execution of above resource block, groupnet would have been created on the PowerScale array. 
# For more information, Please check the terraform state file.

Schema

Required

name (String) The name of the groupnet.

Optional

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. Defaults to True.
description (String) A description of the groupnet.
dns_cache_enabled (Boolean) DNS caching is enabled or disabled. Defaults to True.
dns_resolver_rotate (Boolean) Enable or disable DNS resolver rotate. Defaults to False.
dns_search (List of String) List of DNS search suffixes.
dns_servers (List of String) List of Domain Name Server IP addresses.
server_side_dns_search (Boolean) Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP. Defaults to True.

Read-Only

id (String) Unique Interface ID.
subnets (List of String) Name of the subnets in the groupnet.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_groupnet.example_groupnet <groupnetName>
# Example:
terraform import powerscale_groupnet.example_groupnet groupnetName
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_ldap_provider resource

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

powerscale_ldap_provider (Resource)

This resource is used to manage the LDAP provider entity of PowerScale Array. We can Create, Update and Delete the LDAP provider using this resource. We can also import an existing LDAP provider from PowerScale array. PowerScale LDAP provider enables you to define, query, and modify directory services and resources.

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

# Available actions: Create, Update, Delete and Import.
# After `terraform apply` of this example file it will create a new LDAP provider with the name set in `name` attribute on the PowerScale.

# PowerScale LDAP provider enables you to define, query, and modify directory services and resources.
resource "powerscale_ldap_provider" "example_ldap_provider" {
  # Required params for creating and updating.
  # Specifies the name of the LDAP provider.
  name = "ldap_provider_test"
  # Specifies the root of the tree in which to search identities.
  base_dn = "dc=tthe,dc=testLdap,dc=com"
  # Specifies the server URIs. Begin URIs with ldap:// or ldaps://
  server_uris = ["ldap://10.225.108.54"]

  # Optional ignore_unresolvable_server_urls for creating and updating. If true, ignore unresolvable server URIs.
  ignore_unresolvable_server_urls = false

  # Optional groupnet for creating. Specifies the groupnet identifier.
  groupnet = "groupnet0"

  # Optional params for creating and updating.
  # Specifies the attribute name used when searching for alternate security identities.
  alternate_security_identities_attribute = "altSecurityIdentities"
  # If true, enables authentication and identity management through the authentication provider.
  authentication = true
  # If true, connects the provider to a random server.
  balance_servers = true
  # Specifies the distinguished name for binding to the LDAP server.
  bind_dn = ""
  # Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.
  bind_mechanism = "simple"
  # Specifies the timeout in seconds when binding to an LDAP server. Value should between 1 - 3600.
  bind_timeout = 10
  # Specifies the path to the root certificates file.
  certificate_authority_file = ""
  # Specifies the time in seconds between provider online checks. Value should between 0 - 3600.
  check_online_interval = 100
  # Specifies the canonical name.
  cn_attribute = "cn"
  # Automatically create the home directory on the first login.
  create_home_directory = false
  # Specifies the hashed password value.
  crypt_password_attribute = ""
  # Specifies the LDAP Email attribute.
  email_attribute = "mail"
  # If true, enables the LDAP provider.
  enabled = true
  # If true, allows the provider to enumerate groups.
  enumerate_groups = true
  # If true, allows the provider to enumerate users.
  enumerate_users = true
  # Specifies the list of groups that can be resolved.
  findable_groups = []
  # Specifies the list of users that can be resolved.
  findable_users = []
  # Specifies the LDAP GECOS attribute.
  gecos_attribute = "gecos"
  # Specifies the LDAP GID attribute.
  gid_attribute = "gidNumber"
  # Specifies the distinguished name of the entry where LDAP searches for groups are started.
  group_base_dn = ""
  # Specifies the domain for this provider through which groups are qualified.
  group_domain = "LDAP_GROUPS"
  # Specifies the LDAP filter for group objects.
  group_filter = "(objectClass=posixGroup)"
  # Specifies the LDAP Group Members attribute.
  group_members_attribute = "memberUid"
  # Specifies the depth from the base DN to perform LDAP searches. 
  # Acceptable values: default, base, onelevel, subtree, children.
  group_search_scope = "default"
  # Specifies the path to the home directory template.
  home_directory_template = ""
  # Specifies the LDAP Homedir attribute.
  homedir_attribute = "homeDirectory"
  # If true, continues over secure connections even if identity checks fail.
  ignore_tls_errors = false
  # Specifies the groups that can be viewed in the provider.
  listable_groups = []
  # Specifies the users that can be viewed in the provider.
  listable_users = []
  # Specifies the login shell path.
  login_shell = "/bin/bash"
  # Sets the method by which group member lookups are performed. Use caution when changing this option directly.
  # Acceptable values: default, rfc2307bis.
  member_lookup_method = "default"
  # Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.
  member_of_attribute = ""
  # Specifies the LDAP UID attribute, which is used as the login name.
  name_attribute = "uid"
  # Specifies the distinguished name of the entry where LDAP searches for netgroups are started.
  netgroup_base_dn = ""
  # Specifies the LDAP filter for netgroup objects.
  netgroup_filter = "(objectClass=nisNetgroup)"
  # Specifies the LDAP Netgroup Members attribute.
  netgroup_members_attribute = "memberNisNetgroup"
  # Specifies the depth from the base DN to perform LDAP searches.
  # Acceptable values: default, base, onelevel, subtree, children.
  netgroup_search_scope = "default"
  # Specifies the LDAP Netgroup Triple attribute.
  netgroup_triple_attribute = "nisNetgroupTriple"
  # Normalizes group names to lowercase before look up.
  normalize_groups = false
  # Normalizes user names to lowercase before look up.
  normalize_users = false
  # Specifies the LDAP NT Password attribute.
  nt_password_attribute = ""
  # Specifies which NTLM versions to support for users with NTLM-compatible credentials.
  # Acceptable values: all, v2only, none.
  ntlm_support = "all"
  # Specifies the provider domain.
  provider_domain = ""
  # Determines whether to continue over a non-TLS connection.
  require_secure_connection = false
  # If true, checks the provider for filtered lists of findable and unfindable users and groups.
  restrict_findable = true
  # If true, checks the provider for filtered lists of listable and unlistable users and groups.
  restrict_listable = false
  # Specifies the default depth from the base DN to perform LDAP searches.
  # Acceptable values: base, onelevel, subtree, children.
  search_scope = "subtree"
  # Specifies the search timeout period in seconds. Value should between 10 - 3600.
  search_timeout = 100
  # Sets the attribute name that indicates the absolute date to expire the account.
  shadow_expire_attribute = "shadowExpire"
  # Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.
  shadow_flag_attribute = "shadowFlag"
  # Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.
  shadow_inactive_attribute = "shadowInactive"
  # Sets the attribute name that indicates the last change of the shadow information.
  shadow_last_change_attribute = "shadowLastChange"
  # Sets the attribute name that indicates the maximum number of days a password can be valid.
  shadow_max_attribute = "shadowMax"
  # Sets the attribute name that indicates the minimum number of days between shadow changes.
  shadow_min_attribute = "shadowMin"
  # Sets LDAP filter for shadow user objects.
  shadow_user_filter = "(objectClass=shadowAccount)"
  # Sets the attribute name that indicates the number of days before the password expires to warn the user.
  shadow_warning_attribute = "shadowWarning"
  # Specifies the LDAP Shell attribute.
  shell_attribute = "loginShell"
  # Sets the attribute name that indicates the SSH Public Key for the user.
  ssh_public_key_attribute = "sshPublicKey"
  # Specifies the status of the provider.
  status = "online"
  # If true, indicates that this provider instance was created by OneFS and cannot be removed.
  system = false
  # Specifies the minimum TLS protocol version.
  tls_protocol_min = "1.2"
  # Specifies the LDAP UID Number attribute.
  uid_attribute = "uidNumber"
  # Specifies the groups that cannot be resolved by the provider.
  unfindable_groups = ["wheel", "0", "insightiq", "15", "isdmgmt", "16"]
  # Specifies users that cannot be resolved by the provider.
  unfindable_users = ["root", "0", "insightiq", "15", "isdmgmt", "16"]
  # Sets the LDAP Unique Group Members attribute.
  unique_group_members_attribute = ""
  # Specifies a group that cannot be listed by the provider.
  unlistable_groups = []
  # Specifies a user that cannot be listed by the provider.
  unlistable_users = []
  # Specifies the distinguished name of the entry at which to start LDAP searches for users.
  user_base_dn = ""
  # Specifies the domain for this provider through which users are qualified.
  user_domain = "LDAP_USERS"
  # Specifies the LDAP filter for user objects.
  user_filter = "(objectClass=posixAccount)"
  # Specifies the depth from the base DN to perform LDAP searches.
  # Acceptable values: default, base, onelevel, subtree, children.
  user_search_scope = "default"

  # Optional params for creating and updating -  Only available for PowerScale 9.5 and above.
  # 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.
  # tls_revocation_check_level = "none"
  # Specifies the OCSP server URIs. Begin URIs with http://
  # ocsp_server_uris = []
}

# After the execution of above resource block, LDAP provider would have been created on the PowerScale array. 
# For more information, Please check the terraform state file.

Schema

Required

base_dn (String) Specifies the root of the tree in which to search identities.
name (String) Specifies the name of the LDAP provider.
server_uris (List of String) Specifies the server URIs.

Optional

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.
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. Cannot be updated.
home_directory_template (String) Specifies the path to the home directory template.
homedir_attribute (String) Specifies the LDAP Homedir attribute.
ignore_tls_errors (Boolean) If true, continues over secure connections even if identity checks fail.
ignore_unresolvable_server_urls (Boolean) Ignore unresolvable server URIs when creating and updating.
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_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: “base”, “onelevel”, “subtree”, “children”.
search_timeout (Number) Specifies the search timeout period in seconds.
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”.

Read-Only

id (String) Specifies the ID of the LDAP provider.
zone_name (String) Specifies the name of the access zone in which this provider was created.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_ldap_provider.example_ldap_provider <ldapProviderName>
# Example:
terraform import powerscale_ldap_provider.example_ldap_provider ldapProviderName
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_namespace_acl resource

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

powerscale_namespace_acl (Resource)

This resource is used to manage the Namespace ACL on PowerScale Array. We can Create, Update and Delete the Namespace ACL using this resource. We can also import the existing Namespace ACL from PowerScale array. Note that, when creating the resource, we actually load Namespace ACL from PowerScale to the resource state.

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

# Available actions: Create, Update, Delete and Import.
# If only namespace is provided, `terraform apply` will load Namespace ACL from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load Namespace ACL (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting Namespace ACL from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale Namespace ACL allow you to manage the access control list for a namespace.
resource "powerscale_namespace_acl" "example_namespace_acl" {
  # Required and immutable once set
  namespace = "ifs/example"

  #   # Optional query parameters
  #   nsaccess = true
  #   zone = "system"
  #
  #   # Optional fields both for creating and updating
  #   # For owner and group, please provide either the UID/GID or the name+type
  #   owner = {
  #     id = "UID:0"
  #   }
  #   group = {
  #     name = "Isilon Users",
  #     type = "group"
  #   }
  #
  #   # acl_custom is required for updating. It can be set to [] to remove all acl.
  #   # While creating, if owner or group is provided, acl_custom must be specified as well. If none of
  #   # the three parameters are provided, Terraform will load the settings from the array directly.
  #   # For trustee, please provide either the UID/GID or the name+type
  #   # Please notice, the field acl_custom is the raw configuration, PowerScale will identify and calculate the accessrights
  #   # and inherit_flags provided and return its effective settings, which will be represented in the field acl in state.
  #   acl_custom = [
  #     {
  #       accessrights  = ["dir_gen_all"]
  #       accesstype    = "allow"
  #       inherit_flags = ["container_inherit"]
  #       trustee = {
  #         id = "UID:0"
  #       }
  #     },
  #     {
  #       accessrights  = ["dir_gen_write", "dir_gen_read", "dir_gen_execute", "std_read_dac"]
  #       accesstype    = "allow"
  #       inherit_flags = ["container_inherit"]
  #       trustee = {
  #         name = "Isilon Users",
  #         type = "group"
  #       }
  #     },
  #   ]
}

# After the execution of above resource block, Namespace ACL would have been cached in terraform state file, or
# Namespace ACL would have been updated on PowerScale.
# For more information, Please check the terraform state file.

# Example: A comparison of accessrights between acl_custom (user raw configuration) and acl (array effective settings)
# |                  acl_custom                   |        acl        |    note   |
# |-----------------------------------------------|-------------------|-----------|
# |          "dir_gen_all","dir_gen_read"         |   "dir_gen_all"   |     1     |
# |                 "generic_read"                |   "dir_gen_read"  |     2     |
# | "traverse", "std_read_dac", "std_synchronize" | "dir_gen_execute" |     3     |
#
# Note:
# 1. "dir_gen_read" will be merged into "dir_gen_all"
# 2. "generic_read" will be converted to "dir_gen_read" for a directory
# 3. "traverse", "std_read_dac", "std_synchronize" will be combined to "dir_gen_execute"
# These examples are only typical cases for your reference. Not all cases are listed.

Schema

Required

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

Optional

acl_custom (Attributes List) Customer’s raw configuration of the JSON array of access rights. (see below for nested schema)
group (Attributes) Provides the JSON object for the group persona of the owner. (see below for nested schema)
nsaccess (Boolean) Indicates that the operation is on the access point instead of the store path.
owner (Attributes) Provides the JSON object for the group persona of the owner. (see below for nested schema)
zone (String) Indicates the zone of the namespace.

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.
mode (String) Provides the POSIX mode.

Nested Schema for `acl_custom`

Required:

accesstype (String) Grants or denies access control permissions. Options: allow, deny
trustee (Attributes) Provides the JSON object for the group persona of the owner. (see below for nested schema)

Optional:

accessrights (List of String) Specifies the access control permissions for a specific user or group. Options: std_delete, std_read_dac, std_write_dac, std_write_owner, std_synchronize, std_required, generic_all, generic_read, generic_write, generic_exec, dir_gen_all, dir_gen_read, dir_gen_write, dir_gen_execute, file_gen_all, file_gen_read, file_gen_write, file_gen_execute, modify, file_read, file_write, append, execute, file_read_attr, file_write_attr, file_read_ext_attr, file_write_ext_attr, delete_child, list, add_file, add_subdir, traverse, dir_read_attr, dir_write_attr, dir_read_ext_attr, dir_write_ext_attr
inherit_flags (List of String) Grants or denies access control permissions. Options: object_inherit, container_inherit, inherit_only, no_prop_inherit, inherited_ace
op (String) Operations for updating access control permissions. Unnecessary for access right replacing scenario

Nested Schema for `acl_custom.trustee`

Optional:

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`

Optional:

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`

Optional:

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.

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.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_namespace_acl.namespace_acl_test <namespace_path>
# Example:
terraform import powerscale_namespace_acl.namespace_acl_test namespace_path
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_network_rule resource

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

powerscale_network_rule (Resource)

This resource is used to manage the Network Rule entity on PowerScale array. We can Create, Update and Delete the Network Rule using this resource. We can also import an existing Network Rule from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file for the first time, you will create a network rule on the PowerScale

# PowerScale network rule allows you to manage the network rule on the Powerscale array
resource "powerscale_network_rule" "rule" {
  # Required. Name of the provisioning rule.
  name = "tfacc_rule"
  # Required.
  groupnet = "groupnet0"
  # Required.
  subnet = "subnet0"
  # Required.
  pool = "pool0"
  # Required. Interface name the provisioning rule applies to.
  iface = "ext-2"
  # Optional. Description for the provisioning rule.
  description = "tfacc_rule"
  # Optional. Node type the provisioning rule applies to.
  node_type = "any"
}

# After the execution of above resource block, network rule would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

groupnet (String) Name of the groupnet this rule belongs to
iface (String) Interface name the provisioning rule applies to.
name (String) Name of the provisioning rule.
pool (String) Name of the pool this rule belongs to.
subnet (String) Name of the subnet this rule belongs to.

Optional

description (String) Description for the provisioning rule.
node_type (String) Node type the provisioning rule applies to.

Read-Only

id (String) Unique rule ID.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_network_rule.rule groupnet_name.subnet_name.pool_name.rule_name
# Example:
terraform import powerscale_network_rule.rule groupnet0.subnet0.pool0.rule_name
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_network_settings resource

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

powerscale_network_settings (Resource)

This resource is used to manage the Network Settings entity of PowerScale Array. PowerScale Network Settings provide the ability to configure external network configuration on the cluster.We can Create, Update and Delete the Network Settings using this resource. We can also import an existing Network Settings from PowerScale array. Note that, Network Settings is the native functionality of PowerScale. When creating the resource, we actually load Network Settings from PowerScale to the resource state.

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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load Network Settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load Network Settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting Network Settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale Network Settings provide the ability to configure external network configuration on the cluster.
resource "powerscale_network_settings" "example_network_settings" {

  # Optional fields when updating.

  # Enable or disable Source Based Routing. (Update Supported)
  # source_based_routing_enabled = false

  # Delay in seconds for IP rebalance. (Update Supported)
  # sc_rebalance_delay = 0

  # List of client TCP ports. (Update Supported)
  # tcp_ports = [20, 21, 80, 445, 2049]
}

# After the execution of above resource block, Network Settings would have been cached in terraform state file, or
# Network Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

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.

Read-Only

default_groupnet (String) Default client-side DNS settings for non-multitenancy aware programs.
id (String) Network Settings ID.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_network_settings.example_network_settings <anyString>
# Example:
terraform import powerscale_network_settings.example_network_settings anyString
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_networkpool resource

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

powerscale_networkpool (Resource)

This resource is used to manage the network pool entity of PowerScale Array. We can Create, Update and Delete the network pool using this resource. We can also import an existing network pool from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file for the first time, you will create a network pool on the PowerScale

# PowerScale network pool allows you to add network interfaces to network pools to associate address ranges with a node or a group of nodes.
resource "powerscale_networkpool" "pool_test" {
  #   Required (subnet and groupnet cannot be modified once designated)
  #   Recommend using powerscale_groupnet.groupnet_example.name and powerscale_subnet.subnet_example.name to manage network pool together with groupnet and subnet
  name     = "pool_test"
  subnet   = "subnet0"
  groupnet = "groupnet0"

  #   Optional fields both for creating and updating
  #   access_zone = "System"
  #   aggregation_mode = "lacp"
  #   alloc_method = "static"
  #   description = "Test"
  #   ifaces = [
  #     {
  #       iface = "testIface",
  #       lnn = 0
  #     }
  #   ]
  #   nfsv3_rroce_only = false
  #   ranges = [
  #     {
  #       high = "testIPAddress1",
  #       low = "testIPAddress2"
  #     }
  #   ]
  #   rebalance_policy = "auto"
  #   sc_auto_unsuspend_delay = 0
  #   sc_connect_policy = "round_robin"
  #   sc_dns_zone = "testZoneName"
  #   sc_dns_zone_aliases = ["testZoneNameAlias"]
  #   sc_failover_policy = "round_robin"
  #   sc_subnet = "testSubnetName"
  #   sc_ttl = 0
  #   static_routes = [
  #     {
  #       gateway = "testGatewayAddress",
  #       prefixlen = 10,
  #       subnet = "testSubnetAddress"
  #     }
  #   ]
}

# After the execution of above resource block, network pool would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

groupnet (String) Name of the groupnet this pool belongs to. Cannot be modified once designated
name (String) The name of the pool. It must be unique throughout the given subnet.It’s a required field with POST method.
subnet (String) The name of the subnet. Cannot be modified once designated

Optional

access_zone (String) Name of a valid access zone to map IP address pool to the zone.
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.
ifaces (Attributes Set) List of interface members in this pool. (see below for nested schema)
nfsv3_rroce_only (Boolean) Indicates that pool contains only RDMA RRoCE capable interfaces.
ranges (Attributes Set) List of IP address ranges in this pool. (see below for nested schema)
rebalance_policy (String) Rebalance policy..
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 (Set 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_ttl (Number) Time to live value for SmartConnect DNS query responses in seconds.
static_routes (Attributes Set) List of interface members in this pool. (see below for nested schema)

Read-Only

addr_family (String) IP address format.
id (String) Unique Pool ID.
rules (List of String) Names of the rules in this pool.
sc_suspended_nodes (List of Number) List of LNNs showing currently suspended nodes in SmartConnect.

Nested Schema for `ifaces`

Optional:

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

Nested Schema for `ranges`

Optional:

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

Nested Schema for `static_routes`

Optional:

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_networkpool.pool_test groupnet_name.subnet_name.pool_name
# Example:
terraform import powerscale_networkpool.pool_test groupnet0.subnet0.pool_test
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_nfs_alias resource

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

powerscale_nfs_alias (Resource)

This resource is used to manage the NFS Alias entity of PowerScale Array. We can Create, Update and Delete the NFS Aliases using this resource. We can also import an existing NFS Alias from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import.
# After `terraform apply` of this example file will create the nfs alias on the PowerScale array with the attributes set in the config.
# For update, only name and path is supported. Zone Cannot be updated.

resource "powerscale_nfs_alias" "example" {
  # Required field both for creating and updating
  name = "/exampleNfs"
  path = "/ifs"

  # Optional attribute for creating and updating
  zone = "System"
}

Schema

Required

name (String) Specifies the name by which the alias can be referenced.
path (String) Specifies the path to which the alias points.

Optional

zone (String) Specifies the zone in which the alias is valid.

Read-Only

health (String) Specifies whether the alias is usable.
id (String) Specifies a string which represents the unique location of the alias.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
#terraform import powerscale_nfs_alias.example global_setting name_of_nfs_alias
# Example:
terraform import powerscale_nfs_alias.example global_setting "alias"
# after running this command, populate parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource.

V1.8.1: powerscale_nfs_export resource

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

powerscale_nfs_export (Resource)

This resource is used to manage the NFS export entity of PowerScale Array. PowerScale provides an NFS server so you can share files on your cluster. We can Create, Update and Delete the NFS export using this resource. We can also import an existing NFS export from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will create NFS export on specified paths on the PowerScale

# PowerScale provides an NFS server so you can share files on your cluster
resource "powerscale_nfs_export" "example_export" {
  # Required path for creating
  paths = ["/ifs/example_export"]

  # Computed identifier for export
  # id = 1

  # Optional parameter when creating
  # ignore_bad_auth = true
  # ignore_bad_paths= true
  # ignore_conflicts = true
  # ignore_unresolvable_hosts = true
  # zone = "System"

  # Optional parameter when creating and updating. Will ignore the conflict when set true
  # force = true

  # Optional query. Will return the information according to scope
  # scope = "default"

  # Computed attributes, can be updated
  # all_dirs = false
  # block_size = 8192
  # can_set_time = true
  # case_insensitive = true
  # case_preserving = false
  # chown_restricted = false
  # clients = ["client1"]
  # commit_asynchronous = false
  # conflicting_paths = ["/ifs/conflicting_path"]
  # description = "Example path"
  # directory_transfer_size = 131072
  # encoding = "DEFAULT"
  # link_max = 32767
  # map_all = {
  #   enabled = false,
  #   primary_group = {
  #       id = "GROUP:nobody"
  #   }
  #   secondary_groups = [
  #     {
  #       id   = "GROUP:Users"
  #     }
  #   ]
  #   user = {
  #       id = "USER:nobody"
  #   }
  # }
  # map_failure = {}
  # map_full = true
  # map_lookup_uid = false
  # map_non_root = {}
  # map_retry = true
  # map_root = {}
  # max_file_size = 9223372036854775807
  # name_max_size = 255
  # no_truncate = false
  # read_only = false
  # read_only_clients = []
  # read_transfer_max_size = 1048576
  # read_transfer_multiple = 4194304
  # read_transfer_size = 131072
  # read_write_clients = []
  # readdirplus = true
  # readdirplus_prefetch = 10
  # return_32bit_file_ids = false
  # root_clients = []
  # security_flavors = ["unix"]
  # setattr_asynchronous = false
  # snapshot = "-"
  # symlinks = true
  # time_delta = 0.0000000009999999717180685
  # unresolved_clients = []
  # write_datasync_action = "DATASYNC"
  # write_datasync_reply = "DATASYNC"
  # write_filesync_action = "FILESYNC"
  # write_filesync_reply = "FILESYNC"
  # write_transfer_max_size = 1048576
  # write_transfer_multiple = 512
  # write_transfer_size = 524288
  # write_unstable_action = "UNSTABLE"
  # write_unstable_reply = "UNSTABLE"
}

# After the execution of above resource block, an NFS export would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

paths (Set of String) Specifies the paths under /ifs that are exported.

Optional

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 (Set of String) Specifies the clients with root access to the export.
commit_asynchronous (Boolean) True if NFS commit requests execute asynchronously.
conflicting_paths (Set 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.
force (Boolean) If true, the export will be created even if it conflicts with another export.
ignore_bad_auth (Boolean) Ignore invalid users.
ignore_bad_paths (Boolean) Ignore nonexistent or otherwise bad paths.
ignore_conflicts (Boolean) Ignore conflicts with existing exports.
ignore_unresolvable_hosts (Boolean) Ignore unresolvable hosts.
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_only_clients (Set 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 (Set 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 (Set of String) Clients that have root access to the export.
scope (String) When specified as ’effective’, or not specified, all fields are returned. When specified as ‘user’, only fields with non-default values are shown. When specified as ‘default’, the original values are returned.
security_flavors (Set 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. Cannot be changed once set

Read-Only

id (Number) Specifies the system-assigned ID for the export. This ID is returned when an export is created through the POST method.
unresolved_clients (Set of String) Reports clients that cannot be resolved.

Nested Schema for `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_nfs_export.example_export [<zoneID>]:<name>
# Example 1:  <zoneID> is Optional, defaults to System:
terraform import powerscale_nfs_export.example_export example_export
# Example 2:
terraform import powerscale_nfs_export.example_export zone_id:example_export
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_nfs_export_settings resource

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

powerscale_nfs_export_settings (Resource)

This resource is used to manage the NFS Export Settings of PowerScale Array. We can Create, Update and Delete the NFS Export Settings using this resource.
Note that, NFS Export Settings is the native functionality of PowerScale. When creating the resource, we actually load NFS Export Settings from PowerScale to the resource.

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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load NFS export settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load NFS export settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting NFS export settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale NFS Export Settings allow you to configure NFS export settings on PowerScale.
resource "powerscale_nfs_export_settings" "example" {
  # Optional fields both for creating and updating
  #  all_dirs = false
  #  case_insensitive = false
  #  case_preserving = true
  #  commit_asynchronous = false
  #  no_truncate = false
  #  write_datasync_action = "DATASYNC"
  #  security_flavors = ["unix"]
  #  map_non_root = {
  #    enabled = false
  #    primary_group = {}
  #    secondary_groups = []
  #    user = {
  #      id = "USER:nobody"
  #    }
  #  }
  #
  # Specifies the zone in which the export is valid. Notice that update this field will change the resource you manage.
  #  zone = "System"
}

# After the execution of above resource block, NFS export settings would have been cached in terraform state file, or
# NFS export settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

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. Use “-” to set to default value.
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.

Read-Only

id (String) Id of NFS Export settings. Readonly.

Nested Schema for `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 `map_all.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_all.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_all.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `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 `map_failure.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_failure.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_failure.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `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 `map_non_root.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_non_root.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_non_root.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `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 `map_root.primary_group`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_root.secondary_groups`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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 `map_root.user`

Optional:

id (String) Specifies the serialized form of a persona, which can be ‘GID:0’, ‘GROUP:wheel’
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.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_nfs_export_settings.example <zoneName>
# Example:
terraform import powerscale_nfs_export_settings.example zoneName
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_nfs_global_settings resource

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

powerscale_nfs_global_settings (Resource)

This resource is used to manage the NFS Global Settings of PowerScale Array. We can Create, Update and Delete the NFS Global Settings using this resource.
Note that, NFS Global Settings is the native functionality of PowerScale. When creating the resource, we actually load NFS Global Settings from PowerScale to the resource.

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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load NFS global settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load NFS global settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting NFS global settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale NFS Global Settings allow you to configure NFS global settings on PowerScale.
resource "powerscale_nfs_global_settings" "example" {
  # Optional fields both for creating and updating
  #  nfsv3_enabled = true
  #  nfsv3_rdma_enabled = false
  #  nfsv4_enabled = false
  #  rpc_maxthreads = 16
  #  rpc_minthreads = 16
  #  rquota_enabled = false
  #  service = true
}

# After the execution of above resource block, NFS global settings would have been cached in terraform state file, or
# NFS global settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

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.

Read-Only

id (String) Id of NFS Global settings. Readonly.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_nfs_global_settings.example <anyString>
# Example:
terraform import powerscale_nfs_global_settings.example anyString
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_nfs_zone_settings resource

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

powerscale_nfs_zone_settings (Resource)

This resource is used to manage the NFS Zone Settings of PowerScale Array. We can Create, Update and Delete the NFS Zone Settings using this resource.
Note that, NFS Zone Settings is the native functionality of PowerScale. When creating the resource, we actually load NFS Zone Settings from PowerScale to the resource.

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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load NFS zone settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load NFS zone settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting NFS zone settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale NFS zone settings allow you to configure NFS zone settings on PowerScale.
resource "powerscale_nfs_zone_settings" "example" {

  # Required field both for creating and updating
  zone = "tfaccAccessZone"

  # Optional fields both for creating and updating
  #  nfsv4_no_names = false
  #  nfsv4_replace_domain = true
  #  nfsv4_allow_numeric_ids = true
  #  nfsv4_domain = "localdomain_tfaccAZ"
  #  nfsv4_no_domain = false
  #  nfsv4_no_domain_uids = true
}

# After the execution of above resource block, NFS zone settings would have been cached in terraform state file, or
# NFS zone settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Required

zone (String) Access zone

Optional

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.

Read-Only

id (String) ID of NFS Zone Settings. Value of ID will be same as the access zone.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_nfs_zone_settings.example zone
# Example:
terraform import powerscale_nfs_zone_settings.example tfaccAccessZone
# after running this command, populate the zone field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_ntpserver resource

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

powerscale_ntpserver (Resource)

This resource is used to manage the NTP Server entity of PowerScale Array. We can Create, Update and Delete the NTP Server using this resource. We can also import an existing NTP Server from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file for the first time, you will create a NTP Server on the PowerScale

# PowerScale NTP Server allows you to synchronize the system time
resource "powerscale_ntpserver" "ntp_server_test" {
  #   Required
  #   Name should be a qualified name of an existing NTP Server and cannot be updated
  name = "ntp_server_example"

  #   Optional parameters for updating
  key = "ntp_server_key_example"
}

# After the execution of above resource block, NTP Server would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

name (String) NTP server name.

Optional

key (String) Key value from key_file that maps to this server.

Read-Only

id (String) Field ID.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_ntpserver.ntp_server_test <name>
# Example:
terraform import powerscale_ntpserver.ntp_server_test ntp_server_id
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_ntpsettings resource

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

powerscale_ntpsettings (Resource)

This resource is used to manage the NTP Settings entity of PowerScale Array. We can Create, Update and Delete the NTP Settings using this resource. We can also import the existing NTP Settings from PowerScale array. Note that, NTP Settings is the native functionality of PowerScale. When creating the resource, we actually load NTP Settings from PowerScale to the resource state.

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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load NTP Settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load NTP Settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting NTP Settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale NTP Settings allow you to change the settings of NTP Servers
resource "powerscale_ntpsettings" "example_ntp_settings" {
  # Optional fields both for creating and updating
  #   chimers = 1
  #   excluded = ["1","2"]
  #   key_file = "/ifs/"
}

# After the execution of above resource block, NTP Settings would have been cached in terraform state file, or
# NTP Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_ntpsettings.example_ntp_settings <anyString>
# Example:
terraform import powerscale_ntpsettings.example_ntp_settings anyString
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_quota resource

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

powerscale_quota (Resource)

This resource is used to manage the Quota entity of PowerScale Array. Quota module monitors and enforces administrator-defined storage limits. We can Create, Update and Delete the Quota using this resource. We can also import an existing Quota from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will create Quota on specified paths on the PowerScale Array.
# For more information, Please check the terraform state file.

# PowerScale Quota module monitors and enforces administrator-defined storage limits.

resource "powerscale_quota" "quota_test" {
  # Required and update not supported
  path              = "/ifs/example_quota"
  type              = "user"
  include_snapshots = "false"

  # Optional and update not supported
  # zone = "System"
  # persona = {
  # id = "UID:1501"
  # name = "Guest"
  # type = "user"
  # }

  # Optional and update supported
  # container = true
  # enforced = false
  # force = false
  # thresholds_on = "applogicalsize"
  # ignore_limit_checks = true
  # thresholds = {
  # advisory = 1000
  # soft = 2000
  # hard = 4000
  # soft_grace = 120
  # }
}

# After the execution of above resource block, a Quota would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

include_snapshots (Boolean) If true, quota governs snapshot data as well as head data.
path (String) The ifs path governed.
type (String) The type of quota.

Optional

container (Boolean) If true, quotas using the quota directory see the quota thresholds as share size.
enforced (Boolean) True if the quota provides enforcement, otherwise an accounting quota.
force (Boolean) Force creation of quotas on the root of /ifs or percent based quotas.
ignore_limit_checks (Boolean) If true, skip child quota’s threshold comparison with parent quota path.
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. Set linked as true or false to link or unlink quota
persona (Attributes) Specifies the persona of the file group. persona is required for user and group type. (see below for nested schema)
thresholds (Attributes) The thresholds of quota (see below for nested schema)
thresholds_on (String) Thresholds apply on quota accounting metric.
zone (String) Optional named zone to use for user and group resolution.

Read-Only

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.
id (String) The system ID given to the quota.
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.
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.
usage (Attributes) The usage of quota (see below for nested schema)

Nested Schema for `persona`

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 `thresholds`

Optional:

advisory (Number) Usage bytes at which notifications will be sent but writes will not be denied.
hard (Number) Usage bytes at which further writes will be denied.
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_grace (Number) Time in seconds after which the soft threshold has been hit before writes will be denied.

Read-Only:

advisory_exceeded (Boolean) True if the advisory threshold has been hit.
advisory_last_exceeded (Number) Time at which advisory threshold was hit.
hard_exceeded (Boolean) True if the hard threshold has been hit.
hard_last_exceeded (Number) Time at which hard threshold was hit.
soft_exceeded (Boolean) True if the soft threshold has been hit.
soft_last_exceeded (Number) Time at which soft threshold was hit

Nested Schema for `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.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_quota.quota_example [<zoneID>]:<id>
# Example 1: <zoneID> is Optional, defaults to System:
terraform import powerscale_quota.quota_example example_quota_id
# Example 2:
terraform import powerscale_quota.quota_example zone_id:example_quota_id
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_role resource

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

powerscale_role (Resource)

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

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file for the first time, you will create a role on the PowerScale

# PowerScale role allows you to permit and limit access to administrative areas of your cluster on a per-user basis through roles.
resource "powerscale_role" "role_test" {
  # Required
  name = "role_test"

  # Optional fields only for creating
  zone = "System"

  # Optional fields both for creating and updating
  description = "role_test_description"
  # To add members, the uid/gid is required. Please use user/user_group datasource to look up the uid/gid needed.
  members = [
    {
      id = "UID:10"
    },
    {
      id = "UID:0"
    },
    {
      id = "GID:31"
    }
  ]
  # To add privileges, the id is required. Please use role privilege datasource to look up the role privilege id needed.
  privileges = [
    {
      id         = "ISI_PRIV_SYS_SUPPORT",
      permission = "r"
    },
    {
      id         = "ISI_PRIV_SYS_SHUTDOWN",
      permission = "r"
    }
  ]
}

# After the execution of above resource block, role would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

name (String) Specifies the name of the role.

Optional

description (String) Specifies the description of the role.
members (Attributes List) Specifies the users or groups that have this role. (see below for nested schema)
privileges (Attributes List) Specifies the privileges granted by this role. (see below for nested schema)
zone (String) Specifies which access zone to use.

Read-Only

id (String) Specifies the ID of the role.

Nested Schema for `members`

Optional:

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.

Nested Schema for `privileges`

Required:

id (String) Specifies the ID of the privilege.

Optional:

permission (String) permission of the privilege, ‘r’ = read , ‘x’ = read-execute, ‘w’ = read-execute-write, ‘-’ = no permission

Read-Only:

name (String) Specifies the name of the privilege.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_role.role_test [<zone_id>:]<role_id>
# Example1, <zone_id> is Optional, defaults to System:
terraform import powerscale_role.role_test role_id
# Example2:
terraform import powerscale_role.role_test zone_id:role_id
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_s3_bucket resource

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

powerscale_s3_bucket (Resource)

This resource is used to manage the S3 Bucket entity of PowerScale Array. PowerScale S3 Bucket map to the PowerScale file system as base directory for Objects. We can Create, Update and Delete the S3 Bucket using this resource. We can also import an existing S3 Bucket from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will create S3 Bucket on specified paths on the PowerScale Array.
# For more information, Please check the terraform state file.

# PowerScale S3 Bucket enables access to file-based data that is stored on OneFS clusters as objects.

resource "powerscale_s3_bucket" "s3_bucket_example" {
  # Required attributes and update not supported
  name = "s3-bucket-example"
  path = "/ifs/s3_bucket_example"

  # Optional attributes and update not supported, 
  # Their default value shows as below if not provided during creation 
  # create_path = false
  # owner = "root"
  # zone = "System"

  # Optional attributes, can be updated
  #
  # By default acl is an empty list. To add an acl item, both grantee and permission are required.
  # Accepted values for permission are: READ, WRITE, READ_ACP, WRITE_ACP, FULL_CONTROL 
  # acl = [{
  #   grantee = {
  #     name = "root"
  #     type = "user"
  #   }
  #   permission = "FULL_CONTROL"
  # }]
  #
  # By default description is empty
  # description = ""
  #
  # Accepted values for object_acl_policy are: replace, deny.
  # The default value would be replace if unset.
  # object_acl_policy = "replace"
}

# After the execution of above resource block, a S3 Bucket would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

name (String) Bucket name.
path (String) Path of bucket within /ifs.

Optional

acl (Attributes List) Specifies properties for an S3 Access Control Entry. (see below for nested schema)
create_path (Boolean) Create path if does not exist.
description (String) Description for this S3 bucket.
object_acl_policy (String) Set behavior of modifying object acls.
owner (String) Specifies the name of the owner.
zone (String) Zone Name.

Read-Only

id (String) Bucket ID.
zid (Number) Zone ID.

Nested Schema for `acl`

Required:

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 `acl.grantee`

Required:

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.

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’.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_s3_bucket.s3_bucket_example [<zoneID>]:<id>
# Example 1: <zoneID> is Optional, defaults to System:
terraform import powerscale_s3_bucket.s3_bucket_example example_s3_bucket_id
# Example 2:
terraform import powerscale_s3_bucket.s3_bucket_example zone_id:example_s3_bucket_id
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_s3_global_settings resource

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

powerscale_s3_global_settings (Resource)

This resource is used to manage the S3 Global Setting entity of PowerScale Array. PowerScale S3 Global Setting map to the PowerScale file system as base directory for Objects. We can Create, Update and Delete the S3 Global Setting using this resource. We can also import an existing S3 Global Setting from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will modify S3 Global Settings on  the PowerScale Array.
# For more information, Please check the terraform state file.

# PowerScale S3 global settings allows you to configure S3 global settings on PowerScale.
resource "powerscale_s3_global_settings" "s3_global_setting" {
  service    = true
  https_only = false
  http_port  = 9097
  https_port = 9098
}

Schema

Optional

http_port (Number) Specifies the HTTP port.
https_only (Boolean) Specifies if the service is HTTPS only.
https_port (Number) Specifies the HTTPS port.
service (Boolean) Specifies if the service is enabled.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_s3_global_settings.s3_global_settings_example <any string>
terraform import powerscale_s3_global_settings.s3_global_settings_example ""

# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_s3_key resource

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

powerscale_s3_key (Resource)

This resource is used to manage the S3 Key Entity of PowerScale Array. PowerScale S3 keys are used to sign the requests you send to the S3 protocol. We can Create, Update and Delete the S3 Key using this resource.

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

# Available actions: Create, Update and Delete
# After `terraform apply` of this example file it will generate the s3 key for the user.
# For more information, Please check the terraform state file.

# PowerScale S3 key to generate the keys for users to sign the requests you send to the S3 protocol.

resource "powerscale_s3_key" "skm" {
  user                     = "tf_user"
  zone                     = "System"
  existing_key_expiry_time = 10
}

output "key" {
  value = powerscale_s3_key.skm
}

Schema

Required

user (String) The username to create the S3 key. This resource will be recreated if the value of this field is changed.
zone (String) The zone of the user. This resource will be recreated if the value of this field is changed.

Optional

existing_key_expiry_time (Number) The expiry of the old secret key in minutes. Optional. It will be applicable only if old_secret_key is exist.

Read-Only

access_id (String) Unique identifier of the S3 key.
old_key_expiry (Number) The expiry of the old key. Computed.
old_key_timestamp (Number) The timestamp of the old key. Computed.
old_secret_key (String) The secret key of the old key. Computed.
secret_key (String) The secret key of the key. Computed.
secret_key_timestamp (Number) The timestamp of the secret key. Computed.

Unless specified otherwise, all fields of this resource can be updated.

V1.8.1: powerscale_s3_zone_settings resource

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

powerscale_s3_zone_settings (Resource)

This resource is used to manage the S3 Zone Settings entity of the PowerScale Array. PowerScale S3 Zone Setting map to access zone configuration which provide default location for creating s3 buckets. We can Create, Update and Delete the S3 Zone Setting using this resource. We can also import an existing S3 Zone Settings from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will modify S3 Zone Settings on  the PowerScale Array.
# For more information, Please check the terraform state file.

# PowerScale S3 Zone settings allows you to configure S3 Zone settings on PowerScale.
resource "powerscale_s3_zone_settings" "s3_zone_setting" {
  zone                         = "tfacc-test"
  root_path                    = "/ifs/"
  base_domain                  = "dell.com"
  bucket_directory_create_mode = 511
  object_acl_policy            = "deny" # replace or deny
}

Schema

Required

zone (String) The name of the access zone you want to update settings for s3 service. If this field is updated, Terraform will delete and then recreate this resource.

Optional

base_domain (String) Base Domain for S3 zone
bucket_directory_create_mode (Number) The permission mode for creating bucket directories.
object_acl_policy (String) The default policy for object access control lists (ACLs), which can be either replace or deny.
root_path (String) The root path for the S3 bucket.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# S3 Zone Settings can be imported by the name of the S3 Zone
# The command is
# terraform import powerscale_s3_zone_settings.s3_zone_settings_example <S3 zone name>
terraform import powerscale_s3_zone_settings.s3_zone_settings_example "System"

# after running this command, populate the zone field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_smartpool_settings resource

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

powerscale_smartpool_settings (Resource)

This resource is used to manage the SmartPools Settings of PowerScale Array. We can Create, Update and Delete the SmartPools Settings using this resource.
Note that, SmartPools Settings is the native functionality of PowerScale. When creating the resource, we actually load SmartPools Settings from PowerScale to the resource.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# If resource arguments are omitted, `terraform apply` will load SmartPools Settings from PowerScale, and save to
# terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load SmartPools Settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting SmartPools Settings from PowerScale.
# For more information, Please check the terraform state file.

resource "powerscale_smartpool_settings" "settings" {
  #    global_namespace_acceleration_enabled = false
  #    manage_io_optimization                = true
  #    manage_io_optimization_apply_to_files = false
  #    manage_protection                     = true
  #    manage_protection_apply_to_files      = false
  #    protect_directories_one_level_higher  = true
  #    spillover_enabled                     = true
  #    spillover_target                      = {
  #      name    = "sample_storagepool"
  #      type    = "storagepool" // anywhere or storagepool. name should be empty string when type is anywhere
  #    }
  #    ssd_l3_cache_default_enabled          = true
  #    ssd_qab_mirrors                       = "all"
  #    ssd_system_btree_mirrors              = "all"
  #    ssd_system_delta_mirrors              = "all"
  #    virtual_hot_spare_deny_writes         = true
  #    virtual_hot_spare_hide_spare          = true
  #    virtual_hot_spare_limit_drives        = 4
  #    virtual_hot_spare_limit_percent       = 4
  #  # Note that, default_transfer_limit_state and default_transfer_limit_pct are mutually exclusive and only one can be specified.
  #    default_transfer_limit_state          = "disabled" // available for PowerScale 9.5 and above
  #    default_transfer_limit_pct            = 90 // available for PowerScale 9.5 and above
}

# After the execution of above resource block, SmartPools Settings would have been cached in terraform state file, or
# SmartPools Settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

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.
global_namespace_acceleration_enabled (Boolean) Enable global namespace acceleration.
global_namespace_acceleration_state (String) Whether or not namespace operation optimizations are currently in effect.
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. Acceptable values: one, all
ssd_system_btree_mirrors (String) Controls number of mirrors of system B-tree blocks to place on SSDs. Acceptable values: one, all
ssd_system_delta_mirrors (String) Controls number of mirrors of system delta blocks to place on SSDs. Acceptable values: one, all
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.

Read-Only

id (String) Id of SmartPools settings. Readonly. Fixed value of “smartpools_settings”

Nested Schema for `spillover_target`

Optional:

name (String) Target pool name if target specified as storagepool, otherwise empty string.
type (String) Type of target pool. Acceptable values: storagepool, anywhere

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_smartpool_settings.settings <anystring>
# Example:
terraform import powerscale_smartpool_settings.settings smartpools_settings
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_smb_server_settings resource

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

powerscale_smb_server_settings (Resource)

This resource is used to manage the SMB Server Settings of PowerScale Array. We can Create, Update and Delete the SMB Server Settings using this resource.
Note that, SMB Server Settings is the native functionality of PowerScale. When creating the resource, we actually load SMB Server Settings from PowerScale to the resource.

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

# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load SMB server settings from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load SMB server settings (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting SMB server settings from PowerScale.
# For more information, Please check the terraform state file.

# PowerScale SMB server settings allow you to configure SMB server settings on PowerScale.
resource "powerscale_smb_server_settings" "example" {

  # Optional fields both for creating and updating
  scope = "effective"
  # access_based_share_enum = false
  # dot_snap_accessible_child = true
  # dot_snap_accessible_root = true
  # dot_snap_visible_child = false
  # dot_snap_visible_root = true
  # enable_security_signatures = false
  # guest_user = "nobody"
  # ignore_eas = false
  # onefs_cpu_multiplier = 4
  # onefs_num_workers = 0
  # reject_unencrypted_access = true
  # require_security_signatures = false
  # server_side_copy = true
  # server_string = "PowerScale Server"
  # service = true
  # support_multichannel = true
  # support_netbios = false
  # support_smb2 = true
  # support_smb3_encryption = false
}

# After the execution of above resource block, SMB server settings would have been cached in terraform state file, or
# SMB server settings would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

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

Read-Only

id (String) ID of SMB Server Settings.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_smb_server_settings.example scope
# Example:
terraform import powerscale_smb_server_settings.example effective
# after running this command, populate the scope field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_smb_share resource

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

powerscale_smb_share (Resource)

This resource is used to manage the SMB share entity on PowerScale array. PowerScale SMB shares provide clients network access to file system resources on the cluster. We can Create, Update and Delete the SMB share using this resource. We can also import an existing SMB Share from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will create NFS export on specified paths on the PowerScale Array.
# For more information, Please check the terraform state file.

# PowerScale SMB shares provide clients network access to file system resources on the cluster
resource "powerscale_smb_share" "share_example" {
  # Required information for creating
  name = "smb_share_example"
  path = "/ifs/smb_share_example"
  permissions = [
    {
      permission      = "full"
      permission_type = "allow"
      trustee = {
        id   = "SID:S-1-1-0",
        name = "Everyone",
        type = "wellknown"
      }
    }
  ]

  # Zone is optional while creating and updating
  # zone = "System"

  # Optional attributes, can be updated
  # access_based_enumeration = false
  # access_based_enumeration_root_only = false
  # allow_delete_readonly = false
  # allow_execute_always = false
  # allow_variable_expansion = false
  # auto_create_directory = true
  # browsable = true
  # ca_timeout = 120
  # ca_write_integrity = "write-read-coherent"
  # change_notify = "norecurse"
  # create_path = false
  # create_permissions = "default acl"
  # csc_policy = "manual"
  # description = "description"
  # directory_create_mask = 448
  # directory_create_mode = 0
  # file_create_mask = 448
  # file_create_mode = 64
  # file_filter_extensions = ["ext"]
  # file_filter_type = "deny"
  # file_filtering_enabled = false
  # hide_dot_files = false
  # host_acl = ["example_host"]
  # impersonate_guest = "never"
  # impersonate_user = ""
  # inheritable_path_acl = false
  # mangle_byte_start = 60672
  # mangle_map = ["0x22:-1"]
  # ntfs_acl_support = true
  # oplocks = true
  # run_as_root = [{
  #   id   = "SID:S-1-1-0",
  #   name = "Everyone",
  #   type = "wellknown"
  # }]
  # smb3_encryption_enabled = false
  # sparse_file = false
  # strict_ca_lockout = true
  # strict_flush = true
  # strict_locking = false

  # zid should be computed according to zone
  # zid = 1
}

# After the execution of above resource block, an SMB share would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

name (String) Share name.
path (String) Path of share within /ifs.
permissions (Attributes Set) Specifies an ordered list of permission modifications. (see below for nested schema)

Optional

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.
create_path (Boolean) Create path if does not exist.
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 (Set 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 (Set 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.
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 (Set of String) Character mangle map.
ntfs_acl_support (Boolean) Support NTFS ACLs on files and directories.
oplocks (Boolean) Support oplocks.
run_as_root (Attributes Set) 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.
zone (String) Name of the access zone to which to move this SMB share.

Read-Only

continuously_available (Boolean) Specify if persistent opens are allowed on the share.
id (String) The ID of the smb share.
zid (Number) Numeric ID of the access zone which contains this SMB share.

Nested Schema for `permissions`

Required:

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 `permissions.trustee`

Optional:

id (String) Specifies the serialized form of a persona using security identifier, which can be ‘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 `run_as_root`

Optional:

id (String) Specifies the serialized form of a persona using security identifier, which can be ‘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.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_smb_share.share_example [<zoneID>]:<name>
# Example 1: <zoneID> is Optional, defaults to System:
terraform import powerscale_smb_share.share_example example_share
# Example 2:
terraform import powerscale_smb_share.share_example zone_id:example_share
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_smb_share_settings resource

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

powerscale_smb_share_settings (Resource)

This resource is used to manage the SMB share Settings entity of PowerScale Array. We can Create, Update and Delete the SMB share Settings using this resource. We can also import the existing SMB share Settings from PowerScale array. Note that, SMB share Settings is the native functionality of PowerScale. When creating the resource, we actually load SMB share Settings from PowerScale to the resource state.

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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will create NFS export on specified paths on the PowerScale Array.
# For more information, Please check the terraform state file.

# PowerScale SMB share settings provide clients network access to file system resources on the cluster
resource "powerscale_smb_share_settings" "example" {

  # Required field both for creating and updating
  zone = "System"

  # Optional fields both for creating and updating
  # Please check the acceptable inputs for each setting in the documentation
  #access_based_enumeration           = true
  #access_based_enumeration_root_only = true
  #allow_delete_readonly              = true
  #allow_execute_always               = true
  #ca_timeout                         = 12
  #ca_write_integrity                 = "write-read-coherent"
  #change_notify                      = "none"
  #create_permissions                 = "default acl"
  #directory_create_mask              = 0
  #directory_create_mode              = 0
  #file_create_mask                   = 448
  #file_create_mode                   = 64
  #file_filter_extensions             = []
  #file_filter_type                   = "deny"
  #file_filtering_enabled             = true
  #hide_dot_files                     = true
  #host_acl                           = []
  #impersonate_guest                  = "never"
  #mangle_byte_start                  = 258
  #mangle_map                         = [
  #    "0x01-0x1F:-1",
  #    "0x22:-1",
  #    "0x2A:-1",
  #    "0x3A:-1",
  #    "0x3C:-1",
  #   "0x3E:-1",
  #    "0x3F:-1",
  #    "0x5C:-1",
  #]
  #ntfs_acl_support                   = true
  #oplocks                            = true
  #smb3_encryption_enabled            = true
  #sparse_file                        = true
  #strict_ca_lockout                  = true
  #strict_flush                       = true
  #strict_locking                     = true
  #scope                             = "effective"
}

# After the execution of above resource block, an SMB share Settings would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

zone (String) Name of the access zone in which to update settings

Optional

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 (Set 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 (Set 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 (Set of String) Character mangle map.
ntfs_acl_support (Boolean) Support NTFS ACLs on files and directories.
oplocks (Boolean) Allow oplock requests.
scope (String) When specified as ’effective’, or not specified, all fields are returned. When specified as ‘user’, only fields with non-default values are shown. When specified as ‘default’, the original values are returned.
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.

Read-Only

id (String) ID of SMB share Settings. Value of ID will be same as the access zone.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_smb_share_settings.example zone 
terraform import powerscale_smb_share_settings.example tfaccAccessZone
# after running this command, populate the zone field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_snapshot resource

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

powerscale_snapshot (Resource)

This resource is used to manage the Snapshot entity of PowerScale Array. We can Create, Update and Delete the Snapshot using this resource. We can also import an existing Snapshot from PowerScale array. 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.
*/

# Available actions: Create, Update (name, expire), Delete and Import
# After `terraform apply` of this example file it will create a new snapshot for the path name set in `path` attribute on the PowerScale

# Note: This resource can be used to create a manual snapshot at a single point in time. Howerver, if the user wants to take snapshots on a regular cadence, they should use the snapshot_schedules resource. 

# PowerScale Snapshots is a logical pointer to data that is stored on a cluster at a specific point in time.
resource "powerscale_snapshot" "snap" {

  # Required path to the filesystem to which the snapshot will be taken of
  # This cannot be changed after create
  path = "/ifs/tfacc_file_system_test"

  # Optional name of the new snapshot. If unset uses the current date and time for the name attribute (Can be modified)
  name = "tfacc_snapshot_1"

  # Optional set_expires The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.  (Can be modified)
  # Options: Never(default if unset), 1 Day, 1 Week, 1 Month.
  set_expires = "1 Day"
}

# After the execution of above resource block, snapshot would have been created on the PowerScale array. For more information, Please check the terraform state file.

Schema

Required

path (String) The /ifs path snapshotted. Cannot be updated.

Optional

name (String) The user or system supplied snapshot name. This will be null for snapshots pending delete. Only alphanumeric characters, underscores ( _ ), and hyphens (-) are allowed.
set_expires (String) The amount of time from creation before the snapshot will expire and be eligible for automatic deletion. Resets each time this value is updated

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_snapshot.test <id>
# Example:
terraform import powerscale_snapshot.test id
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_snapshot_restore resource

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

powerscale_snapshot_restore (Resource)

This resource is used to restore the data from the snapshot of PowerScale Array. The restore is done using copy/clone/snaprevert job. We can Create, Update and Delete using this resource.

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

# Restore snapshot using snaprevert job. SnapRevert domain will be deleted once `terraform destroy` is executed.
resource "powerscale_snapshot_restore" "test" {
  snaprevert_params = {
    allow_dup   = true
    snapshot_id = "snapshot_id"
  }
}

# terraform destroy will delete the snaprevert domain if restore is done using snapshot revert.

# Restore snapshot using copy operation
resource "powerscale_snapshot_restore" "test" {
  copy_params = {
    directory = {
      source      = "Path of the snapshot to copy" # e.g. /namespace/ifs/.snapshot/snapshot_name/directory
      destination = "Path of the destination"      # '/' is not required at the start e.g. ifs/dest
      overwrite   = true
    }
  }
}

# Restore snapshot using clone operation
resource "powerscale_snapshot_restore" "test" {
  clone_params = {
    source      = "Path of the snapshot to copy" # e.g. /namespace/ifs/.snapshot/snapshot_name/directory/file
    destination = "Path of the destination"      # '/' is not required at the start e.g. ifs/dest/test.txt
    snapshot_id = "Snapshot ID"
  }
}

Schema

Optional

clone_params (Attributes) Specifies properties for a clone operation. (see below for nested schema)
copy_params (Attributes) Specifies properties for a copy operation. (see below for nested schema)
snaprevert_params (Attributes) Specifies properties for a snapshot revert job. (see below for nested schema)

Read-Only

id (String) Placeholder ID

Nested Schema for `clone_params`

Required:

destination (String) Destination of the snapshot, e.g. ifs/dest/test.txt .
snapshot_id (Number) Snapshot ID.
source (String) Source of the snapshot.

Optional:

overwrite (Boolean) Whether or not to overwrite the destination if it already exists.

Nested Schema for `copy_params`

Optional:

directory (Attributes) Specifies properties for copying directory. (see below for nested schema)
file (Attributes) Specifies properties for copying file. (see below for nested schema)

Nested Schema for `copy_params.directory`

Required:

destination (String) Destination of the snapshot, e.g. ifs/dest.
source (String) Source of the snapshot.

Optional:

continue (Boolean) Whether or not to continue if the destination already exists.
merge (Boolean) Whether or not to merge the destination if it already exists.
overwrite (Boolean) Whether or not to overwrite the destination if it already exists.

Nested Schema for `copy_params.file`

Required:

destination (String) Destination of the snapshot, e.g. ifs/dest/test.txt .
source (String) Source of the snapshot.

Optional:

overwrite (Boolean) Whether or not to overwrite the destination if it already exists.

Nested Schema for `snaprevert_params`

Required:

snapshot_id (Number) Snapshot ID.

Optional:

allow_dup (Boolean) Whether or not to queue the job if one of the same type is already running or queued.

Read-Only:

job_id (Number) Job ID.

Unless specified otherwise, all fields of this resource can be updated.

V1.8.1: powerscale_snapshot_schedule resource

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

powerscale_snapshot_schedule (Resource)

This resource is used to manage the Snapshot Schedule entity on PowerScale array. We can Create, Update and Delete the Snapshot Schedules using this resource. We can also import an existing Snapshot Schedule from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will create NFS export on specified paths on the PowerScale Array.
# For more information, Please check the terraform state file.

# PowerScale SMB shares provide clients network access to file system resources on the cluster
resource "powerscale_snapshot_schedule" "snap_schedule" {
  # Required name of snapshot schedule for creating
  name = "test_snap_schedule"

  # Optional fields

  # The path snapshotted. Default set to : "/ifs"
  # path = "/ifs/tfacc_test"

  # Time value in String for which snapshots created by this snapshot schedule should be retained. Values supported are of format : 
  # "Never Expires, x Second(s), x Minute(s), x Hour(s), x Week(s), x Day(s), x Year(s) where x can be any integer value.
  # Default set to : "1 Week(s)"
  # retention_time = "3 Hour(s)" 

  # Alias name to create for each snapshot.
  # alias = "snap_alias"

  # Pattern expanded with strftime to create snapshot names. Some sample values for pattern are: 'snap-%F' would yield snap-1984-03-20 , 'backup-%FT%T' would yield backup-1984-03-20T22:30:00".
  # Default set to : "ScheduleName_duration_%Y-%m-%d_%H:%M"
  # pattern = "ScheduleName_duration_%Y-%m-%d_%H:%M"

  # The isidate compatible natural language description of the schedule.It specifies the frequency of the schedule.You can specify this as combination of <interval> and <frequency> where each of them can be defined as:  
  #  <interval>:
  # 	  *Every [ ( other | <integer> ) ] ( weekday | day | week [ on <day>] | month [ on the <integer> ] | <day>[, ...] [ of every [ ( other | <integer> ) ] week ] | The last (day | weekday | <day>) of every [ (other | <integer>) ] month | The <integer> (weekday | <day>) of every [ (other | <integer>) ] month | The <integer> of every [ (other | <integer>) ] month | Yearly on <month> <integer> | Yearly on the (last | <integer>) [ weekday | <day> ] of <month>
  #  <frequency>:
  # 			*at <hh>[:<mm>] [ (AM | PM) ] | every [ <integer> ] (hours | minutes) [ between <hh>[:<mm>] [ (AM | PM) ] and <hh>[:<mm>] [ (AM | PM) ] | every [ <integer> ] (hours | minutes) [ from <hh>[:<mm>] [ (AM | PM) ] to <hh>[:<mm>] [ (AM | PM) ]
  #  Additionally:
  # 			<integer> can include "st," "th," or "rd," e.g., "Every 1st month."
  # 			<day> can be a day of the week or a three-letter abbreviation, e.g., "saturday" or "sat."
  # 			<month> must be the name of the month or its abbreviation, e.g., "July" or "Jul."
  # 	Some sample values:  "Every 2 days", "Every 3rd weekday at 11 PM", "Every month on the 15th at 1:30 AM"`
  # Default set to : "every 1 days at 12:00 AM"
  # schedule = "every 1 days at 12:00 AM"

}

# After the execution of above resource block, an SMB share would have been created on the PowerScale array.
# For more information, Please check the terraform state file.

Schema

Required

name (String) The schedule name.

Optional

alias (String) Alias name to create for each snapshot.
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
path (String) The /ifs path snapshotted.
pattern (String) Pattern expanded with strftime to create snapshot names.Some sample values for pattern are: ‘snap-%F’ would yield snap-1984-03-20 , ‘backup-%FT%T’ would yield backup-1984-03-20T22:30:00
retention_time (String) Time value in String for which snapshots created by this snapshot schedule should be retained.Values supported are of format : Never Expires, x Second(s), x Minute(s), x Hour(s), x Day(s), x Week(s), x Year(s) where x can be any integer value
schedule (String) The isidate-compatible natural language description of the schedule. It specifies the frequency of the schedule. You can specify this as combination of and where each of them can be defined as: : *Every [ ( other | ) ] ( weekday | day | week [ on ] | month [ on the ] | [, …] [ of every [ ( other | ) ] week ] | The last (day | weekday | ) of every [ (other | ) ] month | The (weekday | ) of every [ (other | ) ] month | The of every [ (other | ) ] month | Yearly on | Yearly on the (last | ) [ weekday | ] of : *at [:] [ (AM | PM) ] | every [ ] (hours | minutes) [ between [:] [ (AM | PM) ] and [:] [ (AM | PM) ] | every [ ] (hours | minutes) [ from [:] [ (AM | PM) ] to [:] [ (AM | PM) ] Additionally: can include “st,” “th,” or “rd,” e.g., “Every 1st month.” can be a day of the week or a three-letter abbreviation, e.g., “saturday” or “sat.” must be the name of the month or its abbreviation, e.g., “July” or “Jul.” Some sample values: “Every 2 days.”, “Every 3rd weekday at 11 PM.”, “Every month on the 15th at 1:30 AM.”

Read-Only

id (String) The system ID given to the schedule.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

# Copyright (c) 2023-2026 Dell Inc., or its subsidiaries. All Rights Reserved.

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

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


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

# The command is
# terraform import powerscale_snapshot_schedule.snap_schedule <id>
# Example:
terraform import powerscale_snapshot_schedule.snap_schedule id
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_storagepool_tier resource

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

powerscale_storagepool_tier (Resource)

This resource is used to manage the storagepool tier entity of PowerScale Array. We can Create, Update and Delete the storagepool tiers using this resource. We can also import an existing storagepool tier from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import.
# After `terraform apply` of this example file will create the storage pool tier on the PowerScale array with the attributes set in the config.
# For update, name, children, transfer_limit_pct and transfer_limit_state are supported. transfer_limit_pct and transfer_limit_state are mutually exclusive

resource "powerscale_storagepool_tier" "example" {
  # Required field both for creating and updating
  name = "Sample_terraform_tier_7"

  # Optional parameters
  children = [
    "x410_34tb_1.6tb-ssd_64gb"
  ]
  transfer_limit_pct = 40
}

Schema

Required

name (String) Specifies the storagepool tier name.

Optional

children (Set of String) An optional parameter which adds new nodepools to the 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

Read-Only

id (Number) Specifies a string which represents the unique identifier of storagepool tier
lnns (Set of Number) The nodes that are part of this tier.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_storagepool_tier.example id_of_storagepool_tier
# Example:
terraform import powerscale_storagepool_tier.example "tier"
# after running this command, populate parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource.

V1.8.1: powerscale_subnet resource

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

powerscale_subnet (Resource)

This resource is used to manage the Subnet entity on PowerScale array. We can Create, Update and Delete the Subnet using this resource. We can also import an existing Subnet from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create, Update, Delete and Import
# After `terraform apply` of this example file it will create a new subnet with the name set in `name` attribute on the PowerScale

# PowerScale subnet allows you to manage the subnet on the Powerscale array
resource "powerscale_subnet" "subnet" {

  # Required. Name of the new subnet
  name = "subnet1"

  # Required. Name of the groupnet this subnet belongs to
  # Updating is not allowed
  # when managing resource together with groupnet, recommend:
  # groupnet = powerscale_groupnet.example_groupnet.name
  groupnet = "groupnet0"

  # Required. IP address format
  addr_family = "ipv4"

  # Required. Subnet Prefix Length
  prefixlen = 21

  # Optional fields both for creating and updating
  #  description = "terraform subnet"
  #  dsr_addrs = []
  #  gateway="0.0.0.0"
  #  gateway_priority=10
  #  mtu=1500
  #  sc_service_addrs=[{
  #    high="0.0.0.0"
  #    low="0.0.0.0"
  #  }]
  #  sc_service_name=""
  #  vlan_enabled=true
  #  vlan_id=1
}

# After the execution of above resource block, subnet would have been created on the PowerScale array. For more information, Please check the terraform state file.

Schema

Required

addr_family (String) IP address format.
groupnet (String) Name of the groupnet this subnet belongs to. Updating is not allowed.
name (String) The name of the subnet.
prefixlen (Number) Subnet Prefix Length.

Optional

description (String) A description of the subnet.
dsr_addrs (Set of String) List of Direct Server Return addresses.
gateway (String) Gateway IP address.
gateway_priority (Number) Gateway priority.
mtu (Number) MTU of the subnet.
sc_service_addrs (Attributes Set) 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.

Read-Only

base_addr (String) The base IP address.
id (String) Unique Subnet ID.
pools (Set of String) Name of the pools in the subnet.

Nested Schema for `sc_service_addrs`

Optional:

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_subnet.subnet <groupnet_id>.<subnet_id>
# Example:
terraform import powerscale_subnet.subnet groupnet0.subnet0
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_support_assist resource

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

powerscale_support_assist (Resource)

This resource is used to manage the Support Assist settings of PowerScale Array. We can Create, Update and Delete the Support Assist settings using this resource. Note that, Support Assist settings is the native functionality of PowerScale.

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

# Available actions: Create, Read, Update, Delete and Import. Delete will clear the the state file.
# After `terraform apply` of this example file will update the settings according to the attributes set in the config.
# All attributes are optional. This resource expects atleast one attribute to be present in the config.

resource "powerscale_support_assist" "test" {
  supportassist_enabled   = true
  enable_download         = true
  automatic_case_creation = false
  enable_remote_support   = true
  accepted_terms          = true
  access_key              = "key"
  pin                     = "pin"
  telemetry = {
    offline_collection_period = 7200,
    telemetry_enabled         = true,
    telemetry_persist         = true,
    telemetry_threads         = 6
  }
  contact = {
    primary = {
      email      = "abc@gmail.com",
      first_name = "terraform_first",
      language   = "En",
      last_name  = "terraform_last",
      phone      = "1234567890"
    },
    secondary = {
      email      = "xyz@gmail.com",
      first_name = "terraform_second",
      language   = "No",
      last_name  = "terraform",
      phone      = "1234567890"
    }
  }
  connections = {
    mode = "gateway"
    gateway_endpoints = [
      {
        enabled      = true,
        host         = "1.2.3.4",
        port         = 9443,
        priority     = 1,
        use_proxy    = true,
        validate_ssl = true
      },
    ],
    network_pools = ["subnet0:pool0"]
  }
}

Schema

Optional

accepted_terms (Boolean) Set T&C accepted or rejected status
access_key (String) SupportAssist access key
automatic_case_creation (Boolean) True indicates automatic case creation is enabled
connections (Attributes) (see below for nested schema)
contact (Attributes) (see below for nested schema)
enable_download (Boolean) True indicates downloads are enabled
enable_remote_support (Boolean) Allow remote support.
pin (String) SupportAssist pin
supportassist_enabled (Boolean) Whether SupportAssist is enabled
telemetry (Attributes) (see below for nested schema)

Read-Only

id (String) Placeholder ID

Nested Schema for `connections`

Optional:

gateway_endpoints (Attributes List) Gateway details (see below for nested schema)
mode (String) Connection Mode for SupportAssist: can be direct or via gateway
network_pools (List of String) Network pools for gateway use

Nested Schema for `connections.gateway_endpoints`

Optional:

enabled (Boolean) Whether this gateway is enabled/disabled
host (String) Gateway hostname or IPv4 address
port (Number) Gateway port
priority (Number) Gateway’s priority
use_proxy (Boolean) Whether to use Proxy for this gateway
validate_ssl (Boolean) Whether to validate SSL for this gateway

Nested Schema for `contact`

Optional:

primary (Attributes) (see below for nested schema)
secondary (Attributes) (see below for nested schema)

Nested Schema for `contact.primary`

Optional:

email (String) Contact’s email address.
first_name (String) Contact’s first name.
language (String)
last_name (String) Contact’s last name.
phone (String) Contact’s phone number.

Nested Schema for `contact.secondary`

Optional:

email (String) Contact’s email address.
first_name (String) Contact’s first name.
language (String)
last_name (String) Contact’s last name.
phone (String) Contact’s phone number.

Nested Schema for `telemetry`

Optional:

offline_collection_period (Number) Change the offline collection period for when the connection to gateway is down
telemetry_enabled (Boolean) Change the status of telemetry
telemetry_persist (Boolean) Change if files are kept after upload
telemetry_threads (Number) Change the number of threads for telemetry gathers

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_support_assist.example_support_assist <anyString>
# Example:
terraform import powerscale_support_assist.example_support_assist "support_assist"
# After running this command, populate one or more fields in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_synciq_global_settings resource

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

powerscale_synciq_global_settings (Resource)

This resource is used to manage the SyncIQ Global Settings entity of PowerScale Array. We can Update the SyncIQ Global Settings using this resource. We can also import existing SyncIQ Global Settings from PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create and  Update updates the syncIQ  global settings. Delete will delete the state file. Import action is also available.
# After `terraform apply` of this example file will update the settings according to the attributes set in the config

# PowerScale SynIQ global settings allows you to manage the global settings on the Powerscale array
resource "powerscale_synciq_global_settings" "example" {
  preferred_rpo_alert = 3
  source_network = {
    subnet = "subnet0"
    pool   = "pool0"
  }
  report_email            = ["example1@mail.com", "example2@mail.com"]
  renegotiation_period    = 28800
  service                 = "paused"
  rpo_alerts              = true
  restrict_target_network = true
  report_max_count        = 2000
}

# There are other attributes as well. Please refer the documentation.
# After the execution of above resource block, settings would have been updated on the PowerScale array. For more information, Please check the terraform state file.

Schema

Optional

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.
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.
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) ID of the Cluster Email Settings.
report_max_count (Number) The default length of time (in seconds) a policy report will be stored.
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)
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`

Optional:

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_synciq_global_settings.settings <anystring>
# Example:
terraform import powerscale_synciq_global_settings.settings global_setting
# after running this command, populate one or more parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_synciq_peer_certificate resource

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

powerscale_synciq_peer_certificate (Resource)

This resource is used to manage the SyncIQ Peer Certificate entity of PowerScale Array. We can Create, Read, Update and Delete the SyncIQ Peer Certificate using this resource. We can also import existing SyncIQ Peer Certificate from PowerScale array.

Example Usage

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

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

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


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


# Available actions: Create, Read, Update, Delete and Import.

# Step 1: Upload a certificate to the PowerScale filesystem.
# This can be done using the file provisioner.
resource "terraform_data" "cert" {
  provisioner "file" {
    source      = "/root/certs/pscale.crt" # certificate that user has been given
    destination = "/ifs/peerCert1.crt"
  }

  connection {
    type     = "ssh"
    user     = var.username
    password = var.password
    host     = var.powerscaleIP
    port     = var.PowerscaleSSHPort
  }

  provisioner "remote-exec" {
    when   = destroy
    inline = ["rm -f /ifs/peerCert1.crt"]
  }
}

# PowerScale Sync IQ Peer Certificates can be used to establish trust to the peer/target cluster where files are to be replicated to. 
resource "powerscale_synciq_peer_certificate" "certificate" {
  depends_on = [terraform_data.cert]
  // required
  // Cannot be updated
  // If the value of this resource is changed, Terraform will destroy this resource and recreate it.
  path = "/ifs/peerCert1.crt"
  // optional
  name         = "cert1"
  descriptuion = "cert1"
}

# After the execution of above resource block, Sync IQ Certificate would have been cached in terraform state file, or
# Sync IQ Certificate would have been created on PowerScale.
# For more information, Please check the terraform state file.

Schema

Required

path (String) Local path (on the PowerScale filesystem) to the certificate that is to be imported. This resource will be recreated if the value of this field is changed.

Optional

description (String) Description field associated with a certificate provided for administrative convenience.
name (String) Administrator specified name identifier.

Read-Only

id (String) ID of the SyncIQ Peer certificate.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# A Peer Certificate can be imported by its name

# The command to import is
# terraform import powerscale_synciq_peer_certificate.certificate <certificate name>
# Example:
terraform import powerscale_synciq_peer_certificate.certificate2 "peer_certificate_01"

# after running any of these commands, populate the path field with the value "/dummy" to start managing this resource. Add other fields as required.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_synciq_policy resource

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

powerscale_synciq_policy (Resource)

This resource is used to manage the SyncIQ Replication Policy entity of PowerScale Array. We can Create, Read, Update and Delete the SyncIQ Replication Policy using this resource. We can also import existing SyncIQ Replication Policy from PowerScale array.

Example Usage

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

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

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


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


# Available actions: Create, Update, Delete and Import.
# For more information, Please check the terraform state file.

resource "powerscale_synciq_peer_certificate" "cert_10_10_10_10" {
  path        = "/ifs/peerCert_10_10_10_10.pem"
  name        = "peerCert_10_10_10_10"
  description = "Certificate for the replication peer cluster 10.10.10.10"
}

# PowerScale Sync IQ Policies can be used to replicate files or directories from one cluster to another. 
resource "powerscale_synciq_policy" "policy" {
  # Required
  name             = "policy1"
  action           = "sync"
  source_root_path = "/ifs"
  target_host      = "10.10.10.10"
  target_path      = "/ifs/policy1Sink"

  # Optional
  description = "Policy 1 description"
  enabled     = true
  file_matching_pattern = {
    or_criteria = [
      {
        and_criteria = [
          {
            type     = "name"
            value    = "tfacc"
            operator = "=="
          },
        ]
      },
      {
        and_criteria = [
          {
            type     = "size"
            value    = "200MB"
            operator = ">"
          }
        ]
      }
    ]
  }

  source_network = {
    pool   = "pool0"
    subnet = "subnet0"
  }

  accelerated_failback                  = false
  bandwidth_reservation                 = 100
  changelist                            = false
  check_integrity                       = true
  cloud_deep_copy                       = "allow"
  delete_quotas                         = true
  disable_quota_tmp_dir                 = true
  enable_hash_tmpdir                    = true
  encryption_cipher_list                = "aes128-ctr,aes192-ctr,aes256-ctr"
  ignore_recursive_quota                = true
  log_level                             = "fatal"
  priority                              = 1
  report_max_age                        = 3600
  report_max_count                      = 100
  rpo_alert                             = 10
  schedule                              = "Every Monday at 2AM"
  skip_when_source_unmodified           = true
  snapshot_sync_existing                = true
  snapshot_sync_pattern                 = "*"
  source_exclude_directories            = ["/ifs/SourceExcludeDir"]
  source_include_directories            = ["/ifs/SourceIncludeDir"]
  source_snapshot_archive               = true
  source_snapshot_expiration            = 8 * 60 * 60 * 24 # 8 days
  source_snapshot_pattern               = ".*"
  sync_existing_snapshot_expiration     = true
  sync_existing_target_snapshot_pattern = "%%{SnapName}-%%{SnapCreateTime}"
  target_certificate_id                 = powerscale_synciq_peer_certificate.cert_10_10_10_10.id
  target_compare_initial_sync           = true
  target_detect_modifications           = true
  target_snapshot_alias                 = "SIQ-%%{SrcCluster}-%%{PolicyName}-latest"
  target_snapshot_archive               = true
  target_snapshot_expiration            = 80 * 60 * 60 * 24 # 80 days
  target_snapshot_pattern               = "SIQ-%%{SrcCluster}-%%{PolicyName}-%Y-%m-%d_%H-%M-%S"
}

# After the execution of above resource block, a Sync IQ Policy would have been cached in terraform state file
# and a Sync IQ Policies would have been created/updated on PowerScale.
# For more information, Please check the terraform state file.

# sheduling a policy when source is modified
resource "powerscale_synciq_policy" "policy_when_source_modified" {
  name             = "policy_when_source_modified"
  enabled          = true
  action           = "sync"
  source_root_path = "/ifs/Source"
  target_host      = "10.10.10.9"
  password         = "W0ulntUWannaKn0w"
  target_path      = "/ifs/Sink2"

  # scheduling
  schedule  = "when-source-modified"
  job_delay = 20 * 60 * 60

  # OCSP settings
  ocsp_address = "10.20.10.9"
  # Installed ca certificates can be listed using "isi certificate authority list"
  # which gives a list of all certificates with their short IDs.
  # Then full ID can be looked up using "isi certificate authority view <short ID>".
  ocsp_issuer_certificate_id = "16af57a9f676b0ab126095aa5ebadef22ab31119d644ac95cd4b93dbf3f26aeb"
}

Schema

Required

action (String) If ‘copy’, source files will be copied to the target cluster. If ‘sync’, the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
name (String) User-assigned name of this sync policy.
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.

Optional

accelerated_failback (Boolean) If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
allow_copy_fb (Boolean) If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidth_reservation (Number) The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist (Boolean) If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
check_integrity (Boolean) If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloud_deep_copy (String) If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted (Boolean) NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to ‘false’.
delete_quotas (Boolean) If true, forcibly remove quotas on the target after they have been removed on the source.
description (String) User-assigned description of this sync policy.
disable_file_split (Boolean) NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disable_fofb (Boolean) NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disable_quota_tmp_dir (Boolean) If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disable_stf (Boolean) NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enable_hash_tmpdir (Boolean) If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled (Boolean) If true, jobs will be automatically run based on this policy, according to its schedule.
encryption_cipher_list (String) The cipher list (comma separated) 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.
expected_dataloss (Boolean) NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
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)
force_interface (Boolean) NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.
ignore_recursive_quota (Boolean) If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
job_delay (Number) If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
log_level (String) Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
log_removed_files (Boolean) If true, the system will log any files or directories that are deleted due to a sync.
ocsp_address (String) The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocsp_issuer_certificate_id (String) The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password (String) The password for the target cluster. This field is not readable.
priority (Number) Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
report_max_age (Number) Length of time (in seconds) a policy report will be stored.
report_max_count (Number) Maximum number of policy reports that will be stored on the system.
restrict_target_network (Boolean) 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_alert (Number) If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule (String) The schedule on which new jobs will be run for this policy.
skip_lookup (Boolean) Skip DNS lookup of target IPs.
skip_when_source_unmodified (Boolean) If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshot_sync_existing (Boolean) If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires –schedule when-snapshot-taken).
snapshot_sync_pattern (String) The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is “*”).
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_network (Attributes) Restricts replication policies on the local cluster to running on the specified subnet and pool. (see below for nested schema)
source_snapshot_archive (Boolean) If true, archival snapshots of the source data will be taken on the source cluster before a sync.
source_snapshot_expiration (Number) The length of time in seconds to keep snapshots on the source cluster.
source_snapshot_pattern (String) The name pattern for snapshots taken on the source cluster before a sync.
sync_existing_snapshot_expiration (Boolean) If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires –sync-existing-snapshot=true
sync_existing_target_snapshot_pattern (String) The naming pattern for snapshot on the destination cluster when –sync-existing-snapshot is true
target_certificate_id (String) The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
target_compare_initial_sync (Boolean) If true, the target creates diffs against the original sync.
target_detect_modifications (Boolean) If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
target_snapshot_alias (String) The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
target_snapshot_archive (Boolean) If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
target_snapshot_expiration (Number) The length of time in seconds to keep snapshots on the target cluster.
target_snapshot_pattern (String) The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workers_per_node (Number) The number of worker threads on a node performing a sync.

Read-Only

id (String) The system ID given to this sync policy.

Nested Schema for `file_matching_pattern`

Required:

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 `file_matching_pattern.or_criteria`

Required:

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 `file_matching_pattern.or_criteria.and_criteria`

Optional:

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. Possible values are: ==, !=, >, >=, <, <=, !. Default is ==.
type (String) The type of this criterion, that is, which file attribute to match on. Accepted values are , name, path, accessed_time, birth_time, changed_time, size, file_type, posix_regex_name, user_name, user_id, group_name, group_id, no_user, no_group.
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 `source_network`

Optional:

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

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_synciq_policy.policy <policy name>
# Example:
terraform import powerscale_synciq_policy.policy "policy1"
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_synciq_replication_job resource

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

powerscale_synciq_replication_job (Resource)

The PowerScale SyncIQ ReplicationJob resource provides a means of managing replication jobs on PowerScale clusters. This resource allows for the manual triggering of replication jobs to replicate data from a source PowerScale cluster to a target PowerScale cluster. Note: The replication job is an asynchronous operation, and this resource does not provide real-time monitoring of the job’s status. To check the status of the job,please use the powerscale_synciq_replication_report datasource.

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

# Available actions: Create and  Update updates the syncIQ Replication Job. Delete will delete job and clear the state file. 
# After `terraform apply` of this example file will perform action on the synciq replicaiton job according to the attributes set in the config

# PowerScale SynIQ Replication Job allows you to manage the SyncIQ Replication Jobs on the Powerscale array
resource "powerscale_synciq_replication_job" "job1" {
  action    = "run"             # action can be run, test, resync_prep, allow_write or allow_write_revert
  id        = "TerraformPolicy" # id/name of the synciq policy, use synciq policy resource to create policy.
  is_paused = false             # change job state to running or paused.
}

# There are other attributes values as well. Please refer the documentation.
# After the execution of above resource block, job would have been extecuted/updated on the PowerScale array. For more information, Please check the terraform state file.

Schema

Required

action (String) Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resync_prep - Resync_prep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allow_write - allow_write determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allow_write_revert - allow_write_revert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
id (String) ID/Name of the policy

Optional

is_paused (Boolean) change job state to running or paused.
wait_time (Number) Wait Time for the job

Unless specified otherwise, all fields of this resource can be updated.

V1.8.1: powerscale_synciq_rules resource

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

powerscale_synciq_rules (Resource)

This resource is used to manage all the SyncIQ replication Performance Rule entities on PowerScale array.

Example Usage

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

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

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


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

# Available actions: Create and Update updates the syncIQ  replication rules on the PowerScale array.
# Delete will delete the state file. Import action is also available.
# After `terraform apply` of this example file will update the settings according to the attributes set in the config

# PowerScale SynIQ replication rules allows you to manage the replication rules on the Powerscale array
resource "powerscale_synciq_rules" "all_rules" {
  bandwidth_rules = [
    {
      limit       = 10000
      description = "Bandwidth limit for Weekend"
      schedule = {
        begin        = "00:00"
        days_of_week = ["saturday", "sunday"]
        end          = "23:59"
      }
    },
    {
      limit       = 2000
      description = "Bandwidth limit for Weekdays"
      schedule = {
        days_of_week = ["monday", "tuesday", "wednesday", "thursday", "friday"]
      }
    },
  ]

  cpu_rules = [
    {
      limit       = 16
      description = "CPU limit"
    }
  ]

  file_count_rules = [
    {
      limit       = 50
      description = "File limit"
    }
  ]

  worker_rules = [
    {
      limit       = 10
      description = "Worker limit"
      enabled     = false
    }
  ]
}

# After the execution of above resource block, replication rules would have been updated on the PowerScale array. For more information, Please check the terraform state file.

Schema

Optional

bandwidth_rules (Attributes List) List of bandwidth rules. (see below for nested schema)
cpu_rules (Attributes List) List of CPU rules. (see below for nested schema)
file_count_rules (Attributes List) List of file count rules. (see below for nested schema)
worker_rules (Attributes List) List of worker rules. (see below for nested schema)

Read-Only

id (String) Resource ID.

Nested Schema for `bandwidth_rules`

Required:

limit (Number) Amount of the specified system resource type that 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.

Optional:

description (String) Description of this performance rule.
enabled (Boolean) Whether this performance rule is currently in effect during its specified intervals.
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)

Read-Only:

id (String) The system ID given to this performance rule.

Nested Schema for `bandwidth_rules.schedule`

Optional:

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).
days_of_week (Set of String) Set of days of the week during which this rule is in effect. Accepted values are monday, tuesday, wednesday, thursday, friday, saturday, sunday. At least one day must be set.
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).

Nested Schema for `cpu_rules`

Required:

limit (Number) Amount of the specified system resource type that 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.

Optional:

description (String) Description of this performance rule.
enabled (Boolean) Whether this performance rule is currently in effect during its specified intervals.
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)

Read-Only:

id (String) The system ID given to this performance rule.

Nested Schema for `cpu_rules.schedule`

Optional:

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).
days_of_week (Set of String) Set of days of the week during which this rule is in effect. Accepted values are monday, tuesday, wednesday, thursday, friday, saturday, sunday. At least one day must be set.
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).

Nested Schema for `file_count_rules`

Required:

limit (Number) Amount of the specified system resource type that 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.

Optional:

description (String) Description of this performance rule.
enabled (Boolean) Whether this performance rule is currently in effect during its specified intervals.
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)

Read-Only:

id (String) The system ID given to this performance rule.

Nested Schema for `file_count_rules.schedule`

Optional:

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).
days_of_week (Set of String) Set of days of the week during which this rule is in effect. Accepted values are monday, tuesday, wednesday, thursday, friday, saturday, sunday. At least one day must be set.
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).

Nested Schema for `worker_rules`

Required:

limit (Number) Amount of the specified system resource type that 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.

Optional:

description (String) Description of this performance rule.
enabled (Boolean) Whether this performance rule is currently in effect during its specified intervals.
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)

Read-Only:

id (String) The system ID given to this performance rule.

Nested Schema for `worker_rules.schedule`

Optional:

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).
days_of_week (Set of String) Set of days of the week during which this rule is in effect. Accepted values are monday, tuesday, wednesday, thursday, friday, saturday, sunday. At least one day must be set.
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).

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_synciq_rules.all_rules <anystring>
# Example:
terraform import powerscale_synciq_rules.all_rules do_not_care
# after running this command, populate any required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_user resource

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

powerscale_user (Resource)

This resource is used to manage the User entity of PowerScale Array. We can Create, Update and Delete the User using this resource. We can also import an existing User from PowerScale array. 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.
*/

# Available actions: Create, Update, Delete and Import.
# After `terraform apply` of this example file it will create a new user with the name set in `name` attribute on the PowerScale.

# PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.
resource "powerscale_user" "testUser" {
  # Required name for creating
  name = "testUserResourceSample"

  # Optional query_force. If true, skip validation checks when creating user. The force option is required for user ID changes.
  # query_force = false

  # Optional query_zone, will return user according to zone. Specifies the zone that the user will belong to when creating. Once user is created, its zone cannot be changed.
  # query_zone = "testZone"

  # Optional query_provider, will return user according to provider. Specifies the provider that the user will belong to when creating. Once user is created, its provider cannot be changed.
  # query_provider = "testProvider"

  # Optional parameters when creating
  # sid = "SID:XXXX"

  # Optional parameters when creating and updating. 
  # uid      = 11000
  # password = "testPassword"
  # roles    = ["SystemAdmin"]
  # enabled = false
  # unlock = false
  # email = "testTerraform@dell.com"
  # home_directory = "/ifs/home/testUserResourceSample"
  # password_expires = true
  # primary_group = "testPrimaryGroup"
  # prompt_password_change = false
  # shell = "/bin/zsh"
  # expiry = 123456
  # gecos = "testFullName"
}

# After the execution of above resource block, user would have been created on the PowerScale array. 
# For more information, Please check the terraform state file.

Schema

Required

name (String) Specifies a user name. Cannot be updated.

Optional

domain (String) Specifies the domain that the object is part of. Cannot be updated.
email (String) Specifies an email address.
enabled (Boolean) If true, the authenticated user is enabled.
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.
home_directory (String) Specifies a home directory for the user.
password (String, Sensitive) Sets or Changes the password for the user.
password_expires (Boolean) If true, the password is allowed to expire.
primary_group (String) Specifies the name of the primary group.
prompt_password_change (Boolean) If true, Prompts the user to change their password at the next login.
query_force (Boolean) If true, skip validation checks when creating user. Need to be true, when changing user UID.
query_provider (String) Specifies the provider type. Cannot be updated.
query_zone (String) Specifies the zone that the object belongs to. Cannot be updated.
roles (List of String) List of roles, the user is assigned.
shell (String) Specifies a path to the shell for the user.
sid (String) Specifies a security identifier. Cannot be updated.
uid (Number) Specifies a numeric user identifier.
unlock (Boolean) If true, the user account should be unlocked.

Read-Only

dn (String) Specifies a principal name for the user.
dns_domain (String) Specifies the DNS domain.
expired (Boolean) If true, the authenticated user has expired.
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 (Object) Specifies a group identifier. (see below for nested schema)
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.
password_expired (Boolean) If true, the password has expired.
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 (Object) Specifies the persona of the primary group. (see below for nested schema)
provider_name (String) Specifies the authentication provider that the object belongs to.
sam_account_name (String) Specifies a user name.
type (String) Specifies the object type.
upn (String) Specifies a principal name for the user.
user_can_change_password (Boolean) Specifies whether the password for the user can be changed.

Nested Schema for `gid`

Read-Only:

id (String)
name (String)
type (String)

Nested Schema for `primary_group_sid`

Read-Only:

id (String)
name (String)
type (String)

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_user.testUser [<zoneID>:]<userName>
# Example1, <zoneID> is Optional, defaults to System:
terraform import powerscale_user.testUser userName
# Example2:
terraform import powerscale_user.testUser zoneID:userName
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_user_group resource

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

powerscale_user_group (Resource)

This resource is used to manage the User Group entity of PowerScale Array. We can Create, Update and Delete the User Group using this resource. We can also import an existing User Group from PowerScale array. 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.
*/

# Available actions: Create, Update, Delete and Import.
# After `terraform apply` of this example file it will create a new user group with the name set in `name` attribute on the PowerScale.

# PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
resource "powerscale_user_group" "testUserGroup" {
  # Required name for creating
  name = "testUserGroupResourceSample"

  # Optional query_force. If true, skip validation checks when creating user group. The force option is required for user group ID changes.
  # query_force = false

  # Optional query_zone, will return user group according to zone. Specifies the zone that the user group will belong to when creating. Once user group is created, its zone cannot be changed.
  # query_zone = "testZone"

  # Optional query_provider, will return user group according to provider. Specifies the provider that the user group will belong to when creating. Once user group is created, its provider cannot be changed.
  # query_provider = "testProvider"

  # Optional parameters when creating
  # sid = "SID:XXXX"

  # Optional parameters when creating and updating. 
  # gid      = 11000
  # roles    = ["SystemAdmin"]
  # users    = ["MemberOfUser"]
  # groups   = ["MemberOfGroup"]
  # well_knowns    = ["MemberOfWellKnown"]
}

# After the execution of above resource block, user group would have been created on the PowerScale array. 
# For more information, Please check the terraform state file.

Schema

Required

name (String) Specifies a user group name. Cannot be updated.

Optional

domain (String) Specifies the domain that the object is part of. Cannot be updated.
gid (Number) Specifies a numeric user group identifier.
groups (List of String) Specifies list members of group within the group.
query_force (Boolean) If true, skip validation checks when creating user group. Need to be true, when changing group GID.
query_provider (String) Specifies the provider type. Cannot be updated.
query_zone (String) Specifies the zone that the object belongs to. Cannot be updated.
roles (List of String) List of roles, the user is assigned.
sid (String) Specifies a security identifier. Cannot be updated.
users (List of String) Specifies list members of user within the group.
well_knowns (List of String) Specifies list members of well_known within the group.

Read-Only

dn (String) Specifies a principal name for the user group.
dns_domain (String) Specifies the DNS domain.
generated_gid (Boolean) If true, the GID was generated.
id (String) Specifies the user group ID.
provider_name (String) Specifies the authentication provider that the object belongs to.
sam_account_name (String) Specifies a user group name.
type (String) Specifies the object type.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_user_group.testUserGroup [<zoneID>:]<userGroupName>
# Example1, <zoneID> is Optional, defaults to System:
terraform import powerscale_user_group.testUserGroup userGroupName
# Example2:
terraform import powerscale_user_group.testUserGroup zoneID:userGroupName
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_user_mapping_rules resource

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

powerscale_user_mapping_rules (Resource)

This resource is used to manage the User Mapping Rules entity of PowerScale Array. PowerScale User Mapping Rules combines user identities from different directory services into a single access token and then modifies it according to configured rules.We can Create, Update and Delete the User Mapping Rules using this resource. We can also import an existing User Mapping Rules from PowerScale array. Note that, User Mapping Rules is the native functionality of PowerScale. When creating the resource, we actually load User Mapping Rules from PowerScale to the resource state.

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


# Available actions: Create, Update, Delete and Import.
# If resource arguments are omitted, `terraform apply` will load User Mapping Rules from PowerScale, and save to terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load User Mapping Rules (if not loaded) and update the settings.
# `terraform destroy` will delete the resource from terraform state file rather than deleting User Mapping Rules from PowerScale.
# For more information, Please check the terraform state file.

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

  # Optional params for updating.

  # The zone to which the user mapping applies. Defaults to System
  zone = "System"

  # Specifies the parameters for user mapping rules.
  parameters = {
    # Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.
    # When default_unix_user is not null: Designate the user as the default UNIX user.
    # When default_unix_user is null: Allow Dell Technologies to generate a primary UID and GID.
    # When default_unix_user.user is " ": Deny access with the following error: no such user.
    default_unix_user = {
      # Specifies the domain of the user that is being mapped.
      domain = "domain",
      # Specifies the name of the user that is being mapped.
      user = "username"
    }
  }


  # Specifies the list of user mapping rules.
  rules = [
    {
      # Specifies the operator to make rules on specified users or groups. Acceptable values: append, insert, replace, trim, union.
      operator = "append",
      # Specifies the mapping options for this user mapping rule. 
      options = {
        # If true, and the rule was applied successfully, stop processing further.
        break = true,
        # Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information. 
        default_user = {
          # Specifies the domain of the user that is being mapped.
          domain = "domain",
          # Specifies the name of the user that is being mapped.
          user = "Guest"
        },
        # If true, the primary GID and primary group SID should be copied to the existing credential.
        group = true,
        # If true, all additional identifiers should be copied to the existing credential.
        groups = true,
        # If true, the primary UID and primary user SID should be copied to the existing credential.
        user = true
      },
      # Specifies the target user information that the rule can be applied to.
      target_user = {
        domain = "domain",
        user   = "testMappingRule"
      },
      # Specifies the source user information that the rule can be applied from.
      source_user = {
        domain = "domain",
        user   = "Guest"
      }
    },
    {
      # Operator 'trim' only accepts 'break' option and only accepts a single user.
      operator = "trim",
      options = {
        break = true,
      },
      target_user = {
        domain = "domain",
        user   = "testMappingRule"
      }
    },
    {
      # Operator 'union' only accepts 'break' option.
      operator = "union",
      options = {
        break = true,
        default_user = {
          domain = "domain",
          user   = "Guest"
        },
      },
      target_user = {
        user = "tfaccUserMappungRuleUser"
      },
      source_user = {
        user = "admin"
      }
    },
    {
      # Operator 'replace' only accepts 'break' option.
      operator = "replace",
      options = {
        break = true,
        default_user = {
          domain = "domain",
          user   = "Guest"
        },
      },
      target_user = {
        domain = "domain",
        user   = "tfaccUserMappungRuleUser"
      },
      source_user = {
        domain = "domain",
        user   = "admin"
      }
    },
    {
      operator = "insert",
      options = {
        break = true,
        default_user = {
          domain = "domain",
          user   = "Guest"
        },
        group  = true,
        groups = true,
        user   = true
      },
      target_user = {
        domain = "domain",
        user   = "tfaccUserMappungRuleUser"
      },
      source_user = {
        domain = "domain",
        user   = "admin"
      }
    },
  ]

  # List of user identity for mapping test.
  test_mapping_users = [
    {
      # Specifies a user name.
      name = "root"
      # Specifies a numeric user identifier.
      uid = 0
    },
    {
      name = "admin"
    }
  ]
}

# After the execution of above resource block, User Mapping Rules would have been cached in terraform state file, or
# User Mapping Rules would have been updated on PowerScale.
# For more information, Please check the terraform state file.

Schema

Optional

parameters (Attributes) Specifies the parameters for user mapping rules. (see below for nested schema)
rules (Attributes List) Specifies the list of user mapping rules. (see below for nested schema)
test_mapping_users (Attributes List) List of user identity for mapping test. (see below for nested schema)
zone (String) The zone to which the user mapping applies.

Read-Only

id (String) User Mapping Rules ID.
mapping_users (Attributes List) List of test mapping user result. (see below for nested schema)

Nested Schema for `parameters`

Optional:

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 `parameters.default_unix_user`

Required:

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

Optional:

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

Nested Schema for `rules`

Required:

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

Optional:

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)

Nested Schema for `rules.target_user`

Required:

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

Optional:

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

Nested Schema for `rules.options`

Optional:

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 `rules.options.default_user`

Required:

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

Optional:

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

Nested Schema for `rules.source_user`

Required:

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

Optional:

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

Nested Schema for `test_mapping_users`

Optional:

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

Nested Schema for `mapping_users`

Read-Only:

privileges (Attributes List) Specifies the system-defined privilege that may be granted to users. (see below for nested schema)
supplemental_identities (Attributes List) Specifies the configuration properties for a user. (see below for nested schema)
user (Attributes) Specifies the configuration properties for a user. (see below for nested schema)
zid (Number) Numeric ID of the access zone which contains this user.
zone (String) Name of the access zone which contains this user.

Nested Schema for `mapping_users.privileges`

Read-Only:

id (String) Specifies the ID of the privilege.
name (String) Specifies the name of the privilege.
read_only (Boolean) True, if the privilege is read-only.

Nested Schema for `mapping_users.supplemental_identities`

Read-Only:

gid (String) Specifies a user or group GID.
name (String) Specifies a user or group name.
sid (String) Specifies a user or group SID.

Nested Schema for `mapping_users.user`

Read-Only:

name (String) Specifies the user name.
on_disk_user_identity (String) Specifies the user identity on disk.
primary_group_name (String) Specifies the primary group name.
primary_group_sid (String) Specifies the primary group SID.
sid (String) Specifies a user or group SID.
uid (String) Specifies the user UID.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_user_mapping_rules.testUserMappingRules <zoneName>
# Example:
terraform import powerscale_user_mapping_rules.testUserMappingRules System
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

V1.8.1: powerscale_writable_snapshot resource

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

powerscale_writable_snapshot (Resource)

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

# Available actions: Create, Update, Delete and Import
# If resource arguments are omitted, `terraform apply` will load Writable Snapshot Details from PowerScale, and save to
# terraform state file.
# If any resource arguments are specified, `terraform apply` will try to load Writable Snapshot Details (if not loaded).
# `terraform destroy` will delete the Writable Snapshot resource from terraform state file as well as from PowerScale.
# For more information, Please check the terraform state file.


# Scenario 1
# To create multiple writable snapshots using a snap id

# snapshot ID for which writable snapshot needs to be created
variable "snap_id" {
  description = "The ID of the source snapshot"
  type        = string
  # default     = "snap_id"
}

# Number of writable snapshots to be created from the snap_id
variable "num_writable_snapshots" {
  description = "The number of writable snapshots to create"
  type        = number
  default     = 3
}

# Example to create multiple writable snapshots from a single snapshot
resource "powerscale_writable_snapshot" "writablesnap_multiple1" {
  count = var.num_writable_snapshots

  dst_path = "/ifs/writable_snapshot_snap${count.index}"
  snap_id  = var.snap_id
}


# Scenario 2
# To create multiple writable snaphots using datasource

# Fetch snapshot data using snapshot datasource filters
data "powerscale_snapshot" "all" {
  filter {
    # sort = "created"
    # dir = "asc"
    # limit = 5
  }
}

# output command to verify the fetched snapshot
output "powerscale_snapshot_all_snaps" {
  value = data.powerscale_snapshot.all.snapshots_details
}

# create multiple writable snapshots with snap id fetched using datasource
locals {
  writable_snapshots = [
    for i, snap in data.powerscale_snapshot.all.snapshots_details : {
      dst_path = "/ifs/writable_snapshot${i}"
      snap_id  = snap.id
    }
  ]
}

resource "powerscale_writable_snapshot" "writablesnap_multiple2" {
  for_each = { for snap in local.writable_snapshots : snap.dst_path => snap }

  dst_path = each.value.dst_path
  snap_id  = each.value.snap_id
}


# Scenario 3
# To create a single writable snapshot

resource "powerscale_writable_snapshot" "writablesnap_single" {
  # dst_path is the path of the writable snapshot.
  dst_path = "/ifs/writable_snapshot"

  # snap_id is the source snapshot of the writable snapshot.
  snap_id = "snap_id"
}

# After the execution of above resource block, single/multiple Writable Snapshot(s) would have been cached in terraform state file, and
# Single/Multiple new Writable Snapshot(s) would have been created on PowerScale.
# For more information, Please check the terraform state file.

Schema

Required

dst_path (String) The destination path for the writable snapshot.
snap_id (String) The ID of the source snapshot for the writable snapshot.

Read-Only

id (Number) Unique identifier of the writable snapshot.
snap_name (String) The name of the source snapshot for the writable snapshot.
src_path (String) The source path of the writable snapshot.
state (String) The state of the writable snapshot.

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

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

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

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


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

# The command is
# terraform import powerscale_writable_snapshot.writablesnap <path of the Snapshot>
# Example:
terraform import powerscale_writable_snapshot.writablesnap "/ifs/abcd"
# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

Dell Technologies – Resources

V1.8.1: powerscale_accesszone resource

powerscale_accesszone (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for ifs_restricted

Import

V1.8.1: powerscale_aclsettings resource

powerscale_aclsettings (Resource)

Example Usage

Schema

Optional

Import

V1.8.1: powerscale_adsprovider resource

powerscale_adsprovider (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Import

V1.8.1: powerscale_cluster_email resource

powerscale_cluster_email (Resource)

Example Usage

Schema

Required

Read-Only

Nested Schema for settings

Import

V1.8.1: powerscale_cluster_identity resource

powerscale_cluster_identity (Resource)

Example Usage

Schema

Optional

Read-Only

Nested Schema for logon

Import

V1.8.1: powerscale_cluster_owner resource

powerscale_cluster_owner (Resource)

Example Usage

Schema

Optional

Read-Only

Import

V1.8.1: powerscale_cluster_snmp resource

powerscale_cluster_snmp (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Import

V1.8.1: powerscale_cluster_time resource

powerscale_cluster_time (Resource)

Example Usage

Schema

Optional

Read-Only

Import

V1.8.1: powerscale_filepool_policy resource

powerscale_filepool_policy (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for actions

Nested Schema for actions.cloudpool_policy_action

Nested Schema for actions.cloudpool_policy_action.cache

Nested Schema for actions.data_storage_policy_action

Nested Schema for actions.snapshot_storage_policy_action

Nested Schema for file_matching_pattern

Nested Schema for file_matching_pattern.or_criteria

Nested Schema for file_matching_pattern.or_criteria.and_criteria

Import

V1.8.1: powerscale_filesystem resource

powerscale_filesystem (Resource)

Nested Schema for `ifs_restricted`

Nested Schema for `settings`

Nested Schema for `logon`

Nested Schema for `actions`

Nested Schema for `actions.cloudpool_policy_action`

Nested Schema for `actions.cloudpool_policy_action.cache`

Nested Schema for `actions.data_storage_policy_action`

Nested Schema for `actions.snapshot_storage_policy_action`

Nested Schema for `file_matching_pattern`

Nested Schema for `file_matching_pattern.or_criteria`

Nested Schema for `file_matching_pattern.or_criteria.and_criteria`

Nested Schema for `group`

Nested Schema for `owner`

Nested Schema for `acl_custom`

Nested Schema for `acl_custom.trustee`

Nested Schema for `group`

Nested Schema for `owner`

Nested Schema for `acl`

Nested Schema for `acl.trustee`

Nested Schema for `ifaces`

Nested Schema for `ranges`

Nested Schema for `static_routes`