Dell Technologies – Terraform Providers

V1.8.1: Support

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

For all your support needs or to follow the latest ongoing discussions and updates, join our Slack group. Click Here to request your invite.

You can also interact with us on GitHub by creating a GitHub Issue.

V1.8.1: ReadMe

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

Terraform Provider for Dell Technologies PowerScale

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

The Terraform Provider can be used to manage access zone, active directory, cluster, user, user group, file system, smb share, nfs export, snapshot, snapshot schedule, quota, groupnet, subnet, network pool, network settings, smart pool settings, ldap providers, network rule, file pool policy, ntp server, ntp settings, cluster email settings, acl settings, nfs export settings, role, user mapping rules, role privilege, s3 bucket, nfs global settings, nfs zone settings, smb share settings, smb server settings, namespace acl, cluster identity, cluster snmp, cluster owner, cluster time, support assist, s3 keys, s3 zone settings, s3 global settings, synciq policies, synciq rules, synciq global settings, synciq peer certificates, writeable snapshots, snapshot restore, nfs alias, synciq replication job, synciq rules and storage pool tiers.

The logged-in user configured in the Terraform provider must possess adequate permissions against the target Dell PowerScale System.

Support

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

License

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

Prerequisites

Terraform Provider	PowerScale Version	OS	Terraform	Golang
v1.8.1	9.8 9.10 9.13	ubuntu22.04 rhel9.x	1.14.3 and 1.13.5	1.25

List of DataSources in Terraform Provider for Dell PowerScale

Cluster and System Settings

Storage and Filesystem Management

Networking and Access

Data Protection and Replication

User and Role Management

Authentication and Directory Services

File Pool and Storage Tiering

Namespace and ACL Management

List of Resources in Terraform Provider for Dell PowerScale

Cluster and System Settings

Storage and Filesystem Management

Networking and Access

Data Protection and Replication

User and Role Management

Authentication and Directory Services

File Pool and Storage Tiering

Namespace and ACL Management

Installation and execution of Terraform Provider for Dell PowerScale

Installation from public repository

The provider will be fetched from the public repository and installed by Terraform automatically. Create a file called main.tf in your workspace with the following contents

terraform {
  required_providers {
    powerscale = { 
      version = "1.8.0"
      source = "registry.terraform.io/dell/powerscale"
    }
  }
}

Then, in that workspace, run

terraform init

Installation from source code

Clone this repo
In the root of this repo run

make install

Then follow installation from public repo

SSL Certificate Verification

For SSL verifcation on RHEL, these steps can be performed:

Copy the CA certificate to the /etc/pki/ca-trust/source/anchors path of the host by any external means.
Import the SSL certificate to host by running

update-ca-trust extract

For SSL verification on Ubuntu, these steps can be performed:

Copy the CA certificate to the /etc/ssl/certs path of the host by any external means.
Import the SSL certificate to host by running:

 update-ca-certificates

Releasing, Maintenance and Deprecation

Terraform Provider for Dell Technologies PowerScale follows Semantic Versioning.

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

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

Documentation

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

New to Terraform?

Here are some helpful links to get you started if you are new to terraform before using our provider:

Intro to Terraform: https://developer.hashicorp.com/terraform/intro
Providers: https://developer.hashicorp.com/terraform/language/providers
Resources: https://developer.hashicorp.com/terraform/language/resources
Datasources: https://developer.hashicorp.com/terraform/language/data-sources
Import: https://developer.hashicorp.com/terraform/language/import
Variables: https://developer.hashicorp.com/terraform/language/values/variables
Modules: https://developer.hashicorp.com/terraform/language/modules
State: https://developer.hashicorp.com/terraform/language/state

V1.8.1: Release Notes

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

Terraform Provider for Dell PowerScale - Release Notes 1.8.1

Content

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

Terraform Provider for Dell PowerScale - Release Notes 1.8.1

Revision history

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

Table 1. Revision history

Revision	Date	Description
01	Sep 2023	Terraform Provider for Dell PowerScale 1.0.0
02	Dec 2023	Terraform Provider for Dell PowerScale 1.1.0
03	Mar 2024	Terraform Provider for Dell PowerScale 1.2.0
04	Apr 2024	Terraform Provider for Dell PowerScale 1.3.0
05	Jun 2024	Terraform Provider for Dell PowerScale 1.4.0
06	Sep 2024	Terraform Provider for Dell PowerScale 1.5.0
07	Nov 2024	Terraform Provider for Dell PowerScale 1.6.0
08	Feb 2026	Terraform Provider for Dell PowerScale 1.7.0
09	Apr 2026	Terraform Provider for Dell PowerScale 1.7.1
10	Aug 2026	Terraform Provider for Dell PowerScale 1.8.0
11	Mar 2026	Terraform Provider for Dell PowerScale 1.8.1

Product Description

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

The Terraform Provider can be used to manage access zone, active directory, cluster, user, user group, file system, smb share, nfs export, snapshot, snapshot schedule, quota, groupnet, subnet, network pool, network settings, smart pool settings, ldap providers, network rule, file pool policy, ntp server, ntp settings, cluster email settings, acl settings, nfs export settings, role, user mapping rules, s3 bucket, nfs global settings, nfs zone settings, smb share settings, smb server settings, namespace acl, cluster identity, cluster snmp, cluster owner, cluster time, support assist, s3 keys, s3 zone settings, s3 global settings, synciq policies, synciq rules, synciq global settings, synciq peer certificates, writeable snapshots, snapshot restore, nfs alias, synciq replication job, synciq rules and storage pool tiers.

Bug Fixes

This release addresses bug fixes to improve stability and user experience for Dell PowerScale.

Enhancements

Added support of PowerScale Version 9.13

Known Issues

For Support Assist resource, if mode is set to gateway, gateway endpoints must be provided.

Limitations

There are no known limitations.

Distribution

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

Documentation

Readme

Product Guide

V1.8.1: Licensing

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

Terraform Provider is released and licensed under the MPL 2.0 license.

V1.8.1: Adding Asynchronous Operations

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

Terraform Internal Behaviour

Terraform’s concurrent execution capabilities allow multiple operations to run in parallel, each thread responsible for managing the lifecycle of a resource. However, even with this parallel execution, each individual thread must still execute its operations in a synchronous manner. By default, Terraform’s create, update, and delete operations wait for a resource to reach its expected lifecycle state before proceeding with the next step.

For instance, when a resource is in the creation phase, Terraform will not advance to the subsequent step until the resource has successfully reached the completion phase. In scenarios where platform operations are performed asynchronously, which can result in extended creation times, Terraform will wait for the resource to reach the completion phase before proceeding, thereby introducing a delay in the overall workflow.

Consideration for Asynchronous Operations In Terraform

When utilizing Terraform, it is essential to consider the implications of asynchronous operations of the platform. To ensure seamless automation, this guide provides recommendations for resources that support asynchronous operations, enabling users to effectively integrate these features into their infrastructure provisioning workflows.

The state file doesn’t have the full information of the resource because the resource is not yet created.
The resource’s stage must be refreshed to get its full information, including whether the resource failed to be created.
Terraform does not check the stage of a resource again after initiating its creation or deletion. Failed operations are only shown in subsequent refreshes of the resource.
The asynchronous resource must have no dependencies, because the resource is not fully created before another operation begins.

List of Asynchronous Resources

SyncIQ replication Job
Snapshot Restore (Only SnapRevert Operation)

V1.8.1: powerscale_accesszone data source

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

