Skip to content

Latest commit

 

History

History
170 lines (156 loc) · 6.17 KB

smb_mod_share.md

File metadata and controls

170 lines (156 loc) · 6.17 KB
Raw
category command optional_options permalink positional_options sidebar summary synopsis title usage zendesk_source
smb
smb_mod_share
alternate help name required
The ID of the share to modify.
--id
false
alternate help name required
The name of the share to modify.
--name
false
alternate help name required
ID of the tenant the share is in. Only used if using the --name argument.
--tenant-id
false
alternate help name required
Change SMB share name.
--new-name
false
alternate help name required
Change the tenant that the share is in.
--new-tenant-id
false
alternate help name required
Change file system path.
--fs-path
false
alternate help name required
Change share description.
--description
false
alternate help name required
Enable Access-Based Enumeration for this share.
--access-based-enumeration-enabled
false
alternate help name required
Creates the specified file system path if the path does not exist already.
--create-fs-path
false
alternate help name required
Change the default POSIX file create mode bits (octal) for the specified SMB share. These mode bits are applied to new files as they are created. Note: If an inheritable ACE is present in the permissions ACL, this flag has no effect.
--default-file-create-mode
false
alternate help name required
Change the default POSIX directory create mode bits (octal) for the specified SMB share. These mode bits are applied to new directories as they are created. Note: If an inheritable ACE is present in the permissions ACL, this flag has no effect.
--default-directory-create-mode
false
alternate help name required
Require all traffic for this share to be encrypted. If true, clients without encryption capabilities will not be able to connect.
--require-encryption
false
alternate help name required
Print the raw JSON response.
--json
false
alternate help name required
The host addresses or subnet ranges for which access to to this share are not limited by network permissions. Access may still be limited by share and file permissions.
--full-control-hosts
false
alternate help name required
Address ranges which should be permitted read-only access at most.
--read-only-hosts
false
alternate help name required
The host addresses or subnet ranges for which access to the specified share is denied, regardless of other permissions. Important: Because using this flag alone results in all hosts being denied, use the correct --full-control-hosts or --read-only-hosts flags as necessary.
--deny-hosts
false
alternate help name required
Deny all access to this share. Important: To avoid configuration issues, do not apply this flag alongside any others.
--deny-all-hosts
false
/qq-cli-command-guide/smb/smb_mod_share.html
qq_cli_command_reference_sidebar
This section explains how to use the <code>qq smb_mod_share</code> command.
Modify a share
qq smb_mod_share
qq smb_mod_share [-h] (--id ID | --name NAME) [--tenant-id TENANT_ID] [--new-name NEW_NAME] [--new-tenant-id NEW_TENANT_ID] [--fs-path FS_PATH] [--description DESCRIPTION] [--access-based-enumeration-enabled {true,false}] [--create-fs-path] [--default-file-create-mode DEFAULT_FILE_CREATE_MODE] [--default-directory-create-mode DEFAULT_DIRECTORY_CREATE_MODE] [--require-encryption {true,false}] [--json] [--full-control-hosts IP/RANGE [IP/RANGE ...]] [--read-only-hosts IP/RANGE [IP/RANGE ...]] [--deny-hosts IP/RANGE [IP/RANGE ...]] [--deny-all-hosts]
qq CLI Command Guide

Examples

Modifying Host Restrictions

For more information, see:

  • {{site.xref.adminANQ.usingSMBhostRestrict}}
  • {{site.xref.adminOnPrem.usingSMBhostRestrict}}

To Modify Host Restrictions for an Existing SMB Share

{{site.data.alerts.note}}

  • {{site.xref.smbCLI.addModSameFlag}}
  • If you specify new host restrictions, they overwrite any existing host restrictions. You must explicitly specify which host restrictions to retain.
  • If you don't include any flags, no changes take place.
{{site.data.alerts.end}}

Run the qq smb_mod_share command and {{site.xref.smbCLI.addModCommand}} In the following example, Qumulo Core grants hosts {{site.exampleNetworkSegment0}} and {{site.exampleNetworkSegment1}} full control, and denies all other hosts.

{{site.exampleOutput}}

ID: 4
Name: share2
Path: /
Description:
Access Based Enumeration: False
Encryption Required: False
Default File Create Mode: 0644
Default Directory Create Mode: 0755

Permissions:
ID Trustee  Type    Rights 
== ======== ======= ===============================
1  Everyone Allowed Read, Write, Change permissions

Network Permissions:
ID Trustee                        Type    Rights 
== ============================== ======= ===============================
1  {{site.exampleNetworkSegment0}}, {{site.exampleNetworkSegment1}} Allowed Read, Write, Change permissions

To Remove All Host Restrictions from an Existing SMB Share

Run the qq smb_mod_share command, specify the share ID, and specify full control. For example:

For more information, see:

  • {{site.xref.adminANQ.manageSMB3encrypt}}
  • {{site.xref.adminOnPrem.manageSMB3encrypt}}
qq smb_mod_share --id=4 \
  --full-control="*"

Configuring SMB3 Encryption

For more information, see:

  • {{site.xref.adminANQ.manageSMB3encrypt}}
  • {{site.xref.adminOnPrem.manageSMB3encrypt}}

To Configure Share-Level SMB3 Encryption

Run the qq smb_mod_share command, specify the share name or ID, and use the --require-encryption flag to specify true or false. For example:

qq smb_mod_share --name my_share \
  --require-encryption true