DXi Command Line Interface (CLI)

The cliviewer user can view and retrieve information, but it cannot add, change, or delete information. If the cliviewer user attempts to run an intrusive command that changes system information, such as add, edit, or delete, an error is returned.

The cliviewer user is disabled by default. To enable the user, go to Configuration > System > Security > Local Access page in the web-based remote management console.

Note: You can also use the syscli --edit sysuser command to enable accounts.

Login credentials for the cliviewer user

• user name – cliviewer
• password – set by the DXi administrator when the account is enabled

The cliadmin user can view and retrieve information, as well as add, change, or delete information.

The cliadmin user is disabled by default. To enable go to Configuration > System > Security > Local Access page in the web-based remote management console.

Note: You can also use the syscli --edit sysuser command to enable accounts.

Login credentials for the cliadmin user

• user name – cliadmin
• password – set by the DXi administrator when the account is enabled

After deploying your DXi system, you can immediately connect to it through an SSH client using the ServiceLogin account. This account uses a password set by the user, if enabled during setup using the Getting Started Wizard.

Note: The ServiceLogin account should only be enabled if requested by Quantum Service.

The cliadmin and cliviewer accounts use SecureShell (SSH) keys or a password to log on to the DXi system, depending on your configuration. Both accounts are confined to a restricted shell for security.

To add a SSH public key to the cliadmin,cliviewer, and ServiceLogin user accounts, see SSH Public Keys.

Use the following command to disable CLI user accounts:

Command Attributes

Review the following attribute descriptions.

--edit sysuser	Configures access for the specified user.
‑‑name cliadmin|monitor|cliviewer|service|servicelogin	Enter the account for which to change access restrictions.
--account lock|unlock	Regulates the user's ability to log in to the system.
--passwd lock|unlock	Regulates the user's ability to log in to the system with a password-based login.

This command imports list public keys associated with the CLI administrator, CLI viewer, and ServiceLogin user accounts.

Command Attributes

Review the following attribute descriptions.

‑‑list publickey	Prints a list of public keys containing the following information: user and key alias.
‑‑user cliadmin|cliview|servicelogin|veeam	CLI users whose keys are to be listed. If no user is specified, all key users are printed.

This command imports a public key and associates it with the specified CLI user.

Command Attributes

Review the following attribute descriptions.

‑‑add publickey	Imports a public key.
‑‑user cliadmin|cliview|servicelogin|veeam	The account for which the key will provide authentication.
‑‑alias <key alias>	Short alpha-numeric string (up to 20 characters) alias used to identify the key to be added.
‑‑key <public key>	The RSA/DSA public key to be added. The key must be in the following form: <key type> <base64 encoded string (letters, numbers, '+', '/', '=')>

This command allows the CLI administrator to rename public key aliases of the CLI users.

Command Attributes

Review the following attribute descriptions.

‑‑edit publickey	Changes key alias of the specified key.
‑‑user cliadmin|cliview|servicelogin|veeam	The account associated with the key to be renamed.
‑‑alias <key alias>	Current key alias.
‑‑newalias <new key alias>	New key alias to identify the key. The key alias must be a short alpha-numeric string (up to 20 characters) alias used to identify the key to be added.

This command deletes a public key associated with a specified CLI user.

Command Attributes

Review the following attribute descriptions.

‑‑delete publickey	Removes a specified key associated with a specified CLI user.
‑‑user cliadmin|cliview|servicelogin|veeam	Name of the CLI user whose key is to be removed.
‑‑alias <key alias>	Key alias that identifies the key to be removed.
[--sure]	If specified, this command will execute immediate without asking for confirmation.

This command deletes all public keys associated with a CLI user.

Command Attributes

Review the following attribute descriptions.

‑‑deleteall publickey	Removes all public keys associated with the specified CLI user.
‑‑user cliadmin|cliview|servicelogin|veeam	Name of the CLI user whose keys are to be removed.
[--sure]	If specified, this command will execute immediate without asking for confirmation.

Use the following CLI help commands as needed.

syscli

Displays a summary of help commands.

syscli help

Displays syntax for all syscli commands.

syscli help NAS | VTL | OST | REPLICATION |...

Displays syntax for all Network Attached Storage (NAS) commands, Virtual Tape Library (VTL) commands, Open Storage Technology (OST) commands, replication commands, and so on, respectively.

syscli help ‑‑<cmd>

Displays syntax for all commands for the specified value.

Examples

syscli help ‑‑list displays all ‑‑list commands.

syscli help ‑‑add displays all ‑‑add commands.

syscle help ‑‑<cmd> <subcmd>

Displays detailed help for the specific command and subcommand.

Example

syscli help ‑‑list nas displays the complete help for the ‑‑list nas command.

If the system encounters an error when you run a command, it returns an error code. Enter the following command to view the information associated with the error code. This information can assist you in determining the reason for the error.

Command Attributes

Review the following attribute descriptions.

‑‑get	Gets error message, or error code, or symbolic error constant.
‑‑type	Type of output data: message, symbolic constant, or error code. Default is message for most cases.
‑‑value	Error value: Either error code (Ennn, or just nnn where nnn is decimal), or symbolic constant, or full error message.
‑‑terse	If specified, the output will be terse (in one line).

If a command runs to completion successfully, it returns an exit code of zero (0) along with the following message:

Command completed successfully.

If a command fails, it returns an exit code of one (1) along with a one line error message that summarizes the error, such as the following:

ERROR: CIFS server is disabled! (E1000011)

The following options are accepted by every command:

• ‑‑outfile <output_filename>
• ‑‑errfile [<errfile_name>]
• ‑‑file <options_filename>
• ‑‑lockwait <seconds>

See the following sections for additional information about these options.

‑‑outfile <output_filename> and ‑‑errfile [<errfile_name>]

These options replace the shell output redirection characters "<" and ">," which are forbidden in the restricted shell.

• ‑‑outfile specifies that the standard output is saved to the file specified in <output_filename>.
• ‑‑errfile specifies that the standard error is saved to the file specified in <errfile_filename>. If you do not specify a file in this command, the syscli program saves the file to the same file named in <output_filename>.

‑‑file <options_filename>

This option is supported to avoid the problem of quoting and escaping special characters. Instead ‑‑file instructs the program to open the file specified in <options_filename> to read additional options.

Within the Options file, each option or each option=value pair is listed on a separate line. Blank lines or lines beginning with # are ignored.

Example

syscli ‑‑add share ‑‑name abc ‑‑proto cifs

The above command is functionally equivalent to any of the following commands:

1. syscli ‑‑file <myfile>, where <myfile> is a file containing:

   ‑‑add=share

   ‑‑name=abc

   ‑‑proto=cifs

2. syscli ‑‑add share ‑‑file <file1>, where <file1> is a file containing:

   ‑‑name=abc

   ‑‑proto=cifs

3. syscli ‑‑add share ‑‑file <file2> ‑‑ proto cifs, where <file2> is a file containing:

   ‑‑name=abc

Options File Syntax

The following syntax conventions are used for the Options file.

Left to Right Processing

The syscli program processes command line options from left to right. You can override any option in the file by listing it after the ‑‑file option on the command line.

Example

syscli ‑‑add share ‑‑file barcodes ‑‑barcode mybarcode

In the above command, syscli processes ‑‑barcode mybarcode after ‑‑file barcodes, thus ‑‑barcode mybarcode overrides ‑‑file barcodes.

‑‑lockwait <seconds>

This option specifies how long the command can wait for its turn to access a system resource. The default is 15 seconds. In general, when a command needs to change system configuration settings, it has to lock the relevant resources to prevent other commands from changing them at the same time. If a second command tries to read or change the same system settings that are being locked, it has to wait for the first command to complete and release the lock. However, there is a limit on how long it can wait. This limit is called the lock waiting time (15 seconds by default). After the time limit is reached, the second command will give up and fail with a message similar to the following:

Locking failed because file was locked by another process! Try again later.

You can run the command later or rerun it with the ‑‑lockwait option. For example, use the following command to increase the waiting time to 60 seconds:

syscli ‑‑<command> ‑‑lockwait 60

Note: Specifying ‑‑lockwait 0 instructs the command to not wait, and to fail immediately if the resource is busy.

List administrative alerts within the system.

Command Attributes

Review the following attribute descriptions.

‑‑list adminalert	Lists administrative alerts within the system.
‑‑alert <alert_item>	Enter a specific alert item to list information for that item only.

Delete the specified administration alert.

Delete all existing administration alerts. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

Enable or disable NetServer on the current DXi system. Use this system to perform analysis on another DXi system.

Display whether Netserver is enabled on the current DXi system.

Perform a network analysis of the current DXi system using another DXi system.

Note: Enable NetServer on the system performing the analysis using the ‑‑set netserver command.

Command Attributes

Review the following attribute description.

‑‑analyze network	Analyzes the network throughput between the source and target system. Note: NetServer should be enabled on host specified in the 'ipaddress' option.
‑‑ipaddress <ipaddress>	IP Address of the test system with which the network analysis is to be performed.

Perform a disk analysis on the DXi system.

Displays results for the most recent disk OR network analysis.

This command returns the current DAE settings.

This command returns the resource limitations and supported options for the host system.

This command enables or disables DAE. The system will reboot if the feature is enabled or disabled.

Command Attributes

Review the following attribute descriptions.

--set: Enable DAE	Enable DAE. Note: The system will reboot if the DAE enable state is changed.
--enable	If specified, the feature will be enabled or disabled. If the state is changed, the system will reboot.
--guacamole	If specified, enables Apache Guacamole as an alternative to vncviewer and creates the admin account for Guacamole. Password is required.
--password	Password for the Guacamole admin account.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.
‑‑deferreboot	If specified, the reboot will be deferred until a time the user forces a reboot

This command allows for the creation of a new virtual machine (VM) instance.

Command Attributes

Review the following attribute descriptions.

‑‑add dae	Create a new VM instance.
‑‑name <vm name>	The name of the VM.
‑‑cpus <num cpus>	The number of CPUs for the VM.
‑‑memory <ram>	Amount of RAM memory (in MB) for the VM.
‑‑diskspace <vm diskspace>	Amount of disk space (in GB) for the VM operating system.
‑‑isoimage <iso pathToImage>	Selection of the path and image file to use for the operating system install.
‑‑appnetwork <nic port>	Selection of the application network devices (NIC ports). More than one may be specified.
‑‑autostart [yes|no]	Autostart the VM on the system boot. The default is no.
‑‑password <password>	Password for accessing the console over VNC.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.

This command allows for the modification of an existing DAE virtual machine (VM) instance. The VM may be updated in a running state but a restart may be required.

Use to obtain valid ranges and values.

Command Attributes

Review the following attribute descriptions.

‑‑edit dae	Edit VM instance.
‑‑name <vm name>	Edit the name of the VM.
‑‑cpus <num cpus>	Edit the number of CPUs for the VM.
‑‑memory <ram>	Modify the amount of RAM memory (in MB) for the VM.
‑‑appnetwork <nic port>	Modify the application network devices (NIC ports). More than one may be specified.
‑‑autostart [yes|no]	Change the autostart status of the VM on the system boot. The default is no.
‑‑password <password>	Change the password for accessing the console over VNC.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.

This command deletes an existing virtual machine (VM) instance.

Command Attributes

Review the following attribute descriptions.

‑‑delete dae	Delete the VM instance.
‑‑name <vm name>	The name of the VM to be deleted.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.

This command lists current DAE virtual machines (VMs) and summary information on each VM.

Note: Only the cliadmin can access the VM with VNC Viewer

Command Attributes

Review the following attribute descriptions.

‑‑list dae	List the VM instance(s).
‑‑name <vm name>	The name of a specific VM to show (optional).

This command exports a virtual machine (VM) image to a file suitable for import on another system.

Command Attributes

Review the following attribute descriptions.

‑‑export dae	Export a VM image.
‑‑name <vm name>	The name of the VM image to save.
‑‑path <path for image>	Destination for the exported image.

This command lists DAE virtual machine (VM) image files in a specified directory.

Command Attributes

Review the following attribute descriptions.

‑‑list daeexport	Retrieves a list of VM image export files in a specified directory.
‑‑path <export file path>	The directory to search for VM image export files. If not specified, the default path is /Q/shares/VM.

This command imports a virtual machine (VM) image exported using --import dae.

Command Attributes

Review the following attribute descriptions.

‑‑import dae	Import a VM image.
‑‑image <path name>	The name of file containing the VM image to import.
‑‑name <new name>	The name of the imported VM if different from the original name.

This command starts a virtual machine (VM) that has been shutdown or stopped.

Command Attributes

Review the following attribute descriptions.

‑‑start dae	Starts the VM instance.
‑‑name <vm name>	The name of the VM to start.

This command stops a virtual machine (VM) and saves the current state to disk.

Command Attributes

Review the following attribute descriptions.

‑‑stop dae	Stops the VM instance.
‑‑name <vm name>	The name of the VM to stop.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.

This command performs a clean operating system (OS) shutdown of the virtual machine (VM). All services are cleanly shutdown within the VM before it is powered off.

Command Attributes

Review the following attribute descriptions.

‑‑shutdown dae	Shutdown the VM instance.
‑‑name <vm name>	The name of the VM to shutdown.
‑‑poweroff	If specified, the VM instance is immediately powered off. The current state is not preserved, so any open files or active I/O could result in VM corruption.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.

This command lists .iso files in a specified directory.

Command Attributes

Review the following attribute descriptions.

‑‑list daeiso	Retrieves a list of .iso files in the specified directory.
‑‑path <iso path>	The directory to search for the .iso files. If not specified, the default path is /Q/shares/VM.

This command eject the .iso file for the virtual machine (VM).

Command Attributes

Review the following attribute descriptions.

‑‑eject daeiso	Ejects the .iso file for the VM.
‑‑name <vm name>	The name of the VM to eject the .iso file.

This command enables or disables Cloud Share. The system will reboot if the state is changed.

WARNING: If no Application Environment option is selected, the extra memory reserved for these features will NOT be us ed.

Command Attributes

Review the following attribute descriptions.

‑‑set cloudshare	Enable or disable Cloud Share.
‑‑enable on|off	If specified, cloud share will be enabled or disabled. If the state is changed, the system will reboot.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.
‑‑deferreboot	If specified, the reboot will be deferred until a time the user forces a reboot.

This command returns the current Cloud Share feature settings.

This command returns the current Veeam agent settings.

This CLI enables or disables access for the Veeam agent. Either the password and/or the key must be entered. The system will reboot if the enable state is changed. A reboot is not necessary for other options. The system will require a reboot if the access is enabled or disabled. A password change or a change of the memory threshold monitoring will not require a reboot.

Command Attributes

Review the following attribute descriptions.

‑‑set veeam	Enable access for the Veeam agent; either the password and or the key must be entered. The system will reboot if the enable state is changed. If only the password is changed, a reboot is not necessary.
‑‑enable on|off	If specified, the Veeam agent login will be enabled or disabled. If the state is changed, the system will reboot.
‑‑passwd lock|unlock	Specifies if password access is allowed.
‑‑password <password>	If the password is not specified, the command will prompt for the password and it will not be echoed.
--enablememmon on|off	Enables or disables memory threshold monitoring. Veeam must be enabled before the monitoring can be enabled.
--memthreshold <threshold>	Specifies the memory threshold in bytes.
--cgroupslimit <limit>	Amount of memory allocated for Veeam Concurrent Streams, value in GB. Must have DXi9000 with Enhanced CPU and Memory Configuration. If you need to determine if you DXi9000 can be enhanced for Veeam, open the System Management (GUI) status >hardware > Firmware Version and scroll until you see RAM information. The system must have 768 GB RAM to employ this feature.
‑‑deferreboot	If specified, the reboot will be deferred until a time the user forces a reboot.
‑‑sure	If specified, this command will execute immediately without asking for confirmation.

This command enables or disables increased stream count (ISC). The system will reboot if the feature is enabled or disabled.

Command Attributes

Review the following attribute descriptions.

--set isc	Enable ISC - The system will reboot if the enable state is changed.
--enable	If specified, the feature will be enabled or disabled. If the state is changed, the system will reboot.
--sure	If specified, the command will execute immediately without asking for confirmation.
--deferreboot	If specified, the reboot will be deferred until a time the user forces a reboot.

This command returns the increased stream count (ISC) settings.

Command Attributes

Review the following attribute descriptions.

--get isc

Get ISC feature settings.

Add a backup application user.

Command Attributes

Review the following attribute descriptions.

‑‑add backupuser	Adds a backup application user.
‑‑name <backup_user_name>	Enter a user name for the backup application user. Note: A backup user name can contain the following characters: 'a-z', 'A-Z', '0-9', '_', and '.'
‑‑password <backup_user_password>	Enter a password for the backup application user.
‑‑desc <description>	Enter a description of the user. Enclose the description in double-quotation marks if you use spaces or special characters.

Edit a backup application user.

Command Attributes

Review the following attribute descriptions.

‑‑edit backupuser	Edits the specified backup application user's settings.
‑‑name <backup_user_name>	Enter the user name of the backup application user.
‑‑password <backup_user_password>	Enter a password for the backup application user.
‑‑desc <description>	Enter a description of the user. Enclose the description in double-quotation marks if you use spaces or special characters.

Deletes the specified backup application user.

Deletes all backup application users. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

This command lists all users associated with Application Specific shares, OST Storage Servers, and PTT Backup applications.

This command enables Cloud-Based Analytics.

Command Attributes

Review the following attribute descriptions.

‑‑enable	Enables Cloud-Based Analytics on the system. Note: If not already registered, it will automatically register this unit on the CBA server.
‑‑overwrite	If specified, overwrites the current registration. Note: This creates a new instance on the insight server and you lose your old data.

This command disables Cloud-Based Analytics.

This command allows you to configure features or proxy for Cloud-Based Analytics.

Command Attributes

Review the following attribute descriptions.

‑‑set	Sets/configures Cloud-Based Analytics features or proxy.
‑‑feature	Select feature.
‑‑enable	Enable or disable feature.
‑‑proxy	IP or hostname of proxy. Use "none" to unset.
‑‑proxyport	Port number of proxy. Use "none" to unset.
‑‑username	Username for proxy authentication. If omitted, the current value is cleared as well as the password.
‑‑password	Password associated with the username. If the <password> is not specified on the command line, the command will prompt for password and will not echo it on the screen.

This command retrieves current Cloud-Based Analytics settings.

Command Attributes

Review the following attribute descriptions.

‑‑get

Gets settings on the system.

This command pings the insight server.

Command Attributes

Review the following attribute descriptions.

‑‑ping

Pings the insight server.

This command enables Cloud Share (S3) for the specified share or LSU.

Cloud Share cannot be enabled on an object that has one or more of the following configured:

• Replication

• Concurrent Optimized Duplication

• Automatic Image Replication (AIR)

• OST WORM

• Secure Snapshots

WARNING: Once Cloud Share is enabled, it cannot be disabled.

Command Attributes

Review the following attribute descriptions.

‑‑add cloudshare	Enables Cloud Share (S3) for the specified share or LSU.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	Name of the LSU or share.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑bucket <s3 bucket>	S3 bucket for cloud share.
‑‑endpoint <s3 endpoing>	S3 endpoint for cloud share. If not specified, the value is derived from the bucket.
‑‑keyid <aws key id>	AWS Access Key ID.
‑‑secretkey <aws secret key>	AWS Secret Access Key.
‑‑lifetime <days>	This setting is for future functionality. Default = 365.

This command changes the Cloud Share (S3) settings for the specified share or LSU.

Command Attributes

Review the following attribute descriptions.

‑‑edit cloudshare	Changes the Cloud Share (S3) setting for the specified share or LSU.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	Name of the LSU or share.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑endpoint <s3 endpoing>	S3 endpoint for cloud share.
‑‑keyid <aws key id>	AWS Access Key ID.
‑‑secretkey <aws secret key>	AWS Secret Access Key.
‑‑lifetime <days>	This setting is for future functionality. Default = 365.

This command retrieves current Cloud Share settings for the specified share(s) or LS U(s).

Command Attributes

Review the following attribute descriptions.

‑‑list cloudshare	Lists cloud share settings for shares/LSUs on the system. Optionally limited to a certain storage server or a single share/LSU. Results can also b e filtered by cloud storage provider.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	Name of the LSU or share.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑provider <s3>	Cloud storage provider. Currently only S3 API is supported.

This command lists all backup images for a storage object configured for cloud archive.

The list can be limited by the cloud share state, and can be saved to a file and provided as input to --restore cloudimages.

Command Attributes

Review the following attribute descriptions.

‑‑list cloudimages	Lists all images for the object and their cloud share state.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	List images for this object.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑state {local|archived|both}	List images in a specific state. local - The image is stored locally but not yet scheduled for cloud share. both - The image has been copied to the cloud and there is also a local copy. archived - The image has been copied to the cloud and the local copy has been removed.
‑‑imagenamesfile <name>	Writes the image list to the specified file. The file can be provided as input to --restore cloudimages.

This command allows an admin user to archive all local backup images on a specific storage object to a cloud archive.

Command Attributes

Review the following attribute descriptions.

‑‑archive cloudimages	Archive backup images.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	Name of storage object to archive.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑sure	Execute without asking for confirmation.

This command allows an administrator to restore one or more local backup images from a cloud archive.

To restore more than one image, repeat the --image option.

Alternatively, the images can be listed in a file that was created with --list cloudimages.

Note: Restoring from cloud archives may take more than 48 hours.

Command Attributes

Review the following attribute descriptions.

‑‑restore cloudimages	Restore archived images.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	Name of storage object to restore.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑image <name>	Name of the image(s) for the restore.
‑‑imagenamefile <name>	Name of a file containing a list of images to restore. Output is from --list cloudimages.
‑‑sure	Execute without asking for confirmation.

This command allows an administrator to release references to local data of archived images. This data will then be freed locally by Space Reclamation.

To release more than one image, repeat the --image option.

Alternatively, the images can be listed in a file that was created with --list cloudimages.

Command Attributes

Review the following attribute descriptions.

‑‑release cloudimages	Release references of archived images to local data. This data will then be freed locally by Space Reclamation.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	Name of storage object to release.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑image <name>	Name of the image(s) for the release.
‑‑imagenamefile <name>	Name of a file containing a list of images to release. Output is from --list cloudimages.
‑‑sure	Execute without asking for confirmation.

This command used is used to list Cloud Share jobs.

Command Attributes

Review the following attribute descriptions.

‑‑getstatus cloudshare	List cloud share jobs.
‑‑jobid <id>	Job ID. If not specified, all jobs are listed.

This command deletes images in the cloud which do not have corresponding images in the local share.

Command Attributes

Review the following attribute descriptions.

‑‑delete cloudimages	Delete remote images.
‑‑objecttype share|lsu	Object type: LSU or share.
‑‑objectname <name>	Name of storage object to delete.
‑‑storageserver <name>	The storage server the LSU belongs to. Only applicable if --objecttype is lsu.
‑‑sure	Execute without asking for confirmation.

This command is used to get Cloud Share statistics.

Add an access control user account or a workgroup account to the system. If role is not specified, the default is wguser. If adding an access control user that is authenticated by LDAP, the user MUST first be added to the directory server and LDAP MUST be enabled on the DXi (--set ldapsettings). The password is ignored for LDAP accounts. The password for LDAP accounts is set on the LDAP server.

Command Attributes

Review the following attribute descriptions.

‑‑add	Adds a user.
‑‑name	Name of user. A user and group cannot have the same name.
‑‑password	If omitted, the password will be prompted interactively.
‑‑role	The role for the account. Admin has full access. Operator access is determined by group membership (RBAC). Roles wguser and wgadmin are Windows Workgroup users and are allowed only if the system is joined to a workgroup. Workgroup users do not have login privileges on the system. If role is not specified, the default is wguser.
‑‑desc	User description. Enclosed in double quotes if string contains spaces or special characters.
‑‑force	If specified, forcefully kill any suspended process locking the password file. WARNING: This option is recommended for the following case: The command fails to add user simply because another process is locking the password file and is currently suspended (for example, by CTRL-Z). AND You really want to kill the suspended process to allow the command to succeed.

Displays a list of users for a specific role. If --name is specified, only those names that match the specified name are listed. If --namematch is specified, lists only those names of users with the specified role that matches the specified pattern.

Command Attributes

Review the following attribute descriptions.

‑‑list	Lists all users with the specified role. Note: If role is not specifed, workgroup users are listed.
‑‑name	If specified, get information for the specified user name only.
‑‑namematch	If specified, only users whose names match the specified pattern will be listed.
‑‑role	List users with the specified role. If omitted, only workgroup users are listed.

Modify properties of an access control user account or a workgroup account.

Note: At least one property must be specified.

If the user is authenticated by LDAP, the password is ignored. The password for the LDAP accounts is set on the LDAP server.

Command Attributes

Review the following attribute descriptions.

‑‑edit	Edit properties of a user.
‑‑password	If specified, change the password to the new value.
‑‑desc	If specified, change the description. Specify --desc "" to delete the description.

Delete all existing users or all users with a specific role. This CLI will not allow the current user to delete their own account.

Command Attributes

Review the following attribute descriptions.

‑‑deleteall	Deletes all users or those with a specific role, except for the current user.
‑‑role	All users of this role will be deleted, except for the current user.
‑‑sure	If specified, the command will execute immediately without asking for confirmation.

Add a group for access control, where users and group administrators can be added.

Command Attributes

Review the following attribute descriptions.

‑‑add	Creates a user group.
‑‑name	Name of the new group. A user and a group cannot have the same name.
‑‑desc	Group description. Enclosed in double quotes if string contains spaces or special characters.
‑‑user	If specified, add one or more existing users to the group.
‑‑restype	Resource type.
‑‑resname	Resource name.

Delete an access control group.

Command Attributes

Review the following attribute descriptions.

‑‑del	Deletes a user group.
‑‑name	Name of the group to delete.
‑‑sure	If specified, the command will execute immediately without asking for confirmation.

Lists access control groups, the users in the groups, and the access granted to the groups.

Command Attributes

Review the following attribute descriptions.

‑‑list	Lists user groups.
‑‑name	Name of the group to list. If omitted, all groups are listed.

Add one or more users to a group.

Command Attributes

Review the following attribute descriptions.

‑‑add	Adds user(s) to a group.
‑‑group	Name of the group.
‑‑user	Add one or more existing users to the group.

Delete one or more users from a group.

Command Attributes

Review the following attribute descriptions.

‑‑del	Deletes user(s) from a group.
‑‑group	Name of the group.
‑‑user	Delete one or more existing users from the group.

Adds an existing group to one or more resource access control lists (ACLs).

Command Attributes

Review the following attribute descriptions.

‑‑add	Adds an existing user group to one or more ACLs.
‑‑group	Name of the group.
‑‑restype	Resource type.
‑‑resname	Resource name.

Deletes an existing group from one or more resource access control lists (ACLs).

Command Attributes

Review the following attribute descriptions.

‑‑del	Deletes a group from one or more ACLs.
‑‑group	Name of the group.
‑‑restype	Resource type.
‑‑resname	Resource name.

Add one or more groups to a resource's access control list (ACL).

Command Attributes

Review the following attribute descriptions.

‑‑add	Deletes user(s) from a group.
‑‑restype	Resource type.
‑‑resname	Resource name.
‑‑group	One or more groups to add to the access list for the specified resource.

Delete one or more users from a group.

Command Attributes

Review the following attribute descriptions.

‑‑del	Deletes user(s) from a group.
‑‑group	Name of the group.
‑‑user	Delete one or more existing users from the group.

Replace the access control list (ACL) of a resource. Any groups not specified will be removed from the ACL. To add individual groups, use --add access. To delete individual groups or the last group, use --del access.

Command Attributes

Review the following attribute descriptions.

‑‑edit	Update the ACL of a resource.
‑‑restype	Resource type.
‑‑resname	Resource name.
‑‑group	One or more groups to replace the access list for the specified resource.

List groups in the access list of a specific resource.

Command Attributes

Review the following attribute descriptions.

‑‑get	Lists groups with access to the specified resource.
‑‑restype	Resource type.
‑‑resname	Resource name.

Remove one or more groups from the access control list (ACL) of a resource.

Command Attributes

Review the following attribute descriptions.

‑‑del	Removes groups from the access list of a resource.
‑‑restype	Resource type.
‑‑resname	Resource name.
‑‑group	One or more groups to remove from the access list for the specified resource.
‑‑sure	If specified, the command will execute immediately without asking for confirmation.

List resources.

Command Attributes

Review the following attribute descriptions.

‑‑list

Lists resources.

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

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\$

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

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 by specifying the share name.

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

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 contents of a given Application Specific share.

Command Attributes

Review the following attribute descriptions.

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

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 Attributes

Review the following attribute descriptions.

‑‑add share	Adds NAS shares.
‑‑name <sharename>	Enter the name of the share to add. Attribute must consist of maximum 32 letters [A-Z a-z], numbers[0-9], and -_ characters, but may not begin with a hyphen.
‑‑proto {cifs|nfs|app_specific}	Specify the network file sharing protocol to use for the share, either CIFS/SMB, NFS, or Application Specific
‑‑desc <description>	Enter an optional description for the share. Enclose the description with quotation marks if it includes spaces.
‑‑ro	If you specify this option, makes the share read-only. Otherwise, the share is read-write. Note: This command attribute is not applicable to application-specific shares. They are always writable.
‑‑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 . Note: This is root_squash. If you select the none value, all client users are preserved (no_root_squash). 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.
‑‑snapshotretention <days>	Enables Secure Snapshots functionality on a deduplicated share and specifies the snapshot retention period in days. Note: This does not create snapshots. Please use scheduled events or "syscli --add securesnapshot" command to do that.

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 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.
‑‑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. Note: this is "root_squash". If you select the none value, all client users are preserved (no_root_squash). Note: When files are replicated from a share with no_root_squash enabled to a target DXi without no_root_squashsupport, 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: Use 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.
--snapshotretention <days>	Configures Secure Snapshots functionality. A non-zero value enables snapshot creation and specifies the snapshot retention period in days. Note: This does not create snapshots. Please use scheduled events or the syscli --add securesnapshot command. Confirmation is required to apply the change. Use --sure to suppress the prompt. A value of zero disables Secure Snapshots (confirmation required). Existing snapshots retain their current retention value.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

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 Attributes

Review the following attribute descriptions.

‑‑copy path	Copies the specified file or directory in a NAS share.
‑‑name <sharename>	The share containing the path to copy. 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 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: This command only works for NFS shares (in general). you enable hard link support (--enable allowlinks), replication cannot be enabled.

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.

Delete all NAS shares on your DXi system.

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 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.

Join the Samba server to the specified workgroup.

Disjoin the Samba server from its workgroup.

Join the Samba server to an ADS domain.

Command Attributes

Review the following attribute descriptions

‑‑join ads	Joins the Samba server to an ADS domain.
‑‑domain <domain_name>	Enter the name of the ADS domain to which to join the Samba server.
‑‑org <organizational_unit>	If specified, an organizational unit to assign to the domain.
‑‑admin <domain_user authorized_to_join>	Enter the user name for the account that has the right to join the domain. Note: This domain user is defined in the ADS domain and is not necessarily the system’s admin user.
‑‑password <domain_user_password>	Enter the password for the admin account. You can choose not to supply the password on the command line. In this case the CLI prompts you for the password and does not echo the response for security purposes.
‑‑pdc <primary_domain_controller>	Enter the host name or IP address of the Primary Domain Controller (PDC). If you do not specify the PDC, the CLI tries to discover it automatically.
‑‑prewin2kdomain <preWindows_2000_domain_name>	The pre-Windows 2000 domain name is also known as the NetBIOS domain name, which is 15 characters or less. This name can be specified via the ‑‑prewin2kdomain option. Normally you do not need to specify this option because the ‑‑join command can query the AD DS for the pre-Windows 2000 domain name. However, the NetBIOS domain name is sometimes incorrect, such as being longer than 15 characters, causing the ‑‑join command to fail. This failure can happen in an environment with multiple domain controllers with some of them being misconfigured. If a failure occurs Specify ‑‑prewin2kdomain explicitly in the join command. The CLI uses the value instead of querying the domain server/controller. If the domain has more than one domain controllers, specify ‑‑pdc explicitly with the hostname or IP of each domain controller. If a domain controller returns the correct NetBIOS domain name, the join command succeeds. You may need to try rerunning the command with multiple domain controllers until the join command succeeds.

Disjoin the Samba server from an ADS domain. The command only works when the server is currently joined to an ADS domain.

Command Attributes

Review the following attribute descriptions.

‑‑disjoin ads	Disjoins the Samba server from the ADS domain.
‑‑admin <admin_user>	Enter the user name of any account that has the right to disjoin the ADS domain.
‑‑password <admin_password>	Enter the password for the account. You can choose not to supply the password on the command line. In this case the CLI prompts you for the password and does not echo the response for security purposes.

Display the status of the CIFS service.

Displays information about the Windows Domain or Workgroup to which the system is joined in order to access NAS shares configured for the CIFS/SMB protocol on a Window network.

Query CIFS server settings. You can query a single setting OR all settings.

Command Attributes

Review the following attribute descriptions.

‑‑get smbsetting	Queries the specified settings of the CIFS server.
‑‑oplocks	Queries various oplocks settings.
‑‑dbglevel	Queries the debug level setting in the CIFS server.
‑‑ldapsigning	Queries the LDAP client signing setting: client ldap sasl wrapping.
‑‑maxprocesses	Queries the limit on the number of Samba processes: max smbd processes.
‑‑clientntlmv2auth	Queries the NTLMv2 login setting: client NTLMv2 auth.
‑‑all	Queries all global and pre-share CIFS settings.

Change CIFS server settings.You can change a single setting at a time.

Command Attributes

Review the following attribute descriptions.

‑‑set smbsetting	Changes the specified CIFS server settings.
‑‑oplocks yes|no	Changes the kernel oplocks setting in CIFS. In an unstable network environment, you should set the kernel oplocks setting to no.
‑‑dbglevel <n>	Changes the debug level to a nonnegative number (<n>). The higher the value, the more verbose the log files are. A value of zero gives minimum logging (for errors only).
‑‑ldapsigning disabled|enabled	Enables or disables LDAP client signing. You must enable this setting if the LDAP server signing is enabled on the ADS domain server. Otherwise, disable this setting. For more information on how to enable LDAP server signing on the ADS domain server, see Microsoft documentation at: http://support.microsoft.com/kb/935834.
‑‑maxprocesses <max_smbd_processes>	Changes the maximum number of Samba processes at any given time. By default, the limit is 100.
‑‑clientntlmv2auth yes|no	Changes NTLMv2 login setting to yes or no. By default, this setting is set to yes. Do not change the default setting unless the domain group policy on the ADS domain is set to exclusively use the older NTLM (v1).
‑‑serversigning disabled|enabled	Changes the server signing setting to disabled or enabled.

This command provides a list of share administrators. This command works only when the system is joined to an Active Directory domain.

This command allows the admin user to grant share admin privileges to an existing domain user/group. This command works only when the system is joined to an Active Directory Service domain.

• To see a list of existing domain users, type wbinfo -u
• To see a list of existing domain groups, type wbinfo -g

The option --name must be followed by the name of the domain user or group, usually in the form:

<domain_name>\<user_or_group_name>

If you are typing in a shell, make sure to type the backslash twice. For example, if the domain name is quantum.com and the user is joe, you have to type:

syscli --add shareadmin --name quantum\\joe

Command Attributes

Review the following attribute descriptions.

‑‑add

Grants share admin privilege to a domain user.

This command removes the share admin rights from an existing share administrator.

Note: This command works only if the system is joined to an ADS domain.

Command Attributes

Review the following attribute descriptions.

‑‑del shareadmin	Removes share administrator privileges from the specified user/group .
‑‑name <domain_user_or_group_name>	You must enter the domain name after the ‑‑name option, and then enter the name of the specific user or group, as follows: ‑‑name <domain_name>\<user_or_group_name> If you are typing in a shell, make sure to type the backslash twice. Example If the domain name is quantum.com and the user is joe, type the following command at the shell prompt: syscli ‑‑del shareadmin ‑‑name quantum\\joe

Remove the share administrator rights from all domain users or groups previously granted this privilege, with the exception of the built-in domain admins group. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

Display a list all workgroup users that have access to the specified CIFS share. If the returned list is empty, it means all workgroup users are allowed read-write access to the specified share. It is worth noting that the effective access rights depend on share settings (rw/ro), so rw access is not guaranteed. The effective access rights depend on the share access mode. If the share is read-only, all users can have read-only access regardless of their settings.

Note: The shareuser and sharehost sets of commands are also used to regulate access to application-specific shares.

Caution: When working with application specific shares the shareuser commands operate on authenticated users (backupuser set of commands), not workgroup users.

Grant an existing workgroup user the right to access the specified CIFS share.

Command Attributes

Review the following attribute descriptions.

‑‑add shareuser	Adds a workgroup user to the share access list for the specified CIFS share.
‑‑share <CIFS_share_name>	Enter the name of the CIFS share to which you are granting access.
‑‑user <username>	Enter the name of the user to whom you are granting access.
‑‑rw	If you specify this option, the user is allowed complete read-write access to the specified share. However, the effective access rights depend on the share access mode. If the share is read-only, all users can only have read-only access regardless of their settings. By default, the user has read-only access to the share. Note: Application specific shares do not support read-only access, so the --rw option is automatic.

Remove a workgroup user's right to access the specified CIFS share.

Note: When the last workgroup user is deleted from a CIFS share, the share access list of the specified share is empty, which means the share now allows read-write access to all workgroup users. It is worth noting that the effective access rights depend on share settings (rw/ro), so rw access is not guaranteed. The effective access rights depend on the share access mode. If the share is read-only, all users can have read-only access regardless of their settings.

Command Attributes

Review the following attribute descriptions.

‑‑del shareuser	Removes a workgroup user's access from the specified CIFS share.
‑‑share <share_name>	Enter the name of the CIFS share from which you are removing user-access.
‑‑user <username>	Enter the name of the user for whom you are removing access.

Remove all workgroup user rights in accessing the specified CIFS share. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

Note: When all workgroup users are deleted from a CIFS share, the share access list of the specified share is empty, which means the share now allows read-write access to all workgroup users. It is worth noting that the effective access rights depend on share settings (rw/ro), so rw access is not guaranteed. The effective access rights depend on the share access mode. If the share is read-only, all users can have read-only access regardless of their settings.

Display the status of the NFS service.

Display one or more NFS share settings.

Command Attributes

Review the following attribute descriptions.

‑‑get nfssetting	Displays settings for all NFS shares.
‑‑secure	Queries the secure setting. "yes" means all NFS shares are exported with "secure" option. "no" means all NFS shares are exported with "insecure" option.

Changes one or more NFS share settings.

Command Attributes

Review the following attribute descriptions.

‑‑set nfssetting	Changes settings for all NFS shares.
‑‑secure yes|no	"yes" means all NFS shares are exported with "secure" option. "no" means all NFS shares are exported with "insecure" option.

Set up NFS shares to commit data synchronously. When using the synchronous setting:

1. All data that is to be written to the share must be committed to physical storage.
2. All the data must be written to that storage before the system will accept stable write or commit commands.

This setting ensures that all the data resides on disk when a backup completes. By default, NFS shares are created to commit data synchronously.

NFS Commit is an NFSv3 client call to request the NFS server to commit cached data to stable storage. The server has two choices:

Accelerated mode

Allows the NFS server to violate the NFS protocol and reply to commit requests before cached data is committed to stable storage. This mode improves I/O performance, but it may cause data inconsistencies in cases of power failure or severe interruptions.

Standard mode

Honor the NFS commit calls truthfully by committing cached data to stable storage before responding to the clients. This mode guarantees data integrity in cases of power failures or severe interruptions.

Use this CLI command to set up the NFS server to run in Standard mode, with NFS commits running synchronously between server and client.

Command Attributes

Review the following attribute descriptions.

‑‑nfscommit sync	Sets up the specified NFS share to commit data synchronously.
‑‑share <sharename>	Enter a specific share for which to set synchronous data commit.
‑‑all	Enter to set all NFS shares to commit data synchronously.

Set up NFS shares to commit data asynchronously. With this setting, the system allows receipt of stable write or commit commands without requiring the data and related metadata being fully written to disk. This mode allows backups to be completed faster from the backup application point of view.

This CLI command sets up NFS server to run in Accelerated mode (see Commit NFS Synchronously), where NFS commit messages are acknowledged asynchronous after receipt. However, this mode can cause incomplete backups if the system fails before all data is written to disk.

By default, NFS shares are created to commit data synchronously.

Note: Simultaneous inline deduplication of VTL/ OST and Linux NFS traffic represents the mixing of a heavy, intensive IO payload with an out-of-order, bursty, and response-sensitive protocol. For DXi 2.x, we recommend changing the configuration to run shares as asynchronous shares.

Command Attributes

Review the following attribute descriptions.

‑‑nfscommit async	Sets up the specified NFS share to commit data asynchronously.
‑‑share <sharename>	Enter a specific share for which to set asynchronous data commit.
‑‑all	Enter to set all NFS shares to commit data asynchronously.

Display a list of specific NFS hosts with access to the specified NFS share. By default, if this list is empty, all NFS hosts are allowed read-write access to the share. It is worth noting that the effective access rights depend on share settings (rw/ro), so rw access is not guaranteed. The effective access rights depend on the share access mode. If the share is read-only, all users can have read-only access regardless of their settings. However, the effective access right of the host depends on the share access mode. If the share is read-only, all hosts will effectively have read-only access regardless of their settings.

REMINDER: "sharehost" commands also operate on application specific shares.

Grant a host the right to access the specified NFS share.

Command Attributes

Review the following attribute descriptions.

‑‑add sharehost	Adds an host to the share access list for the specified NFS share.
‑‑share <NFS_share_name>	Enter the name of the NFS share to which you are granting access.
‑‑host <NFS_host_name>	Enter the name of the host to whom you are granting access.
‑‑rw	If you specify this option, the host is allowed complete read-write access to the specified share. However, the effective access rights depend on the share access mode. If the share is read-only, all hosts can only have read-only access regardless of their settings. By default, the host has read-only access to the share. Note: For application specific shares: Read-Write access is granted regardless if --rw is specified.

Remove a host's right to access the specified NFS share.

Note: When the last host is deleted from an NFS share, the share access list of the specified share is empty, which means the share now allows read-write access to all hosts.

Command Attributes

Review the following attribute descriptions.

‑‑del sharehost	Removes a host's access from the specified NFS share.
‑‑share <NFS_share_name>	Enter the name of the NFS share from which you are removing access.
‑‑host <NFS_host_name>	Enter the name of the NFS host from whom you are removing access.

Remove all host rights to access the specified NFS share. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

Note: When all hosts are deleted from an NFS share, the share access list of the specified share is empty, which means the share now allows read-write access to all hosts.

Display the system's date, time, time zone, time format, and Network Time Protocol (NTP) server information.

This CLI allows the admin user to set the system date and time. Method (a) requires the name or IP address of an NTP server with which the system date and time will be synchronized. Method (b) requires the user to specify both the new date and time.

Command Attributes

Review the following attribute descriptions.

‑‑set	Sets the date and time of the system using NTP or manually.
‑‑ntpserver	NTP server to be used to set date and time. Note: For a list of commonly used NTP servers, run command syscli --list ntpserver
‑‑date	Date specified in 8 digit format: yyyymmdd.
‑‑time	Time is specified as HH:MM:SS for 24-hour or HH:MM:SS am/pm for 12-hour.
‑‑timeformat	Timeformat to be set, either 12-hour or 24-hour format. Note: A reboot is NOT required for this option.
‑‑timezoneid	Text of time zone to be set. For a list of time zones, run command syscli --list timezone.
‑‑sure	If specified, the command will execute immediately without asking for confirmation.
‑‑deferreboot	If specified, the reboot will be deferred until a time the user forces a reboot

List the public NTP server pools.

List information for all time zones.

Command Attributes

Review the following attribute descriptions.

‑‑list timezone	Lists information for time zones.
‑‑matching <pattern>	If specified, only times zones with file names that match the specified pattern display. The match is case insensitive. Example Patterns ‑‑matching pacific ‑‑matching bangkok

This command tests the specified NTP server.

Command Attributes

Review the following attribute descriptions.

‑‑test	Tests the saved NTPserver.
‑‑server	Name of NTP server or server pool to test. If not specified, the saved server or pool is tested.

Display the outgoing email server's Hostname or IP address, and its From email address.

Assign an email server to send all outgoing email to configured recipients.

Command Attributes

Review the following attribute descriptions.

‑‑set emailserver	Assigns the specified email server to send all outgoing email to configured recipients.
‑‑hostname <server_name_or_IP>	Enter the hostname or IP address of the email server to set as the outgoing email server. Note: Using uppercase letters in the hostname is acceptable but will not be preserved after entry. For that reason, Quantum recommends using lowercase letters in the Hostname or IP Address box.
‑‑emailaddr <from_email_address>	Enter the address to use as the server's From email address.

Delete the outgoing email server.

Specify the secure outgoing email server.

Note: Some outgoing email servers require the from email address to match the username.

Command Attributes

Review the following attribute descriptions.

‑‑set secureemailserver	Specifies the outgoing email server.
--enable off|on	Enables or disables the feature.
--server <server>	The address, either IP or FQDN, of the server.
--port <port>	The port number on the server's side.
--username <username>	Account username.
--password <password>	Account password.
--from <email_from>	The email address of the sender.

Display the secure outgoing email server configuration.

List email recipients who are configured to receive service tickets.

Add an email recipient to receive service tickets.

Command Attributes

Review the following attribute descriptions.

‑‑add emailrecipient	Adds an email recipient to receive service tickets.
‑‑name <recipient_name>	Enter the name of the email recipient.
‑‑emailaddr <recipient_email_address>	Enter the email address for the recipient.
‑‑type {high | highmed | all}	Enter the type of service ticket to send to the recipient: high – Only service tickets with a status of high are sent. highmed – Service tickets with the status of high and medium are sent. all – All service tickets are sent.
‑‑disable	If specified, the recipient's email notification is disabled.

Edit an existing service ticket recipient's email information.

Command Attributes

Review the following attribute descriptions.

‑‑edit emailrecipient	Edits an email recipient's information.
‑‑name <recipient_name>	Enter the name of the email recipient.
‑‑emailaddr <recipient_email_address>	Enter the email address for the recipient.
‑‑type {high | highmed | all}	Enter the type of service ticket to send to the recipient: high – Only service tickets with a status of high are sent. highmed – Service tickets with the status of high and medium are sent. all – All service tickets are sent.
‑‑disable	If specified, the recipient's email notification is disabled.

Delete the specified service ticket recipient from the email list.

Delete all service ticket recipients from the email list. If you specify the ‑‑sure option, the CLI deletes all recipients from the email list without asking for confirmation.

List recipients of emailed configuration and status reports. These recipients receive the reports (either config or status) when a scheduled email report event is executed.

Note: This command is used to output the schedule information, but this command feature has been deprecated. Instead use syscli ‑‑list events ‑‑type emailreports to see the schedule.

Command Attributes

Review the following attribute descriptions.

‑‑get emailhome

Lists the email recipients that will receive reports according to the scheduler.

Add recipients of emailed configuration and status reports. You can add up to four e-mail recipients.

Command Attributes

Review the following attribute descriptions.

‑‑add emailhome	Adds the specified recipients to the email list.
‑‑emailaddr <recipient_email_address>	Enter each recipient's email address. Precede each address by the ‑‑emailaddr attribute.

Delete the specified report recipient from the email list.

Delete all report recipients from the email list. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

Send the status report on demand to the specified recipient.

Send the configuration report on demand to the specified recipient.

List configured SNMP trap destinations.

Add an SNMP trap destination.

Command Attributes

Review the following attribute descriptions.

‑‑add snmptrapdest	Adds an SNMP trap destination to your system.
‑‑ipaddress <trap_dest_address>	Enter the IP address of the trap destination.
‑‑name <trap_dest_name>	Enter the name of the trap destination.
‑‑enable fail, warn, info, avail, unavail	If specified, indicates the types of traps to send to the destination.

Edit an SNMP trap destination.

Command Attributes

Review the following attribute descriptions.

‑‑edit snmptrapdest	Adds an SNMP trap destination to your system.
‑‑ipaddress <trap_dest_address>	Enter the IP address of the trap destination.
‑‑name <trap_dest_name>	Enter the name of the trap destination.
‑‑enable fail, warn, info, avail, unavail	If specified, indicates the types of traps to send to the destination.

Delete the specified SNMP trap destination.

Delete all SNMP trap destinations. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

List the SNMP communities configured on the system.

Add an SNMP community to the system.

Command Attibutes

Review the following attribute descriptions.

‑‑add snmpcom	Adds an SNMP community to the system.
‑‑name <community_name>	Enter the name of the SNMP community.
‑‑ipaddress <community_IP_address>	Enter the IP address of the SNMP community.
‑‑netmask <community_net_mask>	Enter the network mask of the SNMP community.
‑‑accesstype {get | getset}	Enter one of the following access types for the community: get – Allows SNMP get operations. getset – Allows SNMP get and put operations.
‑‑disable	If specified, disables the community.

Edit an SNMP community on the system.

Command Attibutes

Review the following attribute descriptions.

‑‑edit snmpcom	Edit the specified SNMP community on the system.
‑‑name <community_name>	Enter the name of the SNMP community.
‑‑ipaddress <community_IP_address>	Enter the IP address of the SNMP community.
‑‑netmask <community_net_mask>	Enter the network mask of the SNMP community.
‑‑accesstype {get | getset}	Enter one of the following access types for the community: get – Allows SNMP get operations. getset – Allows SNMP get and put operations.
‑‑disable	If specified, disables the community.

Delete the specified SNMP community.

Delete all SNMP communities from the system. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

Verify your system's email configuration by sending a test email to the specified recipient.

Verify your system's SNMP configuration by sending test traps to one or more specified destinations.

This command allows the administrator to enable or disable SSL/TLS for the web interface to the system.

WARNING: The factory-installed certificate files should be considered public domain and will not provide the best security. You should install new certificates to improve security. Use the Management Console: Configuration->System->Security->SSL/TLS to install the certificate files. See Install HTTPS Certificate to install the certificate and private key files.

Command Attributes

Review the following attribute descriptions.

‑‑set tls	Allows the administrator to enable or disable TLS/SSL.
‑‑enabled	Enable TLS/SSL.
‑‑disabled	Disable TLS/SSL.
‑‑sure	If specified, the command will execute immediately without asking for confirmation.

Check whether the system is capable of HD security.

Query the system's HD security status.

Enable the system's HD security, as well as optionally email the HD security keys file to one or more recipients.

Note: Before enabling HD security, make sure the DXi system supports this type of security. See Encryption CLI Commands.

Caution: After you enable Data-at-Rest Encryption, you cannot disable it or turn it off. Make sure to back up your passphrase and security files, as they may be required for future capacity expansion or rare hardware failure scenarios.

Command Attributes

Review the following attribute descriptions.

‑‑enable hdsecurity	Enables the system's HD security.
‑‑passphrase <passphrase>	Enter the passphrase needed to enable HD security. Passphrase minimum requirements Minimum of 8 characters Not more than 32 characters At least 1 upper case character At least 1 lower case character At least 1 numerical character At least 1 non-alphanumerical character, excluding space, tab, single quote, double quote, or dollar sign.
‑‑emailaddr <recipient_email_address	Enter the email address of the recipient receiving the HD security keys file. To email to more than one recipients, precede each recipient's email address by the ‑‑emailaddr option. Example ‑‑emailaddr a@xxx.com ‑‑emailaddr b@yyy.com
‑‑zippassword <zippassword>	Enter the password needed to zip or unzip the HD security keys file.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

This command allows the administrator to install new TLS files for HTTPS encryption. The server certificate and private key files must be in PEM format and saved in /data/upload/.

Command Attributes

Review the following attribute descriptions.

‑‑install httpscertificate	Installs the user-provided TLS certificate.
‑‑certificate	The filename of the certificate previously saved to /data/upload/
‑‑privatekey	The filename of the server private key previously saved to /data/upload/
‑‑activationphrase	The passphrase to activate the certificate.

DEPRECATED

List the following:

• System's serial number
• Each storage array's name
• Whether the premium feature key is installed for each array
• Each array's serial number
• Each array's feature activation code

Send the HD security keys file to one or more recipients.

Command Attibutes

Review the following attribute descriptions.

‑‑send hdsecuritykey	Sends the HD security key files to the specified recipient(s).
‑‑zippassword <password>	Enter the password needed to zip or unzip the HD security keys file.
‑‑emailaddr <recipient_email_address>	Enter the email address of the recipient receiving the HD security keys file. To email to more than one recipients, precede each recipient's email address by the ‑‑emailaddr option. Example ‑‑emailaddr a@xxx.com ‑‑emailaddr b@yyy.com

Downloads the HD security keys file to the current directory.

Command Attibutes

Review the following attribute descriptions.

‑‑download hdsecuritykeysfile	Downloads the HD security keys file to the current directory.
‑‑zippassword <password>	Enter the password needed to zip or unzip the HD security keys file.

List the following:

• System's serial number
• Each storage array's name
• Whether turbo and encryption premium feature key is installed for each storage array.
• Each storage array's serial number

Each storage array's feature activation code (ID).

Enable or disable a specified Health Check.

Command Attributes

Review the following attribute descriptions.

‑‑edit healthcheck	Enables or disables the specified Health Check.
‑‑name <healthcheck_name>	Enter the name of the Health Check to enable or disable. This value can be retrieved from the --list healthcheckstatus CLI.
‑‑enable	Enter to enable the Health Check.
‑‑disable	Enter to disable the Health Check.

Start a Health Check on the system if it is not currently running.

Stop a running Health Check.

List the Health Check status of the system.

List the general status of system Health Checks.

Admin users can add and configure the specified network device with the specified device name, IP address and netmask. The system should be rebooted after all network configuration deletions and additions are made.

The system can be rebooted using the syscli --nodemanage --reboot command.

Command Attributes

Review the following attribute descriptions.

‑‑add netcfg	Adds and configures a network device.
‑‑devname <DEVNAME>	Enter the name of the device to add. Note: Entering the name of a previously configured device will override the previous network configuration values. General Device Name Format The general format is <port>[.<vlanid>][:<vifno>] where: port – port name is an alphanumeric string (for example, em1, p2p1, etc.) vlanid – VLAN ID is an optional field and can range from 2 to 4094. vifno – virtual interface number, which is used to distinguish each set of network layer (L3) values (IP address and netmask values). It can range from 1 to possibly 99, depending on actual systems. When the bridge option is specified, the vifno must not be specified. Note: Virtual interface numbers are used to configure multiple IP addresses for an interface. Device Name Examples em1:1 or bond0:2
‑‑dhcp	If specified, use DHCP for network device configuration. Ipaddr, netmask, and gateway are automatically assigned by the DHCP server.
‑‑ipaddr <IPADDR>	IP address in decimal dotted notation (for example, 10.20.30.156).
‑‑netmask <NETMASK>	Netmask in decimal dotted notation (for example, 255.255.255.0).
‑‑gateway <GATEWAY>	IP address of the gateway. Note: If the port is directly connected to another port, or if the port is not connected to a router, then the gateway IP address should be the same as the device IP address.
‑‑slaves <DEV1>,<DEV2>	If --slaves is specified, specify two or more slave device names, separated by commas. Note: You must enter slave devices when creating a bond.
‑‑mode RR|AB|LACP	Enter a mode, as needed. Currently Round Robin (mode 0), Active Backup (mode 1), and Link Aggregation Control Protocol (LACP) mode 4 are supported. Note: You must enter a mode when creating a bond.
‑‑mtu <SIZE>	MTU size in bytes. Range is any value between 68 and 9192, inclusive. Note: If you do not specify this option, the STD frame size (1500) is used.
‑‑defaultgw YES	Uses the entered <GATEWAY> value as the default gateway. Note: The default for this option is NO.
‑‑segments REP,MGMT,DATA	Specify this option to allow only the specified traffic types on this interface. Note: If you are configuring a replication segment for a device interface along with other segments on the same subnet, make sure to add a route that exclusively reserves the replication segment for replication between a source and a target DXi.
‑‑nat <NAT_IPADDR>	Enter the network address translation (NAT) IP address specified on the target DXi if the source DXi needs to use this NAT IP address for replication.
‑‑hosts <IP1,IP2,IP3>	Only allow communication with these hosts via the specified gateway.
‑‑extHostIp YES	Specify this option to use the host IP address from ‑‑hosts <IP1,IP2,IP3> as the default external host IP adress. Note: The default for this option is NO.
‑‑bridge	If specified, will create a network bridge. Only valid if creating a bond with two ports.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

Edit the specified network device.

Command Attributes

Review the following attribute descriptions.

‑‑edit netcfg	Edits settings for the specified network device.
‑‑devname <DEVNAME>	Enter the name of the device to edit. Note: Entering the name of a previously configured device will override the previous network configuration values. General Device Name Format The following is the general device name format: <label><devno>[<vlanid>]:[<vinfo>] label – The device label, which is an alphanumeric string, such as bond or eth. devno – The device number, which can range from 1 to 99. vlanid – The VLAN ID can range from 2 to 4094. vinfo – The VIF number, which is used to distinguish each set of network layer (L3) values, such as the IP address from the netmask values. This number can range from 1 to 99.
‑‑mtu <1500|9000>	Enter one of the following: ‑‑mtu 1500 – Set MTU size to the standard (STD) frame size of 1500 bytes. ‑‑mtu 9000 – Set MTU size to allow up to the max JUMBO frame size of 9000 bytes. Note: If you do not specify this option, the STD frame size (1500) is used.
‑‑mode RR|AB|LACP	Enter a mode, as needed. Currently RR (mode 0), AB (mode 1), and LACP (mode 4) are supported. Note: You must enter a mode when creating a bond.
‑‑slaves <DEV1>,<DEV2>	Enter names for slave devices, as needed. If you enter multiple slave devices, separate the devices with a comma. Note: You must enter slave devices when creating a bond.
‑‑nat <NAT_IPADDR>	Enter the NAT IP address specified on the target DXi if the the source DXi needs it for replication.
‑‑extHostIp YES|NO	Specify this option to use the host IP address from ‑‑hosts <IP1,IP2,IP3> as the default external host IP adress. The default for this option is NO.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

Delete the specified network device and its IP address information. Any slaves associated with the network device are also deleted.

Command Attributes

Review the following attribute descriptions.

‑‑del netcfg	Deletes the specified network device and its IP information.
‑‑devname <DEVNAME>	Enter the name of the device to delete. General Device Name Format The following is the general device name format: <label><devno>[<vlanid>]:[<vinfo>] label – The device label, which is an alphanumeric string, such as bond or eth. devno – The device number, which can range from 1 to 99. vlanid – The VLAN ID can range from 2 to 4094. vinfo – The VIF number, which is used to distinguish each set of network layer (L3) values, such as the IP address from the netmask values. This number can range from 1 to 99. Note: If you specify a device using only its device number, the system will also delete all of its associated IP information that was added when using the virtual interface number.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

Display the IP address and routing information for a specified network device. If you do not specify a network device, information for all network devices is displayed.

Note: This command displays the network settings that are currently in effect. If you have made changes to the custom network configuration since rebooting the DXi, they will not take effect until after the next reboot.

Command Attributes

Review the following attribute descriptions.

‑‑show netcfg

Displays network device information.

‑‑devname <DEVNAME>

