Customer Configuration Keys Repository

Randomized abstract resource selection (RandomizeAbstractSelection)

Key	`<add key="RandomizeAbstractSelection" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Change the number of matches that are considered for abstract sub-resource requirements (AbstractSubResourceResultsPageSize)

Key	`<add key="AbstractSubResourceResultsPageSize" value="number of results"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	1000
Affected CloudShell Component	CloudShell Portal
Version	2021.1 and above

Setting the response page size (DefaultSandboxApiPagingSize)

Key	`<add key="DefaultSandboxApiPagingSize" value="1000"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	1000
Affected CloudShell Component	CloudShell API
Version	8.1 and above

Extending the API authorization token validity period (AuthToken.ExpirationSpanMinutes)

Key	`<add key="AuthToken.ExpirationSpanMinutes" value="1000"/>`
Possible values	Numeric (in minutes)
Where to add/change	customer.config CloudShell Server installation directory
Default value	300
Affected CloudShell Component	CloudShell API
Version	6.4 and above

Set the default category for new Apps (DefaultAppCategory)

Key	`<add key="DefaultAppCategory" value="app category"/>`
Possible values	<app category> = the new default category
Where to add/change	customer.config CloudShell Server installation directory
Default value	Applications
Affected CloudShell Component	CloudShell Portal
Version	7.0 and above

Enable the modification and deletion of App templates only from the template's domain (RestrictEditToCreatingDomain)

Key	`<add key="RestrictEditToCreatingDomain" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	8.2 and above

Set the maximum number of hops allowed per route (MaxHopsForRoute)

Key	`<add key="MaxHopsForRoute" value="10"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	6
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Enable automatic route configuration (automatically configures L1 connections) (EnableRouteConfiguration)

Key	`<add key="EnableRouteConfiguration" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Enable regular users to change their email address (ChangeEmailEnabled)

Key	`<add key="ChangeEmailEnabled" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	7.0 and above

Enable regular users to change email notifications (ReservationEmail.NonAdminCanChangeNotifications)

Key	`<add key="ReservationEmail.NonAdminCanChangeNotifications" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set the default number of max hops displayed for routes (in the connection’s Max Hops field in the Resource Connections dialog box) (DefaultMaxHopsForRoute)

Key	`<add key="DefaultMaxHopsForRoute" value="2"/>`
Possible values	Numeric (in hops)
Where to add/change	customer.config CloudShell Server installation directory
Default value	2
Affected CloudShell Component	CloudShell Portal
Version	6.1 and above

Set the default connection type when creating a connection (DefaultSelectedConnectionType)

Key	`<add key="DefaultSelectedConnectionType" value=""/>`
Possible values	Text
Where to add/change	customer.config CloudShell Server installation directory
Default value	Route
Affected CloudShell Component	CloudShell Portal
Version	6.2 and above

Set the supported connection types for new connections (SupportedConnectionTypes)

Key	`<add key="SupportedConnectionTypes" value=""/>`
Possible values	Connection type, separated by comma
Where to add/change	customer.config CloudShell Portal installation directory
Default value	Route, Cable, Tap, Connector
Affected CloudShell Component	CloudShell Portal
Version	6.2 and above

New blueprints section: visibility (TopologyDashboardNewTopologies)

Key	`<add key="TopologyDashboardNewTopologies" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

New blueprints section: number of blueprints to display (NewTopologiesCategoryCount)

Key	`<add key="NewTopologiesCategoryCount" value="5"/>`
Possible values	Numeric (suggested 1-20)
Where to add/change	customer.config CloudShell Server installation directory
Default value	5
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

New blueprints section: maximum age for new blueprints (NewTopologiesCategoryDaysLimit)

Key	`<add key="NewTopologiesCategoryDaysLimit" value="20"/>`
Possible values	Numeric (number of days)
Where to add/change	customer.config CloudShell Server installation directory
Default value	-1 (to not restrict to any timeframe)
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Recently modified section: visibility (TopologyDashboardRecentlyModified)

Key	`<add key="TopologyDashboardRecentlyModified" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Recently modified section: number of blueprints to display (RecentlyModifiedTopologiesCategoryCount)

Key	`<add key="RecentlyModifiedTopologiesCategoryCount" value="5"/>`
Possible values	Numeric (suggested 1-20)
Where to add/change	customer.config CloudShell Server installation directory
Default value	5
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Display most recently reserved blueprints in the Blueprint Catalog's Featured view, in which you are either the owner or a permitted user (TopologyDashboardRecentlyReserved)

Key	`<add key="TopologyDashboardRecentlyReserved" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Blueprint Catalog: Set the maximum number of recently reserved blueprints to display in the Featured view's Recently Reserved section (RecentlyReservedTopologiesCategoryCount)

Key	`<add key="RecentlyReservedTopologiesCategoryCount" value="5"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	5
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Specify categories of the blueprints to display in the Featured section of the Blueprint Catalog (TopologyDashboardFeaturedCategories)

Key	`<add key="TopologyDashboardFeaturedCategories" value="Category 1, Category 2"/>`
Possible values	Category names, separated by comma
Where to add/change	customer.config CloudShell Server installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Display all blueprints in the main Blueprint Catalog (TopologyDashboardAllTopologies)

Key	`<add key="TopologyDashboardAllTopologies" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Blueprint display modes (ShowAlphabeticTopologySubCategories)

Key	`<add key="ShowAlphabeticTopologySubCategories" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Hide the Status filter (HideEnvironmentsStatusFilter)

Key	`<add key="HideEnvironmentsStatusFilter" value="False"/`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.2.3 and above

Enable View type blueprints (EnableEnvironmentTypeView)

Key	`<add key="EnableEnvironmentTypeView" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.2.3 and above

Enable reference architecture flows (EnableEnvironmentType)

Key	`<add key="EnableEnvironmentType" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.2 and above

Hide templates that require order to disable creating blueprints using those templates (HideOrders)

Key	`<add key="HideOrders" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.2 and above

Defines the maximum allowed orchestration driver teardown time (TopologyTeardownDurationMaxHours)

Key	`<add key="MinimalRoleForPersistentSandbox" value=""/>`
Possible values	None (default) Regular DomainAdmin SystemAdmin
Where to add/change	customer.config CloudShell Server installation directory
Default value	None
Affected CloudShell Component	Quali Server
Version	2023.1 and above

Defines the maximum allowed orchestration driver setup time (TopologySetupDurationMaxHours)

Key	`<add key="TopologySetupDurationMaxHours" value="24"/>`
Possible values	Numeric (in hours)
Where to add/change	customer.config Quali Server installation directory
Default value	48
Affected CloudShell Component	Quali Server
Version	6.0 and above

Enable the option to show or hide the More Info option from blueprints (HideMoreInfoOnEnvironmentTile)

Key	`<add key="HideMoreInfoOnEnvironmentTile" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.2.3 and above

Block non-admin users from exporting blueprint packages (BlockPackageExportForNonAdmins)

Key	`<add key="BlockPackageExportForNonAdmins" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	9.0 and above

Display Instructions side pane by default (WS_Environment_AutoOpenInstructions)

Key	`<add key="WS_Environment_AutoOpenInstructions" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Display Commands side pane by default (WS_Environment_AutoOpenCommands)

Key	`<add key="WS_Environment_AutoOpenCommands" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Enable users to create blueprints from a template (OnlyAllowNewEnvironmentsFromTemplates)

Key	`<add key="OnlyAllowNewEnvironmentsFromTemplates" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.3 and above

Change the time allocated for exporting the blueprint diagram (ExportToPdf.WaitForRender)

Key	`<add key="ExportToPdf.WaitForRender" value="3000"/>`
Possible values	Numeric (time to wait, in milliseconds)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	2000
Affected CloudShell Component	CloudShell Portal
Version	2021.2 and above

Enable the Check Blueprint Routes option in the Blueprint menu (DetectFailedRoutes)

Key	`<add key="DetectFailedRoutes" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	9.2 and above

Set the route grouping policy (MaxUngroupedRoutes)

Key	`<add key="MaxUngroupedRoutes" value="5"/>`
Possible values	Numeric (number of connection lines to be grouped)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	3
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

Show/hide the main navigation bar components (HideSnQ, HideReservations, HideTopologies, HideInventory)

Keys	`<add key="HideSnQ" value="True"/>` `<add key="HideReservations" value="True"/>` `<add key="HideTopologies" value="True"/>` `<add key="HideInventory" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False for all keys
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set the default home page (HomePageUrl)

