Resource handlers on CloudBolt Documentation

Alibaba Cloud

Mon, 01 Jan 0001 00:00:00 +0000

Adding the handler creates a Cloud Management Platform (CMP) environment for the region. Before ordering a server, import at least one image and one network into that environment.

Before you begin

Collect an access key pair and decide which region the handler connects to. A handler covers one region, so add a handler for each region you use.

Log in to the Alibaba Cloud user center.
Select Create AccessKey, then Save AccessKey Information.
Keep the downloaded CSV file. It holds the Access Key and the Access Key Secret.

Add an Alibaba Cloud resource handler

Go to Admin > Resource Handlers, select Add, then select Alibaba Cloud, under Public Cloud.
Enter the Region, Access Key, and Access Key Secret, then select Continue.

(opens full-size image in a new tab)
Enter a name and an optional description, then select Done.

Azure Local

Mon, 01 Jan 0001 00:00:00 +0000

Azure Local runs Azure services on hardware in your own data center while keeping Azure management and APIs. CMP provisions and manages virtual machines, disks, and network interfaces on its clusters. Azure Local is disabled by default, so enable it before it appears in the technology picker: see Enable a resource handler.

Before you begin

Azure Local uses the same Microsoft Entra ID application and subscription setup as an Azure resource handler. Register the application, give it a role on the subscription, and note its credentials, as described in Configure the Azure portal.

Azure Stack

Mon, 01 Jan 0001 00:00:00 +0000

Azure Stack is a legacy technology and does not appear in the technology picker. You cannot create a new Azure Stack resource handler. Existing handlers continue to work, and you can still edit their credentials and settings.

Credentials for an existing handler

To review or update the connection, open the handler from Admin > Resource Handlers and select Edit Credentials.

Field	Description
Subscription ID	The ID of the subscription this handler manages.
Application ID	The ID of the Active Directory application the handler authenticates as. Azure calls this the Client ID.
Authentication Key	The private key created for that application. Azure displays the value only once, when it is generated. If the password vault feature is enabled, this field offers Locally Stored or Vault Managed. Select Vault Managed to read the key from a configured vault provider.
Directory ID	The directory the application belongs to. Azure calls this the Tenant ID.
Auth Type	How the handler authenticates: Service Principal or Active Directory. Service Principal is the default.
Metadata Endpoint	The Azure Stack endpoint the handler connects to. This field is what distinguishes an Azure Stack handler from an Azure one.

Azure: the current handler for new connections to Azure subscriptions.
Azure Local: run Azure services on hardware in your own data center.
Use password vaults: storing the authentication key in HashiCorp Vault, CyberArk, Keeper, AWS Secrets Manager, or Azure Key Vault.
Legacy technologies: QEMU-KVM and XenServer, which are also closed to new handlers.

Hyper-V

Mon, 01 Jan 0001 00:00:00 +0000

CMP discovers the virtual machines already on the instance, provisions new ones, customizes Windows and Linux guests, manages their disks and networks, and runs scripts against them.

Supported versions

Windows Server 2025
Windows Server 2022
Windows Server 2019
Windows Server 2016

Before you begin

What CMP connects to depends on whether the instance is standalone or clustered.

Standalone instances

Use an IP address or DNS name that the CMP appliance can resolve.
Firewall rules must allow WinRM, typically on port 5985 or 5986.

Clustered instances

Use the cluster’s IP address or hostname, not that of an individual node.
If you use a hostname or an alias, configure DNS or hostname resolution on the CMP appliance.
The WinRM protocol and transport you choose must be enabled on every cluster node.

Certificates for SSL Verification

SSL Verification works only when each cluster node has a valid certificate. Run winrm get winrm/config/Service on a node: the CertificateThumbprint property shows whether a certificate is configured.

IBM Cloud

Mon, 01 Jan 0001 00:00:00 +0000

Cloud Management Platform (CMP) connects through the IBM Cloud classic infrastructure API. Import data centers into CMP, and each one becomes an environment that users can order into.

Before you begin

An IBM Cloud account on at least a Pay-as-you-go plan.
A classic infrastructure API key, and the account ID it belongs to. For how to create and find one, see Managing user API keys in the IBM Cloud documentation.
Outbound access to api.softlayer.com, or to api.service.usgov.softlayer.com for IBM Cloud for Government.

Add an IBM Cloud resource handler

Go to Admin > Resource Handlers, select Add, then select IBM Cloud under Public Cloud.
Enter the account ID in API Username.
Enter the key in API Key. If the password vault feature is enabled, this field offers Locally Stored or Vault Managed; select Vault Managed to read the key from a configured vault provider. Select Continue.

(opens full-size image in a new tab)
Enter a name for the handler, choose the data centers to bring in under Import IBM Cloud datacenters, then select Done.

IPMI

Mon, 01 Jan 0001 00:00:00 +0000

The handler holds no connection details. Each server has its own IPMI address and credentials, which CMP uses to send power commands to that server’s BMC. CMP supports one IPMI resource handler per installation, so the IPMI tile is hidden once one exists.

Add an IPMI resource handler

Go to Admin > Resource Handlers, select Add, then select IPMI.
In the Add an IPMI Resource Handler dialog, enter a Name and, optionally, a Description.
Leave the remaining fields empty. Stop if server on applies only to builds that network-boot the server.
Select Done.

Create an environment

CMP does not create an environment for the IPMI resource handler. Create one so servers can be ordered:

MetalSoft

Mon, 01 Jan 0001 00:00:00 +0000

Each imported MetalSoft data center becomes a CMP environment. For each order, CMP deploys one server of the chosen type into an existing or new MetalSoft infrastructure. MetalSoft provisions physical servers only.

Before you begin

A MetalSoft user for CMP, with its email address and API key.
Network access from CMP to the MetalSoft API.

Add a MetalSoft resource handler

Go to Admin > Resource Handlers, select Add, then select MetalSoft.
Complete the credentials fields described below, then select Continue. CMP checks the connection, including that the API User Email belongs to the API key.
Enter a Name, and optionally a Description and VM Names to Ignore, then select Done.
On the handler’s Overview tab, select Verify Connection at any time to check the connection.

Field	Description
IP address	The host name or IP address of the MetalSoft controller.
Protocol	Usually https. The dialog opens with http; change it.
Port	The MetalSoft API port. The dialog opens with `443`.
API User Email	The email address of the MetalSoft user for CMP.
API Key	That user’s API key. The API key includes the user ID before the colon; enter it in full. If the password vault feature is enabled, this field offers Locally Stored or Vault Managed. Select Vault Managed to read the secret from a configured vault provider. See Use password vaults.
Admin API Connection Info	Optional. A Connection Info record holding a MetalSoft administrator’s email address and API key. Only records tagged `metalsoft` are listed.
SSL Verification	Whether CMP verifies the MetalSoft controller’s SSL certificate.

Import data centers

A new handler has no environments until you import a data center. CMP creates one environment for each selected data center, named after the handler and the data center, for example (MetalSoft) ab-br-c1.

OpenShift Virtualization

Mon, 01 Jan 0001 00:00:00 +0000

Each imported OpenShift namespace becomes a CMP environment. CMP builds servers from OpenShift Virtualization templates and persistent volume claims (PVCs).

Before you begin

OpenShift Virtualization is disabled by default. If its tile is missing from the technology picker, enable the resource handler.
The cluster’s base domain and network access from CMP to its API, which listens on port 6443 by default.
A service account token that can list namespaces, or the username and password of an OpenShift account.

Add an OpenShift Virtualization resource handler

Go to Admin > Resource Handlers, select Add, then select OpenShift Virtualization under Private Cloud.
Complete the credentials fields described below, then select Continue. CMP checks the connection at this point.

(opens full-size image in a new tab)
Enter a Name, complete any of the optional settings described below, then select Done.

OpenStack

Mon, 01 Jan 0001 00:00:00 +0000

Each imported OpenStack project becomes a CMP environment.

Before you begin

An OpenStack account CMP can authenticate as, and network access from CMP to the Identity service, which listens on port 5000 by default.
The account’s domain name and a project ID. In the OpenStack dashboard, find them under Identity > Domains and Identity > Projects.

Add an OpenStack resource handler

Go to Admin > Resource Handlers, select Add, then select OpenStack under Private Cloud.
Complete the credentials fields described below, then select Continue. CMP checks the connection at this point.
Enter a Name, and optionally a Description, VM Names to Ignore, and VM Tags to Include, then select Done.

Field	Description
Protocol	HTTP or HTTPS, as served by the Identity service. The dialog opens with HTTP.
Domain	Required. The Identity domain the account belongs to, for example `default`.
Project ID	Required. The ID of a project the account can access. CMP authenticates against this project.
IP address	The host name or IP address of the Identity service.
Port	The Identity service port. Defaults to `5000`.
Account username	The OpenStack account CMP authenticates as.
Password	The password for that account. If the password vault feature is enabled, this field offers Locally Stored or Vault Managed. Select Vault Managed to read the secret from a configured vault provider. See Use password vaults.
SSL Verification	Whether CMP verifies the Identity service’s SSL certificate.

Import projects

A new handler has no environments until you import a project.

Oracle Cloud Infrastructure

Mon, 01 Jan 0001 00:00:00 +0000

Cloud Management Platform (CMP) authenticates to OCI with an API signing key rather than a password, so set the key up in Oracle Cloud before adding the handler. Oracle Linux images also disable password-based authentication, so plan to use SSH keys to access provisioned servers.

Before you begin

Collect the following from Oracle Cloud. The credentials dialog needs all of it, so keep it to hand:

The region to connect to.
Your user OCID and tenancy OCID, and the compartment OCID if you want the handler scoped to one compartment and its sub-compartments.
An API signing key in PEM format, its fingerprint, and its passphrase if set. Manage an OCI server with SSH keys below generates a key pair you can use for this.

Add an OCI resource handler

Go to Admin > Resource Handlers, select Add, then select Oracle Cloud Infrastructure, under Public Cloud.
Fill in the credentials dialog and select Continue.
Enter a name and an optional description, then select Done.

Field	Description
Region	Required. The OCI region this handler connects to.
User OCID	Required. The OCID of the user the API signing key belongs to.
Certificate Fingerprint	Required. The fingerprint OCI shows after you upload the public key.
Key File	Required. Paste the private key in PEM format.
Passphrase	The passphrase protecting the private key. Leave it empty if the key has none.
Tenancy OCID	Required. The OCID of your tenancy.
Compartment OCID	Optional. Scopes the handler to this compartment and its sub-compartments: environments offer only those compartments, and VM, image, and network discovery follow them. If empty, CMP uses the tenancy.

OCI parameters

The following parameters are imported and may appear on the order form:

Oracle Linux Virtualization Manager

Mon, 01 Jan 0001 00:00:00 +0000

Each imported OLVM cluster becomes a CMP environment, and CMP imports the cluster’s networks into it.

Before you begin

Oracle Linux Virtualization Manager is disabled by default. If its tile is missing from the technology picker, enable the resource handler.
An OLVM account CMP can authenticate as, and HTTPS access from CMP to the OLVM engine.
CMP verifies the engine’s certificate when SSL verification is enabled under Admin > SSL Root Certificates. If the engine’s certificate is issued by a private certificate authority, add the OLVM engine CA certificate on that page before you create the handler.

Add an OLVM resource handler

Go to Admin > Resource Handlers, select Add, then select Oracle Linux Virtualization Manager under Private Cloud.
Enter the IP address, Port, Account username, and Password, then select Continue. CMP checks the connection at this point.

(opens full-size image in a new tab)
Enter a Name, and optionally a Description and VM Names to Ignore, then select Done.

Outscale

Mon, 01 Jan 0001 00:00:00 +0000

Outscale does not appear in the technology picker until enabled. If you cannot find the tile, see Enable a resource handler.

Adding the handler creates a Cloud Management Platform (CMP) environment and imports the Outscale parameters. A handler covers one region, and each region has its own access key pair. Add a separate handler for each region you use.

Before you begin

Collect the following from Outscale:

The Region to connect to. Outscale region names follow the AWS pattern, such as us-east-2. See Outscale’s regions and endpoints reference for the full list.
The Access Key and Access Key Secret for that region.

Add an Outscale resource handler

Go to Admin > Resource Handlers, select Add, then select Outscale under Public Cloud.
Enter the Region, Access Key, and Access Key Secret, then select Continue.
Enter a name and an optional description, then select Done.

