# Versio.io Manual

> Manual for users and administrators of Versio.io, the platform for automated IT inventory (CMDB/ITAM), change monitoring, lifecycle and vulnerability management and compliance.

Versio.io is a software platform that automatically inventories enterprise IT landscapes (CMDB/ITAM),
records every change in a temporal database, evaluates the release, end-of-life and vulnerability (CVE)
status of all hardware and software in use and verifies compliance with internal policies and regulations.
Versio.io is available as SaaS (https://live.versio.io) or on-premises (Versio.io Managed).
Data is collected by the OneImporter/OneGate agents and agentless connectors.

This manual covers agent installation, on-premises platform operation, all importers, the solutions,
alerting integrations and the REST API.

OpenAPI specifications of the REST API:

- [Inventory (database) API](https://docs.versio.io/openapi/versio-database.openapi.json)
- [Monitoring API](https://docs.versio.io/openapi/versio-monitoring.openapi.json)
- [Topology API](https://docs.versio.io/openapi/versio-topology.openapi.json)
- [Ticketing API](https://docs.versio.io/openapi/versio-ticketing.openapi.json)

Product website: https://www.versio.io

## Welcome

- [Welcome to the Versio.io Manual](<https://docs.versio.io/index.md>): Versio.io manual: install OneImporter and OneGate, run Versio.io Managed on-premises, configure alerting and integrate the REST API.
- [Versio.io in a nutshell](<https://docs.versio.io/in-a-nutshell/index.md>): Seven-minute video introduction to Versio.io, the platform for automated IT inventory, change monitoring, lifecycle and compliance.
- [Glossary](<https://docs.versio.io/glossary/index.md>): Glossary of Versio.io terms from API token, asset and benchmark to configuration item, entity, instance, change, policy and workspace.

## OneImporter and OneGate

- [Fundamentals](<https://docs.versio.io/all-about-oneimporter-and-onegate/index.md>): What the OneImporter and OneGate agents do, how they differ and how they inventory hosts, devices and third-party systems securely.
- [System requirements](<https://docs.versio.io/setup-one-importer-systemrequirements/index.md>): System requirements for OneImporter and OneGate: supported Linux and Windows hosts, CPU, memory, locale settings and network access.
- [Installation &amp; update](<https://docs.versio.io/setup-one-importer/index.md>): Install, start, stop and update OneImporter and OneGate as systemd service or Docker container, with parameters and IaC configuration.
- [HTTP proxy usage](<https://docs.versio.io/http-proxy/index.md>): Configure OneImporter and OneGate to use an HTTP proxy via environment variables, with lessons learned from enterprise projects.

## Platform (OnPrem)

- [System requirements](<https://docs.versio.io/setup-managed-system-requirements/index.md>): System requirements for Versio.io Managed on-premises: dedicated 64-bit Linux host, hardware sizing, Docker or Podman and validation script.
- [Installation](<https://docs.versio.io/setup-managed/index.md>): Install Versio.io Managed in your own data centre: run the system requirements check, download the installer and set up the platform.
- [Customizing](<https://docs.versio.io/setup-managed-customizing/index.md>): Customise Versio.io Managed: environment variables, configuration files, SSL certificates, reverse proxy, document storage and limits.
- [Operation](<https://docs.versio.io/setup-managed-operation/index.md>): Operate Versio.io Managed: start up, check the status, shut down and update the container images and the database schema.
- [Backup &amp; Restore](<https://docs.versio.io/setup-managed-backup-restore/index.md>): Back up and restore all content data of a Versio.io Managed instance with the backup script, including a daily crontab setup.
- [Staging](<https://docs.versio.io/setup-managed-staging/index.md>): Run test, acceptance and production stages with Versio.io Managed by deploying a specific monthly release via VERSIO_RELEASE.
- [Mission control](<https://docs.versio.io/mission-control/index.md>): Versio.io Mission Control: optional service that supports the operation and maintenance of Versio.io Managed instances on-premises.

## General UI settings

- [Reset user password](<https://docs.versio.io/user-reset-password/index.md>): First login to Versio.io: set or reset your user password via the e-mail link and find the environment you have access to.
- [User profile settings](<https://docs.versio.io/user-profile-settings/index.md>): Personal Versio.io settings: name, avatar, default environment, password, two-factor authentication and training certificates.
- [User right management](<https://docs.versio.io/user-right-management/index.md>): Versio.io user rights management: environments, users, user groups and workspaces to restrict access to functions and data.
- [Tagging](<https://docs.versio.io/best-practice-instance-change-tagging/index.md>): Tag instances and changes in Versio.io with owner, cost centre or service - manually in the web UI, by policies or via API.

## Importer

- [Host](<https://docs.versio.io/importer-host/index.md>): Host importer: inventory and historise the host a OneImporter runs on - hardware, operating system, network and processes.
- [Host installed software](<https://docs.versio.io/importer-host-installed-software/index.md>): Inventory installed software on Windows, macOS and Linux (Debian, Red Hat, Arch) hosts with zero configuration, and the commands used.
- [Host infrastructure monitoring](<https://docs.versio.io/importer-host-infrastructure-monitoring/index.md>): Collect host infrastructure metrics such as CPU, memory, disk and network with OneImporter for monitoring in Versio.io.
- [Host peripherals](<https://docs.versio.io/importer-host-peripherals/index.md>): Inventory peripherals connected to hosts, such as monitors and Dell docking stations, to keep hardware records up to date.
- [File configuration](<https://docs.versio.io/importer-file-configuration/index.md>): Import, historise and monitor configuration files in formats such as JSON, YAML, XML and INI to detect every change.
- [Folder structure](<https://docs.versio.io/importer-folder-structure/index.md>): Inventory and monitor the metadata of folder structures and files, including size, timestamps and changes over time.
- [Database schema](<https://docs.versio.io/importer-database-schema/index.md>): Import and monitor database schemas with tables and views from Oracle, SQL Server, MySQL, MariaDB and PostgreSQL for audits.
- [SSL certificate](<https://docs.versio.io/importer-ssl-certificate/index.md>): Import and monitor SSL/TLS certificates by domain, host or IP address with OneImporter and track every certificate change.
- [Port scan](<https://docs.versio.io/importer-port-scan/index.md>): Scan IP and port ranges with OneImporter and historise open ports to detect unexpected services and network changes.
- [Application frontend](<https://docs.versio.io/importer-application-frontend/index.md>): Detect the libraries and frameworks used by web applications by domain or IP address and historise them in Versio.io.
- [Application user](<https://docs.versio.io/importer-application-user-inventory/index.md>): Application user inventory: capture users, bots and synthetic monitoring of web applications from end-user devices.
- [Kubernetes](<https://docs.versio.io/importer-kubernetes/index.md>): Kubernetes importer: inventory Kubernetes clusters with OneImporter, from nodes and namespaces to containers, with change history.
- [VMware vSphere](<https://docs.versio.io/importer-vmware-vsphere/index.md>): VMware vSphere importer: connect Versio.io to your vSphere server and inventory your virtual infrastructure with change history.
- [Proxmox PVE](<https://docs.versio.io/importer-proxmox/index.md>): Proxmox VE importer: inventory your Proxmox Virtual Environment via a Proxmox API token, with full change history in Versio.io.
- [Microsoft Azure](<https://docs.versio.io/importer-microsoft-azure/index.md>): Microsoft Azure importer: inventory Azure subscriptions and resources via an app registration with the required API permissions.
- [Amazon Web Services](<https://docs.versio.io/importer-amazon-web-services/index.md>): Amazon Web Services importer: inventory your AWS resources with an access key ID and secret access key, with full change history.
- [Google Cloud Platform](<https://docs.versio.io/importer-google-cloud/index.md>): Google Cloud Platform importer: inventory GCP projects and resources using a service account JSON key.
- [Hetzner Cloud](<https://docs.versio.io/importer-hetzner-cloud/index.md>): Hetzner Cloud importer: inventory your Hetzner Cloud servers and resources via a Hetzner Cloud API token, with change history.
- [OVHcloud](<https://docs.versio.io/importer-ovh-cloud/index.md>): OVHcloud importer: inventory your OVHcloud resources with a read-only consumer key and app credentials, with full change history.
- [Aruba Mobility Conductor](<https://docs.versio.io/importer-aruba-mobility-conductor/index.md>): Aruba Mobility Conductor importer: inventory Aruba network devices and their configuration via a dedicated API user.
- [Check Point](<https://docs.versio.io/importer-checkpoint/index.md>): Check Point importer: inventory Check Point firewalls and their configuration via a dedicated API user.
- [F5](<https://docs.versio.io/importer-f5/index.md>): F5 importer: inventory F5 network devices and their configuration via a dedicated API user, with full change history.
- [Fortinet](<https://docs.versio.io/importer-fortinet/index.md>): Fortinet importer: inventory FortiGate firewalls with interfaces, policies, VPNs, objects, licences, admins and optional metrics.
- [Extreme](<https://docs.versio.io/importer-extreme/index.md>): Extreme Networks importer: inventory Extreme network devices and their configuration via a dedicated device user.
- [Hirschmann](<https://docs.versio.io/importer-hirschmann/index.md>): Hirschmann importer: inventory Hirschmann network devices running Classic OS or HiOS and their configuration.
- [Juniper Networks](<https://docs.versio.io/importer-juniper-networks/index.md>): Juniper Networks importer: inventory Juniper devices, configuration and network topology via an inventory group and user.
- [Palo Alto](<https://docs.versio.io/importer-palo-alto/index.md>): Palo Alto Networks importer: inventory Palo Alto firewalls and their configuration via a dedicated API user.
- [Corroventa SuperVision](<https://docs.versio.io/importer-corroventa/index.md>): Corroventa SuperVision importer: import and historise OT/IoT data from the Corroventa SuperVision portal via an API token.
- [Active Directory](<https://docs.versio.io/importer-active-directory/index.md>): Active Directory importer: inventory directory data from Microsoft Active Directory via LDAP with full change history.
- [Microsoft 365](<https://docs.versio.io/importer-microsoft-365/index.md>): Microsoft 365 importer: inventory M365 identity data via an Entra ID app registration, including the required API permissions.
- [Microsoft Intune](<https://docs.versio.io/importer-microsoft-intune/index.md>): Microsoft Intune importer: inventory managed devices from Intune, including the required API permissions and known limits.
- [Event receiver](<https://docs.versio.io/importer-event-receiver/index.md>): Event receiver: receive events via SNMP trap, Syslog and MQTT in Versio.io, with firewall and syslog troubleshooting.
- [Database base content](<https://docs.versio.io/importer-generic-database-content/index.md>): Import and historise any database content from Oracle, SQL Server, MySQL, MariaDB or PostgreSQL via SQL queries.
- [REST API content](<https://docs.versio.io/importer-generic-rest-api-content/index.md>): Import and historise content from any REST API into Versio.io, mapping objects and IDs with JSON paths on a cron schedule.
- [Microsoft Excel](<https://docs.versio.io/importer-microsoft-excel/index.md>): Import your own configuration items into the Versio.io CMDB from Microsoft Excel using the predefined Excel template.
- [Approach](<https://docs.versio.io/importer-benchmark-approach/index.md>): Continuous hardening with Versio.io: scan, manage and remediate security benchmark results such as CIS and DISA STIG in one loop.
- [Scanner rules import](<https://docs.versio.io/importer-benchmark-rules/index.md>): Import benchmark profiles and rules from scanners such as OpenSCAP into Versio.io for security audits and remediation.
- [Scanner result integration](<https://docs.versio.io/importer-benchmark-scanner-results/index.md>): Integrate benchmark scanner results in XCCDF format, for example from the Ubuntu Security Guide, into Versio.io.
- [Scanner overview](<https://docs.versio.io/importer-benchmark-scanner-overview/index.md>): Overview of open-source, free and commercial security and hardening benchmark scanners that work with Versio.io.
- [Audit log](<https://docs.versio.io/versio-audit-log/index.md>): Versio.io audit log importer: historise all Versio.io configurations to trace every configuration change in the platform.
- [Network scan](<https://docs.versio.io/importer-network-scan/index.md>): Network scan: discover IP devices via ARP, ping, reverse DNS, ports and SNMP to verify the completeness of your inventory.

## Solution

- [Ticketing](<https://docs.versio.io/solution-ticketing/index.md>): Versio.io ticketing: create, edit, merge, split and report tickets with tasks, participants, documents and affected instances.
- [Ticket configuration](<https://docs.versio.io/solution-ticketing-configuration/index.md>): Versio.io ticket types - incident, problem, change request, epic, risk and more - with configuration, defaults and workflows.
- [Workflow states](<https://docs.versio.io/solution-ticketing-workflow-states/index.md>): Workflow states shared by all Versio.io ticket types and how allowed transitions are defined per ticket type.
- [External synchronization](<https://docs.versio.io/solution-ticketing-external-synchronization/index.md>): Synchronise Versio.io tickets one-way into external issue and service management systems, with the supported fields.
- [Assessment criteria](<https://docs.versio.io/risk-assessment-criteria/index.md>): How Versio.io assesses risks: severity, protection requirement index, risk score, group risk score and the risk matrix.
- [Instance history viewer](<https://docs.versio.io/solution-cmdb-configuration-management-database/index.md>): Versio.io CMDB: instance viewer, instance history viewer, object viewer, metadata and topology of configuration items and assets.
- [Operation diary](<https://docs.versio.io/solution-cmdb-configuration-management-database-operation-diary/index.md>): Operation diary: statistics and details of all changes in your IT environment as audit evidence for BaFin, ECB or ISO.
- [Inventory analysis](<https://docs.versio.io/solution-cmdb-configuration-management-database-inventory-analysis/index.md>): Inventory analysis: group, count and calculate hardware, software and application CIs with pivot tables in Versio.io.
- [Topology analysis](<https://docs.versio.io/solution-cmdb-configuration-management-database-topology-analysis/index.md>): Topology analysis: visualise CMDB topologies and their history to understand the architecture of your IT landscape.
- [Change task](<https://docs.versio.io/solution-change-request-management/index.md>): Change task management: define planned changes, monitor live changes in the change window and document their correct execution.
- [Dashboard](<https://docs.versio.io/solution-product-lifecycle-vulnerability/index.md>): Product lifecycle and vulnerability dashboard: release, EOL and support status and known CVEs of all detected product versions.
- [Bill of Material](<https://docs.versio.io/bill-of-material/index.md>): Export a machine-readable bill of materials (BOM) of your entire IT infrastructure - hardware, software and libraries - from Versio.io.
- [General](<https://docs.versio.io/solution-cmdb-governance-compliance-risk/index.md>): Policy monitoring: check configuration items and changes against governance, compliance and risk rules and document violations.
- [Policies](<https://docs.versio.io/solution-cmdb-governance-compliance-risk-policy-definiton/index.md>): Define Versio.io policies with rules, logic and JavaScript to check every change against customer-specific or regulatory guidelines.
- [Benchmarks](<https://docs.versio.io/solution-security-hardening-benchmarks/index.md>): Security and hardening benchmarks: import results from any scanner, assess fulfilment and manage them in device and governance dashboards.
- [Technology radar](<https://docs.versio.io/solution-ea-technology-radar/index.md>): Technology radar for enterprise architecture management: map, assess and manage your technology portfolio in Versio.io.
- [Process map](<https://docs.versio.io/solution-ea-process-map/index.md>): Process map for enterprise architecture management: model business processes and link them to applications and IT infrastructure.
- [Infrastructure monitoring](<https://docs.versio.io/infrastructure-monitoring/index.md>): Infrastructure monitoring in Versio.io: metric sampling rate, downsampling and historisation, custom metrics via API and supported metrics.
- [Service-level management](<https://docs.versio.io/solution-service-level-management/index.md>): Service-level management: define SLAs and SLOs, monitor them in a dashboard and calculate penalty billing in Versio.io.
- [Process &amp; job monitoring](<https://docs.versio.io/settings-cmdb-business-process-job-monitoring/index.md>): Set up business process and batch job monitoring: define process models and derive process steps from instance changes.

## Alerting

- [E-mail](<https://docs.versio.io/integrations-email/index.md>): E-mail alerting: send Versio.io events such as violations and assessment changes by e-mail, with customisable templates.
- [GitLab](<https://docs.versio.io/integrations-gitlab/index.md>): GitLab integration: create and close GitLab incident issues automatically from Versio.io events.
- [TOPdesk](<https://docs.versio.io/integrations-topdesk/index.md>): TOPdesk integration: create first-line and second-line incidents in TOPdesk automatically from Versio.io events.
- [Telegram](<https://docs.versio.io/integrations-telegram/index.md>): Telegram integration: send Versio.io alerting notifications to a Telegram chat via the Versio.io Alerting Bot.
- [n8n Event Umbrella](<https://docs.versio.io/n8n-node-versioio-event-umbrella/index.md>): Versio.io Event Umbrella node for n8n: send custom events from any n8n workflow to Versio.io for central monitoring.

## API

- [Overview](<https://docs.versio.io/api-overview/index.md>): Overview of the Versio.io REST API for importing data, automating tasks, building integrations and exporting data, with OpenAPI specs.
- [Authentication](<https://docs.versio.io/api-authentification/index.md>): Authenticate against the Versio.io REST API: generate and manage API tokens with fine-grained permissions and use them in requests.
- [Fundamentals](<https://docs.versio.io/api-fundamentals/index.md>): Versio.io API fundamentals: UTC millisecond timestamps, request throttling of 50 requests per minute and HTTP response codes.

## Knowledge base

- [JSON Path](<https://docs.versio.io/best-practices-json-path/index.md>): Best-practice JsonPath statements for Versio.io configurations, reporting and generic importers, with examples.
- [Understand Linux kernel](<https://docs.versio.io/best-practices-linux-os-and-kernel-version/index.md>): Understand Linux OS and kernel versions in Ubuntu, Debian and RHEL and why they matter for lifecycle and vulnerability checks.
- [Application assignment](<https://docs.versio.io/settings-application-assignment/index.md>): Assign host processes and services to applications with VERSIO_APPLICATION_ID - for shell scripts, Docker and Docker Compose.

## Service and trust

- [Release notes](<https://docs.versio.io/release-notes/index.md>): Monthly Versio.io release notes: new features, platform updates, security alerts and blog posts for SaaS and Managed customers.
- [Support](<https://docs.versio.io/support/index.md>): Versio.io support: scope, service hours from 9 a.m. to 5 p.m. CET, optional 24/7 support and how to create an incident ticket.
- [Maintenance](<https://docs.versio.io/maintenance/index.md>): Versio.io maintenance: rolling release strategy, monthly versions, update strategy for SaaS and Managed, PLV content and end of life.
- [PoC guidelines](<https://docs.versio.io/template-poc-guidelines/index.md>): Guidelines and templates for a Versio.io proof of concept: participants, motivation, requirements, success criteria and procedure.
- [Operation manual](<https://docs.versio.io/template-operation-manual/index.md>): Template for an operating manual for Versio.io Managed: responsibilities, installation, updates, SSL, backup and restore.
- [Legal &amp; trust center](<https://docs.versio.io/legal/index.md>): Versio.io legal and trust centre: privacy policy, technical and organisational measures, SLA, terms of use and accessibility.