Enter the name of a network device for which to display information. If you do not specify a device, information for all network devices is displayed. General Device Name Format The following is the general device name format: <label><devno>[<vlanid>]:[<vinfo>] label – The device label, which is an alphanumeric string, such as bond or eth. devno – The device number, which can range from 1 to 99. vlanid – The VLAN ID can range from 2 to 4094. vinfo – The VIF number, which is used to distinguish each set of network layer (L3) values, such as the IP address from the netmask values. This number can range from 1 to 99.

Back up the current custom network configuration.

Restore the previously backed-up custom network configuration. If you specify the --sure option, the CLI executes the command without prompting for confirmation.

Display the system network configuration.

This command allows the user to list runtime port states.

Command Attributes

Review the following attribute descriptions.

‑‑list

Lists runtime port states.

This command allows an admin user to manage network settings.

Command Attributes

Review the following attribute descriptions.

‑‑set	Sets the system network parameters for this system.
‑‑hostname	Sets the system's host name. Note: Using uppercase letters in the hostname is acceptable but will not be preserved after entry. For that reason, Quantum recommends using lowercase letters in the Hostname or IP Address box.
‑‑domain	Sets the Domain Suffix Search List (see above for details). Note: A reboot is NOT required for this change to take effect.
‑‑dns	Sets the DNS IP address list: Specify up to 3 comma-separated IP addresses of domain name servers. Note: A reboot is NOT required for this change to take effect.
‑‑defaultgateway	Sets the system's default gateway. Specify an IP address.
‑‑sure	If specified, the command will execute without asking for confirmation.

List available and configured network interfaces.

Note: The Boot Protocol value is dhcp if it was specified. Otherwise the value is static or none.

Command Attributes

Review the following attribute descriptions.

‑‑list interface	Lists available and configured network interfaces.
‑‑xml [<filename>]	Enter to list XML output to the screen or to write XML output to the specified file.
‑‑type [configured|runtime]	Enter to display the interface's configured OR runtime values. If you do not specify a value, the configured values are displayed.

Allows an admin user to enable or disable the Internet verification check. This check allows the system to verify whether it has access to the Internet.

Command Attributes

Review the following attribute descriptions.

‑‑set verifyinternet	Enable or disable Internet verification checks.
‑‑enable	If specified, the feature will be enabled or disabled.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

Returns the current setting of the Internet verification check. This check allows the system to verify whether it has access to the internet.

Command Attributes

Review the following attribute descriptions.

‑‑get verifyinternet

Return the current verify Internet setting.

Add throttling to the source system for the specified network services.

Command Attributes

Review the following attribute descriptions.

‑‑add throttle	Adds throttling to the source system.
‑‑service REP	Enter a service for which to enable throttling. The default service is replication.
‑‑bw <bandwidth><K|M>	Enter the amount of bandwidth to throttle. You can specify the following amounts: Between 32 KB/s and 125 MB/s for 1 GbE systems Between 32 KB/s and 500 MB/s for 10 GbE systems (Bandwidth range to come) for 25 GbE systems. Examples Enter the following for 500 KB/s: ‑‑bw 500K Enter the following for 100 MB/s: ‑‑bw 100M

Delete throttling from the source system for the specified network services.

Command Attributes

Review the following attribute descriptions.

‑‑del throttle	Deletes throttling from the source system.
‑‑service REP	Enter a service for which to disable throttling. The default service is replication.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

This command shows the throttling state for the system. It also lists the services and bandwidth that are throttled for the system.

Add a static route to the system using the specified network IP address, netmask, and gateway.

Note: If you are configuring a replication segment for a device interface along with other segments on the same subnet, make sure to add a route that exclusively reserves the replication segment for replication between a source and a target DXi.

Command Attributes

Review the following attribute descriptions.

‑‑add route	Adds a static route to the system or specified network device.
‑‑devname <DEVNAME>	Enter the name of a network device to add the static route to the device. General Device Name Format The following is the general device name format: <label><devno>[<vlanid>]:[<vinfo>] label – The device label, which is an alphanumeric string, such as bond or eth. devno – The device number, which can range from 1 to 99. vlanid – The VLAN ID can range from 2 to 4094. vinfo – The virtual interface (VIF) number, which is used to distinguish each set of network layer (L3) values, such as the IP address from the netmask values. This number can range from 1 to 99.
‑‑network <IPADDR>	Enter the IP address for the network.
‑‑netmask <NETMASK>	Enter the netmask for the network.
‑‑gateway <GATEWAY>	Enter the IP address for the gateway.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

Delete a static route from the system.

Command Attributes

Review the following attribute descriptions.

‑‑del route	Deletes the static route from the system or specified network device.
‑‑devname <DEVNAME>	Enter the name of the device from which to delete the static route. General Device Name Format The following is the general device name format: <label><devno>[<vlanid>]:[<vinfo>] label – The device label, which is an alphanumeric string, such as bond or eth. devno – The device number, which can range from 1 to 99. vlanid – The VLAN ID can range from 2 to 4094. vinfo – The VIF number, which is used to distinguish each set of network layer (L3) values, such as the IP address from the netmask values. This number can range from 1 to 99. Note: If you specify a device using only its device number, the system will also delete all of its associated IP information that was added when using the virtual interface number.
‑‑network <IPADDR>	Enter the IP address for the network.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

Display the static routes set up for the system.

This command executes the system traceroute command and displays the output.

Command Attributes

Review the following attribute descriptions.

‑‑system traceroute	Executes system traceroute command and displays the output.
‑‑host	Host name or IP to trace to.
‑‑options	Comma-separated list of options passed to the traceroute command.

This command allows admin users to enable or disable the system firewall.

Note: When using segmented networking, the firewall is always enabled.

Command Attributes

Review the following attribute descriptions.

--set firewallenabled	Enable or disable the system firewall.
‑‑enable	Enable or disable the system firewall feature.
‑‑sure	If specified, the CLI executes the command without prompting for confirmation.

Display the system firewall state.

Display the list of active system firewall ports.

Display the list of rules for each active system firewall port.

In this example, the bonded interfaces on the DXi are connected to two different subnets. You can configure two different default gateways for the subnet.

Configure a similar setup

1. Display the existing configuration:

   syscli ‑‑list interface

2. Delete the default bond configuration with all customer ports connected together:

   syscli ‑‑del netcfg ‑‑devname bond0

3. Configure Bond 0 for the first subnet, and configure Gateway 1, as needed:

   syscli ‑‑add netcfg ‑‑devname bond0:1 ‑‑slaves eth0, eth1 ‑‑segments DATA,REP ‑‑ipaddr IPADDR1 ‑‑netmask NETMASK1 ‑‑gateway GATEWAY1

4. Configure Bond 1 for the other subnet, and configure Gateway 2, as needed.

   syscli ‑‑add netcfg ‑‑devname bond1:1 ‑‑slaves eth2, eth3 ‑‑ipaddr IPADDR2 ‑‑netmask NETMASK2 ‑‑gateway GATEWAY2 ‑‑segments DATA,MGMT

In this example, there are only two independent customer ports that are configured. These independent customer ports need to be connected to two independent non-aggregated ports on the switch. You can configure the IP subnet dependent gateways.

Configure a similar setup

1. Display the existing configuration:

   syscli ‑‑list interface

2. Delete the default bond configuration with all customer ports connected together:

   syscli ‑‑del netcfg ‑‑devname bond0

3. Configure Eth0 for IP Address 1 and the replication source, and configure Gateway 1, as needed:

   syscli ‑‑add netcfg ‑‑devname eth0:1 ‑‑segments DATA,REP ‑‑ipaddr IPADDR1 ‑‑netmask NETMASK1 ‑‑gateway GATEWAY1

4. Configure Eth0 for the other subnet, and configure Gateway 2, as needed:

   syscli ‑‑add netcfg ‑‑devname eth0:2 ‑‑ipaddr IPADDR2 ‑‑netmask NETMASK2 ‑‑gateway GATEWAY2 ‑‑segments DATA,MGMT

In this example, there are three bonds, and each bond has two ports. Ensure the switch ports are appropriately aggregated and the gateways, if applicable, are configured.

Configure a similar setup

1. Display the existing configuration:

   syscli ‑‑list interface

2. Delete the default bond configuration with all customer ports connected together:

   syscli ‑‑del netcfg ‑‑devname bond0

3. Configure Bond 0 for IP Address 1 and the replication source, and configure Gateway 1, as needed:

   syscli ‑‑add netcfg ‑‑devname bond0:1 ‑‑slaves eth0, eth1 ‑‑segments REP ‑‑ipaddr IPADDR1 ‑‑netmask NETMASK1 ‑‑gateway GATEWAY1

4. Configure Bond 1 for IP Address 2, and configure Gateway 2, as needed:

   syscli ‑‑add netcfg ‑‑devname bond1:1 ‑‑slaves eth2, eth3 ‑‑ipaddr IPADDR2 ‑‑netmask NETMASK2 ‑‑gateway GATEWAY2 ‑‑segments DATA

5. Configure Bond 2 for IP Address 3, and configure Gateway 3, as needed:

   syscli ‑‑add netcfg ‑‑devname bond2:1 ‑‑slaves eth4, eth5 ‑‑ipaddr IPADDR3 ‑‑netmask NETMASK3 ‑‑gateway GATEWAY3 ‑‑segments MGMT

In this example, the two independent interfaces need to be connected to a non-aggregated port on a switch. The bonded ports are connected to appropriately link the aggregated switch ports.

Configure a similar setup

1. Display the existing configuration:

   syscli ‑‑list interface

2. Delete the default bond configuration with all customer ports connected together:

   syscli ‑‑del netcfg ‑‑devname bond0

3. Configure Bond 0 for IP Address 1 and the replication source, and configure Gateway 1, as needed:

   syscli ‑‑add netcfg ‑‑devname bond0:1 ‑‑slaves eth1, eth2, eth3, eth4 ‑‑ipaddr IPADDR1 ‑‑netmask NETMASK1 ‑‑gateway GATEWAY1 ‑‑segments REP

4. Configure Eth0 for IP Address 2, and configure Gateway 2, as needed:

   syscli ‑‑add netcfg ‑‑devname eth0:1 ‑‑ipaddr IPADDR2 ‑‑netmask NETMASK2 ‑‑gateway GATEWAY2 ‑‑segments REP