CMP opens the new handler. Before ordering, work through its tabs to complete configuration.

Proxmox Virtual Environment

Mon, 01 Jan 0001 00:00:00 +0000

Each imported Proxmox node becomes a CMP environment. CMP builds a server by cloning a Proxmox VM template, then sets its CPUs, memory, and disk size.

Before you begin

Proxmox Virtual Environment is disabled by default. If its tile is missing from the technology picker, enable the resource handler.
A Proxmox account that logs in with a username and password, in the Linux PAM or Proxmox VE realm. The account must not require two-factor authentication.
Network access from CMP to the Proxmox API, which listens on HTTPS port 8006 by default.

Add a Proxmox resource handler

Go to Admin > Resource Handlers, select Add, then select Proxmox Virtual Environment.
Complete the credentials fields described below, then select Continue. CMP checks the connection before moving on.

(opens full-size image in a new tab)
Enter a Name, and optionally a Description and VM Names to Ignore, then select Done.

QEMU-KVM

Mon, 01 Jan 0001 00:00:00 +0000

QEMU-KVM is a legacy technology and does not appear in the technology picker. You cannot create a new QEMU-KVM resource handler. Existing handlers continue to work, and you can still edit their credentials and settings.

Credentials for an existing handler

To review or update the connection, open the handler from Admin > Resource Handlers and select Edit Credentials.

Field	Description
IP address	The IP address of the KVM host.
SSH Port	CMP connects to the host on the standard SSH port, `22`.
Username	The SSH account CMP logs in with. It must be able to run `virsh` and `virt-clone`, and needs read access to the host’s libvirt domain configuration files.
Password	The password for that account. If the password vault feature is enabled, this field offers Locally Stored or Vault Managed. Select Vault Managed to read the secret from a configured vault provider. See Use password vaults.

Templates

CMP treats a libvirt domain as a template when its name matches the handler’s Template name pattern, a regular expression that defaults to -tmpl. With the default, centos7-tmpl is a template. Every other domain is synced as a server. To change the pattern, open the handler’s Overview tab and select Edit Settings.

VMware Cloud Director

Mon, 01 Jan 0001 00:00:00 +0000

Cloud Director is not installed by default and is not controlled by a feature flag. Run the script in Enable the vCloud Director resource handler to display the tile in the picker, where it is listed under its former name, vCloud Director.

Cloud Director groups resources into organizations, and each organization into virtual data centers. Cloud Management Platform (CMP) creates one environment for each organization and virtual data center pair you import, and provisions into it.

XenServer

Mon, 01 Jan 0001 00:00:00 +0000

XenServer is a legacy technology and does not appear in the technology picker. You cannot create a new XenServer resource handler. Existing handlers continue to work, and you can still edit their credentials and settings.

Credentials for an existing handler

To review or update the connection, open the handler from Admin > Resource Handlers and select Edit Credentials. CMP checks the connection when you save, and Verify Connection on the Overview tab checks it on demand.

Resource handlers on CloudBolt Documentation

Alibaba Cloud

Before you begin

Add an Alibaba Cloud resource handler

Azure Local

Before you begin

Azure Stack

Credentials for an existing handler

Related

Hyper-V

Supported versions

Before you begin

Standalone instances

Clustered instances

Certificates for SSL Verification

IBM Cloud

Before you begin

Add an IBM Cloud resource handler

IPMI

Add an IPMI resource handler

Create an environment

MetalSoft

Before you begin

Add a MetalSoft resource handler

Import data centers

OpenShift Virtualization

Before you begin

Add an OpenShift Virtualization resource handler

OpenStack

Before you begin

Add an OpenStack resource handler

Import projects

Oracle Cloud Infrastructure

Before you begin

Add an OCI resource handler

OCI parameters

Oracle Linux Virtualization Manager

Before you begin

Add an OLVM resource handler

Outscale

Before you begin

Add an Outscale resource handler

Proxmox Virtual Environment

Before you begin

Add a Proxmox resource handler

QEMU-KVM

Credentials for an existing handler

Templates

VMware Cloud Director

XenServer

Credentials for an existing handler