QS CLI Reference v5.2 - Revision history

Qadmin at 20:21, 14 July 2020

2020-07-14T20:21:53Z

← Older revision		Revision as of 20:21, 14 July 2020
Line 1:		Line 1:
	~~[[Category:cli_guide]]~~
	<code>		<code>
	OSNEXUS QuantaStor CLI 5.2.0		OSNEXUS QuantaStor CLI 5.2.0

Qadmin at 19:40, 4 May 2019

2019-05-04T19:40:31Z

Show changes

Qadmin at 19:30, 4 May 2019

2019-05-04T19:30:31Z

← Older revision		Revision as of 19:30, 4 May 2019
Line 257:		Line 257:
	\|   \|\| <tt>backup-to-root</tt> \|\| Indicates that the backups should go into the root folder of the Network Share.		\|   \|\| <tt>backup-to-root</tt> \|\| Indicates that the backups should go into the root folder of the Network Share.
	\|-		\|-
	\|   \|\| <tt>maintain-logs</tt> \|\| Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the ~~appliance~~.		\|   \|\| <tt>maintain-logs</tt> \|\| Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the system.
	\|-		\|-
	\|   \|\| <tt>start-date</tt> \|\| Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 \| 2016-12-29T00:00:00Z)		\|   \|\| <tt>start-date</tt> \|\| Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 \| 2016-12-29T00:00:00Z)
Line 370:		Line 370:
	\|   \|\| <tt>backup-to-root</tt> \|\| Indicates that the backups should go into the root folder of the Network Share.		\|   \|\| <tt>backup-to-root</tt> \|\| Indicates that the backups should go into the root folder of the Network Share.
	\|-		\|-
	\|   \|\| <tt>maintain-logs</tt> \|\| Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the ~~appliance~~.		\|   \|\| <tt>maintain-logs</tt> \|\| Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the system.
	\|-		\|-
	\|   \|\| <tt>start-date</tt> \|\| Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 \| 2016-12-29T00:00:00Z)		\|   \|\| <tt>start-date</tt> \|\| Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 \| 2016-12-29T00:00:00Z)
Line 6,991:		Line 6,991:
	\|   \|\| <tt>lock-account</tt> \|\| Set to 'true' to lock the account, 'false' to unlock the user account.		\|   \|\| <tt>lock-account</tt> \|\| Set to 'true' to lock the account, 'false' to unlock the user account.
	\|-		\|-
	\|   \|\| <tt>cli-auth</tt> \|\| Allow the root user account within a QuantaStor ~~appliance~~ to use token based authentication to use this account without having to supply a plain-text password.		\|   \|\| <tt>cli-auth</tt> \|\| Allow the root user account within a QuantaStor System to use token based authentication to use this account without having to supply a plain-text password.
	\|-		\|-
	\|   \|\| <tt>alerts</tt> \|\| Alert types to subscribe to. Alerts at the subscribed level are sent to the user's email address automatically when a SMTP server is configured. [critical, error, info, *none, warning]		\|   \|\| <tt>alerts</tt> \|\| Alert types to subscribe to. Alerts at the subscribed level are sent to the user's email address automatically when a SMTP server is configured. [critical, error, info, *none, warning]

Qadmin: /* backup-policy-create */

2019-05-03T17:30:12Z

backup-policy-create

← Older revision		Revision as of 17:30, 3 May 2019
Line 206:		Line 206:

	===backup-policy-create===		===backup-policy-create===
	Creates a ingest backup policy which pull data from NFS shares to the QuantaStor ~~appliance~~.		Creates a ingest backup policy which pull data from NFS shares to the QuantaStor System.

	<pre> qs backup-policy-create\|bp-create --name=value --desc=value --network-share=value --remote-hostname=value --remote-export-path=value --scan-threads=value [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] [--age-days-min=value ] [--age-days-max=value ] </pre>		<pre> qs backup-policy-create\|bp-create --name=value --desc=value --network-share=value --remote-hostname=value --remote-export-path=value --scan-threads=value [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] [--age-days-min=value ] [--age-days-max=value ] </pre>
Line 271:		Line 271:
	\|   \|\| <tt>age-days-max</tt> \|\| Maximum number of days old the file may be for it to be backed up by the Backup Policy. Setting this to 0 indicates no maximum age. By setting both a minimum and a maximum of 0 all files are backed up. By setting one or both of a minimum and maximum age a file age range may be specified.		\|   \|\| <tt>age-days-max</tt> \|\| Maximum number of days old the file may be for it to be backed up by the Backup Policy. Setting this to 0 indicates no maximum age. By setting both a minimum and a maximum of 0 all files are backed up. By setting one or both of a minimum and maximum age a file age range may be specified.
	\|}		\|}


	===backup-policy-delete===		===backup-policy-delete===

Qadmin: Qadmin moved page QuantaStor CLI Command Reference v5.2 to QS CLI Reference v5.2

2019-03-21T23:00:47Z

Qadmin moved page QuantaStor CLI Command Reference v5.2 to QS CLI Reference v5.2

← Older revision		Revision as of 23:00, 21 March 2019
(No difference)

Qadmin at 22:58, 21 March 2019

2019-03-21T22:58:45Z

← Older revision		Revision as of 22:58, 21 March 2019
Line 1:		Line 1:
			[[Category:cli_guide]]
	<code>		<code>
	OSNEXUS QuantaStor CLI 5.2.0		OSNEXUS QuantaStor CLI 5.2.0

Qadmin: /* tc-commands */

2019-03-21T21:51:15Z

tc-commands

@@ Line 57: / Line 57: @@
 |-
 | &nbsp; || <tt>api</tt> || Generates help output in a parsable format for automating API.
 |}


2019-03-21T21:50:21Z
Created page with "<code> OSNEXUS QuantaStor CLI 5.2.0 Copyright (c) 2009-2019 OSNEXUS Corporation.  All rights reserved.  USAGE     qs COMMAND --mandatory-arg=value [--optional-arg=value] [--fl..."
Show changes

QS CLI Reference v5.2 - Revision history

Qadmin at 20:21, 14 July 2020

Qadmin at 19:40, 4 May 2019

Qadmin at 19:30, 4 May 2019

Qadmin: /* backup-policy-create */

Qadmin: Qadmin moved page QuantaStor CLI Command Reference v5.2 to QS CLI Reference v5.2

Qadmin at 22:58, 21 March 2019

Qadmin: /* tc-commands */

Qadmin: Created page with " OSNEXUS QuantaStor CLI 5.2.0 Copyright (c) 2009-2019 OSNEXUS Corporation. All rights reserved. USAGE qs COMMAND --mandatory-arg=value [--optional-arg=value] [--fl..."

Qadmin: Created page with " `OSNEXUS QuantaStor CLI 5.2.0 Copyright (c) 2009-2019 OSNEXUS Corporation. All rights reserved. USAGE qs COMMAND --mandatory-arg=value [--optional-arg=value] [--fl..."`