5. Configure Eth5 for IP Address 3, and configure Gateway 3, as needed:

   syscli ‑‑add netcfg ‑‑devname eth5:1 ‑‑ipaddr IPADDR3 ‑‑netmask NETMASK3 ‑‑gateway GATEWAY3 ‑‑segments MGMT

Tip

If you are configuring a replication segment for a device interface along with other segments on the same subnet, make sure to add a route that exclusively reserves the replication segment for replication between a source and a target DXi, as shown in the following examples:

syscli ‑‑add netcfg ‑‑devname eth1:1 ‑‑ipaddr IPADDR1 ‑‑netmask NETMASK1 ‑‑gateway GATEWAY1 ‑‑segments DATA,MGMT

syscli ‑‑add netcfg ‑‑devname eth2:1 ‑‑ipaddr IPADDR2 ‑‑netmask NETMASK1 ‑‑ gateway GATEWAY1 ‑‑segments REP

syscli ‑‑add route ‑‑devname eth2:1 ‑‑network DEST_IP_ADDRESS ‑‑netmask 255.255.255.255 ‑‑gateway IPADDR2

In this example, data traffic comes from two media servers going thru GbE port 1 and the two 10 GbE ports. Replication and management traffic are routed to GbE port 0.

Configure a similar setup

1. Display the existing configuration:

   syscli ‑‑list interface

2. Delete the default bond configuration with all customer ports connected together:

   syscli ‑‑del netcfg ‑‑devname bond0

3. Configure Eth0 for IP Address 1, and configure Gateway 1, as needed:

   syscli ‑‑add netcfg ‑‑devname eth0:1 ‑‑ipaddr IPADDR1 ‑‑netmask NETMASK1 ‑‑gateway GATEWAY1

4. Configure Eth1 for IP Address 2, and configure Gateway 2, as needed:

   syscli ‑‑add netcfg ‑‑devname eth1:1 ‑‑ipaddr IPADDR2 ‑‑netmask NETMASK2 ‑‑gateway GATEWAY2

This example demonstrates how to delete a bond that has eth0 and eth1 as slaves and set them up as independent interfaces.

1. Display the output of the current runtime network values.

   Runtime values are values currently being used by the network service. You must first configure values using ‑‑add netcfg and ‑‑del netcfg. In order for these values to become runtime values, you must reboot the system to restart the network service. Use the syscli ‑‑nodemanage ‑‑reboot command to reboot the system.

   [root@rok-dxi92 DXi]# syscli ‑‑show netcfg

   bond0 Link encap:Ethernet HWaddr 00:50:56:AB:00:48

   UP BROADCAST RUNNING MASTER MULTICAST MTU:1500 Metric:1

   RX packets:557471 errors:155 dropped:0 overruns:0 frame:0

   TX packets:48114 errors:0 dropped:0 overruns:0 carrier:0

   collisions:0 txqueuelen:0

   RX bytes:48747984 (46.4 MiB) TX bytes:6195223 (5.9 MiB)

   bond0:2 Link encap:Ethernet HWaddr 00:50:56:AB:00:48

   inet addr:10.20.185.92 Bcast:10.20.191.255

   Mask:255.255.248.0

   UP BROADCAST RUNNING MASTER MULTICAST MTU:1500 Metric:1

   eth0 Link encap:Ethernet HWaddr 00:50:56:AB:00:48

   UP BROADCAST RUNNING SLAVE MULTICAST MTU:1500 Metric:1

   RX packets:278735 errors:5 dropped:0 overruns:0 frame:0

   TX packets:24057 errors:0 dropped:0 overruns:0 carrier:0

   collisions:0 txqueuelen:1000

   RX bytes:24372519 (23.2 MiB) TX bytes:3113468 (2.9 MiB)

   Interrupt:51 Base address:0x2080

   eth1 Link encap:Ethernet HWaddr 00:50:56:AB:00:48

   UP BROADCAST RUNNING SLAVE MULTICAST MTU:1500 Metric:1

   RX packets:278736 errors:150 dropped:0 overruns:0 frame:0

   TX packets:24057 errors:0 dropped:0 overruns:0 carrier:0

   collisions:0 txqueuelen:1000

   RX bytes:24375465 (23.2 MiB) TX bytes:3081755 (2.9 MiB)

   Interrupt:67 Base address:0x20c0

   lo Link encap:Local Loopback

   inet addr:127.0.0.1 Mask:255.0.0.0

   UP LOOPBACK RUNNING MTU:16436 Metric:1

   RX packets:5872300 errors:0 dropped:0 overruns:0 frame:0

   TX packets:5872300 errors:0 dropped:0 overruns:0 carrier:0

   collisions:0 txqueuelen:0

   RX bytes:564058955 (537.9 MiB) TX bytes:564058955 (537.9 MiB)

   10.20.184.0/21 dev bond0 proto kernel scope link src 10.20.185.92

   default via 10.20.184.1 dev bond0 src 10.20.185.92

   0:     from all lookup 255

   32766: from all lookup main

   32767: from all lookup default

   WARNING: No Replication IP configured

   Command completed successfully.

   Note: If WARNING: No Replication IP configured in the CLI, an interface was not configured specifically for replication. Configure the interface for replication using the ‑‑policy REP option in the ‑‑add netcfg command.

2. Delete Bond 0.

   [root@rok-dxi92 DXi]# syscli ‑‑del netcfg ‑‑devname bond0

   You have specified the following data for command "DelNetcfg":

   ‑‑devname = bond0

   Are you sure you want to proceed? [yes|no] > yes

   Command completed successfully.

   Note: This command does not effect runtime values.

3. Add the Eth0 and Eth1 interfaces.

   [root@rok-dxi92 DXi]# syscli ‑‑add netcfg ‑‑devname eth0:1 ‑‑ipaddr 10.20.185.92 ‑‑netmask 255.255.248.0 ‑‑gateway 10.20.184.1

   You have specified the following data for command "AddNetcfg":

   ‑‑devname = eth0

   ‑‑ipaddr = 10.20.185.92

   ‑‑netmask = 255.255.248.0

   ‑‑gateway = 10.20.184.1

   Are you sure you want to proceed? [yes|no] > yes

   Command completed successfully.

   [root@rok-dxi92 DXi]# syscli ‑‑add netcfg ‑‑devname eth1:1 ‑‑ipaddr 10.20.185.117 ‑‑netmask 255.255.248.0 ‑‑gateway 10.20.184.1

   You have specified the following data for command "AddNetcfg":

   ‑‑devname = eth1

   ‑‑ipaddr = 10.20.185.117

   ‑‑netmask = 255.255.248.0

   ‑‑gateway = 10.20.184.1

   Are you sure you want to proceed? [yes|no] > yes

   Command completed successfully.

4. Reboot the system.

   [root@rok-dxi92 DXi]# syscli ‑‑nodemanage ‑‑reboot

   You have specified the following data for command "Nodemanage":

   ‑‑reboot

   Are you sure you want to proceed? [yes|no] > yes

   Broadcast message from root (pts/1) (Wed Jun 8 09:51:50 2011):

   The system is going down for reboot NOW!

   Command completed successfully.

5. After the system comes back up, display the runtime network values.

   These vlaues should now reflect the configured network values, with Eth0 and Eth1 as independent interfaces.

   [root@rok-dxi92 DXi]# syscli ‑‑show netcfg

   eth0  Link encap:Ethernet HWaddr 00:50:56:AB:00:48

   inet addr:10.20.185.92 Bcast:10.20.191.255

   Mask:255.255.248.0

   UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1

   RX packets:373 errors:0 dropped:0 overruns:0 frame:0

   TX packets:80 errors:0 dropped:0 overruns:0 carrier:0

   collisions:0 txqueuelen:1000

   RX bytes:32420 (31.6 KiB) TX bytes:9160 (8.9 KiB)

   Interrupt:51 Base address:0x2080

   eth1  Link encap:Ethernet HWaddr 00:50:56:AB:00:56

   inet addr:10.20.185.117 Bcast:10.20.191.255

   Mask:255.255.248.0

   UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1

   RX packets:260 errors:0 dropped:0 overruns:0 frame:0

   TX packets:4 errors:0 dropped:0 overruns:0 carrier:0

   collisions:0 txqueuelen:1000

   RX bytes:21262 (20.7 KiB) TX bytes:168 (168.0 b)

   Interrupt:67 Base address:0x20c0

   lo    Link encap:Local Loopback

   inet addr:127.0.0.1 Mask:255.0.0.0

   UP LOOPBACK RUNNING MTU:16436 Metric:1

   RX packets:2000 errors:0 dropped:0 overruns:0 frame:0

   TX packets:2000 errors:0 dropped:0 overruns:0 carrier:0

   collisions:0 txqueuelen:0

   RX bytes:177098 (172.9 KiB) TX bytes:177098 (172.9 KiB)

   10.20.184.0/21 dev eth0 proto kernel scope link src 10.20.185.92

   10.20.184.0/21 dev eth1 proto kernel scope link src 10.20.185.117

   169.254.0.0/16 dev eth1 scope link

   default via 10.20.184.1 dev eth0

   0:     from all lookup 255

   32764: from 10.20.185.117 lookup eth1

   32765: from 10.20.185.92 lookup eth0

   32766: from all lookup main

   32767: from all lookup default

   WARNING: No Replication IP configured

   Command completed successfully.

6. Create a bond using Eth0 and Eth1 as slaves.

   [root@rok-dxi92 DXi]# syscli ‑‑add netcfg ‑‑devname bond0:1 ‑‑ipaddr 10.20.185.92 ‑‑netmask 255.255.252.0 ‑‑gateway 10.20.184.1 ‑‑slaves eth0,eth1 ‑‑mode RR

   You have specified the following data for command "AddNetcfg":

   ‑‑devname = bond0

   ‑‑ipaddr = 10.20.185.92

   ‑‑netmask = 255.255.252.0

   ‑‑gateway = 10.20.184.1

   ‑‑slaves = eth0,eth1

   ‑‑mode = RR

   Are you sure you want to proceed? [yes|no] > yes

   Command completed successfully.