/
TenantOS

TenantOS

Dec 08, 2025

Overview

Tenantos is a comprehensive server management and automation platform for hosting providers, data centers, and IT admins, offering a unified interface to control physical servers, virtual machines and external provider servers from one place. The TenantOS module for HostBill delivers a complete automation and billing solution for providers selling dedicated servers through the TenantOS platform.


What happens during account provisioning using this module?

When you accept the order or click on create in account our module will:
- create an user in TenantOS
- find a server with no owner (using tags to search)
- update server owner and name
- update server IPs to product limit, this may remove current IP and re-add another.
- start os installation

Activating the module

  1. If the module is included in your HostBill edition you can download it from your client portal.
  2. If the module is not included in your HostBill edition you can purchase it from our marketplace and then download it from the client area.
  3. Once you download the module extract it in the main HostBill directory.
  4. Go to Settings → Modules → Hosting Modules, find and activate TenantOS module.

Connecting HostBill with TenantOS

  1. Proceed to Settings → Apps → Add new App
  2. From the Applications list select TenantOS
  3. Enter:
    • Name - name of your connection
    • Hostname - hostname of your TenantOS installation
    • API Key - API key obtained from TenantOS
  • Setup server tags that module should auto-add or auto-remove to server at TenantOS (allowing you and module to distinguish free/used servers)
    • tags to add after provisioning
    • tags to remove after provisioning
    • tags to add after termination
    • tags to remove after termination 

      4. Verify entered credentials by clicking Test Connection to check if HostBill can connect
      5. Save Changes


Adding TenantOS Dedicated servers Product

  1. In HostBill go to Settings → Products & Services, and Add new order page
  2. From Order Types select Dedicated Servers
  3. Enter your order page name, select the template and Save Changes
  4. Add a new product to your order page. Provide product name, setup price, Save Changes.
  5. In the product configuration section proceed to "Connect with App", select "TenantOS" and App server created in previous steps.
    1. Once package is connected with module (and saved) you can setup metered billing for billing bandwidth use/overages
  6. Proceed to configuration wizard and set your package limit. 
  7. Submit changes.

Connect with App configuration

Match tags

  • Select tags from TenantOS module should use to find unused server for provisioning of this product

User Role

  • End-client user created for server assignment will be using this Role

OS Template

  • Select an OS template to use during provisioning. 
  • It is possible to allow clients to select the OS template during order.

Suspend

  • Select if module should disable server ports on suspension -
    • Automation will manage the ports only if related switch supports it
  • Select if server should be shut down on suspension

Termination

  • Select if module should Remove User on termination -
    • User is removed only if he has no assigned servers after termination
  • Select what run profile should be used on termination
  • Select if module should reset hostname and to what value after termination
    • You can make use of few variables for auto-generated hostname
  • Select if server should be shut down on termination


Network

  • If IPAM module is active, you can choose to synchronize server IPs with IPAM lists
  • Enter IPv4 Limit
    • It is possible to allow clients to select the IP limit during order.
  • Setup Bandwidth (TB) limit 
    • It is possible to allow clients to setup billable  limit during order.
    • Select what should happen on Bandwidth Overuse detected:
    • Setup email notification threshold for bandwidth usage notification


For more generic product configuration details including price, automation, emails settings refer to Product Configuration article.

Configuring Email Notifications   

In Products & Services → Your Order Page → Your Product → Emails you can control which notifications to send to staff and clients.

For TenantOS you can enable the following notification:

  • Initial Order - Sent right after a new order, before provisioning

  • Account created email - Sent after successful service provisioning

  • Account suspended email - Sent after service suspension

  • Account unsuspended email - Sent after service unsuspension

  • Account terminated email - Sent after service termination

  • Server: Provisioning - Send when server is assigned and OS Installation started

  • Server: Ready to use - Send when initial OS installation finished

  • Server: Reinstall started - Send when os installation operation is started from client area
  • Server: Reinstall finished - Sent when os re-install operation finishes
  • Bandwidth: Near Limit - Sent when bandwidth usage reach specified threshold. You can set at which point this email is sent in module settings 
  • Bandwidth: Over Limit 
  • Server: Disk-wipe Finished - Sent to staff when disk-wipe operation ends



Additional Email variables 

In email configured in Products & Services → (Your DC Product) → Emails module exposes following useful variables:

  • {$service.rootpassword} - Root/Adminstrator password
  • {$service.ip} - Main IP address for created server
  • {$service.additional_ip} - String with Additional IP addresses
  • {$service.os} - OS Name

You can also refer to Forms: Accessing Forms elements in email templates for variables defined for your Components:Forms 

Configuring Client Functions   

In Products & Services → Your Order Page → Your Product → Client Functions you can control what features customer will have access to in client portal, by clicking Enable/Disable next to the given option.
Use Edit button to adjust function appearance in the client portal.

For TenantOS you can enable the following client functions dedicated to this module:

  1.  Console
  2. Server Info
  3. Reinstall Server
  4. Usage Graphs
  5. Server Recovery
  6. Server Power Control
  7. IP Management
  8. Metered Billing details (if metered billing is used)

As well as number of standard client functions