Chat now with support
Chat with Support

QoreStor 7.3.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
Managing QoreStor Storage Operations
Cloud_tier Connection Container iSCSI NDMP Object_container Object_direct Performance_tier Replication Seed Schedule VTL
Maintaining QoreStor About us

schedule --show [--cleaner]

Description

Displays any existing Cleaner schedule.

Syntax

schedule --show [--cleaner]
	         [--replication] 
		 [--cloudreplication]
		 [--cloud_archive]
		 [--name <name>]]

Where

--cleaner            Displays the cleaner schedule.
--replication        Displays all configured replication schedule(s).
--cloudreplication   Displays all configured cloud replication schedule(s).
--cloud_archive      This is used for cloud_replication. It sets cloud tier by default. For archive tier, use --cloud_archive.
--name               Display replication schedule of a specific container.

Result

Cleaner Schedule:
			Start   Stop
Sunday 		05:00   06:00
Monday 		05:00   06:00
Tuesday 		05:00   06:00
Wednesday 		05:00   06:00
Thursday 		05:00   06:00
Friday 		05:00   06:00
Saturday 		05:00   06:00

schedule --add --day <day of the week> [--cleaner] [--replication] [--start_time <hh:mm>] [-- stop_time <hh:mm>] [--name <name>]

Description

Creates a new Cleaner or Replication schedule for a QoreStor instance.

NOTE: Without any Cleaner schedule set, the QoreStor Cleaner process automatically starts within two minutes after it detects that no data ingest operation or other system operation activity is present. So, if your QoreStor runs intermittent or inconsistent ingest or readback, or replication operations, there is no need to set a Cleaner schedule (it will automatically run during periods of low or non-activity). However, if your system runs regular and consistent ingest or readback you should create a Cleaner schedule that runs only during a known period of low or non-activity (for example, on a day or time period sufficient to complete this process). If your system does not meet either of these cases, you can still manually run the Cleaner. For more information, see maintenance filesystem --stop_reclaim_space <storage group name>.

Syntax

schedule --add --day <Day of the week (Sunday|Monday...)>
	[--cleaner]
	[--replication]
	[--cloudreplication]
	[--start_time <HH:MM>]
	[--stop_time <HH:MM>]
	[--name <name>]
	[--cloud_archive]

Where

--day                Day of the week to add.
--cleaner            Set up a cleaner schedule.
--replication        Set up a replication schedule.
--cloudreplication   Set up a cloud replication schedule.
--start_time         Schedule start time in HH:MM format, 00:00 - 23:59 are valid values. To disable or continue from previous day, use -:- for start time.
--stop_time          Schedule stop time in HH:MM format, 00:01 - 24:00 are valid values. To continue to next day, use -:- for stop time.
--name               Replication source Container Name.
--cloud_archive      This is used for cloud_replication. It sets cloud tier by default. For archive tier, use --cloud_archive.

NOTE: Set a corresponding stop time for every start time in each Cleaner (or Replication) schedule you create.

NOTE: Do not select 00:00 for a start time or stop time endpoint for midnight when setting Cleaner or Replication schedules (instead, use either the 23:55 or 00:05 value).

Result

Successfully updated Cleaner schedule.

NOTE: To create a Replication schedule (use the QoreStor CLI --replication command), and the same process shown here to schedule the start and stop times for a Replication schedule. This lets you schedule start and stop times for each day in the week in which you want the Replication process to run.

schedule --delete --day <day of the week> [--cleaner] [--name <name>] [--replication]

Description

Deletes a day in an existing Cleaner or Replication schedule for a QoreStor instance. The --name option is only applicable for replication and not for the cleaner. You can use it to specify a container.

NOTE: To delete days from either an existing Cleaner or Replication schedule, specify the day in the week and the schedule type.

Syntax

schedule --delete --day <Day of the week (Sunday|Monday...)>
	[--cleaner]
	[--name <name>]
	[--replication]
	[--cloudreplication]
       [--cloud_archive]

Where

--day                Day of the schedule to delete.
--cleaner            Delete a cleaner schedule.
--name               Replication source Container Name.
--replication        Delete a specific replication source container's schedule.
--cloudreplication   Delete a specific cloud replication source container's schedule.
--cloud_archive      With cloud_replication, set a cloud tier by default. Also for an archive tier.

Result

Successfully updated Cleaner schedule.

schedule --help

Description

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

Syntax

schedule --help

Result

Usage:
schedule --show [--cleaner]
	[--replication]
	[--cloudreplication]
       [--cloud_archive]
	[--name <name>]
			
schedule --add --day <Day of the week (Sunday|Monday...)>
	[--cleaner]
	[--replication]
	[--cloudreplication]
	[--start_time <HH:MM>]
	[--stop_time <HH:MM>]	
	[--name <name>]
       [--cloud_archive]
			
schedule --delete --day <Day of the week (Sunday|Monday...)>
	[--cleaner]
	[--name <name>]
	[--replication]
	[--cloudreplication]
       [--cloud_archive]
					
schedule --help
					
schedule <command> <command-arguments>
<command> can be one of:
			
	--show     Displays command specific information.
	--add      Adds a schedule for cleaner (use on source DR).
	--delete   Deletes a cleaner schedule (use on source DR).
			
For command-specific help, please type schedule --help <command>
eg:
schedule --help show
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating