Chat now with support
Chat with Support

QoreStor 7.1.3 - Command Line Reference Guide

Introduction to the QoreStor Command Line Reference Guide Introducing QoreStor Managing QoreStor
Alerts Commands Authenticate Commands Email_alerts Commands OST RDA SAML sc_manager command Stats Storage Group commands System User
Managing QoreStor Storage Operations
Cloud_tier Connection Container iSCSI NDMP Object_container Object_direct Performance_tier Replication Seed Schedule VTL
Maintaining QoreStor About us

object_container --setpassphrase

Description

Sets passphrase to an object container.

Syntax

object_container --setpassphrase

Result

Enter current passphrase:
Enter new passphrase:
Re-type passphrase:
Storage Group "ObjectContainer" updated successfully.
Passphrase updated successfully.

object_container --bucket

Description

Create, delete, or list buckets in an object container.

Syntax

object_container --bucket [--create][--enable-object-lock] [--name <bucket name>][--delete] [--name <bucket name>][--set-lock] [--name <bucket name>] [--mode <compliance|governance|none>] 
	[--valid-days <1 to 36500 days>] [--valid-years <1 to 100 years>][--set-retention] [--name <bucket name>] [--retention-mode <compliance|governance>] 
	[--valid-days <1 to 36500 days>] [--valid-years <1 to 100 years>] [--object-prefix <anything>][--show] [--name <bucket name>][--list]

Where

--create               Creates a bucket.
--delete               Deletes a bucket.
--enable-object-lock   enable object locking
--set-lock             Set object lock configuration for a bucket.
--set-retention        Set object retention for objects with a given prefix.
--show                 Show the given bucket details.
--name                 bucket name
--mode                 Object lock configuration mode for a bucket. Valid values are "Compliance" or "Governance".
--retention-mode       Object lock configuration retention mode for an object prefix. Valid values are "Compliance" or "Governance".
--valid-days           Object lock configuration validity for a bucket in days.
--valid-years          Object lock configuration validity for a bucket in years.
--object-prefix        Object prefix to set retention
--list                 list all buckets.

Result

> object_container --bucket --create --name testbucket
Successfully created bucket: teststbucket.

object_container --policy

Description

Set or show policy of an object container.

Syntax

object_container --policy [--set] [--policy_type <readonly|readwrite|none>] --name <user name> [--show] --name <user name>

Where

--set           Set a policy to the user.
--show          Show a policy to the user.
--policy_type   Valid values are "readonly" or "readwrite" or "none".
--name          user name

Result

> object_container --policy --show --name backup_user
Object container user policy: readwrite

object_container --help

Description

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

Syntax

object_container --help

Result

object_container --show [--verbose]
	[--endpoint]
				
object_container --add [--quota <Quota value in GiB or TiB>] [--use_http <yes|no>]
				
object_container --update [--quota <Quota value in GiB or TiB>] [--use_http <yes|no>]
				
object_container --encryption [--set <ON | OFF>]
	[--mode < static | internal >]
	[--interval <7 days to 70 years>]
				
object_container --delete_data
				
object_container --delete
				
object_container --setpassphrase
				
object_container --bucket [--create] [--set-lock] [--set-retention] [--show] [--list] [--enable-object-lock] [--name <bucket name>] [--delete] [--name <bucket name>] [--name <bucket name>] [--mode <compliance|governance|none>] [--valid-days <1 to 36500 days>] [--valid-years <1 to 100 years>] [--name <bucket name>] [--retention-mode <compliance|governance>] [--valid-days <1 to 36500 days>] [--valid-years <1 to 100 years>] [--object-prefix <anything>] [--name <bucket name>]
	
				
object_container --policy [--set] [--policy_type <readonly|readwrite|none>] --name <user name> 
	[--show] --name <user name>
				
object_container --help
				
object_container <command> <command-arguments>
				
<command> can be one of:
	--show            Displays the current list of object_container.
	--add             Adds a new object_container.
	--update          updates an object_container.
	--encryption      updates encryption settings of an object_container.
	--delete_data     Deletes object_container container and its data.
	--delete          Deletes an existing object_container.
	--setpassphrase   sets passphrase to an object_container.
	--bucket          Create, delete or list buckets in an object_container.
	--policy          Set or show policy of object_container user.
For command-specific help, please type object_container --help <command>
	eg:
	object_container --help show
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating