What a customer (an account of level User) may do with its servers is set by switches. They live on the plan, with overrides on the account and on each server, and a reseller can be limited for all its customers. Administrators and resellers acting as themselves are never held to them.
Creating and deleting servers#
Whether a user may create and delete servers itself is the account's May create and delete servers box on its form (Customers › Users, the account). Without it the user only uses the servers created for it. Resellers and administrators can always create servers. Creating a server is still bounded by the reseller's pool (see Account types).
The switches#
All switches are on (allowed) by default, except Clone the server, which is off unless switched on.
| Group | Switches |
|---|---|
| Power and console | Start, shut down and restart · Power off · Screen console · Text console |
| Install and recovery | Reinstall · One-click apps and recipes · Insert ISOs and boot from them · Own ISOs by link · Rescue system · Reset the root password |
| Network | Reconfigure the network · Change the hostname · Reverse DNS · Change the firewall · Port forwards · Private networks |
| Backups and snapshots | See backups · Take backups · Restore backups · Restore backups to a new server · Delete backups · Snapshots |
| Storage and settings | Extra disks · Server settings (boot order, drivers, firmware, start on boot) |
| Other | Clone the server · Usage charts · API access |
API access is set on the account only (making API keys and using them). Not switchable: reading the root password, display name, SSH keys, cancelling a queued task, ending rescue (a customer can always leave rescue). Deleting servers follows May create and delete servers.
Where they are set#
| Where | How |
|---|---|
| Plan | Customers › Hosting plans, edit a plan, section What customers may do: a ticked card per switch. Also Images for reinstalls and setup: Every image, or Only the images chosen here. |
| Account | the customer's page: per switch Follow the plan / Allowed / Not allowed |
| Server | the server's Manage tab: Follow the account and plan / Allowed / Not allowed. Each row says what results and why ("Not allowed: the plan.") |
| Reseller | the reseller's page, What this reseller's customers may do: No limit / Not allowed, for all its customers |
The first that decides wins:
- The customer's reseller has it Not allowed: refused; nothing overrides it.
- The server's own setting.
- The account's setting.
- The plan's setting.
- Allowed.
Plans are set by whoever edits them; account and server settings by administrators and the customer's reseller. A reseller cannot allow what the panel switched off for its customers; on a reseller's plan such switches are shown greyed ("Switched off for your customers by the panel."). Every change is in the audit log.
What the customer sees#
Something not included is greyed out with the reason as its title, or left out (for example Back up now, ISO lists, the Usage tab). An action sent anyway is refused with a sentence such as "Your plan does not include rescue." The API answers 403 not_in_plan with the same sentence.
A billing module acting for the customer sends the header X-On-Behalf-Of: customer, so its client-area actions are held to the customer's switches too. A console link is always held to them. See Billing modules.
Customer setup#
A server can wait for its owner to choose how it is installed, instead of being built at once.
- Per plan: tick New servers wait for their owner to set them up in the plan's Setup, trial and reinstalls section. This applies when an administrator or reseller creates a server for another account (and to API and billing creates that send no keys, password, application, recipes or ISO).
- Per server: on Servers › Create server, Who installs it: Install now, or Let the owner set it up. An account creating a server for itself always installs at once.
A waiting server has status Awaiting setup. Its node, size, addresses and port forwards are reserved and it is billed from its creation, but nothing is sent to the node. It can be set up, deleted (at once), suspended, given another owner and have notes; every other action is refused ("Server X is waiting to be set up. Set it up first."). The owner gets the mail "Your server is ready to be set up".
When the owner opens the server, the setup page asks for:
- Hostname and display name, with Random,
- Operating system (grouped by distribution; images the plan is too small for are shown but not choosable) and an optional application and recipes,
- Swap (None, 512 MB, 1 GB, 2 GB, 4 GB) and Time zone (default UTC). These need a node whose agent runs first-boot scripts; otherwise they are greyed out,
- SSH keys. With none, the server takes the root password over SSH and the password is mailed when the server is ready, after a confirmation,
- Advanced: screen console (VNC) on or off, and DNS resolvers (the provider's, Cloudflare, Google, Quad9 or two of your own).
The button reads Install with the chosen image. The page then shows each build step live and opens the server page when it runs. Staff see an Awaiting setup panel with Set up now instead.
A server awaiting setup cannot be installed from an ISO. Upgrading it (for example a billing module's package change) is applied at once.
Trials#
A plan can make its servers expire:
- Trial length (days): 1 to 365, or No trial.
- When a server expires: Suspend it, or Delete it, with everything on its disks.
Administrators and resellers can also set an expiry when they create a server (Expires: As its plan says, On a date, or Never) and change it on the server's Manage tab (Expiry: set a time, + 7 days, + 30 days, the action, or Remove expiry). Customers cannot set or remove an expiry. Moving the time lifts a suspension the expiry placed; a suspension placed by hand stays.
The owner sees a countdown on the server page and is mailed a warning before expiry (with a copy to its reseller). How many days before is System › Settings › Servers that expire › Tell the owner (days before) (default 3; 0 warns nobody). The scheduler carries expiries out every minute, at most 20 deletes per run; administrators are alerted when deletes are held back or fail. Moving a server to a plan without a trial removes an expiry its old plan's trial gave.
Reinstall limits#
In the plan's Reinstall limit: Reinstalls per server (0 to 1000, or No limit), Per Day, Week (from Monday) or Month, in UTC.
- It holds the customer, and a reseller or administrator acting for it with
X-On-Behalf-Of: customer. Staff acting as themselves are not limited and are not counted. - A reinstall whose task failed or was cancelled is given back. The setup of a waiting server is not a reinstall.
- The customer reads "2 of 5 reinstalls left this month." under Reinstall; at none the button is greyed and says when it resets. The API answers 403
reinstall_limit_reachedwith the limit, used count and reset time.
API#
GET|PATCH /servers/{id}/customer-abilities and GET|PATCH /users/{id}/customer-abilities; plans carry customer_abilities, reinstall_image_ids, customer_setup, trial_days, expiry_action, reinstall_limit and reinstall_period. POST /servers/{id}/setup sets up a waiting server; PUT /servers/{id}/expiry changes an expiry. See the API reference.