Key	`<add key="HomePageUrl" value="/RM/Topology"/>`
Possible values	Scheduling and queueing: “SnQ/Scheduler/" Topologies: “RM/Topology" Reservations: “RM/" Any other page relative address.
Where to add/change	customer.config CloudShell Portal installation directory
Default value	The topologies dashboard URL (“/RM/Topology")
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Add the Contact option to the user menu in CloudShell Portal (ContactUsURL)

Key	`<add key="ContactUsURL" value="<url>"/>`
Possible values	url
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A (disabled)
Affected CloudShell Component	CloudShell Portal
Version	7.0 and above

Specify the number of resource driver executions that can run in parallel (WorkerPoolSize)

Key	`<add key="WorkerPoolSize" value="20"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	20
Affected CloudShell Component	Quali Server
Version	6.0

Enable user definitions to be imported from an active directory (ActiveDirectory.Domain)

Key	`<add key="ActiveDirectory.Domain" value="QUALISYSTEMS"/>`
Possible values	Domain names
Where to add/change	customer.config CloudShell Server installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.3 and above

Manual import of users using LDAP or Active Directory (ExternalUserPluginClass)

Key	`<add key=ExternalUserPluginClass" value="LdapPlugin"/>`
Possible values	`ActiveDirectoryPlugin` `LdapPlugin` - requires additional configurations - see LDAP Integration
Where to add/change	customer.config CloudShell Server installation directory
Default value	`ActiveDirectoryPlugin`
Affected CloudShell Component	CloudShell Portal
Version	7.0 and above

Import user from external system (Active Directory, LDAP) if it does not exist in TestShell (ExternalUserManagement.AutoImportUser)

Key	`<add key="ExternalUserManagement.AutoImportUser" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.1 and above

Disable DBCC TRACEON (sql_sysadmin_membership_exists)

Key	`<add key="sql_sysadmin_membership_exists" value="False"/>`
Possible values	True/False (True = DBCC TRACEON is enabled)
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.1 and above

Set the user cache timeout value in seconds (Authentication.UserCacheTimeoutSeconds)

Key	`<add key="Authentication.UserCacheTimeoutSeconds" value="600"/>`
Possible values	Numeric (in seconds)
Where to add/change	customer.config CloudShell Server installation directory
Default value	600
Affected CloudShell Component	CloudShell Portal
Version	6.1 and above

Specify the path for the packaging logs (PackageLog)

Key	`<add key="PackageLog" value="<InstallationDirectory>:\Program Files (x86)\QualiSystems\CloudShell\Server\Packaging Logs"/>`
Possible values	Text
Where to add/change	customer.config CloudShell Server installation directory
Default value	Installation path:=<InstallationDirectory>:\Program Files(x86)\QualiSystems\CloudShell\Server\Packaging Logs
Affected CloudShell Component	CloudShell Portal
Version	6.2.3 and above

Define the Instructions pane size (WS_InstructionsPanelWidth)

Key	`<add key="WS_InstructionsPanelWidth" value="500"/>`
Possible values	Numeric (in pixels)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	540
Affected CloudShell Component	CloudShell Portal
Version	7.1 and above

Set the default Python version for new Python scripts (DefaultPythonVersion)

Python 3 automation requires Microsoft Visual C++ Redistributable 2015 x86 and x64 to be installed on the Execution Server(s).

Key	`<add key="DefaultPythonVersion" value="Python 3"/>`
Possible values	`Python 2` `Python 3`
Where to add/change	customer.config CloudShell Server installation directory
Default value	Python 3
Affected CloudShell Component	Execution Server
Version	9.2 and above

Show the Drivers management page (HideDriversTabInManage

Key	`<add key="HideDriversTabInManage" value="True"/>`
Possible values	True/False (True = Hide Drivers tab is enabled)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	9.2 and above

Hiding the CloudShell Portal footer (EnableQualiBrandingFooter)

Key	`<add key="EnableQualiBrandingFooter" value="False"/>`
Possible values	True/False (False = hide the footer)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	2021.3 and above

Allowing the execution of orchestration scripts without the need for a blueprint driver (ExecutePythonOrchestrationScriptsDirectly)

Key	`<add key="ExecutePythonOrchestrationScriptsDirectly" value="False"/>`
Possible values	True/False (False = disable the ability to run orchestration scripts directly from Quali Server and require the use of a blueprint driver)
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	9.3 and above

Increasing the time allowed for Quali Server to stop during upgrade (ServiceOnStopTimeSeconds)

Key	`<add key="ServiceOnStopTimeSeconds" value="30"/>`
Possible values	Numeric (in seconds)
Where to add/change	customer.config CloudShell Server installation directory
Default value	30
Affected CloudShell Component	CloudShell Server
Version	2021.3 and above

Change the default Quali API port (QualiApi.Port)

Key	`<add key="QualiApi.Port" value="9001"/>`
Possible values	Numeric (port number)
Where to add/change	customer.config CloudShell Server installation directory
Default value	9000
Affected CloudShell Component	Quali API
Version	6.4 and above

Hide Approval Request content from CloudShell Portal (EnableApprovals)

Key	`<add key="EnableApprovals" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	2023.1 and above

Enabling the automatic removal of expired approval requests (ApprovalsCleanup.EnableOldExpiredRequests)

Key	`<add key="ApprovalsCleanup.EnableOldExpiredRequests" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	2023.1 and above

Setting the expiration timeout for approval requests (ApprovalsCleanup.OldExpiredRequestsTimeoutInHours)

Key	`<add key="ApprovalsCleanup.OldExpiredRequestsTimeoutInHours" value="168"/>`
Possible values	Numeric (in hours)
Where to add/change	customer.config CloudShell Server installation directory
Default value	168
Affected CloudShell Component	CloudShell Portal
Version	2023.1 and above

Setting the interval for detecting for expired approval requests (ApprovalsCleanup.OldExpiredRequestsCheckIntervalInHours)

Key	`<add key="ApprovalsCleanup.OldExpiredRequestsCheckIntervalInHours" value="24"/>`
Possible values	Numeric (in hours)
Where to add/change	customer.config CloudShell Server installation directory
Default value	24
Affected CloudShell Component	CloudShell Portal
Version	2023.1 and above

Allow regular users to reserve resources from the Inventory dashboard (AllowRegularUsersToReserveFromInventory)

Key	`<add key="AllowRegularUsersToReserveFromInventory" value="True"/>`
Possible values	True/False (True = allow this option for regular users)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	9.1 and above

Switching between Sandbox Services (UseEmbeddedSandboxService)

Key	`<add key="UseEmbeddedSandboxService" value="False"/>`
Possible values	True: Use Quali Server's out-of-the-box Sandbox Service False: Use Kubernetes-based Sandbox Service
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	2020.2 and above

Allowing Quali Server to access the Kubernetes-based Sandbox Service (SandboxServiceHost/SandboxServiceRestPort)

Key	`<add key="SandboxServiceHost" value="<sandbox-service-svc-external-ip/hostname>"/>` `<add key="SandboxServiceRestPort" value="<port-number>"/>`
Possible values	SandboxServiceHost - Ip address/hostname SandboxServiceRestPort - port number
Where to add/change	customer.config CloudShell Server installation directory
Default value	8888 - default port number
Affected CloudShell Component	CloudShell Server
Version	2020.2 and above

Allowing Quali Server to access the Kubernetes-based RabbitMQ Service (RabbitHostname/RabbitPort)

Key	`<add key="RabbitHostname" value="<sandbox-service-svc-external-ip/hostname>"/>` `<add key="RabbitPort" value="<port-number>"/>`
Possible values	RabbitHostname - Ip address/hostname RabbitPort - port number
Where to add/change	customer.config CloudShell Server installation directory
Default value	15671 - default port number
Affected CloudShell Component	CloudShell Server
Version	2020.2 and above

Set the duration for CloudShell Monitor logs (ProductLogsDaysBackFilter)

Key	`<add key="ProductLogsDaysBackFilter" value="10"/>`
Possible values	Numeric
Where to add/change	monitor.config Monitor installation directory
Default value	14 (in days)
Affected CloudShell Component	CloudShell Monitor
Version	9.1 and above

Disable the export of usage data to Quali (EnableWatcher)

Key	`<add key="EnableWatcher" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	9.2 GA and above

Disable the export of usage data to CloudShell Monitor (AddUsageDataToMonitoring)

Key	`<add key="AddUsageDataToMonitoring" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Monitor
Version	9.2 GA and above

Determine if to use online help or offline help (ShowOnlineHelp)

For additional information, see Switching between online and offline help.

Key	`<add key="ShowOnlineHelp" value="False"/>`
Possible values	True/False (True = online help)
Where to add/change	customer.config CloudShell Portal / TestShell Studio / CloudShell Authoring / Resource Manager Client installation directory (as appropriate)
Default value	True
Affected CloudShell Component	CloudShell Portal / TestShell / Authoring / Resource Manager Client
Version	6.4 and above

Use non-CloudShell help content (CustomizedHelpUrl)

Key	`<add key="CustomizedHelpUrl" value="help-site-url"/>`
Possible values	"Empty" = CloudShell help content <help-site-url> = different help content
Where to add/change	customer.config CloudShell Portal installation directory
Default value	Empty
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

Set the online computer's name and port (RequirementsRepository)

Note: This applies to CloudShell deployments using PyPi Server to retrieve and serve Python dependencies from a dedicated online computer.

Key	`<add key="RequirementsRepository" value="http://<hostname\|IP>:<port>"/>`
Possible values	hostname or IP address and port
Where to add/change	customer.config CloudShell Execution Server installation directories
Default value	N/A
Affected CloudShell Component	Execution Server
Version	8.2 and above

Define the online computer as a trusted host (RequirementsTrustedHost)

Note: This applies to CloudShell deployments using PyPi Server to retrieve and serve Python dependencies from a dedicated online computer.

Key	`<add key="RequirementsTrustedHost" value="http://<hostname\|IP>:<port>"/>`
Possible values	hostname or IP address specified in the `RequirementsRepository` configuration key
Where to add/change	customer.config CloudShell Execution Server installation directories
Default value	N/A
Affected CloudShell Component	Execution Server
Version	8.2 and above

Set a secondary online python packages repository (RequirementsExtraRepository)

Note: Make sure to set this key on all execution servers.

Key	`<add key="RequirementsExtraRepository" value="http://<hostname\|IP>:<port>"/>`
Possible values	hostname or IP address and port. For example: `<add key="RequirementsExtraRepository" value=https://testpypi.python.org/simple//>`
Where to add/change	customer.config CloudShell Execution Server installation directories
Default value	N/A
Affected CloudShell Component	Execution Server
Version	8.2 and above

Enable registration (Requires also setting the Registration.AdminEmail key, as explained below) (Registration.Enabled)

Key	`<add key="Registration.Enabled" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set email address for a system administrator level user (Registration.AdminEmail)

Key	`<add key="Registration.AdminEmail" value="admin@company.com"/>` Where `admin@company.com` is the email address of a Resource Manager Client system administrator
Possible values	Email address, separated by semi-colons (;)
Where to add/change	customer.config CloudShell Server installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Configure registered user permissions (Registration.DefaultDomain)

Key	`<add key="Registration.DefaultDomain" value=""/>`
Possible values	Default domain
Where to add/change	customer.config CloudShell Server installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Configure registered user permissions (Registration.AdditionalGroup)

Key	`<add key="Registration.AdditionalGroup" value=""/>`
Possible values	Text
Where to add/change	customer.config CloudShell Server installation directory
Default value	External Users
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Configure the default role when a user is registered (Registration.DefaultRole)

Key	`<add key="Registration.DefaultRole" value="Regular"/>`
Possible values	Text
Where to add/change	customer.config CloudShell Server installation directory
Default value	Regular
Affected CloudShell Component	CloudShell Portal
Version	6.1 and above

Enable password reset (ResetPassword.Enabled)

Note: This also requires configuring the SMTP mail. See Enabling password reset.

Key	`<add key="ResetPassword.Enabled" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Hide the "Change Password" option from the user menu (ChangePasswordEnabled)

Key	`<add key="ChangePasswordEnabled" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Change the default idle time for releasing the license (IdleLicenseReleaseWatchdog.IdleTimeInMinutes)

Key	`<add key="IdleLicenseReleaseWatchdog.IdleTimeInMinutes" value="65"/>`
Possible values	Numeric (in minutes)
Where to add/change	customer.config CloudShell Portal / CloudShell Authoring / TestShell Studio installation directory
Default value	65
Affected CloudShell Component	TestShell Studio/TestShell Runner/CloudShell Authoring
Version	6.3 and above

Change the email validation pattern (EmailValidationPattern)

Key	`<add key="EmailValidationPattern" value=""/>` Where the email address strings can include any character in any language or symbol (separated by "@" and "."). For example, to limit the email address to a particular company, set value="`[^\s@]+@company\.com`"
Possible values	Text, email address string
Where to add/change	customer.config CloudShell Portal installation directory
Default value	Email address format (@.*)
Affected CloudShell Component	CloudShell Portal
Version	7.0 and above

Include a link to the sandbox in notification emails (PortalAddressLinkForEmails)

Key

<add key="PortalAddressLinkForEmails" value="protocol://Portal:PortalPort"/>

Parameter	Parameter details
`protocol`	http or https if CloudShell Portal is set to use SSL
`PublicServerName`	The DNS name or IP address of the CloudShell Portal virtual front
`PortalPort`	The port which CloudShell Portal is using (If the port is 80 or 443, remove this parameter and the colon from the key value).

Possible values

Text, email address string

Where to add/change

customer.config CloudShell Server installation directory

Default value

N/A

Affected CloudShell Component

CloudShell Portal

Version

7.0 and above

Controlling the time a command can stay in "pending" state (InstantJobTimeToLiveTimeoutMinutes)

Key	`<add key="InstantJobTimeToLiveTimeoutMinutes" value="10"/>`
Possible values	Numeric (in minutes)
Where to add/change	customer.config CloudShell Server installation directory
Default value	10
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

Enable users to share a sandbox only with other users of the same groups (PickOnlyUsersFromLoggedInUserGroups)

Key	`<add key="PickOnlyUsersFromLoggedInUserGroups" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Prevents users reserving a blueprint from viewing Owner and Permitted Users details (PickOnlyLoggedInUser)

Key	`<add key="PickOnlyLoggedInUser" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	9.0 and above

Unlock sandboxes for use during the Setup process (BlockSandboxDuringSetup)

Key	`<add key="BlockSandboxDuringSetup" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	8.1 and above

Enable extended permissions for external users (ExternalUserHasExtendedPermissions)

Key	`<add key="ExternalUserHasExtendedPermissions" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory * Requires restarting both the Quali Server and CloudShell Portal IIS services.
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Prevent users from using the Reserve Anyway option (BlockReserveWithConflicts)

Key	`<add key="BlockReserveWithConflicts" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Enable regular users to view sandboxes of other users in their domain (ShowOtherUserInDomainReservations)

Key	`<add key="ShowOtherUserInDomainReservations" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set the default duration for new sandboxes (Reservation.DefaultDuration)

Key	`<add key="Reservation.DefaultDuration" value="2"/>`
Possible values	Numeric (in hours)
Where to add/change	customer.config CloudShell Server installation directory
Default value	2
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Disable the "Recurrence" option when creating sandboxes (EnableRecurringReservation)

Key	`<add key="EnableRecurringReservation" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	8.2 and above

Set the default maximum number of sandboxes a user can have at the same time (DefaultUserMaxConcurrentReservations)

Key	`<add key="DefaultUserMaxConcurrentReservations" value="2"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	10
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set the default maximum number of scheduled sandboxes a user can have at the same time (DefaultUserMaxScheduledSandboxes)

Key	`<add key="DefaultUserMaxScheduledSandboxes" value="2"/>`
Possible values	Numeric empty value - unlimited number of scheduled sandboxes allowed 0 - no scheduled sandboxes allowed
Where to add/change	customer.config CloudShell Server installation directory
Default value	10/empty (unlimited) for users migrated from a pre-9.3 Patch 2 CloudShell
Affected CloudShell Component	CloudShell Portal
Version	9.3 Patch 2 and above

Set the default maximum number of blueprints a user can own at any given time (DefaultUserMaxOwnedBlueprints).

Key	`<add key="DefaultUserMaxOwnedBlueprints" value="2"/>`
Possible values	Numeric
Where to add/change	customer.config Quali Server installation directory
Default value	empty (unlimited)
Affected CloudShell Component	Quali Server
Version	2021.3 and above

Set the default maximum number of saved sandboxes a user can create with the Save and Restore add-on (DefaultUserMaxSavedSandboxes).

This key applies only to new users or users created in a CloudShell version prior to 9.0 that are migrated for the first time.

Note: Admins can configure the maximum number of saved sandboxes for a specific user in Resource Manager Client or via API, when updating user settings or when creating a new user.

Key	`<add key="DefaultUserMaxSavedSandboxes" value="2"/>`
Possible values	Numeric
Where to add/change	customer.config Quali Server installation directory
Default value	empty (unlimited)
Affected CloudShell Component	Quali Server
Version	9.0 and above

Set the default maximum sandbox duration limit for each user (DefaultUserMaxReservationDuration)

Key	`<add key="DefaultUserMaxReservationDuration" value="1:00:00:00"/>`
Possible values	days:hours:minutes:seconds
Where to add/change	customer.config CloudShell Server installation directory
Default value	1:00:00:00
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set the maximum number of users per reservation (MaxPermittedUsersForReservarion)

Key	`<add key="MaxPermittedUsersForReservarion" value="10"/>`
Possible values	numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	20
Affected CloudShell Component	CloudShell Portal
Version	7.0 and above

Display Instructions side pane by default (WS_Reservation_AutoOpenInstructions)

Key	`<add key="WS_Reservation_AutoOpenInstructions" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Display Commands side pane by default (WS_Reservation_AutoOpenCommands)

Key	`<add key="WS_Reservation_AutoOpenCommands" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Determine whether sandboxes should end automatically (AutoEndReservation)

Key	`<add key="AutoEndReservation" value="False"/>`
Possible values	True/False (True - auto end sandbox at end time / False = allow sandbox to enter overtime Important: It is not recommended to enable Overtime since it makes managing and troubleshooting conflicts more difficult.
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Show the Mark "in use" option for resources (HideMarkInUseAction)

Key	`<add key="HideMarkInUseAction" value="False"/>`
Possible values	True/False (True - hides the option) Mark "in use" option / False = displays Mark "in use" option
Where to add/change	customer.config Quali Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	9.2 and above

Prevent non-admin users from reserving shared resources exclusively (NonAdminCanUnshareResource)

Key	`<add key="NonAdminCanUnshareResource" value="False"/>`
Possible values	True/False (False = resources marked as ‘Shared by default’ cannot be ‘unshared’ by regular user)
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Prevent non-admin users from viewing the physical connection layer in the sandboxes dashboard (NonAdminCanViewPhysicalLayerInReservation)

Key	`<add key="NonAdminCanViewPhysicalLayerInReservation" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set email notification defaults for sandboxes - notify when sandbox is reserved(ReservationEmail.SendNotificationOnStart)

Key	`<add key="ReservationEmail.SendNotificationOnStart" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Set email notification defaults for sandboxes - notify when setup completes (ReservationEmail.SendNotificationOnSetupComplete)

Key	`<add key="ReservationEmail.SendNotificationOnSetupComplete" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	9.3 GA and above

Set email notification defaults for sandboxes - notify when teardown is scheduled to start (ReservationEmail.SendNotificationBeforeEnd)

Key	`<add key="ReservationEmail.SendNotificationBeforeEnd" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Set email notification defaults for sandboxes - notify x minutes before sandbox is scheduled to end (ReservationEmail.NotificationMinutesBeforeEnd)

Key	`<add key="ReservationEmail.NotificationMinutesBeforeEnd" value="10"/>`
Possible values	Numeric (in minutes)
Where to add/change	customer.config CloudShell Server installation directory
Default value	10
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Set email notification defaults for sandboxes - notify when sandbox ends (ReservationEmail.SendNotificationOnEnd)

Key	`<add key="ReservationEmail.SendNotificationOnEnd" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Add additional recipients for sandbox notifications (ReservationEmail.RecipientsToNotify)

Key	`<add key="ReservationEmail.RecipientsToNotify" value="admin1@company.com;admin2@company.com"/>`
Possible values	Email addresses, separated by semi-colons
Where to add/change	customer.config CloudShell Server installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Set general policies to inform system admins (ReservationEmail.NotifySystemAdmins)

Key	`<add key="ReservationEmail.NotifySystemAdmins" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Set general policies to inform domain admins (ReservationEmail.NotifyDomainAdmins)

Key	`<add key="ReservationEmail.NotifyDomainAdmins" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Force admin notifications On Start even if user disables them (ReservationEmail.OverrideSendNotificationOnStart)

Key	`<add key="ReservationEmail.OverrideSendNotificationOnStart" value="True"/>`
Possible values	True - send an email notification to the admin/domain admin when the sandbox starts False - send an email notification according to the sandbox end-user's settings when booking the sandbox
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Force admin notifications On setup complete even if user disables them (ReservationEmail.OverrideSendNotificationOnSetupComplete)

Key	`<add key="ReservationEmail.OverrideSendNotificationOnSetupComplete" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	9.3 GA and above

Force admin notifications Before End even if user disables them (ReservationEmail.OverrideSendNotificationBeforeEnd)

Key	`<add key="ReservationEmail.OverrideSendNotificationBeforeEnd" value="True"/>`
Possible values	True - send an email notification to the admin/domain admin before the sandbox ends False - send an email notification according to the sandbox end-user's settings when booking the sandbox
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Force admin notifications On end even if user disables them (ReservationEmail.OverrideSendNotificationOnEnd)

Key	`<add key="ReservationEmail.OverrideSendNotificationOnEnd" value="True"/>`
Possible values	True - send an email notification to the admin/domain admin when the sandbox ends False - send an email notification according to the sandbox end-user's settings when booking the sandbox
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	6.0 and above

Enable users to create ad hoc sandboxes (HideCreateNewEmptyReservation)

Key	`<add key="HideCreateNewEmptyReservation" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.2 and above

Enable HTML formatting in Output console, Full Activity Feed and Commands side pane (CommandsOutputConsoleSupportsHtml)

Key	`<add key="CommandsOutputConsoleSupportsHtml" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	7.0 and above

Limit the time to keep sandbox Activity Feed/Output data (SandboxLogAndOutputSaveDuration)

Key	`<add key="SandboxLogAndOutputSaveDuration" value="180"/>`
Possible values	Numeric (in days)
Where to add/change	customer.config CloudShell Server installation directory
Default value	180
Affected CloudShell Component	CloudShell Server
Version	2020.2 EA and above

Prevent the Output console from opening when new sandbox events occur (AutoOpenCommandOutputOnNewEvents)

Key	`<add key="AutoOpenCommandOutputOnNewEvents" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	2021.3 EA and above

Configure a calendar event for future sandboxes (SendEmailForFutureReservations)

Key	`<add key="SendEmailForFutureReservations" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	7.1 and above

Disable admin calendar event when user extends (or cancels a future) sandbox (ReservationEmail.SendNotificationOnReschedule and ReservationEmail.OverrideSendNotificationOnRescheduled)

Keys	`<add key="ReservationEmail.SendNotificationOnReschedule" value="False"/>` `<add key="ReservationEmail.OverrideSendNotificationOnRescheduled" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	8.2 and above

Prevent users from accessing sandbox links in a different domain (AutoSwitchDomain)

Key	`<add key="AutoSwitchDomain" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	9.0 and above

Show/hide user/sandbox details of currently shared resources in CloudShell Portal (ShowSharedResourceUsage)

Key	`<add key="ShowSharedResourceUsage" value="False"/>`
Possible values	True (show user/sandbox details)
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	8.2 and above

Set List view as the default for sandbox workspaces (ShowListViewByDefault)

For additional information, see Sandbox List View.

Key	`<add key="ShowListViewByDefault" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	9.2 and above

Prevent regular users from adding/removing resources in sandboxes (BlockAddRemoveResourcesInSandbox)

Key	`<add key="BlockAddRemoveResourcesInSandbox" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	9.2 GA and above

Allow sandboxes with shorter duration than Before end notification (ReservationEmail.VerifyNotificationBeforeEndLongerThanDuration)

Key	`<add key="ReservationEmail.VerifyNotificationBeforeEndLongerThanDuration" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	True
Affected CloudShell Component	CloudShell Server
Version	2022.2 GA

Set the lowest role that can create and use persistent sandboxes (MinimalRoleForPersistentSandbox)

Key	`<add key="HideOrders" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.2 and above

Set allowed job overtime before termination (ExecutionJobDurationOvertimePercentage)

Key	`<add key="ExecutionJobDurationOvertimePercentage" value="20"/>`
Possible values	Numeric (in percentage)
Where to add/change	customer.config CloudShell Server installation directory
Default value	10
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set number of recently completed jobs to display in the scheduler (NumberOfEndedExecutionJobSetsToDislpay)

Key	`<add key="NumberOfEndedExecutionJobSetsToDislpay" value="4"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	2
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Set the default job time buffer for extra time for tests, per job (DefaultCaluclationBufferInMinutes)

Key	`<add key="DefaultCaluclationBufferInMinutes" value="10"/>`
Possible values	Numeric (in minutes)
Where to add/change	customer.config CloudShell Server installation directory
Default value	10
Affected CloudShell Component	CloudShell Portal
Version	6.1 and above

Lock a test for editing (EnableTestShellStudioAccessControl)

Key	`<add key="EnableTestShellStudioAccessControl" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	7.1 and above

Admin unlock permission (EnableAccessControlAdministration)

Key	`add key="EnableAccessControlAdministration" value="False"/>`
Possible values	True/False
Where to add/change	customer.config TestShell Studio installation directory
Default value	False
Affected CloudShell Component	TestShell Studio
Version	7.1 and above

Set the default severity level for suite notification emails (SuiteEmailNotificationDefaultSeverityLevel)

Key	`<add key="SuiteEmailNotificationDefaultSeverityLevel" value="ErrorsOnly"/>`
Possible values	None, ErrorsOnly, SuiteAndErrors, All
Where to add/change	customer.config CloudShell Portal installation directory
Default value	ErrorsOnly
Affected CloudShell Component	CloudShell Portal
Version	7.1 and above

Set the report template to use for tests executed in the Job Scheduling dashboard (DefaultReportTemplate)

To set the default execution report template for tests that were executed in Remote Runner, see Specifying the default report template.

Key	`<add key="DefaultReportTemplate" value="Test Steps"/>`
Possible values	Test Results, Test Steps, Detailed Report, Failure Report
Where to add/change	customer.config CloudShell Portal installation directory
Default value	Test Results
Affected CloudShell Component	CloudShell Portal
Version	Before 7.0

Set the maximum number of steps for test reports (MaxReportStepCount)

Key	`<add key="MaxReportStepCount" value="10000"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Portal/TestShell installation directory
Default value	10000
Affected CloudShell Component	CloudShell Portal, TestShell Studio and Runner
Version	Before 7.0

Set the default Reporting Profile for automation suite jobs (LoggingProfile)

Key	`<add key="LoggingProfile" value="Results"/>`
Possible values	Results, Measurements and Results, All, None For details, see Setting the default Reporting Profile for automation suite jobs.
Where to add/change	customer.config CloudShell Portal installation directory
Default value	Results
Affected CloudShell Component	CloudShell Portal
Version	Before 7.0

Enable non-admin users to edit and create suite templates (AllowRegularUsersToEditSnQ)

Key	`<add key="AllowRegularUsersToEditSnQ" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.3 and above

Enable blueprint scripts to run concurrently (AllowConcurrentTopologyScriptCommands)

Key	`<add key="AllowConcurrentTopologyScriptCommands" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	CloudShell Server
Version	8.0 and above

Setting Quali Server's timeout period for L1 drivers (L1DriverProcessStartupTime)

Note: For more information, see Set the timeout period for L1 drivers.

Key	`<add key="L1DriverProcessStartupTime" value="3"/>`
Possible values	Numeric (in seconds)
Where to add/change	customer.config CloudShell Server installation directory
Default value	1
Affected CloudShell Component	CloudShell Server
Version	7.1 and above

Show/hide the bulk add resources option (ShowSearchMultiAdd)

Key	`<add key="ShowSearchMultiAdd" value="False"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Ensure the user only uses the chassis/port level for certain device types (SearchOnlySearchables)

Key	`<add key="SearchOnlySearchables" value="True"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Specify the maximum number of filtering attributes (NumberOfTopAttributeNames)

Key	`<add key="NumberOfTopAttributeNames" value="10"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	10
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Specify the maximum number of possible values per attribute (NumberOfTopAttributeValues)

Key	`<add key="NumberOfTopAttributeValues" value="5"/>`
Possible values	Numeric
Where to add/change	customer.config CloudShell Server installation directory
Default value	5
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

SSO – Change the login page in case the user logs out (CustomAbsoluteLoginPage)

Key	`<add key="CustomAbsoluteLoginPage" value="http://anyurl"/>`
Possible values	Text
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

SSO – Enable or disable SSO (Authentication.ExternalLoginMode)

Key	`<add key="Authentication.ExternalLoginMode" value="None"/>`
Possible values	Possible values: Token, Header, None
Where to add/change	customer.config CloudShell Server installation directory
Default value	Token
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

SSO – Enable or disable using Token mode (Authentication.ExternalLoginMode)

Key	`<add key="Authentication.ExternalLoginMode" value="Token"/>`
Possible values	Token, Header, None
Where to add/change	customer.config CloudShell Server installation directory
Default value	Token
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

SSO – Configure token encryption using Rijndael symmetric encryption key (32 bytes) (Authentication.ExternalLoginKey)

Key	`<add key="Authentication.ExternalLoginKey" value="xxxx"/>`
Possible values	Any multiple of 32 bits
Where to add/change	customer.config CloudShell Server installation directory
Default value	As set in the QsTeamServer.exe.config file in the Quali Server installation directory
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

SSO – Configure token encryption using Rijndael symmetric encryption key IV (16 bytes) (Authentication.ExternalLoginIV)

Key	`<add key="Authentication.ExternalLoginIV" value="yyy"/>`
Possible values	Any multiple of 16 bits
Where to add/change	customer.config CloudShell Server installation directory
Default value	As set in the QsTeamServer.exe.config file in the Quali Server installation directory
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

Header mode – used when the username is added to one of the HTTP headers (Authentication.ExternalLoginMode)

Key	`<add key="Authentication.ExternalLoginMode" value="Header"/>`
Possible values	Any username that is added to one of the HTTP headers
Where to add/change	customer.config CloudShell Server installation directory
Default value	Token
Affected CloudShell Component	CloudShell Portal
Version	6.0 and above

SAML SSO – Enable SAML SSO authentication (SamlSSOAuthenticationEnabled)

Key	`<add key="SamlSSOAuthenticationEnabled" value="true" />`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Configure the Assertion Consumer Service URL (SamlAssertionConsumerServiceUrl)

Key	`<add key="SamlAssertionConsumerServiceUrl" value="http://localhost:60433/Saml/Consume" />`
Possible values	URL string with the address of the CloudShell Portal (including server IP address and port number)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Configure the URL of the Identity Provider (SamlIdpTargetUrl)

Key	`<add key="SamlIdpTargetUrl" value="http://stubidp.kentor.se/" />`
Possible values	URL of the Identity Provide (IdP)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Configure the address of the login page (CustomAbsoluteLoginPage)

Key	`<add key="CustomAbsoluteLoginPage" value="http://localhost:60433/Saml/Index" />`
Possible values	Text, URL string with the address of the CloudShell Portal (including server IP address and port number)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Configure the deflate/inflate compression when processing SAML requests (SamlDeflateInflate)

Key	`<add key="SamlDeflateInflate" value="false" />`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	True
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Configure the name of the certificate key file (.pfx file) to sign the SAML request with (SamlIssuerCert)

Key	`<add key="SamlIssuerCert" value="HuaweiCA.pfx;roveafuna" />`
Possible values	Text, if the certificate is locked with a password use a semicolon and provide the password (as shown in the above example)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Configure the HTTP method to use when issuing the SAML request ot the Identity Provider (SamlRequestMethod)

Key	`<add key="SamlRequestMethod" value="GET" />`
Possible values	Get, Post, Redirect
Where to add/change	customer.config CloudShell Portal installation directory
Default value	Redirect (which does not check for browser compatibility)
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Redirect the user to a specified URL whenever the user browses the SAML consumer endpoint without a response (SamlEmptyResponseRedirectUrl)

Key	`<add key="SamlEmptyResponseRedirectUrl" value="http://developer.huawei.com/cn/ict/" />`
Possible values	URL string or Null
Where to add/change	customer.config CloudShell Portal installation directory
Default value	NULL (which means the user will not be redirected and ultimately will get an error message saying the response is empty)
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Redirect the user to a specified URL whenever the user browses the CloudShell Portal login page (CustomAbsoluteLoginPage)

Key	`<add key="CustomAbsoluteLoginPage" value="http://developer.huawei.com/cn/ict/"/>`
Possible values	URL string (In SAML and SSO context, this key is usually used to hide the login page and redirect incoming users to the SAML endpoint. Some environments (like Huawei) use it to redirect users when they log off of the portal back to their landing page.)
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Redirect the user to a specified URL whenever the user browses the CloudShell Portal logout page (CustomAbsoluteLogoutPage)

Key	`<add key="CustomAbsoluteLogoutPage" value="http://[server]/AuthServices/Logout"/>`
Possible values	URL string , where [server] is the IdP server's IP or DNS
Where to add/change	customer.config CloudShell Portal installation directory
Default value	N/A
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

SAML SSO – Enable direct access to CloudShell Portal (BypassCustomLogin)

Key	`<add key="add key="BypassCustomLogin" value="true"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	7.1 and above

SAML SSO – Change the name of the Domain attribute which defines the CloudShell domain to associate the user to (SsoDomainAssertionName)

Note: This attribute may be added when setting up users in an IdP, to log a user into a specific domain if a user belongs to more than one domain. For more information, see Set up an Identity Provider (IdP).

Key	`<add key="SsoDomainAssertionName" value="MyDomainAttribute"/>`
Possible values	Text
Where to add/change	customer.config CloudShell Server installation directory
Default value	Domain
Affected CloudShell Component	CloudShell Portal
Version	8.2 and above

Prevent regular users (non-admins) from creating tests and folders in the Shared test folder

Key	`<add key="AllowNonAdminToCreateTestsUnderSharedRoot" value="false"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Server installation directory
Default value	False
Affected CloudShell Component	TestShell Studio
Version	6.1.1 and above

Hiding the "Shared" test folder from Job Scheduling

Key	`<add key="AllowNonAdminToCreateTestsUnderSharedRoot" value="false"/>`
Possible values	True/False
Where to add/change	customer.config CloudShell Portal installation directory
Default value	False
Affected CloudShell Component	CloudShell Portal
Version	6.4 and above

Customer Configuration Keys Repository

Abstract resources

API

Apps

Connectivity management and route configuration

Blueprint Catalog

Blueprint Workspace

Execution Server

General

Inventory dashboard

New Job Scheduling

LDAP Integration

Monitoring

Online Help

PyPi Server

Registration, passwords, emails, and licenses

Sandboxes

Scheduling and Queuing

Scheduling commands

Search

Single Sign On (SSO)

SAML Single Sign On (SSO)

TestShell Studio