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

```{figure} /images/compute/vm_oracle.webp
:align: center
**OCI VM Provider**
```

```{eval-rst}
.. table:: OCI VM Provider Settings
    :widths: 75

    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | Name                              | Description                                                                                                                     |
    +===================================+=================================================================================================================================+
    | **Name**                          | A name to use to identify the config.                                                                                           |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **User OCID**                     | The OCID of the user to authenticate with the OCI API. (e.g ocid1.user.oc1..xyz).                                               |
    |                                   | You can find this by going to your OCI dashboard -> Click on your Profile -> You can find your user OCID here.                  |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Public Key Fingerprint**        | The public key fingerprint of the authenticated API user created in OCI. (e.g xx:yy:zz:11:22:33)                                |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Private Key**                   | The private key (PEM format) of the authenticated API user created in OCI.                                                      |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Region**                        | The OCI Region name. (e.g us-ashburn-1).                                                                                        |
    |                                   | See `Regions <https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm>`_ for the list                           |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Tenancy OCID**                  | The Tenancy OCID for the OCI account.  (e.g ocid1.tenancy.oc1..xyz)                                                             |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Compartment OCID**              | The Compartment OCID where the auto-scaled agents will be placed. (e.g ocid1.compartment.oc1..xyx)                              |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Network Security Group OCIDs**  | A JSON list of Security Group OCIDs that will be assigned to the auto-scaled agents.                                            |
    | **(JSON)**                        | (e.g :code:`["ocid1.networksecuritygroup.oc1.iad.xxx","ocid1.networksecuritygroup.oc1.iad.yyy"]`).                              |
    |                                   | To create or find existing Network Security Groups, go to your OCI dashboard -> "Network Security Groups".                      |
    |                                   | See `Network Security Groups <https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/networksecuritygroups.htm>`_ for more |
    |                                   | details                                                                                                                         |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Max Instances**                 | The maximum number of OCI compute instances to provision regardless of the need for available free slots.                       |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Availability Domains (JSON)**   | A JSON list of availability domains where the OCI compute instances may be placed.                                              |
    |                                   | (e.g :code:`["BEol:US-ASHBURN-AD-1", "BEol:US-ASHBURN-AD-2"]`).                                                                 |
    |                                   | See `Availability Domains <https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm>`_ for more details          |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Image OCID**                    | The OCID of the Image to use when creating the compute instances. (e.g ocid1.image.oc1.iad.xyz)                                 |
    |                                   | See `OCI Image Families <https://docs.oracle.com/en-us/iaas/images/>`_ for the list                                             |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Shape**                         | The name of the shape used for the created compute instances. (e.g VM.Standard.E4.Flex)                                         |
    |                                   | See `OCI Compute Shapes <https://docs.oracle.com/en-us/iaas/Content/Compute/References/computeshapes.htm>`_ for the list        |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Flex CPUs**                     | The number of OCPUs to assign the compute instance. This is only applicable when a Flex shape is used.                          |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Burstable Base CPU**            | The baseline percentage of a CPU Core that can be use continuously on a burstable instance (Select 100% to use a non-burstable  |
    | **Utilization**                   | instance). `Reference <https://docs.oracle.com/en-us/iaas/Content/Compute/References/burstable-instances.htm>`__.               |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Flex Memory GB**                | The amount of memory (in GB) to assign the compute instance. This is only applicable when a Flex shape is used.                 |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Boot Volume GB**                | The size (in GB) of the boot volume to assign the compute instance.                                                             |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Boot Volume VPUs Per GB**       | The Volume Performance Units (VPUs) to assign to the boot volume. Values between 10 and 120 in mulitples of 10 are acceptable.  |
    |                                   | 10 is the default and represents the `Balanced` profile. The higher the VPUs, the higher the volume performance and cost.       |
    |                                   | `Reference <https://docs.oracle.com/en-us/iaas/Content/Block/Concepts/blockvolumeperformance.htm#Block_Volume_Performance>`__.  |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Custom Tags (JSON)**            | A Json dictionary of custom freeform tags to assigned the auto-scaled instances. e.g :code:`{"foo":"bar", "bin":"baz"}`         |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Subnet OCID**                   | The OCID of the Subnet where the auto-scaled instances will be placed. (e.g ocid1.subnet.oc1.iad.xyz)                           |
    |                                   | To create or find existing subnets, go to your OCI dashboard -> "Networking" -> "Virtual Cloud Networks" -> "Subnets"           |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **SSH Public Key**                | The SSH public key to insert into the compute instances if you want to SSH into your instances. (e.g ssh-rsa XYABC)             |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Startup Script**                | When instances are provisioned, this script is executed and is responsible for installing and configuring the Kasm Agent.       |
    |                                   | Example scripts can be found on our `GitHub repository <https://github.com/kasmtech/workspaces-autoscale-startup-scripts>`_     |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OCI Config Override**           | A JSON dictionary that can be used to customize attributes of the VM request. An OCI Model can be specified with the            |
    |                                   | "OCI_MODEL_NAME" key.                                                                                                           |
    |                                   | Reference: `OCI Python Docs <https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Instance/LaunchInstance>`__              |
    |                                   | and `Kasm Examples <#oci-config-override-examples>`__.                                                                          |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+

```