Skip to content

Latest commit

 

History

History
304 lines (217 loc) · 17.8 KB

nfs_export_settings.md

File metadata and controls

304 lines (217 loc) · 17.8 KB
Raw
title linkTitle page_title subcategory description
powerscale_nfs_export_settings data source
powerscale_nfs_export_settings
powerscale_nfs_export_settings Data Source - terraform-provider-powerscale
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.

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

Read-Only

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.