Skip to main content
Version: 2024.1

Sandboxes

Controlling the time a command can stay in "pending" state

Key<add key="InstantJobTimeToLiveTimeoutMinutes" value="10"/>
Possible valuesNumeric (in minutes)
Where to add/changecustomer.config CloudShell Server installation directory
Default value10
Affected CloudShell ComponentCloudShell Portal
Version6.4 and above

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

Key<add key="PickOnlyUsersFromLoggedInUserGroups" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

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

Key<add key="PickOnlyLoggedInUser" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version9.0 and above

Unlock sandboxes for use during the Setup process

Key<add key="BlockSandboxDuringSetup" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version8.1 and above

Enable extended permissions for external users

Key<add key="ExternalUserHasExtendedPermissions" value="True"/>
Possible valuesTrue/False
Where to add/change

customer.config CloudShell Server installation directory

* Requires restarting both the Quali Server and CloudShell Portal IIS services.

Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Prevent users from using the Reserve Anyway option

Key<add key="BlockReserveWithConflicts" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Enable regular users to view sandboxes of other users in their domain

Key<add key="ShowOtherUserInDomainReservations" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Set the default duration for new sandboxes

Key<add key="Reservation.DefaultDuration" value="2"/>
Possible valuesNumeric (in hours)
Where to add/changecustomer.config CloudShell Server installation directory
Default value2
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Disable the "Recurrence" option when creating sandboxes

Key<add key="EnableRecurringReservation" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version8.2 and above

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

Key<add key="DefaultUserMaxConcurrentReservations" value="2"/>
Possible valuesNumeric
Where to add/changecustomer.config CloudShell Server installation directory
Default value10
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

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

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/changecustomer.config CloudShell Server installation directory
Default value10/empty (unlimited) for users migrated from a pre-9.3 Patch 2 CloudShell
Affected CloudShell ComponentCloudShell Portal
Version9.3 Patch 2 and above

Set the default maximum number of blueprints a user can own at any given time

Key<add key="DefaultUserMaxOwnedBlueprints" value="2"/>
Possible valuesNumeric
Where to add/changecustomer.config Quali Server installation directory
Default valueempty (unlimited)
Affected CloudShell ComponentQuali Server
Version2021.3 and above

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

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 valuesNumeric
Where to add/changecustomer.config Quali Server installation directory
Default valueempty (unlimited)
Affected CloudShell ComponentQuali Server
Version9.0 and above

Set the default maximum sandbox duration limit for each user

Key<add key="DefaultUserMaxReservationDuration" value="1:00:00:00"/>
Possible valuesdays:hours:minutes:seconds
Where to add/changecustomer.config CloudShell Server installation directory
Default value1:00:00:00
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Set the maximum number of users per reservation

Key<add key="MaxPermittedUsersForReservarion" value="10"/>
Possible valuesNumeric
Where to add/changecustomer.config CloudShell Server installation directory
Default value20
Affected CloudShell ComponentCloudShell Portal
Version7.0 and above

Display Instructions side pane by default

Key<add key="WS_Reservation_AutoOpenInstructions" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Portal installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Display Commands side pane by default

Key<add key="WS_Reservation_AutoOpenCommands" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Portal installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Determine whether sandboxes should end automatically

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/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Show the Mark "in use" option for resources

Key<add key="HideMarkInUseAction" value="False"/>
Possible valuesTrue/False (True - hides the option) Mark "in use" option / False = displays Mark "in use" option
Where to add/changecustomer.config Quali Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version9.2 and above

Prevent non-admin users from reserving shared resources exclusively

Key<add key="NonAdminCanUnshareResource" value="False"/>
Possible valuesTrue/False (False = resources marked as ‘Shared by default’ cannot be ‘unshared’ by regular user)
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

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

Key<add key="NonAdminCanViewPhysicalLayerInReservation" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version6.0 and above

Set email notification defaults for sandboxes - notify when sandbox is reserved

