Deploying a template

After you configure a template, you can deploy it to use as a custom execution environment. Deployment is available only for templates with the state Ready.

To deploy a custom environment, access to the internet (to Microsoft servers) from the custom environment instance is recommended but not required.

For Windows XP, online deployment is not possible. We recommend using offline deployment (see the second instruction in this section).

To deploy a template as a custom execution environment to Kaspersky Research Sandbox:

On the Templates & Storage page, select the Templates tab.
In the Actions column, click by the template that you want to deploy as a custom execution environment, and select Deploy in the drop-down list. Also, you can click the required template name and then select the Deploy step.
The Deploy pane opens.
If necessary, edit the name of the custom execution environment in the Name field.
The environment name can have a maximum of 100 characters and contain only alphanumeric characters (letters and numbers), dots, hyphens, round brackets, and underscores.

By default, the template name is displayed. You can change the custom execution environment title at any time later.
Specify the number of slots (software licenses) for the execution environment in the Slots drop-down list.
The specified number limits the amount of execution tasks that can run simultaneously in this environment.

To comply with the terms of use of the installed software, you must accurately specify the number of slots for each execution environment. The overall number of slots for all environments must not exceed the number of software instances that the license allows. When installing software on several images (templates) or deploying several execution environments from one template, you must calculate the applicable number of slots. Please consider that configuring a template by using Virtual Network Computing (VNC) while a file execution task is running on the corresponding environment, may also require additional software license key.

The available values are 1–100. By default, 1 is specified. You can change the number of slots for an execution environment at any time later, if necessary.
If necessary, enter the description for the custom execution environment in the Description field.
The environment description can have a maximum of 1000 characters. By default, the template description is displayed. You can add or change the description at any time later.
If necessary, change a network channel by editing the template parameters.
Manually disable the operating system firewall to be able to start the smallsrv service.
Click the Deploy button.

The template deployment to Kaspersky Research Sandbox starts. The Deploying state is displayed.

Also, you can deploy a template by clicking its name in the Templates table, and then clicking the Deploy button on the Configure template step.

The deployment process is time consuming and depends on your network bandwidth and an image size (up to several gigabytes). While the template is being deployed, no action can be performed to this template, and corresponding buttons and links are unavailable.

To perform the offline deployment:

Obtain the required custom image manifest file.
Use the custom image ID from the error message as the id parameter value.
On the computer with internet access, download the required symbol files specified in the custom image manifest by using a script.
Upload the symbol files to Kaspersky Research Sandbox in one of the following ways:
- By using Kaspersky Research Sandbox API
- By using a script
Deploy a template again.

In case downloading or uploading the symbol files fails, or a template deployment reoccurs after successful symbol files upload, please contact your Kaspersky Research Sandbox administrator.

When the template is successfully deployed, it appears on the Environments page, and also you can select it as an execution environment on the Sandbox page.