> For the complete documentation index, see [llms.txt](https://documentation.ocsinventory-ng.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/proxmox-api/managing-hypervisors.md).

# Managing Hypervisors

A hypervisor is a configured connection to a remote Proxmox server. OCS uses it to authenticate with the Proxmox API and synchronize virtual machine and container inventories.

## Create a Hypervisor

{% stepper %}
{% step %}
Navigate to **Configuration ➜ Inventory ➜ Proxmox Hypervisors** in the top navigation menu.

You'll see the list of existing hypervisors if any.

<figure><img src="https://3061656006-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl1Ar7IGwmD0AGPF9lYkJ%2Fuploads%2FxPMbhnqxDTOcTRIiEGp6%2Focs-proxmox.png?alt=media&amp;token=2101b0df-7f16-42f8-8c92-bfdbcd75b43a" alt="List of existing hypervisors"><figcaption><p>List of existing hypervisors</p></figcaption></figure>
{% endstep %}

{% step %}
Click **Add hypervisor** in the top-right corner.

A form will appear to create a hypervisor entry.
{% endstep %}

{% step %}
Complete the form with:

* **Name**: a unique name for the hypervisor.
* **Description**: a brief description.
* **IP address**: address of the Proxmox server.
* **Port**: port of the Proxmox server (`8006` by default).
* **Node names**: names of the different nodes on the Proxmox server.
* **Proxmox user**: the Proxmox user to log in with.
* **Token ID**: the token that corresponds to the selected user.
* **Token secret**: the secret that corresponds to the selected token and user.
* **Request delay**: time, in milliseconds, between two requests to the same hypervisor during inventory.
* **Active**: if disabled, the Proxmox inventory will not synchronize this hypervisor.

<figure><img src="https://3061656006-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl1Ar7IGwmD0AGPF9lYkJ%2Fuploads%2FQC927z3JyBwP7G4ElvSP%2Fimage_2026-07-30_102323736.png?alt=media&amp;token=7e87d13c-0a4a-485a-9cd6-8228cb75c3ad" alt="Hypervisor creation form" width="563"><figcaption><p>Hypervisor creation form</p></figcaption></figure>
{% endstep %}

{% step %}
Click **Add** to create the hypervisor.

The page will refresh, and your new hypervisor will be displayed in the list.
{% endstep %}
{% endstepper %}

## Edit a Hypervisor

{% stepper %}
{% step %}
In the **Action** column of the Hypervisors table, click the pencil icon for the hypervisor you want to edit.
{% endstep %}

{% step %}
Update the form.

* **Name**: change the name if needed.
* **Description**: update the hypervisor's description.
* **IP address**: correct the address if needed.
* **Port**: adjust the port if needed.
* **Node names**: add, update, or remove node names.
* **Proxmox user**: change the Proxmox user if needed.
* **Token ID**: update the token ID.
* **Token secret**: update the token secret.
* **Request delay**: adjust the request delay.
* **Active**: enable or disable the hypervisor.

<figure><img src="https://3061656006-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl1Ar7IGwmD0AGPF9lYkJ%2Fuploads%2FwF335tWDlfq0aA6NnoCX%2Fimage_2026-07-30_102415865.png?alt=media&amp;token=65a135ab-a4ef-430f-a9f1-6e11c21c15f3" alt="Example: editing the hypervisor&#x27;s description" width="563"><figcaption><p>Example: editing the hypervisor's description</p></figcaption></figure>
{% endstep %}

{% step %}
Save your changes.

Click **Save** to apply your updates.
{% endstep %}
{% endstepper %}

## Removing a Hypervisor

{% stepper %}
{% step %}
In the **Action** column of the Hypervisors table, locate the hypervisor you want to remove and click the trash icon.
{% endstep %}

{% step %}
When prompted, confirm the deletion to permanently remove the hypervisor.
{% endstep %}
{% endstepper %}


---

# 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, and the optional `goal` query parameter:

```
GET https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/proxmox-api/managing-hypervisors.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
