Introduction to the QoreStor Command Line Reference Guide
Introducing QoreStor
Managing QoreStor
Alerts Commands
Managing QoreStor Storage Operations
Alerts Command Usage
alerts --show
Authenticate Commands
alerts --show [--events] [--index <[-]number> [--count <number>] [--all]
alerts --show [--alerts] [--index <[-] number>] [--count <number>] [--all]
alerts --show [--summary]
alerts --help
Authenticate Command Usage
authenticate --show
Email_alerts Commands
OST
authenticate --show [--users]
authenticate --show [--domain <domain name>]
authenticate --show [--login_group]
authenticate --join
authenticate --leave
authenticate --update
authenticate--guestmode
authenticate --server_signing
authenticate --help
OST Command Usage
RDA
ost --show [--config] [--file_history] [--name <name>] [--active_files] [--name <name>] [--clients] [--limits]
ost --update --opdup_encryption <none | aes128 | aes256>
ost --delete_client --name <OST Client Hostname>
ost --update_client --name <OST Client Hostname> --mode <auto | passthrough | dedupe>
ost --limit --speed <<num><KBps | MBps | GBps | default> --target <ip address | hostname>
ost --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]
ost --help
RDA Command Usage
Sc_manager command
Stats
rda --show [--config] [--file_history] [--name <name>] [--active_files] [--name <name>] [--clients] [--limits]
rda --update --opdup_encryption <none | aes128 | aes256>
rda --delete_client --name <RDA Client Hostname>
rda --update_client --name <RDA Client Hostname> --mode <auto| passthrough| dedupe>
rda --limit --speed <<num><KBps| MBps| GBps> | default> --target <ip address | hostname>
rda --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]
rda --help
Stats Command Usage
Storage Group commands
stats --system
stats --cpu
stats --memory
stats --datacheck
stats --nfs
stats --cifs
stats --ost
stats --rds
stats --ndmp
stats --ndmp_completed
stats --iscsi [--verbose]
stats --fc [--iostat] [--linkstat]
stats --container --name <name>
stats --storage_group --name <name>
stats --replication [--name <name>]
stats --cleaner
stats --clients [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>]
stats --reset [--nfs] [--cifs] [--ost] [--rds] [--datacheck]
stats --seed
stats --help
Storage Group Command Usage
System
User
storage_group --show [--name <name>] [--verbose]
storage_group --add --name <name> [--compression_mode <fast|best>]
storage_group --update --name <name> [--compression_mode <fast|best>]
storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]
storage_group --delete --name <name>
storage_group --setpassphrase --name <name>
storage_group --help
User Command Usage
user --show [--users] [--logins] [--verbose][--name <username>] [--roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|email_recipient>
user --add --name <user name>
user --update --name <user name> [--new_name <user name>] [--add_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--remove_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--full_name <full name>] [--phone <phone number>] [--email_addr <
user --delete --name <user name>
user --setpassword --name <user name>
user --help
Connection
Maintaining QoreStor
Connection Command Usage
Container
connection --show [--name <name>] [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>] [--verbose]
connection --add --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hostname, or WWPN>][--target <WWPN>][--rootmap <nobody|root|administrator>] [--options <NFS|CIFS
connection --update --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hostname, or WWPN>][--target <WWPN>][--rootmap <nobody|root|administrator>] [--options <NFS|CI
connection --delete --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>]
connection --enable --name <name> --type <NFS|CIFS|OST|RDS>
connection --disable --name <name> --type <NFS|CIFS|OST|RDS>
connection --help
Container Command Usage
FC
iSCSI
NDMP
Replication
container --show [--name <name>] [--verbose]
container --add --name <name> [--type <VTL>] [--tape_size <tape_size>][--no_of_drives <1–60>][--is_oem <yes|no>][--oem_vendor <QUEST|DELL>][--group_name <name>]
container --update --name <name> [--no_of_drives <1–60>]
container --delete --name <name> [--delete_files]
container --marker [--enable <Auto | CommVault | Networker | TSM | ARCserve | HP_DataProtector | Unix_Dump | BridgeHead>] [--disable <Auto | CommVault | Networker | TSM | ARCserve | HP_DataProtector | Unix_Dump | BridgeHead>] --name <name>
container --delete_files --name <name>
container --help
Replication Command Usage
Seed
replication --add --name <name> --role <source | target> --peer <ip address | hostname> [--peer_name <name>] [--peer_group_name <name>] [--replication_traffic <ip address | hostname>] [--encryption <none | aes128 | aes256>][--username <user name>]
replication --update --name <name> --role <source | target> [--peer <ip address | hostname>] [--encryption <none | aes128 | aes256>] [--username <user name>]
replication --delete --name <name> --role <source | target> [--force]
replication --start --name <name> --role <source | target>
replication --stop --name <name> --role <source | target>
replication --limit --speed <<num><KBps | MBps | GBps> | default> --target <ip address | hostname>
replication --resync --name <name> --role <source | target>
replication --troubleshoot --peer <ip address | hostname>
replication --help
Seed Command Usage
Schedule
seed --create --op <import | export> [--enc_type <aes128 | aes256>] [--storage_group_name <name>]
seed --add_container --name <container name>
seed --add_device --server <server name> --volume <volume> --username <username> --domain <domain name>
seed --cleanup
seed --remove_device
seed --show
seed --start
seed --help
Schedule Command Usage
VTL
schedule --show [--cleaner]
schedule --show [--replication] [--name <name>]
schedule --add --day <day of the week> [--cleaner] [--replication] [--start_time <hh:mm>] [-- stop_time <hh:mm>] [--name <name>]
schedule --delete --day <day of the week> [--cleaner] [--name <name>] [--replication]
schedule --help
VTL Command Usage
vtl --show [--name <name>]
vtl --show --verbose [--name <name>]
vtl --update_carts --name <name> --add --no_of_tapes <number>
vtl --activate --name <name> [--force <yes|no>]
vtl --deactivate --name <name>
vtl --rescan --name <name> [--force <yes|no>]
vtl --set_rw --name <name> [--id <number>]
vtl --show_replstate --name <name>
vtl --help
Maintenance
About us
Maintenance command
maintenance --filesystem [--scan_status]
maintenance --filesystem [--scan_report [verbose]]
maintenance --filesystem [--repair_history [verbose]]
maintenance --filesystem [--scan_restart [verify_data | verify_rda_metadata | verify_metadata]]
maintenance --filesystem [--reclaim_space]
maintenance --filesystem --stop_reclaim_space
maintenance --filesystem [--clear_quarantine]
maintenance --filesystem [--start_scan [verify_data | verify_rda_metadata | verify_metadata] [--storage_group <name>]
maintenance --filesystem [--stop_scan]
maintenance --diags --collect
maintenance --diags --show
maintenance --diags --delete <name>
maintenance --diags --delete_all
system --show [--storage]
Description
Displays the Path, Total Storage, Available Storage, and Status for your QoreStor server.
Syntax
system --show --storage
Result
system --show --storage ENCLs Path Total(GB) Available(GB) Status ENCL_0 /home/qorestor/ocaroot 9252 9252 On
system --show [--license] [--verbose]
Description
Displays the summary license status (using the system --show --license command) or the detailed license status (using the system --show --license --verbose command) for the current data storage expansion shelves (enclosures) installed in a QoreStor. For more information on validating or adding licenses for data storage expansion shelves, see system --license [--validate] [--add].
Syntax
system --show --license
Result
ID Description Status
1 1 Storage Enclosure 1TB QoreStor license Enabled
|
|
NOTE: To display a more detailed license status, use the following QoreStor CLI command: |
system --show --license --verbose Feature ID : 1 Description : 1TB QORESTOR license Status : Enabled License ID : 126-798-350 Start Date : Wed Jul 18 05:41:20 2018 End Date : N/A Is Eval : Yes In Use : Yes
system --show
Description
Displays the current configuration of the QoreStor server, including the system ID, QoreStor version, repository location, metadata location, and system state.
Syntax
system --show
Result
system --show System Name : qorestor_1 Current Time : Thu Jun 7 09:42:08 2018 MST System ID : 400A7AC39A684DFCA68F07705D99677E Product Name : QORESTOR Version : 5.0.0 Build : 156 Repository location : /ocaroot/ocaroot Metadata location : /ocaroot/qs_metadata Dictionary type : Demo System State : Operational Mode Reason : Filesystem is fully operational for I/O. Configuration Server : RUNNING Jun 6 03:04:23 Filesystem Server : RUNNING Jun 6 03:04:24 Health Monitor : RUNNING Jun 6 03:04:20 Filesystem Checker : STOPPED SecureConnect Server : RUNNING Jun 6 03:04:23 QoreStor UI : RUNNING Jun 6 03:04:24
system --license [--validate] [--add]
Description
QoreStor installs with a 1 TB trial license. If you have purchased a perpetual license, you can install it using the system --license command, as described below.
When you have downloaded your license file, you will need to copy it to the QoreStor server before installing the license. In the examples below <path> is used to represent the directory that contains the license file.
Syntax
system --license --validate --file <path>
Result
License file is valid and can be installed.
To add a validated license for a QoreStor server, use the following QoreStor CLI command:
system --license --add --file <path> License file has successfully installed.