+ CLI Guide Overview - Revision history

Qadmin at 20:18, 16 September 2022

2022-09-16T20:18:55Z

← Older revision		Revision as of 20:18, 16 September 2022
Line 10:		Line 10:

	==Authentication==		==Authentication==
	''It is important to note that running the ''qs'' CLI locally as ''root'' affords no additional access privileges. Each command run via the CLI must include the ''--server'' specification which includes which server and what credentials should be used to access the system with.''		''It is important to note that running the ''qs'' CLI locally as ''root'' affords no additional access privileges. Each command run via the CLI must include the ''--server'' specification which includes which server and what credentials should be used to access the system with. The QuantaStor CLI uses the same REST API calls that the QuantaStor Web User Interface (WUI) does. For this reason if you change the QuantaStor user "admin"'s default password, you will need to use one of the following authentication methods.''
	=== Authentication via --server Argument ===		=== Authentication via --server Argument ===
	All CLI commands accept the server specification argument which is of this form:		All CLI commands accept the server specification argument which is of this form:
Line 25:		Line 25:
	export QS_SERVER=myhostname.domain.net,mike,mypass123		export QS_SERVER=myhostname.domain.net,mike,mypass123
	</pre>		</pre>
	=== Authentication via .qs.cnf Configuration File ===		=== Authentication via .qs.cnf Configuration File Using Password ===
	Finally, rather than using an environment variable you can also create a file in your home directory called .qs.cnf with your credentials in it. Here's an example of how to create the file:		Finally, rather than using an environment variable you can also create a file in your home directory called .qs.cnf with your credentials in it. Here's an example of how to create the file:
	<pre>		<pre>
Line 31:		Line 31:
	chmod 600 ~/.qs.cnf		chmod 600 ~/.qs.cnf
	</pre>		</pre>
			=== Authentication via .qs.cnf Configuration File Using Passwordless Token ===
			IF a QuantaStor user is configured with "Enable '[QSCLITKN]' token based authentication for QS CLI via 'root' console account" then the users password will not have to be added to the .qs.cnf file as described above.
			This user option can be set in the WUI or via the command line.
			If the admin users default password has not been changed, then the following command will enable token based authentication at the command line:
			<pre>
			qs user-modify --user=admin --cli-auth=true
			</pre>
			If the admin users password has been changed, then the QuantaStor Web UI / Security tab / admin user / right mouse Modify User / Advanced Settings tab / Enable '[QSCLITKN]' token based authentication for QS CLI via 'root' console account can be checked to allow token based authentication.

			Once the admin user has this option checked, the following must be done to allow the root user to execute "qs" CLI commands without a password.

			<pre>
			echo "localhost,admin,[QSCLITKN]" > /root/.qs.cnf
			chmod 600 ~/.qs.cnf
			</pre>

			After that file is created a command such as "qs system-list" should work without error.

	==Usage==		==Usage==

Qadmin: /* CLI Command Reference Versions */

2022-01-25T00:47:49Z

CLI Command Reference Versions

← Older revision		Revision as of 00:47, 25 January 2022
Line 135:		Line 135:
	=CLI Command Reference Versions=		=CLI Command Reference Versions=

	Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting.		Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting. Click the link below to access the latest version of the QS CLI Reference documentation.

	===[[QuantaStor CLI Command Reference]]===		===[[QuantaStor CLI Command Reference]]===

Qadmin: /* CLI Command Reference Versions */

2022-01-25T00:47:12Z

CLI Command Reference Versions

← Older revision		Revision as of 00:47, 25 January 2022
Line 138:		Line 138:

	===[[QuantaStor CLI Command Reference]]===		===[[QuantaStor CLI Command Reference]]===

	~~=== Archived CLI Command Reference Documentation ===~~

	* [[QuantaStor CLI Command Reference v5.8]]
	* [[QuantaStor CLI Command Reference v5.6 & 5.7]]
	* [[QuantaStor CLI Command Reference v5.5]]
	* [[QuantaStor CLI Command Reference v5.4]]
	* [[QuantaStor CLI Command Reference v5.3]]
	* [[QuantaStor CLI Command Reference v5.2]]

	~~====[[QuantaStor CLI Command Reference v4.3]]====~~
	CHANGES: Adds commands for disk-multipath-config-add/list/remove/scan, site-cluster-restart-services, pool-add-write-log, pool-remove-write-log, replica-report-entry-get/list, replica-report-summary-get/list/delete, password-policy-get/set, share-session-get/list. session-list/get/close was renamed to volume-session-list/get/close, target-port commands are now network-port commands. To maintain backward compatibility the old command names still work but are marked as deprecated.

	~~====[[QuantaStor CLI Command Reference v4.2]]====~~
	NOTES: QuantaStor v4.2 introduces new CLI commands for creation of pass-thru Storage Volumes so that NVMe and other physical devices and be presented directly to HA control nodes via iSCSI/FC. Additionally new commands are added for creation of Network Share aliases and sub-shares.

