OneProvider VPS - WHMCS Module installation

This guide explains how to install the suite and migrate from the legacy OneCloud integration using the built-in Migration tools. Follow the steps in order. When completed correctly, you should not need a support ticket for a standard install or migration.

---

1. Before you begin

Requirements

• A working WHMCS installation with administrator access
• Your commercial license key for OneProvider VM Automation
• OneProvider API credentials: Api-Key and Client-Key (from the OneProvider / OP-Net panel)

If you are migrating from OneCloud

Keep the legacy OneCloud addon and products available until migration finishes and you have verified live services. Do not delete legacy products, servers, or API credentials until you confirm VMs open correctly in the new dashboard.

Recommended preparation

1. Take a full WHMCS backup (files + database) before activating or migrating.
2. Note which products currently use OneCloud.
3. Confirm your Api-Key and Client-Key still work in the provider panel.
4. Plan a short maintenance window if you have many live services.

---

2. Fresh installation

Step A — Upload and activate

1. Upload the module package provided by WHMCSModule Networks into your WHMCS installation using the vendor’s usual delivery layout (provisioning module + addon module).
2. In WHMCS admin, open Setup → Addon Modules (or System Settings → Addon Modules on newer WHMCS).
3. Find OneProvider VM Manager / OneCloud VPS Manager and click Activate.
4. Grant the admin role access you need, then Save Changes.

After activation, the admin menu under Addons shows OneCloud VPS Manager.

Step B — Enter the license

1. Open Addons → OneCloud VPS Manager → License.
2. Paste your license key and save.
3. Wait until the status shows Active (or equivalent success state).

Step C — Add an API account

1. Open Addons → OneCloud VPS Manager → Accounts (API Accounts).
2. Create an account with:
   • A clear display name (for example Production)
   • Api-Key
   • Client-Key
   • Optional default project (recommended)
3. Save, then use Test connection (or equivalent) if shown.
4. Confirm the account appears as active.

You may add more than one API account if you operate multiple OneProvider credentials.

Step D — Create or configure a product

1. Go to Setup → Products/Services → Products/Services.
2. Create a new product (or edit an existing one) and set the module to this suite’s provisioning module (the same product family as OneCloud VPS Manager / OneProvider VM).
3. Open Module Settings and complete at least:
   • API account (from Step C)
   • Project (or rely on the account default)
   • Plan / size
   • Location
   • Operating system / template (or allow selection via configurable options as you prefer)
   • Feature visibility toggles (network, traffic, reinstall, snapshots, console, and so on)
4. Save the product.

The suite creates the required product custom fields automatically when Module Settings load, including:

• VM ID (admin-only resource link)
• SSH Keys (order form; customer pastes a public key; registered automatically on create)

Step E — Order and verify

1. Place a test order for the product (or create a pending service and run Create / module create).
2. Confirm the service receives IP/password (when the provider returns them) and that VM ID is populated for admins.
3. Open the client area service page and the admin services tab; confirm the dashboard loads (Overview, power actions, console if enabled).

---

3. Migrating from legacy OneCloud

Use this path when you already sell OneCloud products and want to move them to this suite in place (same products and services, new module wiring).

Overview

Migration has two built-in stages on Addons → OneCloud VPS Manager → Migration:

1. Import API keys from the legacy OneCloud addon settings into a sealed API account named like Migrated from OneCloud.
2. Migrate each product — switch the product to this suite, map account / plan / project / location, and relink live services to the new VM ID field.

Legacy provider server records are left in place for safety. Do not remove them until you have verified every important service.

Step 1 — Install and license (same as fresh install)

Complete Section 2, Steps A–B first. You need an active license before Migration is usable.

Step 2 — Import OneCloud API keys

1. Open Addons → OneCloud VPS Manager → Migration.
2. In Import OneCloud API Keys, check the status lines:
   • OneCloud ApiKey — found or missing
   • OneCloud ClientKey — found or missing
3. If either key is missing, open the legacy OneCloud addon configuration, confirm both keys are saved, then return here.
4. Click Import Keys (or Update Migrated Account Keys if you already imported once).
5. Confirm the prompt. You should see a migrated account id/name on success.

That account is then available under Accounts and in product Module Settings.

Step 3 — Migrate each product

On the same Migration page, the Product Migration table lists OneCloud products and any already migrated products.

For each legacy product:

1. Click Migrate.
2. In the dialog, review the legacy plan / project hints.
3. Choose:
   • API account (usually the migrated account)
   • New plan (required)
   • Project (or account default)
   • Location (or auto)
   • Markup % if you use catalog markup
4. Confirm migration.

What happens automatically:

• The product is switched to this suite’s provisioning module
• Module Settings are written for account, project, plan, location, and defaults
• Required custom fields (VM ID, SSH Keys) are ensured
• Live services on that product are relinked: the provider VM identifier is copied into VM ID when it can be resolved from the service’s existing data
• A non-blocking catalog sync may run afterward

Repeat for every product you still sell.

Step 4 — Verify after migration

For each important migrated product:

1. Open Setup → Products/Services, edit the product, and confirm Module Settings show the correct account, plan, location, and features.
2. Open a sample Active service in admin:
   • Confirm VM ID is filled
   • Open the module actions / dashboard tab and confirm live provider data loads
3. Log in as the client (or use Login as Owner) and open the service in the client area.
4. Spot-check: power status, console (if enabled), network, and SSH key list.

If a service has no VM ID after migrate:

• The automated relink could not find a stored VM identifier for that service
• You can set VM ID manually on the service (admin custom fields) using the provider’s VM id, then reopen the dashboard

Step 5 — Optional cleanup (only after verification)

When every live service you care about works:

1. You may deactivate the legacy OneCloud addon if you no longer need it.
2. Keep historical invoices and service history untouched.
3. Do not mass-delete legacy server rows until you are certain you will not roll back.

---

4. Day-to-day configuration tips

Multiple API accounts

• Use separate Accounts entries for different credentials or environments. Each product selects exactly one account in Module Settings.

SSH keys on new orders

• On the order form, customers should paste their SSH public key (one per line), for example ssh-ed25519 … or ssh-rsa ….
• On create, the suite registers the key with the provider and attaches it to the new VPS. Customers do not need a provider UUID.

Feature toggles

• Module Settings include show/hide controls for client features (network, traffic, reinstall, recovery, snapshots, logs, console, custom images). Admins still see full controls on the admin services tab.

Action protection

• Clients/admins can enable action protection on a service to block destructive actions such as reinstall until protection is turned off.

---

5. Troubleshooting (self-service)

Symptom	What to check
Addon pages say unlicensed / locked	License page: key saved and status Active
Menu label vs page title differ	Admin menu shows OneCloud VPS Manager; product branding may still say OneProvider VM Manager — that is expected
No API accounts in product settings	Create an account under Accounts and ensure it is active
Create fails: missing parameters	Product Module Settings: account, plan, location, and OS/template must be set
Create fails: SSH error	Public key format invalid, or provider rejected the key — fix the order custom field and retry create
Dashboard: no VM assigned	VM ID empty — set it on the service or re-run create / migration relink
Dashboard: connection / provider error	Test the API account; confirm Api-Key and Client-Key; check Module Log in WHMCS for masked API calls
Migration Import Keys disabled	Legacy OneCloud keys not present in legacy addon settings
Some services not relinked	Set VM ID manually for those services; migration reports how many were linked
Client cannot see a tab	Feature toggle off in Module Settings for that product

Module Log (WHMCS Utilities → Logs → Module Log) records API exchanges with keys masked. Prefer that over opening a ticket when diagnosing connectivity.

---