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 --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 --peformance_tier
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 --show
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 --disaster_recovery
maintenance --help
container --update --name <name> [--no_of_drives <1–60>]
Managing QoreStor Storage Operations > Container > Container Command Usage > container --update --name <name> [--no_of_drives <1–60>]
Description
Updates the specified container.
Syntax
container --update --name <name> [--no_of_drives <1-60>][--cloud_replication <yes|no>]
Where
--name Name of the container. Valid values are [a-z,A-Z,0-9,'-' and '_' for non-VTL containers] and maximum of 32 characters. --no_of_drives Number of Drives (applicable to FC containers only) --cloud_replication <yes|no>
Result
The FC service will be restarted for this change to take effect, Do you want to continue? (yes/no) [n]? y Successfully updated Container FC1's number of drives as 32.
container --delete --name <name> [--delete_files]
Managing QoreStor Storage Operations > Container > Container Command Usage > container --delete --name <name> [--delete_files]
Description
Deletes the files and the existing container on which the files reside in a QoreStor when using the --name option with --delete_files command.
Syntax
container --delete --name <name> [--delete_files]
Where
--name Name of container. --delete_files Deletes the files in the container.
Result
WARNING: All the data in the container acme4 will be deleted! Do you want to continue? (yes/no) [n]? y Please enter the administrator password: Container "default_ost" marked for deletion. Please run "maintenance --filesystem --reclaim_space" to recover the storage space.
|
|
NOTE: Be aware that it may take a fair amount of time for the QoreStor file and container deletion processes to complete and update the system status. For details on deleting the files within an OST container, see container --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>
Managing QoreStor Storage Operations > Container > Container Command Usage > container --marker [--enable <Auto ||||||| BridgeHead>] [--disable <Auto ||||||| BridgeHead>] --name <name>
Description
Enables or disables a marker type or an automatic marker setting type (Auto) on an existing container in the QoreStor. To enable or disable the automatic marker setting type on an existing container, substitute Auto in place of a specific marker type (for example, Networker in the CLI command.
Syntax
container --marker [--enable <Auto|CommVault|Networker|TSM|ARCserve|HP_DataProtector|Unix_Dump|BridgeHead|TiNa|Acronis>] [--disable <Auto|CommVault|Networker|TSM|ARCserve|HP_DataProtector|Unix_Dump|BridgeHead|TiNa|Acronis>] --name <name>
Where
--enable Enable marker of given type. --disable Disable marker of given type. --name Name of container.
Result
Marker updated successfully.
Other Examples
Disables amarker on an existing container in the QoreStor:
container --marker --disable--name acme99 Marker updated successfully.
container --cloud_policy
Managing QoreStor Storage Operations > Container > Container Command Usage > container --cloud_policy
Description
Cloud policy for a replication primary container.
Syntax
container --cloud_policy [--age_of_file <1 hours to 70 years (in hours)>] [--incl_file_ext <file extension list>] [--excl_file_ext <file extension list>] [--incl_file_regex <file regex pattern>] [--excl_file_regex <file regex pattern>] [--incl_dir <include directory list>] [--excl_dir <exclude directory list>] [--on_prem_reten_age <1 hours to 70 years (in hours)>] [--reset <incl_file_ext|incl_file_regex|excl_file_ext|excl_file_regex|incl_dir|excl_dir>] --name <name>
Where:
--age_of_file Age of file in hours to be pushed to cloud. --incl_file_ext Comma separated list of file extensions of files to be pushed to cloud.( Ex: .jpg,.gz ) --excl_file_ext Comma separated list of file extensions of files to be excluded from pushing to cloud.( Ex: .jpg,.gz ) --incl_file_regex | separated list of regular expressions files to be pushed to cloud.( Ex: .jpg|.gz ) --excl_file_regex | separated list of regular expressions files to be pushed to cloud.( Ex: .jpg|.gz ) --incl_dir Comma separated list of directories in which files under those directories needs to be pushed to cloud. ( Ex: /inc_dir1/,/inc_dir2 ) --excl_dir Comma separated list of directories in which files under those directories that should be excluded from pushing to cloud. ( Ex: /excl_dir1/,.excl_dir2 ) --on_prem_reten_age Age in number of hours the on_prem data that is uploaded to cloud should be retained. --reset reset incl_file_ext, excl_file_ext, incl_dir or excl_dir. --name Name of container.