Manage NAS Shares for a DXi System

List NAS Shares

View a list of all existing NAS shares and their attributes.

Command

syscli ‑‑list share [{‑‑proto cifs|nfs|app_specific} | {‑‑name <share name>}] [‑‑namematch <pattern>]

Command Attributes

Review the following attribute descriptions.

‑‑list share [{‑‑proto cifs|nfs|app_specific} | {‑‑name <share name>}]

Lists all NAS shares.

You can limit the list to the type of protocol by defining a value for the ‑‑proto option, either Common Internet File System (CIFS) / Server Message Block (SMB), Network File System (NFS), Application Specific, OR you can limit the list to a specific share by using the ‑‑name option.

‑‑namematch <pattern>

If you use this option, only shares whose names match the specified pattern are listed. The wild characters ^ and $ are supported as follows:

^xxx – Matches pattern xxx at the start of names
xxx$ – Matches pattern xxx at the end of names
Because $ is special to the shell, remember to escape the character with a backslash (\) because it is special to the shell.
Example
To list all shares ending with test in the names, enter the following command:
syscli ‑‑list share ‑‑namematch test\$

List NAS Share Names

View a list of all names for both CIFS/SMB, Network File System (NFS), and Application Specific shares.

Command

syscli ‑‑list sharename [‑‑proto cifs|nfs|app_specific] [‑‑namematch <pattern>]

Command Attributes

Review the following attribute descriptions.

‑‑list sharename [‑‑proto cifs|nfs|app_specific]

Lists all NAS share names.

You can limit the list to the type of protocol by defining a value for the ‑‑proto option, either CIFS/SMB, NFS, or Application Specific.

‑‑namematch <pattern>

If you use this option, only shares whose names match the specified pattern are listed. The wild characters ^ and $ are supported as follows:

^xxx – Matches pattern xxx at the start of names
xxx$ – Matches pattern xxx at the end of names
Because $ is special to the shell, remember to escape the character with a backslash (\) because it is special to the shell.
Example
To list all shares ending with test in the names, enter the following command:
syscli ‑‑list sharename ‑‑namematch test\$

List a Single NAS Share Name

List a single NAS share by specifying the share name.

Command

syscli ‑‑get share ‑‑name <sharename>

Example Output

Output data:

Share name = NAS1

Protocol = nfs

Export Path = /Q/shares/NAS1

Hidden = false

Dedup = Enabled

Permissions = rw

Access = All hosts

Description =

Squash = root

Commit = sync

Allow Links = Disabled

Anonymous uid = 4294967294

Anonymous gid = 4294967294

List Total NAS Share Count

List the total count of NAS shares defined in the system.

Command

syscli ‑‑getcount share [‑‑proto cifs|nfs|app_specific] [‑‑namematch <pattern>]

Command Attributes

Review the following attribute descriptions.

‑‑getcount share [‑‑proto cifs|nfs|app_specific]

Lists the total count of NAS shares.

You can limit the count to the type of protocol by defining a value for the ‑‑proto option, either CIFS/SMB, NFS, or Application Specific.

‑‑namematch <pattern>

If you use this option, only shares whose names match the specified pattern are listed. The wild characters ^ and $ are supported as follows:

^xxx – Matches pattern xxx at the start of names
xxx$ – Matches pattern xxx at the end of names
Because $ is special to the shell, remember to escape the character with a backslash (\) because it is special to the shell.
Example
To list all shares ending with test in the names, enter the following command:
syscli ‑‑getcount share ‑‑namematch test\$

List NAS Share Content

View a list of all existing NAS shares and their attributes.

Command

syscli ‑‑list share [{‑‑proto cifs|nfs|app_specific} | {‑‑name <share name>}] [‑‑namematch <pattern>]

Command Attributes

Review the following attribute descriptions.

‑‑list share [{‑‑proto cifs|nfs|app_specific} | {‑‑name <share name>}]

Lists all NAS shares.

You can limit the list to the type of protocol by defining a value for the ‑‑proto option, either Common Internet File System (CIFS) / Server Message Block (SMB), Network File System (NFS), Application Specific, OR you can limit the list to a specific share by using the ‑‑name option.

‑‑namematch <pattern>

If you use this option, only shares whose names match the specified pattern are listed. The wild characters ^ and $ are supported as follows:

^xxx – Matches pattern xxx at the start of names
xxx$ – Matches pattern xxx at the end of names
Because $ is special to the shell, remember to escape the character with a backslash (\) because it is special to the shell.
Example
To list all shares ending with test in the names, enter the following command:
syscli ‑‑list share ‑‑namematch test\$

List Application Specific NAS Share Content

List contents of a given Application Specific NAS share.

Command

syscli --list appsharecontents --name <sharename> [--terse]

Command Attributes

Review the following attribute descriptions.