Key<add key="ReservationEmail.SendNotificationOnStart" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Set email notification defaults for sandboxes - notify when setup completes

Key<add key="ReservationEmail.SendNotificationOnSetupComplete" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version9.3 GA and above

Set email notification defaults for sandboxes - notify when teardown is scheduled to start

Key<add key="ReservationEmail.SendNotificationBeforeEnd" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Set email notification defaults for sandboxes - notify x minutes before sandbox is scheduled to end

Key<add key="ReservationEmail.NotificationMinutesBeforeEnd" value="10"/>
Possible valuesNumeric (in minutes)
Where to add/changecustomer.config CloudShell Server installation directory
Default value10
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Set email notification defaults for sandboxes - notify when sandbox ends

Key<add key="ReservationEmail.SendNotificationOnEnd" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Add additional recipients for sandbox notifications

Key<add key="ReservationEmail.RecipientsToNotify" value="admin1@company.com;admin2@company.com"/>
Possible valuesEmail addresses, separated by semi-colons
Where to add/changecustomer.config CloudShell Server installation directory
Default valueN/A
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Set general policies to inform system admins

Key<add key="ReservationEmail.NotifySystemAdmins" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Set general policies to inform domain admins

Key<add key="ReservationEmail.NotifyDomainAdmins" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Set general policies to inform domain admins

Key<add key="ReservationEmail.NotifyDomainAdmins" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Force admin notifications On Start even if user disables them

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/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Force admin notifications On setup complete even if user disables them

Key<add key="ReservationEmail.OverrideSendNotificationOnSetupComplete" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version9.3 GA and above

Force admin notifications Before End even if user disables them

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/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Force admin notifications On end even if user disables them

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/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Server
Version6.0 and above

Enable users to create ad-hoc sandboxes

Key<add key="HideCreateNewEmptyReservation" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version6.2 and above

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

Key<add key="CommandsOutputConsoleSupportsHtml" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Portal installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version7.0 and above

Limit the time to keep sandbox Activity Feed/Output data

Key<add key="SandboxLogAndOutputSaveDuration" value="180"/>
Possible valuesNumeric (in days)
Where to add/changecustomer.config CloudShell Server installation directory
Default value17910
Affected CloudShell ComponentCloudShell Server
Version2020.2 EA and above

Prevent the Output console from opening when new sandbox events occur

Key<add key="AutoOpenCommandOutputOnNewEvents" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version2021.3 EA and above

Configure a calendar event for future sandboxes

Key<add key="SendEmailForFutureReservations" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Server
Version7.1 and above

Disable admin calendar event when user extends (or cancels a future) sandbox

Key

<add key="ReservationEmail.SendNotificationOnReschedule" value="False"/>

<add key="ReservationEmail.OverrideSendNotificationOnRescheduled" value="False"/>

Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Server
Version8.2 and above
Key<add key="AutoSwitchDomain" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version9.0 and above

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

Key<add key="ShowSharedResourceUsage" value="False"/>
Possible valuesTrue (show user/sandbox details)
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version8.2 and above

Set List view as the default for sandbox workspaces

For additional information, see Sandbox List View.

Key<add key="ShowListViewByDefault" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Portal installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Portal
Version9.2 and above

Prevent regular users from adding/removing resources in sandboxes

Key<add key="BlockAddRemoveResourcesInSandbox" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueFalse
Affected CloudShell ComponentCloudShell Server
Version9.2 GA and above

Allow sandboxes with shorter duration than Before end notification

Key<add key="ReservationEmail.VerifyNotificationBeforeEndLongerThanDuration" value="False"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Portal installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Server
Version2022.2 GA

Set the lowest role that can create and use persistent sandboxes

Key<add key="HideOrders" value="True"/>
Possible valuesTrue/False
Where to add/changecustomer.config CloudShell Server installation directory
Default valueTrue
Affected CloudShell ComponentCloudShell Portal
Version6.2 and above