Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

QoreStor 5.1.0 - 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

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

Authenticate Commands

Authenticate Command Usage authenticate --show

authenticate --show [--users] authenticate --show [--domain <domain name>] authenticate --show [--login_group]

authenticate --join

authenticate --join --domain <domain name> [--ou <org-unit name>] --user <user name>

authenticate --leave

authenticate --leave [--user <user name>] [--force]

authenticate --update

authenticate --update --kerberos

authenticate--guestmode

authenticate --guestmode [--enable] authenticate --guestmode [--disable]

authenticate --server_signing

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

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

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

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 --delete_files --name <name> container --help

FC Command Usage

fc --show [--verbose] [--target] fc --sessions [--topology] [--condensed] fc --help <command>

ISCSI Command Usage

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

NDMP Command Usage

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

Replication Command Usage

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 --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

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 [--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

rda --help

Managing QoreStor > RDA > RDA Command Usage > rda --help

Decription

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

Syntax

rda --help

Result

	rda --show [--config]
		[--file_history] [--name <name>]
		[--active_files] [--name <name>]
		[--clients]
		[--limits]

	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

	rda <command> <command-arguments>
   <command> can be one of:
		--show			Displays command specific information.
		--delete_client		Deletes the Rapid Data Access (RDA) client.
		--update_client		Updates attributes of a Rapid Data Access (RDA) client.
		--limit			Delete existing bandwidth rules for all ports and set new throttling limits for RDA replication over WAN.
		--partial_images	Lists or cleans up partial images.

For command-specific help, please type rda --help <command>
        eg:
            rda --help show

Sc_manager command

Managing QoreStor > Sc_manager command

The sc_manager command have the following functions:

Displays the current status of Secure Connect.
Enables Secure Connect
Disables Secure Connect

Sc_manager Command Usage

Managing QoreStor > Sc_manager command > Sc_manager Command Usage

The following commands are run for sc_manager:

sc_manager --status
sc_manager --disable
sc_manager --enable

sc_manager status --property <path_to_sc_client.property_file>

Managing QoreStor > Sc_manager command > Sc_manager Command Usage > sc_manager status --property <path_to_sc_client.property_file>

NOTE: The sc_manager command must be run using the root account.

Description

Displays the Secure Connect status for the machine on which the command is run.

Syntax

If run from the directory containing the sc_client.property file:

sc_manager status

If run from a different directory:

/opt/qorestor/bin/sc_manager status --property <path_to_sc_client.property_file>

Result

SecureConnect.enabled = true

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