Page 3
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 NAS Configuration CLI Commands Listing the Existing NAS Share and Attributes ......22 Listing of Existing NAS Share Names .
Page 4
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Disabling NAS Share Replication Options on the Source ....46 Checking Readiness on Source ........47 Aborting Replication of VTL or NAS.
Page 5
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Editing OST Target Mappings ........57 Deleting an OST Target Mapping .
Page 6
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Other System Configuration CLI Commands E-Mail Recipient CLI Commands ........77 Outgoing E-mail Server CLI Commands.
Page 7
Getting the Summary of the Secure File Shred Progress ....99 Quantum Repository Package Commands......99 Network CLI Commands Adding Network Configurations .
Page 8
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Listing Fibre Channel Ports ........122 Setting the Fiber Channel Port Type .
Page 9
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Health Check CLI Commands Starting a Health Check......... 128 Stopping a Health Check.
Page 10
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Contents...
Page 11
The Command Line Interface (CLI) for DXi™-Series systems serves as a command line equivalent of the remote management functionality. This guide describes the CLI commands for DXi 2.3 Software, which is available for the following systems: • DXi V-Series (DXi V1000 virtual appliance) • DXi4000 Family • DXi6000 Family • DXi8500 Not all CLI commands are available for all DXi-Series systems, as noted below in the sections describing the CLI commands.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 (such as add, edit, or delete) that changes any information in the system, an error will be returned. Additional commands are available to the CLI admin user but not to the CLI viewer user.
Page 13
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 CLI Syntax Conventions The CLI program is named syscli. It is usually invoked with parameters necessary to carry out a predefined task. The first parameter is usually a verb indicating the action to be performed and hence is called a command.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • Curly braces “{ }” in the syntax are used to group options and/or values together for readability. These characters should not be used when entering the commands.
Page 15
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • Typing syscli help --<cmd> will show syntax for all commands named <cmd>. For example, syscli help --list shows all list commands, syscli help --add shows all --add commands.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 <options_filename> to read additional options, where each option (or each option=value pair if the option requires a value) is listed on a separate line. Blank lines or lines starting with “#” are ignored. For example, the command...
Page 17
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • The third password has five characters: a, \, !, b, and c. • The fourth password has five characters: ", a, b, c, and ". CLI Exit Code...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Note: It is strongly recommended that all CLI commands not be run in Web Services mode when both the server and the client are on the same system. It is much faster to run the commands directly without using Web Services.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 During the session: • Any CLI commands specified with the --ws option will be executed on the axis2 server. • Any CLI commands without the --ws option will be executed directly as usual (i.e, not via Web Services).
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Documentation of Web Because Web Services commands and regular CLI commands differ only in the Services Commands additional options --ws and --credtoken, there is no need to document WS commands separately.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Listing Existing VTL and syscli --list vtl [--name <VTL_name>]] Its Attributes This CLI command allows the CLI admin to display a list of all existing VTLs on the system and their attributes when no partition name is specified. If a VTL name is specified, only that VTL is listed with its attributes.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 productid = Scalar i2000 description = ADIC Scalar i2000 Listing of Supported syscli --list drive Tape Drive This CLI command allows the CLI admin to display a list of the available virtual tape drive models. A specific virtual tape drive model is required when adding or creating a new partition.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 The library model can be derived from the 'productid' value returned from the list of available library models. Caution: Do not use an underscore ( _ ) in the name of the VTL partition.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 capability = RW Creating Media syscli --add media --name <VTL_name> --type <media_type> --media <number_of_media> --barcodestart <starting_barcode> --location slot | ieslot [--capacity <media capacity>] This CLI command allows the CLI admin to create a media for a defined VTL.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 for each host. If the host alias was not added initially, the output will indicate that no alias was given. An example output of a host with no alias given is shown below.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Listing Devices syscli --list device --name <VTL_name> This CLI command allows the CLI admin to display a list of devices on the system. The list includes the type of device (VMC or VTD), serial number of the device and the virtual tape library name the device is in.
SAN. The CCL is accessible to hosts only through LUN 0. Caution: If you are not sure if you should use CCL, contact Quantum Customer Support before you enable this option.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Listing VTL Storage syscli --list vtlstorage --name <VTL_name> --loc source | dest [--type drive | Locations and Index slot | ieslot] This CLI command allows the CLI admin to list the source and destination storage locations.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • Listing of Existing NAS Share Names • Getting the Total NAS Share Count • Adding a NAS Share • Editing a NAS Share • Enabling Allowlinks on a NAS Share •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Listing of Existing NAS syscli --list sharename [--proto cifs|nfs] [--namematch <pattern>] Share Names This CLI lists all share names for both CIFS and NFS. If --proto is specified, only names of shares associated with the specified protocol will be listed.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Note: When files are replicated from a share with no_root_squash enabled to a target DXi where no_root_squash was not supported, then NFS hosts accessing the target DXi will have root access permissions mapped (squashed) to the anonymous user.
Page 35
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 This CLI command allows the admin user to modify one or more attributes of a NAS share such as description, permissions, hidden (CIFS only), etc. Although the syntax says all attributes are optional, at least one attribute must be specified.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • User can browse these files in browsers but cannot open, rename, move, copy, or delete. In this case, to access them via CIFS, their names have to be changed to lower case, but this task is impossible to do over CIFS.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 CLI command options: • --deleteall: Deletes all existing NAS shares. • * --proto: if specified, delete all shares of this type only. • * --namematch: if specified, only shares whose names match the specified pattern will be deleted.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --join: Joins CIFS server to a Windows Active Directory domain. If --password is specified and <admin_password> is not, or if --password is omitted, it will be prompted interactively and the password is not echoed on screen.
Page 39
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • Delete a Workgroup User • Delete All Workgroup Users List of Workgroup Users syscli --list user [--name <username> |--namematch <pattern>] This CLI command provides a list of workgroup users. If --name is specified, only those names that match the specified name are listed.
If the command is typed in a shell, the backslash has to be typed twice. For example, if the domain name is quantum.com and the user is joe, the command to be typed a the shell prompt reads as follows:...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Delete All Share Administrators syscli --deleteall shareadmin [--sure] This CLI command allows the admin user to remove the share admin rights from all domain users or groups that have previously been granted this privilege (that is, share administrators) except the built-in domain admins group.
Page 42
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 An example output of share users when the system is joined to a workgroup is shown below. Total count = 1 [User = 1] Username = userone Access Rights = rw Adding a Share User syscli --add shareuser --share <CIFS_share_name> --user <username>...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 This command works only when the server is joined to a workgroup. If the server is joined to an Active Directory domain, please use the Microsoft Management Console (MMC) tool. If the --sure option is specified, no confirmation prompt will be displayed.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Deleting All Share Hosts syscli --deleteall sharehost --share <NFS_share_name> [--sure] This CLI command allows the admin user to remove the right to access the specified NFS share from all NFS hosts. As a result, the share access list of the specified share is empty, which means the share now allows read-write access to all NFS hosts (see command --add sharehost).
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Query NFS Service Status syscli --getstatus nfs This CLI command allows the admin user to display the status of the NFS service. An example output of this command: NFS status = running...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 This CLI command enables or disables LDAP client signing. This setting must be enabled if and only if the LDAP server signing is enabled on the ADS server. Otherwise, it must be disabled. For more information on how to enable LDAP server signing on the ADS server, see Microsoft documentation at: http://support.microsoft.com/kb/935834...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 system fails before all the data gets written to disk. The user can set up this property for one NFS share at a time or all NFS shares at the same time. By default, NFS shares are created to commit data synchronously until changed by this command.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • Disabling NAS Share Replication Options on the Source • Checking Readiness on Source • Aborting Replication of VTL or NAS • Aborting Synchronization of VTL or NAS •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • Listing Unpack Queue Items • Getting the Status of the Active Synchronization Requests • Listing the File/Directory-Based Replication Status and Statistics • Listing Shares Eligible to Receive Directory/File Based Data •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 CLI command options: • --replicate: Initiates replication for a specified NAS share. • --name: Must be a valid NAS share name for the system. • --target: Target host name or IP of the replication job. If the system or the share/partition has two targets configured, you must use the --target option and you must specify a target IP or hostname.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Initiating Source to syscli --sync vtl --name <VTL_name> [--target <host_name_or_ip>] Target Cartridge or File This CLI command allows the CLI admin to initiate source to target cartridge Synchronization synchronization for a specified VTL that has cartridge based replication enabled.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Adding a Source on a syscli --add sourcerep --hostid <host_id> Target This CLI command allows the admin user to add or specify the replication source IP or hostname of a source DXi system for this system as a target.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Adding a Target on a syscli --add targetrep --hostid <host_id> [--encrypt [--encrypttype Source 128|256]] --sourceip <source_ip> This CLI command allows the admin user to add or specify the replication target IP or hostname of a DXi system for this system as a source.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --name: Must be a valid NAS share name for the system. To see a list of available NAS shares on the system, use syscli --list share. • --target: The host name or IP address of the replication target.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --name: Must be a valid partition name for the system. To see a list of available partitions on the system, use syscli --list vtl. • --target: The host name or IP address of the replication target to be removed.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Note: This command disables replication for all targets configured for the VTL. You cannot enable replication for a single target. Instead, run the following command to allow or disallow replication to a particular target: syscli --add/del <vtltarget>...
Page 57
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Note: Before editing replication settings (using --enablerep nas, --disablerep nas), first disable File/Directory Based replication (using --disable filedirrep), then add and remove targets (using --add nastarget or -- del nastarget).
Page 58
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Resuming the syscli --resume replication [--target <host_name_or_ip>] Replication Service on The CLI allows the admin user to resume all or a specified active replication the Source target(s). CLI command options: •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 VTL name = test1 replication state = Enabled replication sync id = last replication start = Thu Mar 5 11:02:03 2009 last replication completion = Thu Mar 5 11:02:07 2009 last replication status = Success last synchronization start = last synchronization completion = last synchronization status = Listing Deduplicated syscli --list dedupnas [--name <sharename> |--namematch <pattern>] NAS on the Source This CLI command returns the list of deduped NAS shares on the source.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Replication Finished = Thu Mar 5 13:08:59 2009 Replication Status = Success Listing a Replicated syscli --list repnas NAS Share on the This CLI command allows the admin user to display a list of all the replicated Target NAS share(s) that have been performed on the target system.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 cartridges, you will only be able to select DLT-S4 tape drives when mapping devices to the recovered partition. Recovering a NAS Share syscli --recover nas --repname <replicated_NAS_share_name> --srchost on the Target <source_hostname_or_IP_address>...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Failback a NAS Share on syscli --failback repnas --repname <nas_share_name> --srchost the Target <source_host> --id <id> --tgthost <target_host> [--encrypt [-- encrypttype 128|256]] This CLI command allows the admin user to failback a replicated share to its specified source.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Listing the Replicated syscli --list vtlrecjob VTL Recovery Jobs on This CLI command allows the user to list the replicated VTL recovery jobs on the the Target target. The information listed includes the old and the new VTL name, source host name or IP address and recovery job details.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 address and failback job details. The failback job details contains when the job started, finished and its status. Output data: List of all replicated VTL failback jobs: Total count = 1 [failback job = 1] ID = 1 VTL Name = part4 Target Host = 10.40.164.70 Failback Job Started = Wed Jun 3 16:45:53 2009 Failback Job Finished = Wed Jun 3 16:46:01 2009 Failback Job Status = Success...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Aborting the Replicated syscli --abort nasfailbackjob --repname <NAS_share_name> --tgthost NAS Failback Job on the <target_hostname> --id <ID_of_the_failback_job> Target This CLI command allows the admin user to abort a current running replicated NAS share failback job.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --target: Target host name or IP of the replication report. If the system or the share/partition has two targets configured, you must use the --target option and you must specify a target IP or hostname. If the system or the share/partition has no target configured, invoking the commands will result in error.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Note: When the output of the share's state is Enabled, the share is eligible to receive directory/file based data. Listing the Cartridge syscli --list cartrepstats --name <VTL name>...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 CLI command options: • --edit: Allows to edit the existing map of OST target ip address to a replication ip address. • --replicationip: Must be a valid IP.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Scheduler CLI Commands (DEPRECATED) Note: Configuring scheduled events using the CLI interface will be discontinued in a future release. Please use the Configuration > Scheduler page in the GUI instead.
Page 70
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --healthcheck: Indicates this is a scheduled healthcheck event. Note: Healthcheck requires a daily or weekly recurrence not to exceed every 7 days or once a week. • --emailreports: Indicates this is a scheduled email reports event. This will send the --type to all recipients in the list obtained from syscli --get emailhome.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --interval: This specifies how often the recurrence is repeated. Recur every <interval> amount. If --interval is not specified, the default is 1. ex: if daily recurrence, interval=5 : recurs every 5 days....
Page 72
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --healthcheck: Indicates this is a scheduled healthcheck event. Note: Healthcheck requires a daily or weekly recurrence not to exceed every 7 days or once a week. • --emailreports: Indicates this is a scheduled email reports event. This will send the --type to all recipients in the list obtained from syscli --get emailhome.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --monthday: Recur monthly on a specific weekday within the month starting at the time obtained from the --start specification. If last is specified, then the event will occur on the last day of each month.
Page 74
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --instances: If specified, all instances matching the specified data will be returned. This is the default option. • --series: If specified, only the series (or parents) events will be returned.
Page 75
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 start = Sat Jul 7 12:00:00 2012 recurrence = FREQ=WEEKLY;BYDAY=SU The string can contain any of the following; however, not necessarily at the same time. FREQ • DAILY: Event will occur every day. Example: recurrence = FREQ=DAILY •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Where # represents how many events to occur before it "deactivates" itself. Example: recurrence = FREQ=MONTHLY;COUNT=10;BYMONTHDAY=1 UNTIL=<epoch_time> Where <epoch_time> represents a specific date of when to stop the events or to "deactivate"...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Displaying the Ingest syscli --get ingestrate Throughput Rate This CLI command displays the ingest throughput rate of the system. OST CLI Commands The following sections are the supported OST CLI commands: •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --name: Name of the storage server. • --maxconnect: connect_count: the maximum number of connections allowed. The range is any value between 3 and 65536, inclusive. • --target: Allowed replication target host ids. Multiple targets can be specified, for example: --target target1 --target target2.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --namematch: if specified, only storage servers whose names match the specified pattern are listed. The wild characters ^ and $ are supported as follows: • ^xxx – Matching pattern xxx at the start of names •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 LSU name = Lsu1 Server name = Back_Server Physical capacity = 20.00 GB Backup images = 0 Description = LSU_One OST AIR = enabled AIR user = JohnD Target Server name = TargSS Target LSU name = TargLSU Note: The last 3 items are only displayed if OST AIR = enabled. Otherwise, it will just show: OST AIR = disabled...
Page 81
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 By default, the report will list the aggregate statistics of all media servers. If --all is specified, the report consists of the aggregate statistics followed by the statistics of individual media servers.
Page 82
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Processed last 60 seconds = 5000000 bytes Unique last 60 seconds = 2500000 bytes Processed to Unique ratio = 2.00:1 Ethernet bandwidth rate = 41666.67 bytes/s Virtual rate = 83333.34 bytes/s Bandwidth Reduction = 50.00 Ethernet In = 0.04 MB/s Inline = 0.08 MB/s Command completed successfully. _____________________________________________________________ An example output of --list oststats is shown below. (with Accent stats not present): syscli --list oststats Output data: OST Statistics:...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Command completed successfully. ______________________________________________________________ Installing the TLS syscli --install tlscertificate [--certificate <certificate_fullpath>] [-- Certificate Files privatekey <key_fullpath>] [--certificateauthority <authority_fullpath>] [- -rejectionlist <rejection_fullpath>] This CLI allows the admin user to install the user provided Transport Layer Security (TLS) certificate files.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --password: Password associated with --username. If the <air_user_password> is not specified, the command will prompt for a password and will not echo it on the screen. • --desc: User description. Enclose in double quotes if string contains spaces or special characters.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Adding a Replication syscli --add ostair --sourcess <source_server_name> [--sourcelsu Source to a Target LSU <source_lsu_name>] --targetss <target_server_name> [--target <host_name_or_ip>] [--targetlsu <target_lsu_name>] --airuser for AIR <air_username> This CLI allows the admin user to set up the initial relationship that directs a Storage Server/LSU to replicate to a target Storage Server/LSU for Automatic Image Replication (AIR).
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Editing a Replication syscli --edit ostair --sourcess <source_server_name> [--sourcelsu Source to a Target LSU <source_lsu_name>] [--disabled | --enabled] [--targetss <target_server_name>] [--target <host_name_or_ip>] [--targetlsu for AIR <target_lsu_name>] [--airuser <air_username>]...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 This CLI command allows the admin user to delete the specified e-mail recipient. Deleting All E Mail Recipients syscli --deleteall emailrecipient [--sure] This CLI command allows the admin user to delete all e-mail recipients. If the --sure option is specified, the user will not be prompted for confirmation.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 mail CLI Commands The following e-mail home commands are supported: • Getting the E-mail Information • Adding an E-mail Schedule Recipient • Deleting an E-mail Schedule Recipient •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 On Demand E-mail Configuration syscli --send configondemand --emailaddr <recipient_email_address> This CLI command allows the admin user to send the e-mail containing Status information, on demand. SNMP Trap Destination...
Page 91
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Adding SNMP Trap Destinations syscli --add snmptrapdest --ipaddress <trap_dest_address> --name <trap_dest_name> [ --enable fail, warn, info, avail, unavail ] This CLI command allows the admin user to add SNMP trap destination Editing SNMP Trap Destinations syscli --edit snmptrapdest --ipaddress <trap_dest_address>...
Page 92
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Editing an SNMP Community syscli --edit snmpcom --name <community_name> [--ipaddress <community_IP_address>] [--netmask <community_net_mask>] [--accesstype {get | getset}] [--disable] This CLI command allows the admin user to edit an SNMP community.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 The following utilities CLI commands are available: • Checking for HD Security Capability • Getting HD Security Status • Enabling HD Security • Listing HD Security Storage Array Information •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 CLI command options: --enable: Enables the system's hard drive security, a.k.a Data-at-Rest Encryption. --passphrase: The passphrase to enable the hard drive security, a.k.a Data-at- Rest Encryption. If --passphrase is omitted, it will be prompted interactively.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Installing Turbo PFK syscli --install turbopfk --turbopfkfile <turbopfk_file> --name (6800 only) Qarray1|Qarray2|Qarray3|Qarray4 This CLI allows the admin user to install turbo PFK (Premium Feature Key) file to the system.
Page 96
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Utility CLI Commands The following utilities CLI commands are available: • Upgrading the System Firmware • Listing Upgrades • Downloading Upgrades • Installing Upgrades • Getting the Cluster Status of Local Node •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • Getting Progress Details about the current Secure File Shred Operation • Getting the Status of the Last Secure File Shred Operation • Getting the Summary of the Secure File Shred Progress •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Installing Upgrades syscli --install upgrades --name <ID> This CLI command allows the admin user to install the downloaded upgrade to the system. CLI command options: • --install upgrades: Installs the downloaded upgrade. The upgrade can and must be downloaded first using the --download upgrades.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 The --getstatus option returns the following status for space compaction: Output data: Compaction Status = Status Progress = 0 % Start Time = End Time = Compacted = 0.00 MB Still to compact = 0.00 MB Space Reclamation The following space reclamation commands are available: • Starting Space Reclamation •...
February 2014 Reclaimable Space = 0.00 MB More information regarding space reclamation can be found in two reports that are produce by Quantum's DXi Advanced Reporting (DAR) application. • The Space Reclamation Report presents space reclamation progress and space reclamation in bytes. • The Disk Usage graph in the Capacity Report presents reclaimable space, which is the amount of disk space available for new deduplicated data.
Page 101
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 License Name = De‐Duplication Installed = Yes Date Installed = 2009 01 15:32:42 License Description = Enables De‐Deduplication [License = 4] License Name = Replication Installed = Yes Date Installed = 2009 03 08:59:17 License Description = Enables Replication [License = 5] License Name = Storage Capacity Installed = Yes Date Installed = 2009 01 15:32:24 License Description = Limit Storage Capacity [License = 6] License Name = OST Installed = No Date Installed = ‐‐ Not Installed ‐‐ License Description = Limit Open Storage Server Connections [License = 7] License Name = Vision Installed = No Date Installed = ‐‐ Not Installed ‐‐ License Description = Enables Advanced Reporting Adding a License syscli --add license --key <license_key>...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Getting License Status (DXi V-Series only) syscli --getstatus license This CLI command reports the license status, the capacity, the date license installed, the expiration, the license type, and the number of days the license remains.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 This CLI command allows users to download the current diagnostic log to the current working directory. CLI command options: • --system: Downloads the system diagnostic log. This is the default if no diagnostic type is specified.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Version = 2.0 [WSDL Support = 2] Name = Common.xsd Version = 1.0‐2010/11/13 [WSDL Support = 3] Name = Dxi.wsdl Version = 1.0‐2010/05/18 [WSDL Support = 4] Name = Nas.wsdl Version = 1.0‐2010/05/18 [WSDL Support = 5] Name = Nas.xsd Version = 1.0‐2010/11/05 [WSDL Support = 6] Name = Replication.wsdl Version = 1.0‐2010/07/17 [WSDL Support = 7] Name = Replication.xsd Version = 1.0‐2010/07/17 [WSDL Support = 8] Name = System.wsdl Version = 1.0‐2010/09/09 [WSDL Support = 9] Name = System.xsd Version = 1.0‐2010/09/09 Command completed successfully. Example 2: bash‐3.2$ syscli ‐‐authenticate ‐‐name cliadmin ‐‐password ...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 syscli --release credential [--credtoken <credential_token>] --ws [<remotehost>[:<portnumber>]] For a description of the --ws option, see Web Services Session on page 8. This command allows the user to release the specified credential token to terminate a Web Services session.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Changing the Password syscli --change password --name admin|monitor|cliadmin|cliviewer -- oldpassword <old_password> --newpassword <new_password> This CLI allows the admin user to change the password of the following special users:...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Note: For security reasons, all HTML and script tags will be removed from the text before storing it on the system. Only <b>, <i>, and <p> tag are allowed.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 --direction: Sorting direction. Default is by ascending id --xml: If specified, the output will be exported in xml format in file_name in current directory. Getting the Count of...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Starting the Secure File syscli --start securefileshred [--sure] Shredder This CLI allows the admin user to start the secure file shred operation. CLI command options: --start: Starts the secure file shred operation.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 This CLI allows the user to remove the specified package(s) from the system. syscli --system list --type all|available|updates|installed|obsoletes|recent [--package <commas_separated_packages>] This CLI allows the user to displays information of the specified package(s).
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Caution: Changes made with netcfg CLI commands might cause the system to become inoperable or unreachable. Adding Network syscli --add netcfg --devname <DEVNAME> [--dhcp] |[--ipaddr <IPADDR> - Configurations -netmask <NETMASK>...
Page 112
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --netmask: Netmask in decimal dotted notation (e.g. 255.255.255.0) • --gateway: IP address of gateway used to get to a different network (subnet) or repeat the IP address for the devname option above if the desire is to limit packets to this network.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Deleting Network syscli --del netcfg --devname <DEVNAME> [--sure] Configurations This CLI command allows the admin user to delete the specified network device and its IP address information. Any slaves associated with the network device will also be deleted.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • vifno: Virtual interface number, which is optional and can range from 1 to possibly 99, depending on actual systems. Backing Up the Current syscli --backup netcfg Network Configuration This CLI command allows the admin user to back up the current custom network configuration.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Listing Network syscli --list interface [--xml [<filename>]] [--type [configured]|runtime] Interfaces This CLI allows the user to list available and configured network interfaces. CLI command options: • --list: Lists network interfaces.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Adding Throttle on the syscli --add throttle [--service REP] --bw <bandwidth><K|M> Source System This CLI allows the admin user to add throttling on the source for the specified network services.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --domain: Sets the system's domain name. • --dns: Sets the DNS search path. Can specify up to 3 IP addresses. DNS will search each path in the order of the specified IP addresses.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Adding a Static Route syscli --add route [--devname <DEVNAME>] --network <IPADDR> -- netmask <NETMASK> --gateway <GATEWAY> [--sure] This CLI allows the admin user to add a static route for the system (and optionally for a network device) using the specified network IP addr, netmask and gateway.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • devno: Device number, which can range from 0 to possibly 99, depending on actual systems. • vifno: Virtual interface number, which is optional and can range from 1 to possibly 99, depending on actual systems.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Disabling Jumbo Frames syscli --disable jumbo DEPRECATED. Use the syscli --add netcfg command to set jumbo frames instead. Getting Jumbo Frame Status syscli --getstatus jumbo DEPRECATED. Use the syscli --list interface command to get jumbo frames instead.
Page 121
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • DXi 6540 With Only Two Independent Ports Being Used • DXi 6540 With Three Bonds of Two Ports Each • DXi 6540 With One Bond and Two Independent Interfaces •...
Page 122
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Then, configure bond1 for the other subnet. If applicable, configure the GATEWAY2: syscli --add netcfg --devname bond1:1 --slaves eth2, eth3 --ipaddr IPADDR2 --netmask NETMASK2 --gateway GATEWAY2 --segments DATA,MGMT DXi 6540 With Only Two Independent Ports Being Used There are only two independent customer ports that are configured.
Page 123
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Then configure Eth0 for the other subnet. If applicable, configure GATEWAY2: syscli --add netcfg --devname eth0:2 --ipaddr IPADDR2 --netmask NETMASK2 --gateway GATEWAY2 --segments DATA,MGMT DXi 6540 With Three Bonds of Two Ports Each Ensure that the switch ports are appropriately aggregated and the gateways, if applicable, are configured.
Page 124
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Then configure bond2 for IPADDR3 and, if applicable, configure GATEWAY3: syscli --add netcfg --devname bond2:1 --slaves eth4, eth5 --ipaddr IPADDR3 --netmask NETMASK3 --gateway GATEWAY3 --segments MGMT DXi 6540 With One Bond and Two Independent Interfaces The two independent interfaces have to be connected to a non-aggregated port on a switch.
Page 125
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Then configure Eth5 for IPADDR3 and, if applicable, configure GATEWAY3: syscli --add netcfg --devname eth5:1 --ipaddr IPADDR3 --netmask NETMASK3 --gateway GATEWAY3 --segments MGMT When configuring replication segmentation for an interface (device) in addition...
Page 126
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 First, delete the default bond configuration with all customer ports connected together: syscli --del netcfg --devname bond0 Then configure Eth0 for IPADDR1 and, if applicable, configure GATEWAY1: syscli --add netcfg --devname eth0:1 --ipaddr IPADDR1 --netmask...
Page 127
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 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. 2 Delete bond0: [root@rok‐dxi92 DXi]# syscli ‐‐del netcfg ‐‐devname bond0...
Page 128
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 ‐‐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 using the syscli --nodemanage --reboot command: [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.
Page 129
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 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 To create a bond using eth0 and eth1 as slaves, enter the following: [root@rok‐dxi92 DXi]# syscli ‐‐add netcfg ‐‐devname bond0:1 ‐‐ipaddr ...
6-67081-09 Rev B February 2014 Path To Tape CLI Commands The following Path to Tape CLI commands are available: Note: Path to Tape CLI commands are not available for the DXi V-Series and DXi4000 systems. • Listing the Path to Tape Initiator •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Editing a Backup User syscli --edit backupuser --name <backup_user_name> --password <backup_user_password> [--desc <description>] This CLI command allows the admin user to edit a backup application user. • --desc: user description. Enclosed in double quotes if string contains spaces or special characters.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Using Medium syscli --use medchanger --sernum <medium changer serial number> Changers --usetype {backupapplicationspecific | ignore} This CLI command allows the admin user to set the intended use for the specified medium changer.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 • --sure: if specified, the command will execute immediately without asking for confirmation. Date and Time CLI Commands The following sections describe the supported date and time CLI commands: •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Displaying the Time syscli --list timezone [--matching <pattern>] Zone This CLI command allows the user to list information for all time zones. If matching <pattern> is specified, list only time zones that have their time zone filenames match the specified pattern such as pacific, central, bangkok, etc.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Getting the VTL Logical syscli --getstatus vtllogical [--vtl <VTL_name>] View Status This CLI command returns the logical view of the VTL(s). If an optional VTL name is specified, only that VTL’s logical view is displayed.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Alert CLI Commands The following sections describe the supported Alert CLI commands: • Deleting an Administration Alert • Deleting All Administration Alerts • Editing the Service Ticket Analysis •...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Showing the Service syscli --show ticketanalysis --ticketnum <ticketnum> Ticket Analysis This CLI command allows the admin user to show the service ticket analysis. Showing the Service syscli --show ticketdetail --ticketnum <ticketnum>...
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Displaying the syscli --getstatus netserver NetServer Status This CLI command displays whether NetServer is enabled or disabled on the system. Displaying the Last Run syscli --show throughput --disk | --network Result of the Disk/ This CLI command displays the last run result of the disk/network analysis.
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Healthcheck Name = De‐Duplication State = enabled Started = Sun Dec 19 05:00:05 2010 Finished = Sun Dec 19 05:00:05 2010 Status = Success HealthCheck = 2 Healthcheck Name = Integrity State = enabled Started = Sun Dec 19 05:00:08 2010 Finished = Sun Dec 19 05:00:08 2010 Status = Success Command completed successfully. Editing the Health syscli --edit healthcheck --name <healthcheck_name> --enable | --disable Check This CLI command allows the admin user to enable or disable the health check on a specified healthcheck name.
Page 140
Quantum DXi-Series Command Line Interface (CLI) Guide 6-67081-09 Rev B February 2014 Health Check CLI Commands...
Need help?
Do you have a question about the DXi V-Series and is the answer not in the manual?
Questions and answers