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
stats --cleaner
The stats --cleaner command displays the current running cleaner progress and the amount of time taken to complete its latest full pass. The Cleaner is an asynchronous process in the QoreStor that reclaims disk storage space by reclaiming space that previously contained unreferenced datastore files.
Syntax
stats --cleaner
Result
Last Run: Last Files Processed : 0 Last Bytes Processed : 0 Last Bytes Reclaimed : 0 Last Start Time : 11/30/16 01:57:32 Last End Time : 11/30/16 01:57:37 Time To Completion(s) : 5.00 Current Run: Start Time : 11/30/16 02:00:37 Files Processed : 100 Bytes Processed : 37748736000 Bytes Reclaimed : 15281899829 Phase 1 Start Time : 11/30/16 02:00:38 Phase 1 Records Processed : 0 Phase 1 End Time : 11/30/16 02:00:38 Phase 2 Start Time : 11/30/16 02:00:38 Phase 2 Records Processed : 1172436 Phase 2 End Time : 11/30/16 02:00:39 Phase 3 Start Time : 11/30/16 02:00:39 Phase 3 Records Processed : 1600 Phase 3 End Time : 11/30/16 02:00:47 Phase 4 Start Time : 11/30/16 02:00:51 Phase 4 Records Processed : 1637 Phase 4 End Time : 11/30/16 02:00:51 Phase 5 Start Time : 11/30/16 02:00:51 Phase 5 Records Processed : 0 Phase 5 End Time : 11/30/16 02:00:51 Last Completed Run: Last Completed Start Time : 11/30/16 01:50:15 Last Completed End Time : 11/30/16 01:50:30 Last Completion time(s) : 15.00 Cleaner Pending Work: Estimated Logical Bytes Left : 3130982400
stats --clients [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>]
Description
Displays the current clients that are configured on the QoreStor.
To filter the list of clients to display a specific client type on a QoreStor, use the QoreStor CLI --type command option.
|
|
NOTE: For clients, the value under Connections is 0 (zero) when the connection is configured (but it is not in use), and 1 when the connection is in use. |
Syntax
stats --clients [--type <NFS|||||>]
Where
--type Type of clients (| only).
Result
No client(s) are connected. Client(s) Type Plugin OS Backup Software Last Access Connection(s) Mode BabuK-W2K8-02 2.1.201 Windows Server 2008 R2 NetVault 9.20 Build 12 Aug 13 07:53:26 1 Passthrough R720xd-Netvault -- -- -- -- 0 Default
stats --reset [--nfs] [--cifs] [--ost] [--rds] [--datacheck]
Managing QoreStor > Stats > Stats Command Usage > stats --reset [--nfs] [--cifs] [--ost] [--rds] [--datacheck]
Description
Resets the current RDS statistics for a QoreStor. The following example shows --rds; to reset another statistic type, just replace that option type in the QoreStor CLI command.
Syntax
stats --reset [--rds] [--datacheck]
Where
--rds Reset statistics for RDS connections.
--datacheck Reset statistics for online data verification
Result
RDS Protocol message statistics are reset successfully.
stats --seed
Description
Use to monitor the seeding progress.
Syntax
stats --seed Result
Seeding Source Stats: Seed state: SEED_STARTED Seed status: FINISHED Seed device mount: /mnt/.__seed_device Blockmaps read: 12 Seeding Dictionary updates: 1065 Streams read: 196042 Comp bytes read: 5959925818 Streams committed: 196042 Streams deduped: 141245 DS's committed: 475 Total bytes processed: 10401873920 Total bytes deduped: 4441947702 Total inline bytes: 400 Total orig bytes committed: 5959925818 Total comp bytes committed: 5959925818 Device orig bytes committed: 5959925818 Device comp bytes committed: 5959925818 Logical Avg Throughput: 0.000 KB/s Logical Max Throughput: 2462955.935 KB/s Physical Avg Throughput: 0.000 KB/s Physical Max Throughput: 151010.166 KB/s Estimated time to sync: 0 days 0 hours 0 minutes 0 seconds ……. ……. …….