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


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

    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | **Setting**            | **Description**                                                                                                                                                                                                                                                                        |
    +========================+========================================================================================================================================================================================================================================================================================+
    | Name                   | An identifying name for this provider configuration e.g. Harvester Docker Agent Autoscale Provider                                                                                                                                                                                     |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Max Instances*         | The maximum number of autoscale instances to be provisioned, regardless of other settings                                                                                                                                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Host                   | The address of the Harvester instance, from the KubeConfig file (e.g. https://harvester.example.com/k8s/clusters/local)                                                                                                                                                                |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | SSL Certificate        | The Harvester certificate as a base64 encoded string, from the KubeConfig file                                                                                                                                                                                                         |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | API Token              | The API token for authentication to Harvester, from the KubeConfig file                                                                                                                                                                                                                |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | VM Namespace           | The name of the Harvester namespace where the VMs will be provisioned                                                                                                                                                                                                                  |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | VM SSH Public Key      |  A public key to add to the autoscale agents, this is then provided as `{ssh_key}` for use in the startup script                                                                                                                                                                       |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Cores                  | The number of CPU cores to configure for the autoscale agents                                                                                                                                                                                                                          |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Memory                 | The amount of memory in GiB for the autoscale agents                                                                                                                                                                                                                                   |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Disk Image             | The name of the Harvester image to use for autoscale agents. See :ref:`harvester-disk-image` for more details.                                                                                                                                                                         |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Disk Size              | The size of the disk in GiB to use for autoscale agents                                                                                                                                                                                                                                |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Network Type           | The network type for the autoscale agents (pod or multus)                                                                                                                                                                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Interface Type         | The interface type for the autoscale agents (masquerade or bridge)                                                                                                                                                                                                                     |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Network Name           | The name of the network to connect to the autoscale agents to (multus network type only)                                                                                                                                                                                               |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Startup Script         | cloud-init, Bash, or Powershell script to run after agent creation, typically to install the Kasm Agent and/or any other runtime dependencies you may have.                                                                                                                            |
    |                        | Example scripts can be found on our `GitHub repository. <https://github.com/kasmtech/workspaces-autoscale-startup-scripts>`_ Make sure to use the correct script based on the target OS (bash/cloud-init for Linux and Powershell for Windows).                                        |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Configuration Override | A optional config override that contains a complete YAML manifest file used when provisioning the autoscale agents                                                                                                                                                                     |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Enable TPM             | Enable TPM for the autoscale agents                                                                                                                                                                                                                                                    |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Enable EFI Boot        | Enable the EFI bootloader for the autoscale agents                                                                                                                                                                                                                                     |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Enable Secure Boot     | Enable Secure Boot for the autoscale agents (required EFI Boot to be enabled)                                                                                                                                                                                                          |
    +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
```