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
connection --help
Description
Displays the listing of user and related options that you can use as a reference when using the QoreStor CLI.
Syntax
connection --help
Results
Usage:
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, hostname, or WWPN>]
[--target <WWPN>]
[--rootmap <nobody | root | administrator>]
[--options <NFS | CIFS mount export options>]
[--capacity <Positive decimal number>]
connection --update --name <name>
--type <NFS | CIFS | OST | RDS | NDMP | ISCSI | FC>
[--clients <ip address>]
[--dma <ip address>]
[--initiator <IQN, ip address, hostname, or WWPN>]
[--target <WWPN>]
[--rootmap <nobody | root | administrator>]
[--options <NFS | CIFS mount export options>]
[--capacity <Positive decimal number>]
connection --delete --name <name>
--type <NFS | CIFS | OST | RDS | NDMP | ISCSI | FC>
[--clients <ip address>]
connection --enable --name <name>
--type <NFS | CIFS | OST | RDS | NDMP | ISCSI | FC>
connection --disable --name <name>
--type <NFS | CIFS | OST | RDS | NDMP | ISCSI | FC>
connection --help
connection <command> <command-arguments>
<command> can be one of:--show Displays the current connections on a container.
--add Adds a new connection to a container.
--update Updates an existing connection.
--delete Deletes an existing connection.
--enable Enables access to a container through a connection.
--disable Disables access to a container through a connection.
For command-specific help, please type connection --help <command>
eg:
connection --help show
Container
This topic introduces the set of QoreStor CLI commands that allow you to perform the following tasks:
- Display the status of all current containers (summary or detail)
- Create (and name) new containers
- Delete existing containers
Container Command Usage
This topic introduces the container command usage:
- container --show [options]
- container --add --name [options]
- container --update [options]
- container --delete --name [options]
- container --marker --name <name> [--enable options] [--disable options]
- container --delete_files --name <name>
- container --help
|
|
NOTE: If you specify a command without supplying the expected value or option, you will be prompted to provide the correct value or option. |
container --show [--name <name>] [--verbose]
Managing QoreStor Storage Operations > Container > Container Command Usage > container --show [--name <name>] [--verbose]
Displays the summary status of an existing container in a QoreStor that you specify using the container --show --name command.
Syntax
container –-show --name vRanger_Fast
Result
container --show --name vRanger_Fast Container's Group ID : 4 Container's Group Name : vRanger_PTY Container Name : vRanger_Fast Container Path : /containers/vRanger_Fast Container Marker : None RDS connection Quota : Unlimited RDS connection Used Capacity : 10.0 GiB RDS connection Enabled : Yes RDS connection status : Available
Other Examples
Displays the detailed status of an existing container that you specify by name using the container --show --name --verbose command:
Container Entry ID : 1 Container's Group ID : 0 Container's Group Name : DefaultGroup Container Name : NV_QS1 Container Path : /containers/NV_QS1 Container Marker : None Container Created On : Fri Apr 20 06:09:46 2018 Container Created Ver : Container Created Bld : 174 RDS connection Entry ID : 1 RDS connection Quota : Unlimited RDS connection Used Capacity : 257.0 GiB RDS connection Enabled : Yes RDS connection status : Available