Skip to main content

Exporting System Configurations

  1. Log into the Workspace UI as an administrator.

  2. From the Admin panel, select Diagnostics -> System Info from the menu.

  3. Navigate to the Import/Export Config tab and Click the Export Config button in the Export Configuration section.

Export Configuration
Export Configuration
  1. Enter the password you would like the export zip file to utilize.
Export Configuration
Export Configuration
  1. The entire configuration of the system , except for the logs, will be downloaded to password-protected zip file.
Export Download
Export Download
  1. The password for this file will be the one provided in the previous form. This zip utilizes AES256 encryption, which means that a utility such as 7zip is needed to extract the data. Many zip utilities built into operating systems like Windows and MacOS do not support AES256 for zip files. A file named export_data.yaml resides inside and contains the configurations.
Extract
Extract
Example Export

Below is a short example snippet of the yaml based configuration export.

Exported Configuration Snippet
 alembic_version: 52136dd39702
 images:
   - allow_network_selection: false
     available: false
     categories:
     - Development
     cores: 2.0
     cpu_allocation_method: Inherit
     description: The Collaboration Platform for API Development.
     docker_registry: https://index.docker.io/v1/
     docker_token: null
     docker_user: null
     enabled: false
     exec_config: {}
     filter_policy_force_disabled: false
     filter_policy_id: null
     friendly_name: Postman
     gpu_count: 0
     hash: null
     hidden: false
     image_id: 2ba504c975654fd18c554905478fc5a1
     image_src: img/thumbnails/postman.png
     image_type: Container
     link_url: null
     memory: 2768000000
     name: kasmweb/postman:develop
     notes: null
     persistent_profile_path: null
     require_gpu: false
     restrict_network_names: []
     restrict_to_network: false
     restrict_to_server: false
     restrict_to_zone: false
     run_config: {}
     server_id: null
     server_pool_id: null
     session_time_limit: null
     volume_mappings: {}
     x_res: 800
     y_res: 600
     zone_id: null
   - allow_network_selection: false
     available: true
     categories:
     - Desktop
     - Productivity
     - Development
     cores: 2.0
     cpu_allocation_method: Inherit
     description: Ubuntu is a Linux distribution based on Debian.
     docker_registry: https://index.docker.io/v1/
     docker_token: null
     docker_user: null
     enabled: true
     exec_config: {}
     filter_policy_force_disabled: false
     filter_policy_id: null
     friendly_name: Ubuntu Jammy
     gpu_count: 0
     hash: null
     hidden: false
     image_id: 98df48adf16d4f5eb5ca64506aaddbab
     image_src: img/thumbnails/ubuntu.png
     image_type: Container
     link_url: null
     memory: 2768000000
     name: kasmweb/ubuntu-jammy-desktop:develop
     notes: null
     persistent_profile_path: null
     require_gpu: false
     restrict_network_names: []
     restrict_to_network: false
     restrict_to_server: false
     restrict_to_zone: false
     run_config:
       hostname: kasm
     server_id: null
     server_pool_id: null
     session_time_limit: null
     volume_mappings: {}
     x_res: 800
     y_res: 600
     zone_id: null