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
replication --help
Description
Displays the list of all replication-related options that can be used as a reference when using the QoreStor CLI.
Syntax
replication --help
Result
Usage:
replication --show [--name <name>]
[--role <source | target>]
[--verbose]
[--limits]
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>]
[--replication_traffic <ip address | hostname>]
[--encryption <none | aes128 | aes256>]
[--username <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
replication <command> <command-arguments>
<command> can be one of:
--show Displays command specific information.
--add Adds a replication link to a container.
--update Updates a replication link to a container.
--delete Deletes a replication link from a container.
--start Starts replication.
--stop Stops replication.
--limit Delete existing bandwidth rules for all ports and sets new throttling limits.
--resync Initiates a replication re-sync.
--troubleshoot Troubleshoots replication connection.
For command-specific help, please type replication --help <command>
For example:
replication --help showSeed
The QoreStor seed operations allow for exporting data on the source to a portable seed device to then import the seed data to a primary target, and, if required, a secondary target as well. Replication seeding is an alternative to using network bandwidth for the initial re-synchronization of the source and target(s). After the target(s) are seeded, continuous replication can be started, which will keep the target(s) up to date by sending only unique data.
The QoreStor CLI seed commands support the following operations:
- Create a job to perform seeding export or import.
- Delete an existing seeding export or import job.
- Specify containers for seeding export.
- Remove a container which is already added for seeding export.
- Add a device to be used for seeding.
- Remove a device which is already added for seeding.
- Start seeding process (export/import).
- Stop running seeding process (export/import).
- Start cleaner to process seed ZL logs on target.
|
|
NOTE: The seeding device must be a CIFS share: a USB device connected to a Windows or Linux system and shared for import as a CIFS-mounted folder. |
|
|
NOTE: The following scenarios are not supported for seeding:
|
Seed Command Usage
This topic introduces the seed command usage:
- seed --create --op <options> [--enc_type <options>] [--storage_group_name <name>]
- seed --delete
- seed --add_container --name <container name>
- seed --remove_container --name <container name>
- seed --add_device --server <server name> --volume <volume> --username <user name> --domain <domain name>
- seed --remove_device
- seed --start
- seed --stop
- seed --show
- seed --cleanup
- seed --help
seed --create --op <import | export> [--enc_type <aes128 | aes256>] [--storage_group_name <name>]
Managing QoreStor Storage Operations > Seed > Seed Command Usage > seed --create --op <import | export> [--enc_type <aes128 | aes256>] [--storage_group_name <name>]
Description
Creates a seed export job of type import or export on the source QoreStor or DR. The command will prompt for a password, and this password will be requested on the target to import the data. The command allows you to specify the type of encryption that will be used to encrypt the data on the seed device. The default value is aes256. The default value for storage group name is DefaultGroup.
Syntax
seed --create --op export --enc_type aes256 --storage_group_name cust1
Result
Enter password for seed export: Re-enter password for seed export: Successfully created seed job details.