Qadmin: /* CLI Command Reference Versions */

2021-07-22T21:08:22Z

CLI Command Reference Versions

← Older revision		Revision as of 21:08, 22 July 2021
Line 137:		Line 137:
	Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting.		Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting.

	===[[QuantaStor CLI Command Reference ~~v5.8~~]]===		===[[QuantaStor CLI Command Reference]]===

	=== Archived CLI Command Reference Documentation ===		=== Archived CLI Command Reference Documentation ===

	~~====~~[[QuantaStor CLI Command Reference v5.6 & 5.7]]~~====~~		* [[QuantaStor CLI Command Reference v5.8]]
			* [[QuantaStor CLI Command Reference v5.6 & 5.7]]
	~~====~~[[QuantaStor CLI Command Reference v5.5]]~~====~~		* [[QuantaStor CLI Command Reference v5.5]]
			* [[QuantaStor CLI Command Reference v5.4]]
	~~====~~[[QuantaStor CLI Command Reference v5.4]]~~====~~		* [[QuantaStor CLI Command Reference v5.3]]
			* [[QuantaStor CLI Command Reference v5.2]]

	~~====~~[[QuantaStor CLI Command Reference v5.3]]~~====~~


	~~====~~[[QuantaStor CLI Command Reference v5.2]]~~====~~

	====[[QuantaStor CLI Command Reference v4.3]]====		====[[QuantaStor CLI Command Reference v4.3]]====

Qadmin: /* Archived Command Reference Documentation */

2020-11-20T23:43:16Z

Archived Command Reference Documentation

← Older revision		Revision as of 23:43, 20 November 2020
Line 139:		Line 139:
	===[[QuantaStor CLI Command Reference v5.8]]===		===[[QuantaStor CLI Command Reference v5.8]]===

	=== Archived Command Reference Documentation ===		=== Archived CLI Command Reference Documentation ===

	====[[QuantaStor CLI Command Reference v5.6 & 5.7]]====		====[[QuantaStor CLI Command Reference v5.6 & 5.7]]====

Qadmin: /* CLI Command Reference Versions */

2020-11-20T23:42:41Z

CLI Command Reference Versions

← Older revision		Revision as of 23:42, 20 November 2020
Line 137:		Line 137:
	Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting.		Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting.

	===[[QuantaStor CLI Command Reference v5.~~6 & 5.7~~]]===		===[[QuantaStor CLI Command Reference v5.8]]===

			=== Archived Command Reference Documentation ===

	===[[QuantaStor CLI Command Reference v5.5]]===		====[[QuantaStor CLI Command Reference v5.6 & 5.7]]====

			====[[QuantaStor CLI Command Reference v5.5]]====

	===[[QuantaStor CLI Command Reference v5.4]]===		====[[QuantaStor CLI Command Reference v5.4]]====


	===[[QuantaStor CLI Command Reference v5.3]]===		====[[QuantaStor CLI Command Reference v5.3]]====


	===[[QuantaStor CLI Command Reference v5.2]]===		====[[QuantaStor CLI Command Reference v5.2]]====

	===[[QuantaStor CLI Command Reference v4.3]]===		====[[QuantaStor CLI Command Reference v4.3]]====
	CHANGES: Adds commands for disk-multipath-config-add/list/remove/scan, site-cluster-restart-services, pool-add-write-log, pool-remove-write-log, replica-report-entry-get/list, replica-report-summary-get/list/delete, password-policy-get/set, share-session-get/list. session-list/get/close was renamed to volume-session-list/get/close, target-port commands are now network-port commands. To maintain backward compatibility the old command names still work but are marked as deprecated.		CHANGES: Adds commands for disk-multipath-config-add/list/remove/scan, site-cluster-restart-services, pool-add-write-log, pool-remove-write-log, replica-report-entry-get/list, replica-report-summary-get/list/delete, password-policy-get/set, share-session-get/list. session-list/get/close was renamed to volume-session-list/get/close, target-port commands are now network-port commands. To maintain backward compatibility the old command names still work but are marked as deprecated.

	===[[QuantaStor CLI Command Reference v4.2]]===		====[[QuantaStor CLI Command Reference v4.2]]====
	NOTES: QuantaStor v4.2 introduces new CLI commands for creation of pass-thru Storage Volumes so that NVMe and other physical devices and be presented directly to HA control nodes via iSCSI/FC. Additionally new commands are added for creation of Network Share aliases and sub-shares.		NOTES: QuantaStor v4.2 introduces new CLI commands for creation of pass-thru Storage Volumes so that NVMe and other physical devices and be presented directly to HA control nodes via iSCSI/FC. Additionally new commands are added for creation of Network Share aliases and sub-shares.

