QoreStor 6.1.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 --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 --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

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 --set_rw --name <name> [--id <number>] vtl --show_replstate --name <name> vtl --help

Maintaining QoreStor

Maintenance

Maintenance command

About us

connection --delete --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>]

Managing QoreStor Storage Operations > Connection > Connection Command Usage > connection --delete --name <name> --type <NFS||||||FC> [--clients <ip address>]

Description

Deletes an existing container connection.

Syntax

connection --delete --name <name> --type <NFS|||||> [--clients <ip address>]

Where

--name      Name of container.
--type      Type of sharing to remove (NFS|||||).
--clients   List of comma separated hs.

Result

Successfully deleted connection entry.

connection --enable --name <name> --type <NFS|CIFS|OST|RDS>

Managing QoreStor Storage Operations > Connection > Connection Command Usage > connection --enable --name <name> --type <NFS|||RDS>

Description

Enables access to a container through a connection.

Syntax

connection --enable --name <name> --type <NFS|||RDS>

Where

--name   Name of container.
--type   Type of sharing (NFS|||RDS).

Result

Successfully updated connection entry.
RDS connection Quota            : Unlimited
RDS connection Used Capacity    : 257.0 GiB
RDS connection Enabled          : Yes

connection --disable --name <name> --type <NFS|CIFS|OST|RDS>

Managing QoreStor Storage Operations > Connection > Connection Command Usage > connection --disable --name <name> --type <NFS|||RDS>

Description

Disables access to a container through a connection.

Syntax

connection --disable --name <name> --type <NFS|||RDS>

Where

--name   Name of container.
--type   Type of sharing (NFS|||RDS).

Result

Successfully updated connection entry.
 connection Quota 						: Unlimited
 connection Used Capacity	: 5.0 GB
 connection Enabled 					: No

connection --help

Managing QoreStor Storage Operations > Connection > Connection Command Usage > connection --help

Description

Displays the listing of user and related options that you can use as a reference when using the QoreStor CLI.

Syntax

connection --help

Results

Usage:
	connection --show 
		[--name <name>]
		[--type <NFS|CIFS|OST|RDS|NDMP|ISCSI>]
		[--verbose]
				
	connection --add --name <name>
		--type <NFS|CIFS|OST|RDS|NDMP|ISCSI>
		[--clients <ip address>]
		[--dma <ip address>]
		[--initiator <IQN, ip address, hostname, or WWPN>]
		[--rootmap <nobody | root | administrator>]
		[--options <NFS | CIFS mount export options>]
		[--capacity <Positive decimal number>]
				
	connection --update --name <name>
		--type <NFS|CIFS|OST|RDS|NDMP|ISCSI>
		[--clients <ip address>]
		[--dma <ip address>]
		[--initiator <IQN, ip address, hostname, or WWPN>]
		[--rootmap <nobody | root | administrator>]
		[--options <NFS | CIFS mount export options>]
		[--capacity <Positive decimal number>]
				
	connection --delete --name <name>
		--type <NFS|CIFS|OST|RDS|NDMP|ISCSI>
		[--clients <ip address>]
				
	connection --enable --name <name>
		--type <NFS|CIFS|OST|RDS>
				
	connection --disable --name <name>
		--type <NFS|CIFS|OST|RDS>
				
	connection --help
				
	connection <command> <command-arguments>
	<command> can be one of:
		--show      Displays the current connections on a container.
		--add       Adds a new connection to a container.
		--update    Updates an existing connection.
		--delete    Deletes an existing connection.
		--enable    Enables access to a container through a connection.
		--disable   Disables access to a container through a connection.
				
	For command-specific help, please type connection --help <command>
	eg:
	connection --help show

Please select your product:

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

Recommended Solutions for Your Problem

QoreStor 6.1.0 - Command Line Reference Guide

connection --delete --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>]

Description

Syntax

Result

connection --enable --name <name> --type <NFS|CIFS|OST|RDS>

Description

Syntax

Result

connection --disable --name <name> --type <NFS|CIFS|OST|RDS>

Description

Syntax

Result

connection --help

Description

Syntax

Results