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
replication --stop --name <name> --role <source | target>
Managing QoreStor Storage Operations > Replication > Replication Command Usage > replication --stop --name <name> --role <source | target>
Description
Stops the replication process on an existing replication link to a container in a QoreStor.
Syntax
replication --stop --name <name> --role <source | target>
Where
--name Name of container. --role Role of container.
Result
Replication configuration updated successfully. Replication Container : acme59 Replication Role : Source Replication Target System : acme-85 Replication Target System IP : 10.20.22.20 Replication Target Container : acme85-S2 Replication Enabled : No Replication Compression Enabled : Yes Replication Encryption : AES 128-bit
replication --limit --speed <<num><KBps | MBps | GBps> | default> --target <ip address | hostname>
Managing QoreStor Storage Operations > Replication > Replication Command Usage > replication --limit --speed <<num><KBps || GBps> | default> --target <ip address | hostname>
Description
Limits the bandwidth used during replication by defining a bandwidth limit using any of the following settings:
- Kilobytes/second (KBps)
- Megabytes/second (MBps)
- Gigabytes/second (GBps)
- Unlimited bandwidth (this is the default setting); minimum allowed bandwidth setting is 192 KBps
|
|
IMPORTANT: Bandwidth rules for all ports will be deleted. New rules will be applied by QoreStor with this command. |
Syntax
replication --limit --speed <<num><KBps|MBps|GBps> | default> --target <ip address | hostname>
Where
--speed Replication speed limit (eg. 10MBps). --target Replication peer IP address.
Result
Successfully updated replication limit for acme-60 to 10 GBps. Changing traffic control policies ... done.
replication --resync --name <name> --role <source | target>
Managing QoreStor Storage Operations > Replication > Replication Command Usage > replication --resync --name <name> --role <source | target>
Description
Resynchronizes the replication process between a source and target container in a replication relationship on a QoreStor.
|
|
IMPORTANT: This command should only be used in an emergency situation with the help of Quest Support. Do not mistake this command as an ability to start a replication sync outside of the schedule window. If your intention is to start a replication outside of the window, you can either delete the schedule, or add a temporary replication window to the current schedule and delete it when the systems are in sync. |
Syntax
replication --resync --name <name> --role <source | target>
Where
--name Name of container.
--role Role of container.
Result
Successfully initiated replication resync on container dataStorage3.
replication --troubleshoot --peer <ip address | hostname>
Managing QoreStor Storage Operations > Replication > Replication Command Usage > replication --troubleshoot --peer <ip address | hostname>
Description
Troubleshoots the replication connections between a source and target container on a QoreStor.
|
|
NOTE: This command only reports 9915 and 9916 as succeeding against a replication peer that has native Qorestor or DR Series replication configured to another system. If the peer is not currently using any replication ports, 9915 and 9916 will report as connection refused. |
Syntax
replication --troubleshoot --peer <ip address | hostname>
Where
--peer IP address or name of remote machine to troubleshoot.
Result
The following examples shows both successful and unsuccessful replication connection attempts:
Testing connection to port 9904... Connected! Testing connection to port 9911... Connected! Testing connection to port 9915... Connected! Testing connection to port 9916... Connected! Replication troubleshooting completed successfully - Connection to all ports is OK!
replication --troubleshoot --peer acme-205 Testing connection to port 9904... Connected! Testing connection to port 9911... Connected! Testing connection to port 9915... Unable to connect to socket - Connection refused Could not connect to acme-205 on port 9915 - (Connection refused) Testing connection to port 9916... Unable to connect to socket - Connection refused Could not connect to acme-205 on port 9916 - (Connection refused)