Qadmin: /* How to use the CLI */

2020-10-26T19:14:28Z

How to use the CLI

← Older revision		Revision as of 19:14, 26 October 2020
Line 4:		Line 4:
	=How to use the CLI=		=How to use the CLI=
	QuantaStor CLI is a full featured interface into all of the QuantaStor management features and can communicates with the local core management service as well as remote storage systems.		QuantaStor CLI is a full featured interface into all of the QuantaStor management features and can communicates with the local core management service as well as remote storage systems.


	''' OSNEXUS Videos '''		''' OSNEXUS Videos '''

Qadmin at 19:13, 26 October 2020

2020-10-26T19:13:32Z

← Older revision		Revision as of 19:13, 26 October 2020
Line 1:		Line 1:
	[[Category:cli_guide]]		[[Category:cli_guide]]
	The QuantaStor command line interface (CLI) can be used to remotely manage your QuantaStor based systems via a Windows or Linux system, and it is also a powerful tool for scripting the configuration and provisioning of storage volumes, network shares, and other resources. The command line utility for managing your QuantaStor system is called simply 'qs'. You can run 'qs' after logging into your QuantaStor system via an SSH connection, or you can download the QuantaStor Remote CLI client installer for Windows which is available for download from the OSNEXUS web site.		The QuantaStor command line interface (CLI) can be used to remotely manage your QuantaStor based systems via a Windows or Linux system, and it is also a powerful tool for scripting the configuration and provisioning of storage volumes, network shares, and other resources. The command line utility for managing your QuantaStor system is called simply 'qs'. You can run 'qs' after logging into your QuantaStor system via an SSH connection, or you can download the QuantaStor Remote CLI client installer for Windows which is available for download from the OSNEXUS web site.

			=How to use the CLI=
			QuantaStor CLI is a full featured interface into all of the QuantaStor management features and can communicates with the local core management service as well as remote storage systems.

	''' OSNEXUS Videos '''		''' OSNEXUS Videos '''
	* [[Image:youtube_icon.png\|50px\|link=https://www.youtube.com/watch?v=WiUu-Eq1zm8]] [https://www.youtube.com/watch?v=WiUu-Eq1zm8 Covers Introduction to QS CLI and how to script storage provisioning [25:31]]		* [[Image:youtube_icon.png\|50px\|link=https://www.youtube.com/watch?v=WiUu-Eq1zm8]] [https://www.youtube.com/watch?v=WiUu-Eq1zm8 Covers Introduction to QS CLI and how to script storage provisioning [25:31]]

	~~=How to use the CLI=~~
	~~QuantaStor CLI is a full featured interface into all of the QuantaStor management features and can communicates with the local core management service as well as remote storage systems.~~

	==Authentication==		==Authentication==

Qadmin at 19:12, 26 October 2020

2020-10-26T19:12:52Z

← Older revision		Revision as of 19:12, 26 October 2020
Line 1:		Line 1:
	[[Category:cli_guide]]		[[Category:cli_guide]]
	The QuantaStor command line interface (CLI) can be used to remotely manage your QuantaStor based systems via a Windows or Linux system, and it is also a powerful tool for scripting the configuration and provisioning of storage volumes, network shares, and other resources. The command line utility for managing your QuantaStor system is called simply 'qs'. You can run 'qs' after logging into your QuantaStor system via an SSH connection, or you can download the QuantaStor Remote CLI client installer for Windows which is available for download from the OSNEXUS web site.		The QuantaStor command line interface (CLI) can be used to remotely manage your QuantaStor based systems via a Windows or Linux system, and it is also a powerful tool for scripting the configuration and provisioning of storage volumes, network shares, and other resources. The command line utility for managing your QuantaStor system is called simply 'qs'. You can run 'qs' after logging into your QuantaStor system via an SSH connection, or you can download the QuantaStor Remote CLI client installer for Windows which is available for download from the OSNEXUS web site.

			''' OSNEXUS Videos '''
			* [[Image:youtube_icon.png\|50px\|link=https://www.youtube.com/watch?v=WiUu-Eq1zm8]] [https://www.youtube.com/watch?v=WiUu-Eq1zm8 Covers Introduction to QS CLI and how to script storage provisioning [25:31]]

	=How to use the CLI=		=How to use the CLI=

Qadmin: /* CLI Command Reference Versions */

2020-07-14T20:20:06Z

CLI Command Reference Versions

← Older revision		Revision as of 20:20, 14 July 2020
Line 132:		Line 132:

	Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting.		Each new release of QuantaStor CLI generates an updated specification which can be found below. All effort is made to maintain backward compatibility between versions but we recommend that the XML mode be used for scripting.

			===[[QuantaStor CLI Command Reference v5.6 & 5.7]]===


	===[[QuantaStor CLI Command Reference v5.5]]===		===[[QuantaStor CLI Command Reference v5.5]]===