> For the complete documentation index, see [llms.txt](https://docs.vergeos-demo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vergeos-demo.com/run-the-platform/tenants/create-tenants.md).

# Creating Tenants

## Tenant Creation Methods

VergeOS provides multiple methods for creating new tenants:

* Using the [**Tenant Wizard**](#tenant-wizard)
* [**Cloning**](#tenant-cloning) an Existing tenant
* Using a [**Tenant Recipe**](#tenants-from-recipes)

## Tenant Wizard

The *Tenant Wizard* steps through multiple input forms to create a new custom tenant.

### Create a New Tenant Using the Tenant Wizard

1. Click **Tenants** from the top menu.
2. Select **+ New Tenant**.
3. At the top left, select *From Wizard*.
4. Click **Next**. The ***Tenant Settings***** form is presented.**
5. Enter a ***Name*** for the tenant.
6. ***URL*** is simply a helper field to provide a link to the tenant's UI from the **Connect to UI** menu link in the service provider's VergeOS user interface. This field can be left blank as it will automatically be populated when the first external IP is assigned to the tenant.
7. Enter an ***Admin User Password*** and again in the ***Confirm Admin User Password*** field (required). This sets the password for the tenant’s “admin” root user that will be auto-created.
8. **Optionally**, the **Require Password Change** option can be selected to force a password change when the tenant admin initially logs in.
9. **Optionally**, a **Description** can be entered to record more information about the tenant.
10. By default, the **Expose System Snapshots** option (checkbox) is selected. When selected, the tenant is able to browse the system snapshots of the parent and "self-serve" download their own tenant snapshot from the provider's snapshot timestamps.
11. Configure **Theme access**:
    * ***Cannot create new themes, read-only access to all host themes***
    * ***Cannot create new themes, read-only access specified host themes***
    * ***Can create new themes, no access to host themes***
    * ***Can create new themes, read-only access to host themes***
12. **Optionally**, the **Custom help URL** allows for providing a location for alternate help content for the tenant. Tenant users are directed to this URL when they click help links in the VergeOS UI.
13. **OIDC Application** allows for defining an authorization source for the tenant. The selection list will include OIDC applications defined on the parent. When *--None--* is selected, the local tenant user database is used for authentication.
14. Click **Submit** (bottom of page) to proceed. Continue with the ***New Tenant Node***** form**.

### New Tenant Node Form

Settings defined here will apply to the single tenant node created with the wizard. Additional tenant nodes, if needed, can be created upon completion of the wizard.

{% hint style="success" %}
[**KB Article: *****Tenant Node Planning Guide***](/knowledge-base/tenants/tenant-node-planning-guide.md) **walks through the considerations involved in deciding the number of tenant nodes to employ and RAM/Cores to assign to those tenant nodes.**
{% endhint %}

1. Select the number of ***Cores*** and amount of ***RAM*** to provision to the tenant node.
2. **Optionally**, a ***Cluster*** can be selected to run the tenant, or it can be left at --Default -- (specified by *System >Settings > Default cluster for tenant nodes*)
3. **Optionally**, a **Failover cluster** can be selected to run the tenant if the primary selected cluster is not available. Or it can be left at *--Default --* (specified by *System > Settings > Default failover cluster for tenant nodes*)
4. Defining a **Preferred node** is **Typically Not Recommended for a tenant node**. This is an advanced setting for tenant nodes; setting it incorrectly can adversely affect built-in redundancy. Consult with VergeOS Support for additional assistance.
5. **Optionally**, a **Description** can be entered to record further information for this initial tenant node.
6. Select desired ***On Power Loss*** setting:
   * ***Last State*** - tenant will only be powered on if it was on at the time of power loss.
   * ***Leave Off*** - tenant will not be powered on when power is restored (regardless of its state at the time of power loss).
   * ***Power On*** - tenant will be powered on when power is restored (regardless of its state at the time of power loss).
7. Click the **Submit** button (bottom of page) to proceed. Continue with the ***New Tenant Storage***** form**.

### New Tenant Storage Form

1. Select which **Tier** to use for tenant storage from the **Tier** dropdown menu.
2. Select the amount of storage capacity to be provisioned for the tenant.
3. Click the **Submit** button to proceed. Continue with the **UI Management** form.

### UI Management Form

1. You can optionally assign one external IP to the tenant. External IPs can be assigned to a tenant after creation as well. By default, the first one assigned to a tenant is configured to be the tenant's UI address.
2. Select from the **Assign External IP**\* dropdown. (This list will include all unassigned Virtual IPs defined in the parent).
3. If the desired IP is not already configured as a Virtual IP in the parent system, click ***Create a new External IP*** to create the address:
   * **Network** - select appropriate network from the dropdown list.
   * **Type** - **Virtual IP**
   * **IP Address** - enter the public(external) IP address or leave blank to auto-create the next available IP in the network.
   * **Hostname and Description fields** - can be left blank.
   * **Owner** (dropdown) - name of the new tenant.

{% hint style="success" %}
**Remember that an external IP is one that is external to the VergeOS system; it may or may not be a public Internet address. An external IP can be a private address on your external LAN/WAN, for example: 10.10.10.100**
{% endhint %}

4. Click **Submit** to finish. You should see a message saying the tenant was created successfully and the new tenant dashboard is presented.
5. If a Proxy is being used for tenants, there is an option to **Create a new FQDN** for the tenant

* See [**Create a New Tenant with Proxy**](/knowledge-base/tenants/configuring-proxy.md#creating-a-new-tenant-with-proxy) for instructions on creating a new tenant with a proxy and assigning an FQDN to it.

{% hint style="success" %}
**Apply Rules**

If external IP(s) were assigned to the tenant, rules will need to be applied to the selected external network. Click the orange-highlighted message "Needs Apply Rules" on the tenant dashboard to apply the necessary rules.
{% endhint %}

**To Start the New Tenant:**\
Upon creating a tenant, the UI will land at the tenant dashboard page. From this dashboard page, the tenant can be started by clicking ***Power On*** on the left menu.

## Tenant Cloning

Cloning a tenant will make a duplicate of an existing tenant. This can be very useful for testing, development, restores, and other scenarios when you need a copy of a tenant.

{% hint style="warning" %}
**Cloning Considerations**

When creating clones, be careful to avoid producing conflicts from duplicate IP addresses, MAC addresses, application instances, etc. running on the same network.
{% endhint %}

### Create a New Tenant from a Clone

1. Click **Tenants** on the top menu.
2. Select **+ New Tenant**.
3. In the top left, select the *Clone Existing* option.
4. All VMs will be listed under the ***Selections Available*** area on the right. **Select the desired VM.** Click **Next** (bottom of page). The ***Name***** input form appears**.
5. The ***Name*** for the tenant clone can be changed as desired. (The Name will default to the *NameofSourceVM* +”clone”, for example: when cloning a tenant named “Tenant2”, the Name will default to “Tenant2 clone”.)
6. Optionally, the ***Clone as New Tenant*** option can be selected to create the new tenant instance without accompanying history statistics, logs, and snapshots with expiration. This is the recommended option when these items are not needed.
7. Click **Submit** (bottom of page). The tenant is created and the new tenant dashboard appears.

**To Start the New Tenant:**\
From the tenant dashboard page the tenant can be started by clicking ***Power On*** from the left menu.

## Tenants from Recipes

Tenant recipes allow for automated creation of tenants using a base tenant template and questions that allow customizing each new tenant instance.

The [Tenant Recipes page](/automate-protect-and-extend/automation/tenant-recipes.md) provides information about creating and using tenant recipes.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.vergeos-demo.com/run-the-platform/tenants/create-tenants.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.