Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

QoreStor 7.1.1 - Command Line Reference Guide

Table of Contents

Introduction to the QoreStor Command Line Reference Guide

About the QoreStor CLI documentation Other information you may need

Introducing QoreStor

Understanding the QoreStor CLI Accessing the QoreStor CLI commands

Accessing the CLI commands

QoreStor CLI commands overview

Managing QoreStor

Alerts Commands

Alerts Command Usage

alerts --show [--events] [--index <[-]number> [--count <number>] [--all] alerts --help

Authenticate Commands

Authenticate Command Usage

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

Email_alerts Commands

Email_alerts command usage

email_alerts --clear-config email_alerts --enable email_alerts --disable email_alerts --status email_alerts --configure email_alerts --test-email email_alerts --help

Email_stats Commands

email_stats command usage

email_stats --clear-config email_stats --enable email_stats --disable email_stats --status email_stats --configure email_stats --test-email email_stats --help

OST Command Usage

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

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

SAML configuration command usage

saml_cfg --help

sc_manager command

sc_manager Command Usage

sc_manager status --property <path_to_sc_client.property_file> sc_manager disable --property <path_to_sc_client.property_file> sc_manager enable --property <path_to_sc_client.property_file>

Stats Command Usage

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 commands

Storage Group Command Usage

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

System Command Usage

system --show [--version] system --license [--validate] [--add] system --storage system --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

Managing QoreStor Storage Operations

Cloud_tier Command Usage

cloud_tier --show cloud_tier --add cloud_tier --update cloud_tier --delete cloud_tier --setpassphrase cloud_tier --enable cloud_tier --purge-ssl-certificate cloud_tier --src_cont_list cloud_tier --help

Connection Command 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(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

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

ISCSI Command Usage

iscsi --show [--user] iscsi --setpassword iscsi --sessions iscsi --help

NDMP Command Usage

ndmp --show ndmp --update [--port <port number>] ndmp --help

Object_container

object_container command usage

object_container --show object_container --add object_container --update object_container --encryption object_container --delete_data object_container --delete object_container --setpassphrase object_container --bucket object_container --policy object_container --help

object_direct command usage

object_direct --show object_direct --update_sentinel object_direct --update object_direct --help

Performance_tier

Performance_tier command usage

performance_tier --show performance_tier --add performance_tier --update performance_tier --encryption performance_tier --setpassphrase performance_tier --test-iops performance_tier --help

Replication Command Usage

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

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

schedule --show [--cleaner] 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 --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

Maintaining QoreStor

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 --disaster_recovery maintenance --help

cloud_tier --purge-ssl-certificate

Managing QoreStor Storage Operations > Cloud_tier > Cloud_tier Command Usage > cloud_tier --purge-ssl-certificate

Description

Remove the cached self signed ssl certificate.

Syntax

cloud_tier --purge-ssl-certificate

Result

cloud_tier --src_cont_list

Managing QoreStor Storage Operations > Cloud_tier > Cloud_tier Command Usage > cloud_tier --src_cont_list

Description

Displays the source container list of an existing cloud connection.

Syntax

cloud_tier --src_cont_list
	[--cloud_archive]

Where

--cloud_archive   Displays cloud archive tier connection source containers list

Result

Cloud source container entries are:
ObjectContainer (groupid: 3)

cloud_tier --help

Managing QoreStor Storage Operations > Cloud_tier > Cloud_tier Command Usage > cloud_tier --help

Description

Displays the list of cloud_tier related options that can be used as a reference when using the QoreStor CLI.

Syntax

cloud_tier --help

Result

cloud_tier --show [--verbose]
	[--cloud_archive]
            
cloud_tier --add --cloud_container <bucket name>
	--cloud_provider <AWS-S3|AZURE|Wasabi-S3|Google-S3|IBM-S3|S3-Compatible>
	[--cloud_archive_service <S3-Glacier|S3-Deep-Archive>]
	[--archive_retention_in_warm <1 to 365 days>]
	[--archive_role_arn <archive role arn>]
       [--archive_restore_type <Batch|Lambda>]
           
cloud_tier --update [--cloud_password]
	[--cloud_archive]
	[--archive_retention_in_warm <1 to 365 days>]
	[--archive_role_arn <archive role arn>]

           
cloud_tier --delete [--cloud_archive]
			
cloud_tier --setpassphrase [--cloud_archive]
			
cloud_tier --enable --src_name <name>
	[--cloud_archive]
			
cloud_tier --purge-ssl-certificate
			
cloud_tier --src_cont_list [--cloud_archive]
			
cloud_tier --help
			
cloud_tier <command> <command-arguments>
			
	<command> can be one of:
	--show                    Displays the current cloud connection details.
	--add                     Adds a new cloud connection.
	--update                  Updates a cloud connection details.
	--delete                  Deletes an existing cloud connection.
	--setpassphrase           sets passphrase to a cloud connection.
	--enable                  Enable cloud replication for source container.
	--purge-ssl-certificate   Remove the cached self signed ssl certificate.
	--src_cont_list           Source container list of an existing cloud connection.
			
For command-specific help, please type cloud_tier --help <command>
	eg:
	cloud_tier --help show

Connection

Managing QoreStor Storage Operations > Connection

This topic introduces the set of QoreStor CLI commands that allow you to manage, configure, and display connection-related settings for containers on a QoreStor server. For more information, see Container Command Usage .

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center