Introduction to the QoreStor Command Line Reference Guide
Introducing QoreStor
Managing QoreStor
Alerts Commands
Authenticate Commands
Managing QoreStor Storage Operations
Authenticate Command Usage
Email_alerts Commands
OST
authenticate --show [--users]
authenticate --join --domain <domain name> [--ou <org-unit name>] --user <user name>
authenticate --leave [--user <user name>] [--force]
authenticate --update --kerberos
authenticate --add [--user <user name>]
authenticate --delete--user <user name>
authenticate --set --user <user name>
authenticate --guestmode [--enable]
authenticate --server_signing --mode <auto | mandatory | disabled>
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 --nfs
stats --cifs
stats --ost
stats --rds
stats --ndmp
stats --ndmp_completed
stats --iscsi [--verbose]
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 --cloud_tier
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
Cloud_tier
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
iSCSI
NDMP
Performance_tier
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 --cloud_policy
container --delete_files --name <name>
container --add_uac
container --delete_uac
container --update_uac
container --show_uac
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
VTL
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
VTL Command Usage
vtl --show [--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 [--repair_now]
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
maintenance --help
storage_group --show [--name <name>] [--verbose]
Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --show [--name <name>] [--verbose]
Description
Displays the current list of storage groups on the QoreStor. If you specify the –name option, you can view details of a specific storage group. The –verbose option displays more details.
Syntax
storage_group --show [--name <name>] [--verbose]
Where
--name Display details for a specific Storage group.
--verbose Display more details
Result
Storage_group Entry ID : 0 Storage_group Name : DefaultGroup Storage_group Compression Type : Fast Storage_group Encryption Set : Off Storage_group Encryption Mode : Off Storage_group Rotate Period : 0 Storage_group Passphrase set : No Storage_group Created On : Thu Nov 17 00:40:14 2016 PST Storage_group Created Bld : 62141 DefaultGroup's Containers ------------------------- backup vtl-iscsi
storage_group --add --name <name> [--compression_mode <fast|best>]
Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --add --name <name> [--compression_mode <fast|best>]
Description
Adds a new storage group to the QoreStor with the name specified by the --name command option.
|
|
NOTE: When adding a name, valid values for the name are (a-z, A-Z, 0–9, ‘_’, and ‘_’) |
|
|
NOTE: Do not change the chunk_type parameter from the default setting unless directed to do so by Quest Support. |
You can also set the compression mode for the storage group as fast or best, described as follows:
- Fast — Results in shorter backup time, but with less space savings.
- Best — Provides the highest space savings, but with a longer backup time.
Syntax
storage_group --add --name <name> [--compression_mode <fast|best>][--map_exclusive <enclosure filesystem dir>]
Where
--name Name of the storage group. Valid values are [a-z,A-Z,0-9,'-' and '_'] and maximum of 32 characters. --compression_mode Valid values are Fast and Best. --map_exclusive Absolute directory path for exclusively mapped enclosure.
Result
Storage Group "StorageGroup_1" created successfully.
storage_group --update --name <name> [--compression_mode <fast|best>]
Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --update --name <name> [--compression_mode <fast|best>]
Description
Allows you to modify the settings for the specified storage group.
Syntax
storage_group --update --name <name> [--compression_mode <fast|best>]
Where
--name Name of the storage group. Valid values are [a-z,A-Z,0-9,'-' and '_'] and maximum of 32 characters. --compression_mode Valid values are Fast and Best
Result
Storage Group "StorageGroup_1" updated successfully.
storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]
Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]
Description
Allows you to set the encryption level for a specified storage group on the QoreStor. You turn encryption on or off by using the --set ON or --set OFF command options. The --mode option sets the mode of key lifecycle management as one of the following:
- static—A global, fixed key is used to encrypt all data.
- internal—Content encryption keys are generated and rotated on a specified period of days.
If you select Internal as the mode of key management, you need to set the --interval option, which specifies the number of days for key rotation when a new key is to be generated.
|
|
NOTE: In Internal mode there is a maximum limit of 1023 keys. The key rotation period is set to 30 days by default when the passphrase is set and/or encryption is turned on. You can later change the key rotation period from 7 days to 70 years for internal mode. |
|
|
NOTE: After encryption is enabled, all of the data that is backed up is encrypted and is kept encrypted until it is expired and cleaned by the system cleaner. Note that encryption is an irreversible process. |
|
|
NOTE: Due to export regulations, the encryption at rest feature is not available in certain markets, and, therefore, may not be available in your locale. |
Syntax
storage_group --encryption --name <name> [--set <ON | OFF>] [--mode < static | internal >] [--interval <7 days to 70 years>]
Where
--name Name of the storage group. Valid values are [a-z,A-Z,0-9,'-' and '_'] and maximum of 32 characters. --set Valid values are On and Off. --mode Valid values are static and internal. --interval Valid values are between 7 days to 70 years (in days)
Result
Storage Group "StorageGroup_1" updated successfully.