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

storage_group --update --name <name> [--compression_mode <fast|best>]

Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --update --name <name> [--compression_mode <fast|best>]

Description

Allows you to modify the settings for the specified storage group.

Syntax

storage_group --update --name <name> [--compression_mode <fast|best>] [--quota <Quota value in GiB or TiB>]

Where

--name			Name of the storage group. Valid values are [a-z,A-Z,0-9,'-' and '_'] and maximum of 32 characters.
--compression_mode	 Valid values are Fast and Best
--quota		 Quota value in GiB or TiB.

Result

Storage Group "StorageGroup_1" updated successfully.

storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]

Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]

Description

Allows you to set the encryption level for a specified storage group on the QoreStor. You turn encryption on or off by using the --set ON or --set OFF command options. The --mode option sets the mode of key lifecycle management as one of the following:

static—A global, fixed key is used to encrypt all data.
internal—Content encryption keys are generated and rotated on a specified period of days.

If you select Internal as the mode of key management, you need to set the --interval option, which specifies the number of days for key rotation when a new key is to be generated.

	NOTE: In Internal mode there is a maximum limit of 1023 keys. The key rotation period is set to 30 days by default when the passphrase is set and/or encryption is turned on. You can later change the key rotation period from 7 days to 70 years for internal mode.
	NOTE: After encryption is enabled, all of the data that is backed up is encrypted and is kept encrypted until it is expired and cleaned by the system cleaner. Note that encryption is an irreversible process.

NOTE: Due to export regulations, the encryption at rest feature is not available in certain markets, and, therefore, may not be available in your locale.

Syntax

storage_group --encryption --name <name> [--set <ON | OFF>] [--mode < static | internal >] [--interval <7 days to 70 years>]

Where

--name       Name of the storage group. Valid values are [a-z,A-Z,0-9,'-' and '_'] and maximum of 32 characters.
--set        Valid values are On and Off.
--mode       Valid values are static and internal.
--interval   Valid values are between 7 days to 70 years (in days)

Result

Storage Group "StorageGroup_1" updated successfully.

storage_group --delete --name <name>

Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --delete --name <name>

Description

Deletes the specified storage group from the QoreStor.

NOTE: Before a storage group can be deleted, all of the containers inside the storage group must first be deleted.

Syntax

storage_group --delete --name <name>

Where

--name   Name of storage_group.

Result

Storage Group "StorageGroup_1" has been deleted.

storage_group --setpassphrase --name <name>

Managing QoreStor > Storage Group commands > Storage Group Command Usage > storage_group --setpassphrase --name <name>

Description

Sets the passphrase for the specified storage group to be used to encrypt content encryption keys. (The passphrase string can take up to 255 characters. And, alphanumeric and special characters can be entered as part of the passphrase string.) This command will prompt you to enter and confirm a passphrase. This command also requires a filesystem server restart.

NOTE: It is mandatory to define a passphrase to enable encryption for a storage group. If the passphrase is compromised or lost, the administrator should change it immediately so that the content encryption keys do not become vulnerable.

Syntax

storage_group --setpassphrase --name <name>

Where

--name   Storage group name

Result

Storage Group "StorageGroup_1" updated successfully.
Passphrase updated successfully.

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

storage_group --update --name <name> [--compression_mode <fast|best>]

Description

Syntax

Result

storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]

Description

Syntax

Result

storage_group --delete --name <name>

Description

Syntax

Result

storage_group --setpassphrase --name <name>

Description

Syntax

Result