powerscale_accesszone (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `access_zones_details`

Read-Only:

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

Nested Schema for `access_zones_details.ifs_restricted`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_aclsettings (Data Source)

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

Example Usage

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

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

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


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

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

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

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

Schema

Read-Only

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

V1.8.1: powerscale_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 data source

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

powerscale_adsprovider (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `ads_providers_details`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_cluster (Data Source)

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

Example Usage

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

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

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


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

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

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

Schema

Read-Only

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

Nested Schema for `acs`

Read-Only:

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

Nested Schema for `config`

Read-Only:

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

Nested Schema for `config.devices`

Read-Only:

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

Nested Schema for `config.onefs_version`

Read-Only:

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

Nested Schema for `config.timezone`

Read-Only:

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

Nested Schema for `identity`

Read-Only:

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

Nested Schema for `identity.logon`

Read-Only:

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

Nested Schema for `internal_networks`

Read-Only:

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

Nested Schema for `internal_networks.failover_ip_addresses`

Read-Only:

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

Nested Schema for `internal_networks.int_a_ip_addresses`

Read-Only:

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

Nested Schema for `internal_networks.int_b_ip_addresses`

Read-Only:

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

Nested Schema for `nodes`

Read-Only:

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

Nested Schema for `nodes.errors`

Read-Only:

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

Nested Schema for `nodes.nodes`

Read-Only:

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

Nested Schema for `nodes.nodes.drives`

Read-Only:

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

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

Read-Only:

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

Nested Schema for `nodes.nodes.hardware`

Read-Only:

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

Nested Schema for `nodes.nodes.partitions`

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

Nested Schema for `nodes.nodes.sensors`

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

Nested Schema for `nodes.nodes.state`

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

Nested Schema for `nodes.nodes.status`

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

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

Read-Only:

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

V1.8.1: powerscale_cluster_email data source

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

powerscale_cluster_email (Data Source)

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

Example Usage

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

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

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


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

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

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

Schema

Read-Only

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

Nested Schema for `settings`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_filepool_policy (Data Source)

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

Example Usage

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

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

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


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

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

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


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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

names (Set of String)

Nested Schema for `file_pool_policies`

Read-Only:

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

Nested Schema for `file_pool_policies.actions`

Read-Only:

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

Nested Schema for `file_pool_policies.actions.cloudpool_policy_action`

Read-Only:

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

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

Read-Only:

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

Nested Schema for `file_pool_policies.actions.data_storage_policy_action`

Read-Only:

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

Nested Schema for `file_pool_policies.actions.snapshot_storage_policy_action`

Read-Only:

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

Nested Schema for `file_pool_policies.file_matching_pattern`

Read-Only:

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

Nested Schema for `file_pool_policies.file_matching_pattern.or_criteria`

Read-Only:

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

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

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_filesystem (Data Source)

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

Example Usage

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

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

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


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

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

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

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

Schema

Optional

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

Nested Schema for `file_systems_details`

Optional:

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

Nested Schema for `file_systems_details.file_system_attributes`

Optional:

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

Nested Schema for `file_systems_details.file_system_namespace_acl`

Optional:

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

Nested Schema for `file_systems_details.file_system_namespace_acl.acl`

Optional:

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

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

Optional:

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

Nested Schema for `file_systems_details.file_system_namespace_acl.group`

Optional:

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

Nested Schema for `file_systems_details.file_system_namespace_acl.owner`

Optional:

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

Nested Schema for `file_systems_details.file_system_quotas`

Optional:

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

Nested Schema for `file_systems_details.file_system_quotas.usage`

Optional:

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

Nested Schema for `file_systems_details.file_system_snapshots`

Optional:

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

V1.8.1: powerscale_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 data source

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

powerscale_groupnet (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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


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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `groupnets`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_ldap_provider (Data Source)

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

Example Usage

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

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

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


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

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

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

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


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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `ldap_providers`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_namespace_acl (Data Source)

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

Example Usage

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

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

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


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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Required:

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

Optional:

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

Nested Schema for `acl`

Read-Only:

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

Nested Schema for `acl.trustee`

Read-Only:

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

Nested Schema for `group`

Read-Only:

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

Nested Schema for `owner`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_network_rule (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `network_rules`

Read-Only:

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

V1.8.1: powerscale_network_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 data source

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

powerscale_network_settings (Data Source)

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

Example Usage

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

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

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


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

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

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

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

Schema

Read-Only

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

V1.8.1: powerscale_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 data source

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

powerscale_networkpool (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `network_pools_details`

Read-Only:

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

Nested Schema for `network_pools_details.ifaces`

Read-Only:

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

Nested Schema for `network_pools_details.ranges`

Read-Only:

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

Nested Schema for `network_pools_details.static_routes`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_nfs_alias (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `nfs_aliases`

Read-Only:

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

V1.8.1: powerscale_nfs_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 data source

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

powerscale_nfs_export (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `nfs_exports`

Read-Only:

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

Nested Schema for `nfs_exports.map_all`

Optional:

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

Nested Schema for `nfs_exports.map_all.primary_group`

Optional:

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

Nested Schema for `nfs_exports.map_all.secondary_groups`

Optional:

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

Nested Schema for `nfs_exports.map_all.user`

Optional:

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

Nested Schema for `nfs_exports.map_failure`

Optional:

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

Nested Schema for `nfs_exports.map_failure.primary_group`

Optional:

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

Nested Schema for `nfs_exports.map_failure.secondary_groups`

Optional:

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

Nested Schema for `nfs_exports.map_failure.user`

Optional:

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

Nested Schema for `nfs_exports.map_non_root`

Optional:

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

Nested Schema for `nfs_exports.map_non_root.primary_group`

Optional:

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

Nested Schema for `nfs_exports.map_non_root.secondary_groups`

Optional:

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

Nested Schema for `nfs_exports.map_non_root.user`

Optional:

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

Nested Schema for `nfs_exports.map_root`

Optional:

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

Nested Schema for `nfs_exports.map_root.primary_group`

Optional:

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

Nested Schema for `nfs_exports.map_root.secondary_groups`

Optional:

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

Nested Schema for `nfs_exports.map_root.user`

Optional:

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

V1.8.1: powerscale_nfs_export 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 data source

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

powerscale_nfs_export_settings (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `nfs_export_settings`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_all`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_all.primary_group`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_all.secondary_groups`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_all.user`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_failure`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_failure.primary_group`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_failure.secondary_groups`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_failure.user`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_non_root`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_non_root.primary_group`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_non_root.secondary_groups`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_non_root.user`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_root`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_root.primary_group`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_root.secondary_groups`

Read-Only:

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

Nested Schema for `nfs_export_settings.map_root.user`

Read-Only:

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

V1.8.1: powerscale_nfs_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 data source

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

powerscale_nfs_global_settings (Data Source)

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

Example Usage

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

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

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


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

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

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

Schema

Read-Only

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

V1.8.1: powerscale_nfs_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 data source

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

powerscale_nfs_zone_settings (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

zone (String) Access zone

Nested Schema for `nfs_zone_settings`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_ntpserver (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `ntp_servers_details`

Read-Only:

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

V1.8.1: powerscale_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 data source

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

powerscale_ntpsettings (Data Source)

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

Example Usage

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

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

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


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

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

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

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

Schema

Read-Only

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

V1.8.1: powerscale_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 data source

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

powerscale_quota (Data Source)

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

Example Usage

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Schema

Optional

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

Read-Only

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

Nested Schema for `filter`

Optional:

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

Nested Schema for `quotas`

Read-Only:

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

Nested Schema for `quotas.persona`

Read-Only:

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

Nested Schema for `quotas.thresholds`

Read-Only:

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

Nested Schema for `quotas.usage`

Read-Only:

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

V1.8.1: powerscale_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.

Dell Technologies – Terraform Providers

V1.8.1: Support

V1.8.1: ReadMe

Terraform Provider for Dell Technologies PowerScale

Table of Contents

Support

License

Prerequisites

List of DataSources in Terraform Provider for Dell PowerScale

Cluster and System Settings

Storage and Filesystem Management

Networking and Access

File Sharing

Data Protection and Replication

User and Role Management

Authentication and Directory Services

File Pool and Storage Tiering

Namespace and ACL Management

List of Resources in Terraform Provider for Dell PowerScale

Cluster and System Settings

Storage and Filesystem Management

Networking and Access

File Sharing

Data Protection and Replication

User and Role Management

Authentication and Directory Services

File Pool and Storage Tiering

Namespace and ACL Management

Installation and execution of Terraform Provider for Dell PowerScale

Installation from public repository

Installation from source code

SSL Certificate Verification

Releasing, Maintenance and Deprecation

Documentation

New to Terraform?

V1.8.1: Release Notes

Terraform Provider for Dell PowerScale - Release Notes 1.8.1

Content

Revision history

Product Description

Bug Fixes

Enhancements

Known Issues

Limitations

Distribution

Documentation

V1.8.1: Licensing

V1.8.1: Adding Asynchronous Operations

Terraform Internal Behaviour

Consideration for Asynchronous Operations In Terraform

List of Asynchronous Resources

V1.8.1: powerscale_accesszone data source

powerscale_accesszone (Data Source)

Example Usage

Schema

Optional

Read-Only

Nested Schema for filter

Nested Schema for access_zones_details

Nested Schema for access_zones_details.ifs_restricted

V1.8.1: powerscale_accesszone resource

powerscale_accesszone (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for ifs_restricted

Import

V1.8.1: powerscale_aclsettings data source

powerscale_aclsettings (Data Source)

Example Usage

Schema

Read-Only

V1.8.1: powerscale_aclsettings resource

powerscale_aclsettings (Resource)

Example Usage

Schema

Optional

Import

Nested Schema for `filter`

Nested Schema for `access_zones_details`

Nested Schema for `access_zones_details.ifs_restricted`

Nested Schema for `ifs_restricted`

Nested Schema for `filter`

Nested Schema for `ads_providers_details`

Nested Schema for `acs`

Nested Schema for `config`

Nested Schema for `config.devices`

Nested Schema for `config.onefs_version`

Nested Schema for `config.timezone`

Nested Schema for `identity`

Nested Schema for `identity.logon`

Nested Schema for `internal_networks`

Nested Schema for `internal_networks.failover_ip_addresses`

Nested Schema for `internal_networks.int_a_ip_addresses`

Nested Schema for `internal_networks.int_b_ip_addresses`

Nested Schema for `nodes`

Nested Schema for `nodes.errors`

Nested Schema for `nodes.nodes`

Nested Schema for `nodes.nodes.drives`

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

Nested Schema for `nodes.nodes.hardware`

Nested Schema for `nodes.nodes.partitions`

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

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

Nested Schema for `nodes.nodes.sensors`

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

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

Nested Schema for `nodes.nodes.state`

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

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

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

Nested Schema for `nodes.nodes.status`

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

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

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

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

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

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

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

Nested Schema for `settings`

Nested Schema for `settings`