Chat now with support
Chat with Support

QoreStor 7.1.1 - Command Line Reference Guide

Introduction to the QoreStor Command Line Reference Guide Introducing QoreStor Managing QoreStor
Alerts Commands Authenticate Commands Email_alerts Commands Email_stats 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

rda --help

Decription

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

Syntax

rda --help

Result

	rda --show [--config]
		[--file_history] [--name <name>]
		[--active_files] [--name <name>]
		[--clients]
		[--limits]

	rda --update --opdup_encryption <none | aes128 | aes256>
				
	rda --delete_client --name <RDA Client Hostname>

	rda --update_client --name <RDA Client Hostname> --mode <auto|passthrough|dedupe>

	rda --limit --speed <<num><KBps|MBps|GBps> | default> --target <ip address | hostname>

	rda --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]

	rda --help

	rda <command> <command-arguments>
   <command> can be one of:
		--show			Displays command specific information.
		--delete_client		Deletes the Rapid Data Access (RDA) client.
		--update_client		Updates attributes of a Rapid Data Access (RDA) client.
		--limit			Delete existing bandwidth rules for all ports and set new throttling limits for RDA replication over WAN.
		--partial_images	Lists or cleans up partial images.

For command-specific help, please type rda --help <command>
        eg:
            rda --help show

SAML

SAML is the protocol QoreStor uses to provide multi-factor authentication (MFA) and single sign-on (SSO) through third-party service providers.

This set of QoreStor CLI commands allow you to perform the following configuration for SAML:

  • Add a SAML configuration
  • Update a SAML configuration with changes
  • Show a list of existing SAML configurations
  • Delete a configuration

SAML configuration command usage

This topic introduces the saml_cfgcommand usage:

  • saml_cfg --add
  • saml_cfg --update
  • saml_cfg --show
  • saml_cfg --delete
  • saml_cfg --help

NOTE: If you specify a command without supplying the expected value or option, you will be prompted to provide the correct value or option.

saml_cfg --help

Description

Displays a list of all commands for managing a SAML configuration with a compatible identity provider (IDP) when using the QoreStor CLI.

Syntax

saml_cfg --help

Result 

Usage:
	saml_cfg --add [--idp_entity_id <anything>]
			[--idp_login_url <anything>]
			[--idp_logout_url <anything>]
			[--idp_metadata_url <anything>]
	saml_cfg --update [--idp_entity_id <anything>]
			[--idp_login_url <anything>]
			[--idp_logout_url <anything>]	
			--idp_metadata_url <anything>
	saml_cfg --show
	saml_cfg --delete
	saml_cfg --help

saml_cfg <command> <command-arguments>
<command> can be one of:
	--add      Add SAML Configuration to this system.
	--update   Updates SAML Configuration.
	--show     Display SAML Configuration.
	--delete   Delete SAML Configuration.

For command-specific help, please type saml_cfg --help <command>

	eg:
		saml_cfg --help add
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating