# OCS Inventory - Wiki

## OCS Inventory v3 - Wiki

- [Welcome to OCS Inventory](https://documentation.ocsinventory-ng.org/project-overview/readme.md)
- [Introduction](https://documentation.ocsinventory-ng.org/project-overview/introduction.md)
- [Release notes](https://documentation.ocsinventory-ng.org/project-overview/release-notes.md)
- [Useful links](https://documentation.ocsinventory-ng.org/project-overview/useful-links.md)
- [v2 vs v3: What’s changed?](https://documentation.ocsinventory-ng.org/project-overview/v2-vs-v3-whats-changed.md)
- [Migration guidelines](https://documentation.ocsinventory-ng.org/project-overview/migration-guide.md)
- [Migrating the administrative data](https://documentation.ocsinventory-ng.org/project-overview/migration-guide/migrating-the-administrative-data.md)
- [Enterprise support](https://documentation.ocsinventory-ng.org/project-overview/enterprise-support.md): OCS Inventory: Free software, sustainable project
- [For Users](https://documentation.ocsinventory-ng.org/quickstart-guides/for-users.md)
- [Console overview](https://documentation.ocsinventory-ng.org/quickstart-guides/for-users/console-overview.md)
- [Base and Template Inventory](https://documentation.ocsinventory-ng.org/quickstart-guides/for-users/base-and-template-inventory.md)
- [Using the Multi-criteria search](https://documentation.ocsinventory-ng.org/quickstart-guides/for-users/using-the-multi-criteria-search.md)
- [For Administrators](https://documentation.ocsinventory-ng.org/quickstart-guides/for-administrators.md)
- [Installation essentials](https://documentation.ocsinventory-ng.org/quickstart-guides/for-administrators/installation-essentials.md)
- [Agent setup](https://documentation.ocsinventory-ng.org/quickstart-guides/for-administrators/agent-setup.md)
- [Asset Management](https://documentation.ocsinventory-ng.org/user-docs/asset-management.md)
- [Inventory and Templates](https://documentation.ocsinventory-ng.org/user-docs/asset-management/inventory-and-templates.md)
- [Software inventory](https://documentation.ocsinventory-ng.org/user-docs/asset-management/inventory-and-templates/software-inventory.md)
- [Managing template versions](https://documentation.ocsinventory-ng.org/user-docs/asset-management/inventory-and-templates/managing-template-versions.md)
- [Asset Groups](https://documentation.ocsinventory-ng.org/user-docs/asset-management/asset-groups.md)
- [Administrative Data](https://documentation.ocsinventory-ng.org/user-docs/asset-management/administrative-data.md)
- [Console Tools](https://documentation.ocsinventory-ng.org/user-docs/console-tools.md)
- [Multi-criteria search](https://documentation.ocsinventory-ng.org/user-docs/console-tools/multi-criteria-search.md)
- [Saved searches](https://documentation.ocsinventory-ng.org/user-docs/console-tools/saved-searches.md)
- [Deployment](https://documentation.ocsinventory-ng.org/user-docs/deployment.md)
- [Packages](https://documentation.ocsinventory-ng.org/user-docs/deployment/packages-and-actions.md)
- [Actions](https://documentation.ocsinventory-ng.org/user-docs/deployment/actions.md)
- [Results](https://documentation.ocsinventory-ng.org/user-docs/deployment/results.md)
- [Deployment workflow](https://documentation.ocsinventory-ng.org/user-docs/deployment/deployment-workflow.md)
- [System Requirements](https://documentation.ocsinventory-ng.org/administrator-docs/system-requirements.md)
- [Scalability and Performance](https://documentation.ocsinventory-ng.org/administrator-docs/scalability-and-performance.md)
- [Server Setup](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup.md)
- [Installation methods](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/installation-methods.md)
- [Using Official Repositories](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/installation-methods/using-official-repositories.md)
- [Running OCS Inventory Server with Docker](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/installation-methods/docker-installation.md)
- [Security](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/security.md)
- [Securing OCS with SSL](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/security/securing-ocs-with-ssl.md)
- [Encryption Key](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/security/encryption-key.md)
- [Configuration](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration.md)
- [Configuration basics](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/basics.md)
- [Users](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/basics/users.md)
- [Groups and permissions](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/basics/groups-and-permissions.md)
- [General configuration](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/basics/general-configuration.md)
- [Authentication](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/basics/authentication.md)
- [Advanced configuration](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/advanced.md)
- [Managing Rules](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/advanced/managing-rules.md)
- [Compliance](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/advanced/compliance.md)
- [Automated actions](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/advanced/automations.md)
- [Inventory logs](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/advanced/inventory-logs.md)
- [Advanced settings](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/configuration/advanced/advanced-settings.md)
- [Customization](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/customization.md)
- [Categories](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/customization/categories.md)
- [Dashboard](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/customization/dashboard.md)
- [Virtual columns and layouts](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/customization/virtual-columns-and-layouts.md)
- [Troubleshooting](https://documentation.ocsinventory-ng.org/administrator-docs/server-setup/troubleshooting.md)
- [Network Discovery](https://documentation.ocsinventory-ng.org/administrator-docs/network-discovery.md)
- [IPDiscover](https://documentation.ocsinventory-ng.org/administrator-docs/network-discovery/ipdiscover.md)
- [Network groups](https://documentation.ocsinventory-ng.org/administrator-docs/network-discovery/network-groups.md)
- [SNMP](https://documentation.ocsinventory-ng.org/administrator-docs/network-discovery/snmp.md)
- [Agent Setup](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup.md)
- [Agent overview](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/agent-overview.md)
- [Installation methods](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/installation-methods.md)
- [Linux installation](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/installation-methods/using-official-repositories-linux.md)
- [MacOS installation](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/installation-methods/macos-installation.md)
- [Windows installation](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/installation-methods/windows-installation.md)
- [Configuration](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/configuration.md): Configure how the agent runs, connects to the server, and handles deployment.
- [Updating the agent](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/updating-the-agent.md)
- [Uninstalling the agent](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/uninstalling-the-agent.md)
- [Managing legacy devices](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/managing-legacy-devices.md): Connect and reconcile devices that use OCS Inventory Agent 2.x.
- [Troubleshooting](https://documentation.ocsinventory-ng.org/administrator-docs/agent-setup/troubleshooting.md)
- [Setup development environment](https://documentation.ocsinventory-ng.org/developer-docs/setup-development-environment.md)
- [Backend](https://documentation.ocsinventory-ng.org/developer-docs/setup-development-environment/backend.md)
- [Frontend](https://documentation.ocsinventory-ng.org/developer-docs/setup-development-environment/frontend.md)
- [Agent](https://documentation.ocsinventory-ng.org/developer-docs/setup-development-environment/agent.md)
- [Docker](https://documentation.ocsinventory-ng.org/developer-docs/setup-development-environment/docker.md)
- [Default Inventoried Data](https://documentation.ocsinventory-ng.org/default-inventoried-data.md)
- [Legacy Agent](https://documentation.ocsinventory-ng.org/default-inventoried-data/legacy-agent.md)
- [Windows Agent](https://documentation.ocsinventory-ng.org/default-inventoried-data/windows-agent.md)
- [Linux Agent](https://documentation.ocsinventory-ng.org/default-inventoried-data/linux-agent.md)
- [MacOS Agent](https://documentation.ocsinventory-ng.org/default-inventoried-data/macos-agent.md)
- [Open API Reference](https://documentation.ocsinventory-ng.org/open-api-reference.md)
- [Accountinfo](https://documentation.ocsinventory-ng.org/open-api-reference/accountinfo.md)
- [Api Auth](https://documentation.ocsinventory-ng.org/open-api-reference/api-auth.md)
- [Api Check](https://documentation.ocsinventory-ng.org/open-api-reference/api-check.md)
- [Asset](https://documentation.ocsinventory-ng.org/open-api-reference/asset.md)
- [Auth Config](https://documentation.ocsinventory-ng.org/open-api-reference/auth-config.md)
- [Auth Mapping](https://documentation.ocsinventory-ng.org/open-api-reference/auth-mapping.md)
- [Auth Method](https://documentation.ocsinventory-ng.org/open-api-reference/auth-method.md)
- [Automation](https://documentation.ocsinventory-ng.org/open-api-reference/automation.md)
- [Categories](https://documentation.ocsinventory-ng.org/open-api-reference/categories.md)
- [Compliance](https://documentation.ocsinventory-ng.org/open-api-reference/compliance.md)
- [Config](https://documentation.ocsinventory-ng.org/open-api-reference/config.md)
- [Dashboard](https://documentation.ocsinventory-ng.org/open-api-reference/dashboard.md)
- [Debug](https://documentation.ocsinventory-ng.org/open-api-reference/debug.md)
- [Deployment](https://documentation.ocsinventory-ng.org/open-api-reference/deployment.md)
- [Extensions](https://documentation.ocsinventory-ng.org/open-api-reference/extensions.md)
- [Fields](https://documentation.ocsinventory-ng.org/open-api-reference/fields.md)
- [Filemanager](https://documentation.ocsinventory-ng.org/open-api-reference/filemanager.md)
- [Groups](https://documentation.ocsinventory-ng.org/open-api-reference/groups.md)
- [Myaccount](https://documentation.ocsinventory-ng.org/open-api-reference/myaccount.md)
- [Netdevices](https://documentation.ocsinventory-ng.org/open-api-reference/netdevices.md)
- [Netgroups](https://documentation.ocsinventory-ng.org/open-api-reference/netgroups.md)
- [Networks](https://documentation.ocsinventory-ng.org/open-api-reference/networks.md)
- [Notes](https://documentation.ocsinventory-ng.org/open-api-reference/notes.md)
- [Permissions](https://documentation.ocsinventory-ng.org/open-api-reference/permissions.md)
- [Search](https://documentation.ocsinventory-ng.org/open-api-reference/search.md)
- [Sections](https://documentation.ocsinventory-ng.org/open-api-reference/sections.md)
- [Server Info](https://documentation.ocsinventory-ng.org/open-api-reference/server-info.md)
- [Snmp](https://documentation.ocsinventory-ng.org/open-api-reference/snmp.md)
- [Software Dictionary](https://documentation.ocsinventory-ng.org/open-api-reference/software-dictionary.md)
- [Software Mapping](https://documentation.ocsinventory-ng.org/open-api-reference/software-mapping.md)
- [Templates](https://documentation.ocsinventory-ng.org/open-api-reference/templates.md)
- [Users](https://documentation.ocsinventory-ng.org/open-api-reference/users.md)
- [Virtual Cols](https://documentation.ocsinventory-ng.org/open-api-reference/virtual-cols.md)
- [Models](https://documentation.ocsinventory-ng.org/open-api-reference/models.md)

## OCS Inventory v3 - Extensions

- [Introduction](https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/overview/introduction.md)
- [Managing Extensions](https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/overview/managing-extensions.md)
- [Proxmox API](https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/proxmox-api.md)
- [Managing Hypervisors](https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/proxmox-api/managing-hypervisors.md)
- [Inventory Synchronization](https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/proxmox-api/inventory-synchronization.md)
- [Proxmox Inventory and Templates](https://documentation.ocsinventory-ng.org/ocs-inventory-v3-extensions/proxmox-api/proxmox-inventory-and-templates.md)


---

# 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
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.ocsinventory-ng.org/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
