---
myst:
  html_meta:
    "description lang=en": "Proxmox VM Provider Settings."
    "keywords": "Kasm, Proxmox"
    "property=og:locale": "en_US"
---


```{eval-rst}
.. table:: Proxmox Settings
    :widths: 200

    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **Setting**         | **Description**                                                                                                                                                                                                 |
    +=====================+=================================================================================================================================================================================================================+
    | Name                | An identifying name for this provider configuration e.g. Proxmox Docker Agent Autoscale Provider                                                                                                                |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Max Instances       | The maximum number of autoscale instances to be provisioned, regardless of other settings                                                                                                                       |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Host                | The hostname or IP and port of your Proxmox instance (e.g. 192.168.100.40:8006)                                                                                                                                 |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Username            | The name of the autoscale user in Proxmox, including the auth realm (e.g. KasmUser@pve)                                                                                                                         |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Token Name          | The name of the API token associated with the user (e.g. kasm_token and not KasmUser@pve!kasm_token)                                                                                                            |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Token Value         | The secret value of the API token associated with the user                                                                                                                                                      |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Verify SSL          | Whether or not to verify the SSL certs in the Proxmox environment. Disable if you are using self-signed certs                                                                                                   |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | VMID Range Lower    | The start of the VMID range for Kasm to use for autoscale agents. Must not overlap with any other Proxmox autoscale providers configured in Kasm                                                                |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | VMID Range Upper    | The end of the VMID range for Kasm to use for autoscale agents. Must not overlap with any other Proxmox autoscale providers configured in Kasm                                                                  |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Full Clone          | If enabled performs a full clone rather than a linked clone. A linked clone is faster to provision but will have reduced performance compared to a full clone                                                   |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Template Name       | The name of the VM template to use when cloning new autoscale agents                                                                                                                                            |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Cluster Node Name   | The name of the Proxmox node containing the VM template                                                                                                                                                         |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Resource Pool Name  | Specify the resource pool to use for cloning the new autoscale agents                                                                                                                                           |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Storage Pool Name   | Optionally specify a storage pool to use for cloning the new autoscale agents. This requires Full Clone to be enabled                                                                                           |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Target Node Name    | Optionally specify a cluster node to provision new autoscale agents on (defaults to the Cluster Node Name)                                                                                                      |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | VM Cores            | The number of CPU cores to configure for the autoscale agents                                                                                                                                                   |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | VM Memory           | The amount of memory in GiB for the autoscale agents                                                                                                                                                            |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Installed OS Type   | Linux or Windows                                                                                                                                                                                                |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Startup Script Path | The absolute path to where the startup script will be uploaded and run from, typically `/tmp` for Linux or `C:\windows\temp` for Windows. The path must exist on the template.                                  |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Startup Script      | Bash (Linux) or Powershell (Windows) startup script to run after agent creation, typically to install the Kasm Agent and/or any other runtime dependencies.                                                     | 
    |                     | Example scripts are available on our `GitHub repository <https://github.com/kasmtech/workspaces-autoscale-startup-scripts>`_                                                                                    |
    +---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
```