Content Error or Suggest an Edit
Notice a grammatical error or technical inaccuracy? Let us know; we will give you credit!
GridPane Knowledge Base CLI Reference
At the time of this original writing May 13th 2021 there was no documented CLI from GridPane. So I created this page, and then they released it at some point. So You can find the following cli refences on the GridPane Knowledge Base.
GridPane GP-CLI Quick Reference
GP-CLI Quick Reference | GridPane
This article details all of the available GP CLI commands that you can run on your GridPane servers. It’s rapid-fire, and so doesn’t go into any in-depth…
GridPane CLI Service Management: Nginx
Service Management: Nginx | GridPane
Nginx Configuration Check Run either of these commands after making configuration changes to find issues before reloading or restarting the Nginx. Stop/
GridPane CLI Service Management: PHP
Service Management: PHP | GridPane
Stop/Start PHP These commands stop and start PHP. Run them separately. You have to designate the version in the command. For example: Restart PHP The restart…
GridPane Configure Monit Service Management and Notifications with GP-CLI
Configure Monit Service Management and Notifications with GP-CLI | GridPane
GridPane uses Monit to manage services and restart them if they start misbehaving. Sometimes you might wish to adjust these settings yourself – for example…
How to Use GP WP-CLI and Regular WP-CLI on GridPane Servers
How to Use GP WP-CLI and Regular WP-CLI on GridPane Servers | GridPane
This article digs into how to use WP-CLI commands on your GridPane servers. By default, WP-CLI is installed on all GridPane servers out of the box and you…
GridPane CLI Commands
I’ve scrapped all of these commands and put them into a table for easy searching and filtering.
Command | Action | Group |
---|---|---|
gp ngx -t | Test Nginx configuration syntax | nginx |
gp ngx -status | Show Nginx service status | nginx |
gp ngx -stop | Stop Nginx service | nginx |
gp ngx -start | Start Nginx service | nginx |
gp ngx -reload | Reload Nginx configuration without full restart | nginx |
gp ngx -restart | Restart Nginx (stop + start) | nginx |
gp stack nginx geoip -on {account.id}:{license.key} | Enable GeoIP2 module with license | nginx |
gp stack nginx geoip -off | Disable GeoIP2 module | nginx |
gp stack nginx worker -connections {integer} | Configure worker connections | nginx |
gp stack nginx limits -client-body-timeout {integer} | Set client body timeout | nginx |
gp php {version} -stop | Stop PHP service (specific version) | php |
gp php {version} -start | Start PHP service (specific version) | php |
gp php {version} -reload | Reload PHP configuration | php |
gp php {version} -restart | Restart PHP service (specific version) | php |
gp stack php {version} -max-exec-time {integer} | Set max execution time | php |
gp mysql -stop | Stop MySQL service | mysql |
gp mysql -start | Start MySQL service | mysql |
gp mysql -restart | Restart MySQL service | mysql |
gp stack mysql -max-connections {value} | Set maximum database connections | mysql |
gp redis -stop | Stop Redis service | redis |
gp redis -start | Start Redis service | redis |
gp redis -restart | Restart Redis service | redis |
gp stack redis -max-memory {integer} | Set maximum Redis memory | redis |
gp ngx -t | Test Nginx configuration syntax | nginx |
gp ngx -status | Show Nginx status | nginx |
gp ngx -stop | Stop Nginx service | nginx |
gp ngx -start | Start Nginx service | nginx |
gp ngx -reload | Reload Nginx configuration | nginx |
gp ngx -restart | Restart Nginx service | nginx |
gp stack nginx geoip -on {account.id}:{license.key} | Enable GeoIP2 with license | nginx |
gp stack nginx geoip -off | Disable GeoIP2 | nginx |
gp stack nginx geoip -update {iso.code}:{yes.no} | Update GeoIP2 country settings | nginx |
gp stack nginx geoip -remove {iso.code} | Remove GeoIP2 country entries | nginx |
gp stack nginx worker -connections {integer} | Set worker connections | nginx |
gp stack nginx worker -rlimit-nofile {integer} | Set worker file descriptor limit | nginx |
gp stack nginx server-name -in-redirect {value} | Configure server name redirect | nginx |
gp stack nginx server-name -hash-bucket-size {int} | Configure server name hash bucket size | nginx |
gp stack nginx limits -client-body-buffer-size {int} | Set client body buffer size | nginx |
gp stack nginx limits -client-body-timeout {int} | Set client body timeout | nginx |
gp stack nginx limits -keepalive-timeout {int} | Set keepalive timeout | nginx |
gp stack nginx open-file-cache -max {elements} -inactive {timeout} | Configure open file cache | nginx |
gp stack nginx fastcgi -buffering {value} | Enable/disable FastCGI buffering | nginx |
gp stack nginx fastcgi -buffers {quantity} {size} | Set FastCGI buffer sizes | nginx |
gp stack nginx proxy -buffering on/off | Toggle proxy buffering | nginx |
gp stack nginx proxy -cache-background-update on/off | Toggle proxy cache background update | nginx |
gp site {site.url} -disable-xmlrpc | Disable XML-RPC | site |
gp site {site.url} -enable-xmlrpc | Enable XML-RPC | site |
gp site {site.url} -block-wp-content.php | Block access to wp-content.php | site |
gp php {version} -stop | Stop PHP service (specific version) | php |
gp php {version} -start | Start PHP service (specific version) | php |
gp php {version} -reload | Reload PHP service | php |
gp php {version} -restart | Restart PHP service | php |
gp stack php {version} -max-exec-time {int} | Set max PHP execution time | php |
gp stack php {version} -mem-limit {int} | Set PHP memory limit | php |
gp stack php {version} -upload-max-filesize {int} | Set upload max filesize | php |
gp stack php {version} -opcache-enable | Enable PHP Opcache | php |
gp stack php {version} -opcache-disable | Disable PHP Opcache | php |
gp stack php -site-max-exec-time {int} {site.url} | Set site PHP execution time | php |
gp stack php -site-mem-limit {int} {site.url} | Set site PHP memory limit | php |
gp stack php -site-pm {value} {site.url} | Configure PHP process manager | php |
gp site {site.url} -switch-php {version} | Switch site PHP version | site |
gp mysql -stop | Stop MySQL | mysql |
gp mysql -start | Start MySQL | mysql |
gp mysql -reload | Reload MySQL | mysql |
gp mysql -restart | Restart MySQL | mysql |
gp stack mysql -max-connections {int} | Set max MySQL connections | mysql |
gp stack mysql -innodb-buffer-pool-size {int} | Set InnoDB buffer pool size | mysql |
gp redis -stop | Stop Redis | redis |
gp redis -start | Start Redis | redis |
gp redis -reload | Reload Redis | redis |
gp redis -restart | Restart Redis | redis |
gp stack redis -max-memory {int} | Set Redis max memory | redis |
gp stack redis -enable-persistence | Enable Redis persistence | redis |
gp stack redis -disable-persistence | Disable Redis persistence | redis |
gp site {site.url} -route-domain-www | Force www domain | site |
gp site {site.url} -route-domain-root | Force root domain | site |
gp site {site.url} -route-domain-off | Disable domain routing | site |
gp site {site.url} -redis-cache -ttl {seconds} | Enable Redis page cache | site |
gp site {site.url} -fastcgi-cache -ttl {seconds} | Enable FastCGI cache | site |
gp site {site.url} -cache-off | Disable caching | site |
gp site {site.url} -redis-object-caching on/off | Toggle Redis object cache | site |
gp fix cached {site.url} | Clear all caches for site | site |
gp fix cached | Clear all caches on server | nginx |
gp site {site.url} -6g-on | Enable 6G WAF | site |
gp site {site.url} -6g-off | Disable 6G WAF | site |
gp site {site.url} -7g-on | Enable 7G WAF | site |
gp site {site.url} -7g-off | Disable 7G WAF | site |
gp site {site.url} -modsec-on | Enable ModSec WAF | site |
gp site {site.url} -modsec-off | Disable ModSec WAF | site |
gp site {site.url} -modsec -paranoia-level {1-4} | Set ModSec paranoia level | site |
gp site {site.url} -enable-wp-fail2ban | Enable Fail2Ban for WordPress | site |
gp site {site.url} -disable-wp-fail2ban | Disable Fail2Ban for WordPress | site |
gpbup {site.url} -purge {storage} {date.from} {date.to} | Purge backups from storage | backup |
gpbup -update-gridpane-backups-system | Update backups system | backup |
gpbup {site.url} -remote-bup-on/off | Enable/disable remote backups | backup |
gpbup all-sites -set-backup-schedule … | Schedule backups for all sites | backup |
gpbup all-sites -set-prune-schedule … | Set prune schedule for all sites | backup |
gp site {site.url} -wp-debug-on/off | Toggle WP debug mode | site |
gp site {site.url} -gpcron-on {interval} | Enable GP-Cron with interval | site |
gp site {site.url} -gpcron-off | Disable GP-Cron | site |
gp site {site.url} -brotli-on/off | Toggle Brotli compression | site |
gp site {site.url} -http-auth | Enable HTTP authentication | site |
gp site {site.url} -http-auth-off | Disable HTTP authentication | site |
gp site {site.url} -csp-header-on/off | Toggle CSP headers | site |
gp site {site.url} -suspend | Suspend a site | site |
gp site {site.url} -unsuspend | Unsuspend a site | site |
gp site {site.url} -suspend -use-server-custom | Suspend with server custom template | site |
gp wp {site.url} {wp.cli.command} | Run WP-CLI command on site | site |
gp site all-sites sync-php-settings | Sync PHP settings across all sites | php |
gp site all-sites sync-6g-settings | Sync 6G WAF settings | site |
gp site all-sites sync-7g-settings | Sync 7G WAF settings | site |
gp site all-sites sync-modsec-settings | Sync ModSec WAF settings | site |
gp site all-sites sync-wpf2b-settings | Sync Fail2Ban settings | site |
gp site all-sites sync-nginx-cache-settings | Sync Nginx cache settings | nginx |
gp site all-sites sync-object-cache-settings | Sync Redis object cache settings | redis |
gpmonit {service} -cpu-warning-percent {int} -cpu-warning-cycles {int} -cpu-restart-percent {int} -cpu-restart-cycles {int} -mem-high-mb {int} -mem-high-cycles {int} -mem-restart-mb {int} -mem-restart-cycles {int} | Configure thresholds for a service | monit |
gpmonit {service} –debug | Show debug information | monit |
gpmonit {service} –no-reload | Do not reload Monit | monit |
gpmonit nginx -cpu-warning-percent 50 -cpu-warning-cycles 5 -cpu-restart-percent 70 -cpu-restart-cycles 5 -mem-high-mb 800 -mem-high-cycles 10 -mem-restart-mb 900 -mem-restart-cycles 10 | Set Nginx CPU/memory thresholds | monit |
gpmonit mysql -cpu-warning-percent 120 -cpu-warning-cycles 10 -cpu-restart-percent 180 -cpu-restart-cycles 5 -mem-high-mb 2692 -mem-high-cycles 10 -mem-restart-mb 3365 -mem-restart-cycles 10 | Set MySQL CPU/memory thresholds | monit |
gpmonit mysql -mem-high-mb 800 -mem-restart-mb 900 | Increase MySQL memory limits | monit |
gpmonit mysql -cpu-warning-percent {int} | Set MySQL CPU warning percent | monit |
gpmonit redis -cpu-warning-percent 120 -cpu-warning-cycles 10 -cpu-restart-percent 160 -cpu-restart-cycles 5 -mem-high-mb 907 -mem-high-cycles 10 -mem-restart-mb 1207 -mem-restart-cycles 10 | Set Redis CPU/memory thresholds | monit |
gpmonit redis -mem-high-mb 800 -mem-restart-mb 900 | Increase Redis memory limits | monit |
gpmonit redis -mem-high-mb {int} | Adjust Redis memory high limit | monit |
gpmonit nginx -cpu-warning-percent 100 -cpu-warning-cycles 5 -cpu-restart-percent 120 -cpu-restart-cycles 5 -mem-high-mb 1615 -mem-high-cycles 10 -mem-restart-mb 2826 -mem-restart-cycles 10 | Set Nginx CPU/memory thresholds (alt) | monit |
gpmonit openlitespeed -cpu-warning-percent 100 -cpu-warning-cycles 5 -cpu-restart-percent 120 -cpu-restart-cycles 5 -mem-high-mb 1615 -mem-high-cycles 10 -mem-restart-mb 2826 -mem-restart-cycles 10 | Set OLS CPU/memory thresholds | monit |
gpmonit php71 / php72 / php73 / php74 | Select PHP version for Monit | monit |
gpmonit php7{x} -cpu-warning-percent 120 -cpu-warning-cycles 10 -cpu-restart-percent 180 -cpu-restart-cycles 5 -mem-high-mb 2692 -mem-high-cycles 10 -mem-restart-mb 3365 -mem-restart-cycles 10 | Set PHP CPU/memory thresholds | monit |
gp server -update-monit | Update Monit settings | monit |
gpols site {site.url} | Generate site vhconf and restart OpenLiteSpeed | site |
gpols httpd | Generate server conf and restart OpenLiteSpeed service | nginx |
gpols log {site.url} | View last 500 lines of site error log | site |
gpols log {site.url} -f | Follow site error log in real-time | site |
gpols log {site.url} -a | View site access log | site |
gpols log httpd | View server error log | nginx |
gpols log httpd -f | Follow server error log in real-time | nginx |
gpols log httpd -a | View server access log | nginx |
GridPane Undocummented CLI Commands
These commands are not documented by GridPane.
Command | Action | Group |
---|---|---|
gpupdate | Updated GridPane scripts | core |
cat /usr/local/bin/lib/ols/versions | Show available openlitespeed versions that GridPane allows | ols |
Changelog
- 08-20-2025 – Added GridPane CLI references from their knowledge base, added some unknown commands.