Skip to content

Latest commit

 

History

History
150 lines (122 loc) · 7.06 KB

smb_server_settings.md

File metadata and controls

150 lines (122 loc) · 7.06 KB
Raw
title linkTitle page_title subcategory description
powerscale_smb_server_settings resource
powerscale_smb_server_settings
powerscale_smb_server_settings Resource - terraform-provider-powerscale
This resource is used to manage the SMB Server Settings of PowerScale Array. We can Create, Update and Delete the SMB Server Settings using this resource. Note that, SMB Server Settings is the native functionality of PowerScale. When creating the resource, we actually load SMB Server Settings from PowerScale to the resource.

powerscale_smb_server_settings (Resource)

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

Example Usage

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

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

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


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

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

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

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

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

Schema

Optional

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

Read-Only

  • id (String) ID of SMB Server Settings.

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

Import

Import is supported using the following syntax:

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

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

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


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

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