Skip to content

Dynamic IP Assignments

Dynamic IP assignments can be used to automatically allocate a specified number of IP addresses or subnet assignments to servers.

Depending on the configuration, Tenantos can dynamically create new subnets based on the requested CIDR and/or reuse existing subnets, provided the necessary conditions are met.

Configuration Levels

The dynamic IP assignment system uses a hierarchical configuration approach:

  1. Global Settings - Default settings applied to all products
  2. Product-Specific Settings - Override global settings for individual products
  3. Configurable Options - Client-selectable options that override both global and product settings

Setup Guide

Global Configuration

  1. Open the "System Configuration" page of the module (Addons → Server Manager → System Configuration).
  2. Scroll down to the "Ordering: Dynamic IP Assignment Settings" section.
  3. Configure the default settings for all products:
    • Enable/disable IPv4 and IPv6 assignments
    • Set default IP counts and types
    • Configure additional settings such as assignment modes and subnet parameters

The configured settings will be applied to all products by default and can be overridden by product-specific settings or via configurable options.

Product-Specific Configuration

To override global settings for a specific product:

  1. Open the product configuration page in WHMCS, go to the "Module Settings" tab, and click on "Manage Dynamic IP Assignment Settings".
  2. Each setting can be individually overridden or inherited from the global configuration.

Configurable options can be used to further customize the IP assignment settings per product or to let the client select their own preferences during ordering.

Configurable Options Setup

Documentation for configurable options is available directly in WHMCS by clicking the "Configurable Options Documentation" button.

Testing the Dynamic IP Assignment System

Once the system is configured, you can test it with an existing service. The test does not make any changes to the server or service unless you choose to execute the API call.

The test shows the API payload that would be sent to Tenantos. Since the payload is designed to be easily understandable, you can see what the outcome would be. Optionally, you can perform the actual API call.

Notes

VLAN Automation

If dynamic IP assignments are used by a reseller without access to VLAN automation, the subnet configuration in Tenantos will determine whether VLAN automation is executed. This is controlled by the "Copy configuration to childs" setting in the subnet configuration.

If the API user has access to VLAN automation, the "Perform Network Automation Actions" setting in the WHMCS module will control whether VLAN automation is executed.

Resellers need the "Use Dynamic IP Assignments" permission to use this feature.

Exclude Subnets from Dynamic IP Assignment

To exclude subnets from dynamic IP assignments, enable the "Exclude from Dynamic IP Assignments" setting in the respective subnet configuration in Tenantos.

Screenshots

Global Configuration: Global Configuration

Product Configuration: Product Configuration Button

Product Configuration Settings

Test Configuration: Test Service

Configurable Options Documentation:

Configurable Options Documentation #1

Configurable Options Documentation #2