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
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
SAML
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 --object_direct
stats --archive_tier
stats --object_container
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
Object_container
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
object_container command usage
Object_direct
Performance_tier
Replication
object_container --show
object_container --add
object_container --update
object_container --encryption
object_container --delete_data
object_container --delete
object_container --setpassphrase
object_container --bkt-add
object_container --bkt-del
object_container --bkt-list
object_container --bkt-lock
object_container --bkt-version
object_container --bkt-legalhold
object_container --bkt-retention
object_container --bkt-show
object_container --policy-list
object_container --policy-set
object_container --policy-unset
object_container --policy-update
object_container --policy-show
object_container --user-add
object_container --user-del
object_container --user-enable
object_container --user-disable
object_container --user-list
object_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 --restore
vtl --set_rw --name <name> [--id <number>]
vtl --show_replstate --name <name>
vtl --help
Maintenance
About us
Maintenance commands
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
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 --cloud_policy [options]
- container --delete_files --name <name>
- container --add_uac [options]
- container --delete_uac [options]
- container --update_uac [options]
- container --show_uac [options]
- 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 current list of containers.
Syntax
container --show [--name <name>] [--verbose]
Where
--name Display details for a specific container. --verbose Display more details.
Result
container --show --name vRanger_FastContainer's Group ID : 2 Container's Group Name : tool-load Container Name : QSPL-4300-13_OST Container Path : /containers/QSPL-4300-13_OST Container Object Direct Storage : No Container Cloud Replication : None Container Marker : None Recycle Bin Enabled : No OST connection Quota : Unlimited OST connection Used Capacity : 758222.0 GiB OST connection Enabled : Yes OST connection status : Available Number of container UACs : 1
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 : 6 Container's Group ID : 2 Container's Group Name : tool-load Container Name : QSPL-4300-13_OST Container Path : /containers/QSPL-4300-13_OST Container Object Direct Storage : No Container Cloud Replication : None Container Marker : None Container Created On : Tue Jun 26 11:56:43 2018 EDT Container Created Ver : 4.1.0.235 Container Created Bld : 1082C Recycle Bin Enabled : No OST connection Entry ID : 5 OST connection Quota : Unlimited OST connection Used Capacity : 758222.0 GiB OST connection Enabled : Yes OST connection status : Available Number of container UACs : 1 user: backup_user, user_id: 1, access: RWD
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>]
Managing QoreStor Storage Operations > Container > Container Command Usage > 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>]
Description
Creates and names a new container in QoreStor.
|
|
NOTE: If a storage group name is not provided, the container will be placed in Default Group. |
|
|
NOTE: Container names and storage group names cannot exceed 32 characters in length. Container names cannot start with a number, and the /, #, and @ special characters are not allowed. Valid values for the container and storage group name are [a-z, A-Z, 0–9, and ‘_’. |
Syntax
container --add --name <name> [--type <VTL>] [--tape_size <800GB|400GB|200GB|100GB|50GB|10GB>] [--no_of_drives <1-60>] [--is_oem <yes|no>] [--oem_vendor <QUEST>] [--group_name <name>]
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. --type Type of the container. --tape_size Tape size <800GB|400GB|200GB|100GB|50GB|10GB> --no_of_drives Number of Drives (applicable to FC containers only) --is_oem Is OEM <yes|no> --oem_vendor oem_vendor <QUEST> --group_name Name of the storage group. Valid values are [a-z,A-Z,0-9,'-' and '_'] and maximum of 32 characters.
Result
Container "acme99" created successfully.