PowerScaleOneFS CLI Command Reference

Syntax

isi smb shares modify <share> 
  [--name <string>]
  [--path <path>]
  [--zone <string>]
  [--new-zone <string>]
  [--host-acl <host-acl>]
  [--revert-host-acl]
  [--clear-host-acl]
  [--add-host-acl <string>]
  [--remove-host-acl <string>]
  [--description <string>]
  [--csc-policy {manual | documents | programs | none}]
  [--revert-csc-policy]
  [--allow-variable-expansion {yes | no}]
  [--revert-allow-variable-expansion]
  [--auto-create-directory {yes | no}]
  [--revert-auto-create-directory {yes | no}]
  [--browsable {yes | no}]
  [--revert-browsable]
  [--allow-execute-always {yes | no}]
  [--revert-allow-execute-always]
  [--directory-create-mask <integer>]
  [--revert-directory-create-mask]
  [--strict-locking {yes | no}]
  [--revert-strict-locking]
  [--hide-dot-files {yes | no}]
  [--revert-hide-dot-files]
  [--impersonate-guest {always | "bad user" | never}]
  [--revert-impersonate-guest]
  [--strict-flush {yes | no}]
  [--revert-strict-flush]
  [--access-based-enumeration {yes | no}]
  [--revert-access-based-enumeration]
  [--access-based-enumeration-root-only {yes | no}]
  [--revert-access-based-enumeration-root-only]
  [--ca-timeout <integer>]
  [--revert-ca-timeout]
  [--strict-ca-lockout {yes | no}]
  [--revert-strict-ca-lockout]
  [--ca-write-integrity {none | write-read-coherent | full}]
  [--revert-ca-write-integrity]
  [--mangle-byte-start <integer>]
  [--revert-mangle-byte-start]
  [--file-create-mask <integer>]
  [--revert-file-create-mask]
  [--create-permissions {"default acl" | "inherit mode bits" 
    | "use create mask and mode"}]
  [--revert-create-permissions]
  [--mangle-map <mangle-map>]
  [--revert-mangle-map]
  [--clear-mangle-map]
  [--add-mangle-map <string>]
  [--remove-mangle-map <string>]
  [--impersonate-user <string>]
  [--revert-impersonate-user]
  [--change-notify {all | norecurse | none}'
  [--revert-change-notify]
  [--oplocks {yes | no}]
  [--revert-oplocks]
  [--allow-delete-readonly {yes | no}]
  [--revert-allow-delete-readonly]
  [--directory-create-mode <integer>]
  [--revert-directory-create-mode]
  [--ntfs-acl-support {yes | no}]
  [--revert-ntfs-acl-support]
  [--file-create-mode <integer>]
  [--revert-file-create-mode]
  [--file-filtering-enabled {yes | no}]
  [--revert-file-filtering-enabled]
  [--file-filter-type {deny | allow}]
  [--revert-file-filter-type]
  [--file-filter-extensions <string>]
  [--clear-file-filter-extensions]
  [--add-file-filter-extensions <string>]
  [--remove-file-filter-extensions <string>]
  [--revert-file-filter-extensions]
  [--smb3-encryption-enabled {yes | no}]
  [--revert-smb3-encryption-enabled]
  [--verbose]  

Options

<share>

Required. Specifies the name of the SMB share to modify.

--name <name>

Specifies the name for the SMB share.

--path <path>

Specifies a new path for the SMB share, starting in /ifs.

--zone <string>

Specifies the access zone that the SMB share is assigned to. If no access zone is specified, the system modifies the SMB share with the specified name assigned to the default System zone, if found.

--new-zone <string>

Specifies the new access zone that SMB share will be reassigned to.

--host-acl <host-acl>

An ACL expressing which hosts are allowed access. Specify --host-acl for each additional host ACL clause.

--revert-host-acl

Sets the value to the system default for --host-acl.

--clear-host-acl

Clears the value of an ACL that expresses which hosts are allowed access.

--add-host-acl <string>

Adds an ACL expressing which hosts are allowed access. Specify --add-host-acl for each additional host ACL clause to add.

--remove-host-acl <string>

Removes an ACL expressing which hosts are allowed access. Specify --remove-host-acl for each additional host ACL clause to remove.

--description <string>

The description for this SMB share.

--csc-policy, -C {manual | documents | programs | none}

Specifies the client-side caching policy for the shares.

--revert-csc-policy

Sets the value to the system default for --csc-policy.

{--allow-variable-expansion | -a} {yes | no}

Allows the automatic expansion of variables for home directories.

--revert-allow-variable-expansion

Sets the value to the system default for --allow-variable-expansion.

{--auto-create-directory | -d} {yes | no}

Automatically creates home directories.

--revert-auto-create-directory

Sets the value to the system default for --auto-create-directory.

{--browsable | -b} {yes | no}

The share is visible in the net view and the browse list.

--revert-browsable

Sets the value to the system default for --browsable.

--allow-execute-always {yes | no}

Allows users to execute files they have read rights for.

--revert-allow-execute-always

Sets the value to the system default for --allow-execute-always.

--directory-create-mask <integer>

Specifies the directory create mask bits.

--revert-directory-create-mask

Sets the value to the system default for --directory-create-mask.

--strict-locking {yes | no}

Specifies whether byte range locks contend against the SMB I/O.

--revert-strict-locking

Sets the value to the system default for --strict-locking.

--hide-dot-files {yes | no}

Hides files and directories that begin with a period ".".

--revert-hide-dot-files

Sets the value to the system default for --hide-dot-files.

--impersonate-guest {always | "bad user" | never}

Specifies the condition in which user access is done as the guest account.

--revert-impersonate-guest

Sets the value to the system default for --impersonate-guest.

--strict-flush {yes | no}

Handles the SMB flush operations.

--revert-strict-flush

Sets the value to system default for --strict-flush.

--access-based-enumeration {yes | no}

Specifies to only enumerate files and folders that the requesting user has access to.

--revert-access-based-enumeration

Sets the value to the system default for --access-based-enumeration.

--access-based-enumeration-root-only {yes | no}

Specifies access-based enumeration on only the root directory of the share.

--revert-access-based-enumeration-root-only

Sets the value to the system default for --access-based-enumeration-root-only.

--ca-timeout <integer>

The amount of time, in seconds, a persistent handle is retained after a client is disconnected or a server fails. The default is 120 seconds.

--revert-ca-timeout

Sets the value to the system default for --ca-timeout.

--strict-ca-lockout {yes | no}

If set to yes, prevents another client from opening a file if a client has an open but disconnected persistent handle for that file. If set to no, OneFS issues persistent handles, but discards them if any client other than the original opener attempts to open the file. This option is only relevant if --continuously-available was set to yes when the share was created. The default is yes.

--revert-strict-ca-lockout

Sets the value to the system default for --strict-ca-lockout.

--ca-write-integrity {none | write-read-coherent | full}

Specifies the level of write integrity on continuously available shares:

none

Continuously available writes are not handled differently than other writes to the cluster. If you specify none and a node fails, you may experience data loss without notification. Therefore, we do not recommend this option.

write-read-coherent

Ensures that writes to the share are moved to persistent storage before a success message is returned to the SMB client that sent the data. This is the default setting.

full

Ensures that writes to the share are moved to persistent storage before a success message is returned to the SMB client that sent the data, and prevents OneFS from granting SMB clients write-caching and handle-caching leases.

--revert-ca-write-integrity

Sets the value to the system default for --ca-write-integrity.

--mangle-byte-start <interger>

Specifies the wchar_t starting point for automatic byte mangling.

--revert-mangle-byte-start

Sets the value to the system default for --mangle-byte-start.

--file-create-mask <integer>

Specifies the file create mask bits.

--revert-file-create-mask

Sets the value to the system default for --file-create-mask.

--create-permissions {"default acl" | "inherit mode bits" | "use create mask and mode"}

Sets the create permissions for new files and directories in a share.

--revert-create-permissions

Sets the value to the system default for --create-permissions.

--mangle-map <mangle-map>

The character mangle map. Specify --mangle-map for each additional character mangle map.

--revert-mangle-map

Sets the value to the system default for --mangle-map.

--clear-mangle-map

Clears the value for character mangle map.

--add-mangle-map <string>

Adds a character mangle map. Specify --add-mangle-map for each additional Add character mangle map.

--remove-mangle-map <string>

Removes a character mangle map. Specify --remove-mangle-map for each additional Remove character mangle map.

--impersonate-user <string>

The user account to be used as a guest account.

--revert-impersonate-user

Sets the value to the system default for --impersonate-user.

--change-notify {all | norecurse | none}

Specifies the level of change notification alerts on a share.

--revert-change-notify

Sets the value to the system default for --change-notify.

--oplocks {yes | no}

Supports oplocks.

--revert-oplocks

Sets the value for the system default of --oplocks.

--allow-delete-readonly {yes | no}

Allows the deletion of read-only files in the share.

--revert-allow-delete-readonly

Sets the value for the system default of --allow-delete-readonly.

--directory-create-mode <integer>

Specifies the directory create mode bits.

--revert-directory-create-mode

Sets the value for the system default of --directory-create-mode.

--ntfs-acl-support {yes | no}

Supports NTFS ACLs on files and directories.

--revert-ntfs-acl-support

Sets the value for the system default of --ntfs-acl-support.

--file-create-mode <integer>

Specifies the file create mode bits.

--revert-file-create-mode

Sets the value for the system default of --file-create-mode.

--file-filtering-enabled {yes | no}

If set to yes, enables file filtering at the share level. The default setting is no.

--revert-file-filtering-enabled

Sets the value for the system default of --file-filtering-enabled.

--file-filter-type {deny | allow}

If set to allow, allows the specified file types to be written to the share. The default setting is deny.

--revert-file-filter-type

Sets the value for the system default of --file-filter-type.

--file-filter-extensions <string>

Specifies the list of file types to deny or allow writes to the share, depending on the setting of --file-filter-type. File types may be specified in a list of comma separated values.

--clear-file-filter-extensions

Clears the list of file filtering extensions for the share.

--add-file-filter-extensions <string>

Adds entries to the list of file filter extensions. Repeat for each file extension to add.

--remove-file-filter-extensions <string>

Removes entries to the list of file filter extensions. Repeat for each file extension to remove.

--revert-file-filter-extensions

Sets the value for the system default of --file-filter-extensions.

--smb3-encryption-enabled {yes | no}

Enables SMBv3 encryption on the share.

--revert-smb3-encryption-enabled

Sets the value to the system default for --smb3-encryption-enabled.

{--verbose | -v}

Displays more detailed information.