Chat now with support
Chat with Support

QoreStor 7.4.0 - Command Line Interface 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 Anomaly Detection
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 --user-enable

Description

Enables the user/accesskey.

Syntax

object_container --user-enable --name <container name> 
--user-name <user name>

Where

--name Name of the container 
--user-name Name of the user

Result

Successfully enabled user `backup_user` in `ObjectContainer1`.

NOTE: This command is valid for the Object containers created from QoreStor 7.4.0 onwards.

object_container --user-disable

Description

Disables the user/accesskey.

Syntax

object_container --user-disable --name <container name>
--user-name <user name>
            

Where

--name Name of the container
--user-name Name of the user


Result

Successfully disabled user `backup_user` in `ObjectContainer1`.

NOTE: This command is valid for the Object containers created from QoreStor version 7.4.0 and onwards.

object_container --user-list

Description

Lists the users/accesskeys on a store.

Syntax

object_container --user-list --name <container name>
            

Where

--name Name of the container

Result

enabled    backup_user
 

NOTE: This command is valid for the Object containers created from QoreStor 7.4.0 onwards.

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 [--name <container name>]
					
object_container --add --name <new container name>
 			[--group <group name>]
		        [--use-http <yes|no>]
object_container --start --name <container name> 
[--use-http <yes|no>]
object_container --stop --name <container name>
object_container --update [--compression_mode <fast|best>]
		 [--quota <Quota value in GiB or TiB>]	
		 [--use-http <yes|no>]
		 --name <container name>
object_container --encryption --name <ObjectContainer>
[--set <ON | OFF>]
[--mode < static | internal >]
[--interval <7 days to 70 years>]
								
object_container --delete_data --name <container name>
				
object_container --delete --name <container name>
object_container --setpassphrase --name <ObjectContainer>
object_container --bkt-add --name <container name>
		  --bkt-name <bucket name>
		 [--enable-object-lock]		
		 [--enable-object-versioning]
object_container --bkt-del --name <container name> 
		 --bkt-name <bucket name>


object_container --bkt-list --name <container name> 
		 [--bkt-name <bucket name>] 
		 [--object-prefix <anything> 
]

object_container --bkt-lock --name <container name>
		  --bkt-name <bucket name>		
		  --mode <compliance|governance|none>
		 [--object-name <anything>] 
                [--object-prefix <anything>]
		 [--valid-days <1 to 36500 days>]
		 [--valid-years <1 to 100 years>] 


object_container --bkt-version --name <container name>
		 --bkt-name <bucket name>
		 --mode <enable|suspend>
 
object_container --bkt-legalhold --name <container name> 
		--bkt-name <bucket name>	
		--mode <set|clear>
		[--object-name <anything>]
		[--object-prefix <anything>]
 

object_container --bkt-retention --name <container name> 
		--bkt-name <bucket name>
		--mode <compliance|governance|none>
		[--object-name <anything>]
		[--object-prefix <anything>]
		[--valid-days <1 to 36500 days>]
		[--valid-years <1 to 100 years>]

object_container --bkt-show --name <container name>
		--bkt-name <bucket name>
		[--object-name <anything>]
		[--object-prefix <anything>]
 
object_container --policy-list --name <container name>

object_container --policy-set --name <container name>
		  --policy-name <Policy name>
		  --user-name <user name>

object_container --policy-unset --name <container name>
		  --policy-name <Policy name>
		  --user-name <user name>


object_container --policy-update --name <container name> 
		  --policy-name <Policy name>
		  --user-name <user name>
object_container --policy-show --name <container name>   --user-name <user name> 

object_container --user-add --name <container name>
--user-name <user name>
object_container --user-del --name <container name>    
                 --user-name <user name>
object_container --user-enable --name <container name>  
                 --user-name <user name>
object_container --user-disable --name <container name> 
                 --user-name <user name>
object_container --user-list --name <container name>
object_container --cleaner-status [--name <container 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 and starts a connection to it.	
	--start            Start/Enable object container connection.
	--stop             Stop/Disable object container connection.
	--update           updates an object_container.
	--encryption       updates encryption settings of an object_container.
       --delete_data      Stop and deletes object_container and its data.
	--delete           Stops and deletes an existing object_container.
	--setpassphrase    sets passphrase to an object_container.
	--bkt-add          Create bucket in an object_container.
	--bkt-del          Delete a bucket/object(s) in an object_container.
	--bkt-list         List bucket(s)/object(s) in an object_container.
       --bkt-lock         Lock configuration of buckets specifically in ObjectContainer only.
	--bkt-version      Enable or suspend bucket versioning.
	--bkt-legalhold    Legalhold configuration of objects in a bucket for containers other than ObjectContainer.
	--bkt-retention    Retention configuration of bucket and objects inside it.
	--bkt-show         Show Locking and Retention configuration of a bucket and objects inside it.
	--policy-list      List all the available policies
	--policy-set       Set a policy to user
	--policy-unset     Unset a policy to user
	--policy-update    Update a policy to user
	--policy-show      Show policies set to a user
	--user-add         Create user/accesskey.
	--user-del         Delete user/accesskey.
	--user-enable      Enable user/accesskey.
	--user-disable     Disable user/accesskey.
	--user-list        List users/accesskeys on a store.
	--cleaner-status   Display status of MT trash cleaner
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating