The ClientExec plugin (version 0.1.0) is a server plugin. It creates the customer's panel account and server, follows suspensions, deletions and package changes, gives clients a Server panel and staff a sign-in into the panel as the client.
Requirements#
- ClientExec 6.x or 7.x on PHP 8.1 or later, with cURL.
- The panel reachable over HTTPS with a valid certificate.
- A panel API key as described in API key for a billing system.
Install#
- Get the package
vmstack-clientexec-<version>.zip(see Integrations). From the source,php build.phpwrites it todist/. - Unpack it into
<clientexec>/plugins/server/, so thatplugins/server/vmstack/PluginVmstack.phpexists.
Connect to the panel#
- Settings › Products › Servers › Add server.
- Hostname: the panel's address (no
https://, no path). Plugin: VMStack. - Plugin settings:
| Setting | Meaning |
|---|---|
| API Key | the key (vmk_…), stored encrypted |
| Panel Address | optional, overrides Hostname |
| SSH Keys Custom Field | name of a product custom field (text area) holding SSH keys, one per line. With no key SSH password login is turned on. |
| Root Password Custom Field | name of the custom field that receives the root password (with Send welcome password) |
- Press Test Connection. It fails for a user's key or missing scopes, and otherwise shows the summary with a placement note.
Product setup#
Create a hosting product on that server and fill in its plugin settings:
| Setting | Default | Meaning |
|---|---|---|
| Plan | – | the panel plan |
| Placement | – | a location, node group or node |
| Default image | – | used without an OS add-on |
| Hostname pattern | empty | {serviceid} (the package ID), {clientid}, {domain}. Empty: the package's domain name, else the panel picks one |
| Reseller for new accounts | empty | panel ID of the reseller new accounts go under (administrator keys) |
| Customer sets up the server | off | the server waits for the customer (customer setup) |
| Send welcome password | off | writes the root password to the root password custom field; needs servers:secrets |
| Allow the client to create servers in the panel | off | ticks May create and delete servers on new accounts |
| Delete the panel account on terminate | off | deletes the panel account after its server is deleted |
| Single sign-on | on | Open control panel |
| Bind sign-in links to the client's address | on | links work only from the client's address |
Add-ons#
Add-on variables (a CUSTOM_ prefix is ignored, names match without regard to case or separators; values ID or ID|Label):
| Variable | Effect |
|---|---|
PLAN |
overrides the plan |
LOCATION, NODE_GROUP |
override the placement (location first) |
OPERATING_SYSTEM (or OS, IMAGE) |
overrides the image |
APPLICATION |
one-click application slug, or none |
EXTRA_IPV4 |
IPv4 addresses beyond the plan's |
The plugin writes the package's Server Acct Properties (the panel server ID; type one to link an existing server), IP Address and Domain Name.
What the plugin does#
| ClientExec | Panel |
|---|---|
| Create | finds or creates the client's account, creates the server, syncs extra IPv4; a rerun finishes what is left |
| Suspend / Unsuspend | suspends ("Overdue invoice") / lifts it |
| Delete | deletes the server, optionally the account |
| Update package | a changed password resets the root password (the server restarts); other changes upgrade the plan (downgrades refused) and re-sync extra IPv4 |
Staff actions: Create, Delete, Suspend, UnSuspend, Start, Shutdown, Reboot, PowerOff, RescueOn, RescueOff, and Sign in to VMStack as the client.
The client's Server panel shows status, application, plan, resources, location, OS, addresses with reverse DNS (or the NAT address and SSH port) and traffic, with Start, Shut down, Reboot, Power off, Start and End rescue (with Show password), Console, Open control panel, reverse DNS, Reinstall (confirmed by typing the hostname), Reset root password and Set up your server. A client acts only on its own active packages.
Limitations#
- Client actions are sent with the key's own rights, not on behalf of the customer, so the plan's customer permissions and reinstall limits are not applied in ClientExec (they still apply in the panel).
- No usage billing.
- A changed client email is not sent to the panel.
- Only extra IPv4 as an add-on; no port forwards in the client area.
- No admin server tab.