QoreStor 7.0.0 - Command Line Reference Guide

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

OST

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

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

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

System Command Usage

system --show [--version] system --license [--validate] [--add] system --storage system --help

User

User Command Usage

Managing QoreStor Storage Operations

Cloud_tier

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

Connection Command Usage

Container

Container Command Usage

iSCSI

ISCSI Command Usage

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

NDMP

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

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

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

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

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

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

Maintenance command

About us

sc_manager enable --property <path_to_sc_client.property_file>

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

Description

Enables Secure Connect for the machine on which the command is run.

Syntax

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

sc_manager enable

If run from a different directory:

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

Result

SecureConnect.enabled = true

Stats

Managing QoreStor > Stats

This set of QoreStor CLI commands let you display the current statistics for a QoreStor in the following categories:

All containers (cumulative): --system
CPU: --cpu
Memory: --memory
NFS: --nfs
CIFS: --cifs
OST media server: --ost
RDS media server --rds
NDMP: --ndmp
Completed NDMP sessions: --ndmp_completed
iSCSI: --iscsi [--verbose]
A specific container: --container --name
Storage group: --storage_group --name <name>
Replication: --replication
Cleaner: --cleaner
Clients: --clients [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI>]
Seeding: --seed
Cloud tiers: --cloud_tier
Peformance tier: --performance_tier
Help: --help

In addition, this QoreStor CLI command also allows you to reset the following statistic types:

RDS --reset --rds

Stats Command Usage

Managing QoreStor > Stats > Stats Command Usage

This topic introduces the stats command usage:

stats --system
stats --cpu
stats --memory
stats --nfs
stats --cifs
stats --ost
stats --rds
stats --container --name
stats --storage_group --name
stats --replication [options]
stats --cleaner
stats --clients [options]
stats --reset [options]
stats --seed
stats --performance_tier
stats --cloud_tier
stats --object_direct
stats --archive_tier
stats --object_container
stats --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.

stats --system

Managing QoreStor > Stats > Stats Command Usage > stats --system

Description

Displays the current cumulative system statistics for all of the configured containers on a QoreStor.

Syntax

stats --system

Result

stats --system
Capacity Used                   : 0.0 GiB
Capacity Used in GB             : 0.000
Capacity Free                   : 690.5 GiB
Capacity Free in GB             : 741.394
Cloud Capacity Used             : 0.0 GiB
Cloud Capacity Used in GB       : 0.000
ObjectDirect Capacity Used      : 0.0 GiB
ObjectDirect Capacity Used in GB: 0.000
Archive Capacity Used           : 0.0 GiB
Archive Capacity Used in GB     : 0.000
Metadata Used                   : 256.0 GiB
Metadata Used in GB             : 274.895
Reserve Space                   : 0.0 GiB
Reserve Space in GB             : 0.000
Total Capacity                  : 1280.0 GiB
Total Capacity in GB            : 1374.406
Licensed Capacity               : 1280.0 GiB
Licensed Capacity in GB         : 1374.406
Read Throughput                 : 0.00 MiB/s
Write Throughput                : 0.00 MiB/s
Current Files                   : 0
Current Files Stubbed           : 0
Modified Files Uploaded to Cloud: 0
Modified Files Uploaded to Archive: 0
Current Bytes                   : 0
Current Stubbed Bytes           : 0
Current Local Bytes             : 0
Post Dedupe Bytes               : 0
Post Compression Bytes          : 0
Post Encryption Bytes           : 0
Post Encryption Bytes in GiB    : 0.0 GiB
Cleaner Status                  : Done
Compression Status              : Done
Total Inodes                    : 0
Bytes decrypted                 : 0
Dedupe Savings                  : 0.00 %
Compression Savings             : 0.00 %
Total Savings                   : 0.00 %
Local Dedupe Savings            : 0.00 %
Local Compression Savings       : 0.00 %
Local Total Savings             : 0.00 %

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

QoreStor 7.0.0 - Command Line Reference Guide

sc_manager enable --property <path_to_sc_client.property_file>

Description

Syntax

Result

Stats

Stats Command Usage

stats --system

Description

Syntax

Result