Show/hide the main navigation bar components
Show/hide the main navigation bar components (HideSnQ, HideReservations, HideTopologies, HideInventory)
| Key | <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
| 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 |
| 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
| 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
| 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
| 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
| 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
| 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
| 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
| 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
| 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
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
| 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 |
| 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
| 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 | temp |
| Default value | customer.config CloudShell Server installation directory |
| Affected CloudShell Component | CloudShell Server |
| Version | 9.3 and above |
Increasing the time allowed for Quali Server to stop during upgrade
| 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
| 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
| 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
| 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
| 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
| 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 |
Keep ports in reservation when removing visual connectors
| Key | <add key="EnableVisualConnectorDisconnectRemovePorts" value="false"/> |
| Possible values | Boolean |
| Where to add/change | customer.config CloudShell Server installation directory |
| true | false |
| Affected CloudShell Component | CloudShell Server |
| Version | 2024.1 and above |
Resource Enrichment Cache
| Key | <add key="EnableResourceEnrichmentCache" value="false"/> |
| Possible values | True/False (True - This cache promotes faster retrieval of resource details when rendering diagrams. False - disables for specific problematic scenarios - very large diagrams) |
| Where to add/change | customer.config CloudShell Server installation directory |
| true | false |
| Affected CloudShell Component | CloudShell Server |
| Version | 2024.1 and above |
Environment variable configuration overrides
Starting with CloudShell 2024.1, CloudShell supports overriding customer.config values using environment variables. This enables configuration management without modifying files directly, which is useful for containerized deployments and automation scenarios.
To override a configuration key, set an environment variable with the prefix QS_ followed by the key name (with dots replaced by underscores). For example, to override <add key="MyKey" value="SomeValue"/>, set the environment variable QS_MyKey.
| Key | N/A (environment variable prefix: QS_) |
| Possible values | Any value that would be valid in the corresponding customer.config key |
| Where to add/change | System environment variables on the machine running the CloudShell component |
| Default value | N/A |
| Affected CloudShell Component | All (Quali Server, Portal, Execution Server) |
| Version | 2024.1 and above |
Environment variable overrides take precedence over values defined in customer.config. This allows you to manage configuration centrally (e.g., via orchestration tools or container runtime) without modifying config files on disk.
Allow unicode characters in script command context
When set to true, allows passing unicode characters to script environment variables. This is useful when usernames or other context values contain unicode characters.
| Key | <add key="AllowUnicodeForCommandContext" 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 | 2024.1 and above |
Administrators can configure an AI Assistant menu item in the Portal by setting a URL template. This adds a menu item that opens an AI chat interface in a new browser tab, passing context about the current Portal page (and the current sandbox, when applicable) to the external AI chat service.
The URL template can include placeholders, wrapped in curly braces, that are replaced with the actual context values at runtime. For example, the template https://your-ai-chat-url.com?page={pageUrl}&user={user} opens the chat URL with the current page path and the logged-in user's name filled in.
Because the template is set as the value of an XML attribute in customer.config, any literal & that separates URL query parameters must be written as &. You can also use commas instead.
The following placeholders are supported:
Always available (provided on every Portal page):
| Placeholder | Description |
|---|
{user} | Username of the logged-in user. |
{domain} | Name of the current domain (empty if none). |
{version} | CloudShell version (without the build number). |
{pageType} | Identifier of the current Portal page (empty if not available). |
{pageUrl} | Path and query string of the current Portal page. |
Available only inside a sandbox or blueprint page (replaced with empty values on all other pages, such as the catalog or inventory):
| Placeholder | Description |
|---|
{sandboxId} | ID of the current sandbox/blueprint. |
{sandboxName} | Name of the current sandbox/blueprint. |
{status} | Reservation status of the sandbox. |
{setupStage} | Current setup stage of the sandbox. |
{resourceList} | Comma-separated list of resource names in the sandbox/blueprint. |
{resourceCount} | Number of resources in the sandbox/blueprint. |
Sandbox placeholders ({sandboxId}, {sandboxName}, {status}, {setupStage}, {resourceList}, {resourceCount}) are only populated when the user opens the AI Assistant from within a sandbox or blueprint diagram. On any other page they are replaced with empty values.
| Key | <add key="AIChatURL" value="https://your-ai-chat-url.com?page={pageUrl}&sandbox={sandboxId}"/> |
| Possible values | A URL template containing any of the supported placeholders listed above. |
| Where to add/change | customer.config CloudShell Portal installation directory |
| Default value | N/A (disabled) |
| Affected CloudShell Component | CloudShell Portal |
| Version | 2026.1 and above |