`‑‑list appsharecontents`	Lists all files and directories on a Application Specific NAS share.
`‑‑name <sharename>`	Enter the name of the Application Specific NAS share to be listed.
`--terse`	If specified, only the directory listing will be displayed in the output.

Add NAS Shares

Add one or more NAS shares. To add more than one share, repeat the same set of options noting that all mandatory options must be re-specified even if they are unchanged.

Command

syscli --add share (--name <sharename> --proto {cifs|nfs|app_specific} [--desc<description>] [--ro] [--dedup] [--hidden] [--namecase lower|default] [--squash root|none] [--anonuid <anonymous uid>] [--anongid <anonymous_gid>])

Example command for adding 3 NAS shares

syscli --add share --name share1 --proto app_specific --name share2 --proto cifs --ro --name share3 --proto nfs

Command Attributes

Review the following attribute descriptions.

`‑‑add share`	Adds NAS shares.
`‑‑name <sharename>`	Enter the name of the share to edit. You must use alphanumeric characters for the share name.
`‑‑proto {cifs\|nfs\|app_specific}`	Specify the network file sharing protocol to assign to the share, either CIFS/SMB, NFS, or Application Specific
`‑‑desc <description>`	Enter an optional description for the share. Enclose the description with quatiation marks if it includes spaces
`‑‑ro`	If you specify this option, makes the share read-only. Otherwise, the share is read-write.
`‑‑dedup`	If you specify this option, deduplication is enabled. You cannot change this attribute after a share is created.
`‑‑hidden`	If you specify this option, the share name will not be displayed in the browser. This option is applicable to CIFS/SMB shares only.
`‑‑namecase lower\|default`	For CIFS/SMB shares only, client file/directory names are stored using the specified character case. If you select the `lower` value, all incoming client file/directory names will be converted to lower case before saving or searching. If you select the `default` value or do not specify a value, client file/directory names are treated as case-insensitive and casepreserved. File/directory names will be saved in the original character case as is, and all search will be performed in a case-insensitive manner.
`‑‑squash root\|none`	For NFS only, squashes (maps) NFS client users to a nobody user. If you select the `root` value, the client root is mapped to a nobody user . If you select the `none` value, all client users are preserved. Note: When files are replicated from a share with `no_root_squash` enabled to a target DXi without `no_root_squash`support, NFS hosts accessing the target DXi will have root access permissions mapped (squashed) to the anonymous user. By default, if `‑‑squash` is not specified, root_squash is enabled.
`‑‑anonuid <anonymous_uid>`	For NFS only, the anonymous user ID. This ID is usually 4294967294 on 32-bit systems or 65534 on 16-bit systems. If not specified, the default ID is 4294967294.
`‑‑anongid <anonymous_gid>`	For NFS only, the anonymous group ID. This ID is usually 4294967294 on 32-bit systems or 65534 on 16-bit systems. If not specified, default ID is 4294967294.

Edit NAS Shares

Modify one or more attributes of a NAS share. You must specify at least one attribute to edit, even though the syntax implies that all attributes are optional.

Command

syscli ‑‑edit share ‑‑name <sharename> [‑‑desc <description>] [‑‑perms rw|ro [‑‑restart]] [‑‑hidden false|true] [‑‑squash root|none] [‑‑anonuid <anonymous_uid>] [‑‑anongid <anonymous_gid>] [‑‑namecase default [‑‑sure]]

Command Attributes

Review the following attribute descriptions.

`‑‑edit share`	Edits the specified attributes of a NAS share.
`‑‑name <sharename>`	Enter the name of the share to edit. You must use alphanumeric characters for the share name.
`‑‑desc <description>`	Edit the description for the share.
`‑‑perms rw\|ro`	Change share permissions to either read-write (rw) or read-only (ro). Note: If a CIFS/SMB share's permissions are changed, users who are currently logged on the share will not see the changes until they log off and log in again, or until CIFS/SMB service is restarted
`‑‑restart`	For CIFS/SMB share only, restarts the CIFS/SMB service. Caution: If CIFS/SMB service is restarted, users who are currently logged on to CIFS/SMB shares may experience disconnection and/or I/O disruption. In addition, backup jobs connected to CIFS/SMB shares may fail I/O.
`‑‑hidden false\|true`	If you specify `true` for this option, the share name will not be displayed in the browser. This option is applicable to CIFS/SMB shares only.
`‑‑squash root\|none`	For NFS only, squashes (maps) NFS client users to a nobody user. If you select the `root` value, the client root is mapped to a nobody user . If you select the `none` value, all client users are preserved. Note: When files are replicated from a share with `no_root_squash` enabled to a target DXi without `no_root_squash`support, NFS hosts accessing the target DXi will have root access permissions mapped (squashed) to the anonymous user. By default, if `‑‑squash` is not specified, root_squash is enabled.
`‑‑anonuid <anonymous_uid>`	For NFS only, the anonymous user ID. This ID is usually 4294967294 on 32-bit systems or 65534 on 16-bit systems. If not specified, the default ID is 4294967294.
`‑‑anongid <anonymous_gid>`	For NFS only, the anonymous group ID. This ID is usually 4294967294 on 32-bit systems or 65534 on 16-bit systems. If not specified, default ID is 4294967294.
`‑‑namecase default`	For CIFS/SMB shares only, client file/directory names are treated as case-insensitive and case-preserved. File/directory names will be saved in the original character case as is, and all search will be performed in a case-insensitive manner. Use this option in the following situations: Users creates a share using option `‑‑namecase lower` so that all incoming client file/directory names will be converted to lower case before saving or searching. Files/directories with mixed case are copied over to the share without using CIFS/SMB. Users can seach for these files in browsers but cannot open, rename, move, copy, or delete the files. In this case, to access the files through a CIFS/SMB share, the file names have to be changed to lower case. However, this task is impossible to do over CIFS/SMB. A solution to this issue is to use this edit command to revert name support to the default (case-insensitive and case-preserved). After the `‑‑namecase` option is executed successfully, the following occurs: Old file/directory names in the share remain unchanged. New file/directory names will be saved as is (case-preserved). File/directory search is performed in a case-insensitive manner. Note: After specifying the `‑‑namecase` default option in this command, you cannot change the share back to support lower case file/directory names.
`‑‑sure`	If specified, the CLI executes the command without prompting for confirmation.

NAS Server Side Copy

This command copies files directly on the DXi without the need to move the data between the DXi and the client requesting the copy. This feature leverages deduplicated data and avoids retrieving and storing a copy of the file over the network.

Use this command for making a restore point copy of a rolling full image, before updating that image with the latest incremental changes.

For example, when using Oracle RMAN's Rolling Forward Image Copy Backups on a DXi NAS (NFS or SMB) share, a copy of the current backup image can be made quickly and efficiently on the DXi using this feature. The copy can then be added to the RMAN catalog via scripted commands on the Oracle server, before the next set of incremental changes are made to the image.

Note: Server Side Copy (SSC) is only available for RMAN disk backups on DXi NAS shares. It is not available for RMAN sbt backups (RMAN plug-in with Application Specific shares).

Command

syscli --copy path --name <sharename> --source <path> [--destname <sharename>] --dest <path> [--terse]

Command Attributes

Review the following attribute descriptions.

`‑‑copy path`	Copies the specified file or directory in a NAS share.
`‑‑name <sharename>`	Enter the name of the NAS share to be copied. You must use alphanumeric characters for the share name.
`‑‑source <path>`	Enter the path to the directory or file to be copied.
`‑‑destname <sharename>`	The NAS share to copy the directory or file to. If not specified, the copy is made to the source share.
`‑‑dest <path>`	Enter the path to copy to in the destination share.
`‑‑terse`	If specified, output will only be shown if an error occurs.

Enable Allowlinks

Enable the allowlinks attribute for a single share by entering the share name OR for all shares. When the allowlinks attribute is enabled, the share supports hard links. By default, all shares are created the with allowlinks attribute disabled. If you enable the attribute, it cannot be disabled.

Note: If you enable hard link support (‑‑enable allowlinks) for an NFS share, replication cannot be enabled for the share; likewise, if you enable replication for the share, hard link support is disabled.

Command

syscli ‑‑enable allowlinks {‑‑share <sharename>} | ‑‑all

Delete a NAS Share

Delete one or more existing NAS shares. You must enter the NAS share name to delete a share.

When a share is deleted, all connections to the share are severed and all data stored on it is removed permanently. Any scheduled replications will be removed.

Command

syscli ‑‑del share (‑‑name <sharename>)

Delete All NAS Shares

Delete all NAS shares on your DXi system.

Command

syscli ‑‑deleteall share [‑‑proto {cifs|nfs|app_specific}] [‑‑namematch <pattern>] [‑‑sure]

Command Attributes

Review the following attribute descriptions

`‑‑deleteall share`	Deletes all NAS shares.
`‑‑proto {cifs\|nfs\|app_specific}`	If you use this option, deletes only shares of the specified protocol type.
`‑‑namematch <pattern>`	If you use this option, only shares whose names match the specified pattern are deleted. The wild characters `^` and `$` are supported as follows: `^xxx` – Matches pattern xxx at the start of names `xxx$` – Matches pattern xxx at the end of names Because `$` is special to the shell, remember to escape the character with a backslash (\) because it is special to the shell. Example To delete all shares ending with test in the names, enter the following command: `syscli ‑‑deleteall share ‑‑namematch test\$`
`‑‑sure`	If specified, the CLI executes the command without prompting for confirmation.