Skip to content
NexPanel
Docs/Operations/CLI reference

Operations

CLI reference

nexpanelctl (nodes)

nexpanelctl talks to the local agent and works even when the controller is unreachable.

Command Purpose
nexpanelctl status Node metrics and web server
nexpanelctl services Service status
nexpanelctl service <unit> <action> start, stop, restart, reload, enable, disable
nexpanelctl ps [-user U] [-n N] Top processes by CPU
nexpanelctl kill <pid> [-9] Kill a hosting-account process
nexpanelctl kill-user <username> Kill all processes of an account
nexpanelctl mysql ps MariaDB process list
nexpanelctl mysql kill <id> Kill a query
nexpanelctl accounts Accounts on this node
nexpanelctl account <username> Account details
nexpanelctl suspend <username> / unsuspend <username> Suspend or unsuspend an account
nexpanelctl rebuild Regenerate every account's configuration from the agent's state
nexpanelctl webserver Current web server
nexpanelctl webserver switch <name> [-dry-run] nginx, apache, nginx-apache, litespeed, openlitespeed

Other node tools

Command Purpose
nexpanel-agent version Agent version
nexpanel-lve status Live resource usage per account
nexpanel-lve-selftest Check that resource limits are applied
systemctl status nexpanel-agent Agent service; logs with journalctl -u nexpanel-agent

Controller

Run artisan commands as the panel user from /opt/nexpanel-controller:

cd /opt/nexpanel-controller
sudo -u nexpanel php artisan <command>
Command Purpose
nexpanel:admins List admin users
nexpanel:create-admin <email> <name> Create an admin
nexpanel:admin-password <email> Reset an admin's password
nexpanel:node-add <name> --ip=… --web-server=… Add a node and print its enrollment token
nexpanel:node-status <name> Show a node's status
nexpanel:node-resync <name> Rebuild a node's sites, then re-send firewall, WAF, NexShield and mail settings
nexpanel:dns-sync Re-send DNS zones to PowerDNS
nexpanel:run-backups Run due backup jobs now

The controller's services are nexpanel-web (all-in-one) or PHP-FPM and Nginx (separate controller), nexpanel-scheduler.timer, and the panel proxies nexpanel-proxy-admin, nexpanel-proxy-customer and nexpanel-proxy-webmail (all-in-one).

nexpanel-updater --check shows the controller's installed and offered versions; see Updates.

Wrong or missing something? Let us know.