GP CLI Quick Reference

10 min read

Quick Intro

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 explanations, but the detailed Knowledge Base articles that go into detail are linked beneath the title of each section. We strongly recommend that you refer to the dedicated articles to ensure correct usage.

We’ll keep this article up-to-date as more GP CLI commands are released/updated in the future.

Nginx

Nginx Services

Full article: Service Management: Nginx

gp ngx -t
gp ngx -status
gp ngx -stop
gp ngx -start
gp ngx -reload
gp ngx -restart

Nginx Stack

The GP-CLI commands below are thoroughly detailed in our Configure Nginx article. If you’re unsure about how or if you should use any of these commands, please read this before running any of them on your servers. They’re included here only for reference purposes.

Full article: Configure Nginx

GeoIP2

gp stack nginx geoip -on {account.id}:{license.key}
gp stack nginx geoip -off
gp stack nginx geoip -update {iso.code}:{yes.no},{iso.code}:{yes.no}
gp stack nginx geoip -remove {iso.code},{iso.code},{iso.code}

Configure Nginx Workers

gp stack nginx worker -connections {integer}
gp stack nginx worker -rlimit-nofile {integer}

Server Name Configurations

gp stack nginx server-name -in-redirect {accepted.value}
gp stack nginx server-name -hash-bucket-size {accepted.integer}

Limit Configurations

gp stack nginx limits -client-body-buffer-size {accepted.integer}
gp stack nginx limits -client-body-timeout {accepted.integer}
gp stack nginx limits -client-header-buffer-size {accepted.integer}
gp stack nginx limits -client-header-timeout {accepted.integer}
gp stack nginx limits -keepalive-requests {accepted.integer}
gp stack nginx limits -keepalive-timeout {accepted.integer}
gp stack nginx limits -large-client-headers-buffers {b.quantity} {b.size}
gp stack nginx limits -req-zone-one {store.size.mb} {req.per.sec}
gp stack nginx limits -req-zone-wp {store.size.mb} {req.per.sec}
gp stack nginx limits -reset-timedout-connection {accepted.value}
gp stack nginx limits -send-timeout {accepted.value}
gp stack nginx limits -types-hash-max-size {accepted.value}

Open File Cache Configurations

gp stack nginx open-file-cache -max {elements} -inactive {timeout}
gp stack nginx open-file-cache -errors {accepted.value}
gp stack nginx open-file-cache -min-uses {accepted.value}
gp stack nginx open-file-cache -valid {accepted.value}

FastCGI Configurations

gp stack nginx fastcgi -buffering {accepted.value}
gp stack nginx fastcgi -buffers {b.quantity} {b.size}
gp stack nginx fastcgi -buffer-size {accepted.value}
gp stack nginx fastcgi -busy-buffers-size {accepted.value}
gp stack nginx fastcgi -cache-background-update on
gp stack nginx fastcgi -cache-background-update off
gp stack nginx fastcgi -max-cache-size {accepted.value}
gp stack nginx fastcgi -cache-revalidate {accepted.value}
gp stack nginx fastcgi -connect-timeout {accepted.value}
gp stack nginx fastcgi -keep-connections {accepted.value}
gp stack nginx fastcgi -read-timeout {accepted.value}
gp stack nginx fastcgi -send-timeout {accepted.value}

Proxy Configurations

gp stack nginx proxy -buffering on
gp stack nginx proxy -buffering off
gp stack nginx proxy -buffers {b.quantity} {b.size}
gp stack nginx proxy -buffer-size {accepted.value}
gp stack nginx proxy -busy-buffers-size {accepted.value}
gp stack nginx proxy -cache-background-update on
gp stack nginx proxy -cache-background-update off
gp stack nginx proxy -max-cache-size {accepted.value}
gp stack nginx proxy -cache-revalidate on
gp stack nginx proxy -cache-revalidate off
gp stack nginx proxy -connect-timeout {accepted.value}
gp stack nginx proxy -keep-connections on
gp stack nginx proxy -keep-connections off
gp stack nginx proxy -read-timeout {accepted.value}
gp stack nginx proxy -send-timeout {accepted.value}

Limits Configurations

gp stack nginx limits -site-zone-one-burst {queue.size} {site.url}
gp stack nginx limits -site-zone-wp-burst {queue.size} {site.url}

FastCGI Configurations

gp stack nginx limits -site-max-body-size {accepted.value} {site.url}
gp stack nginx fastcgi -site-cache-valid {accepted.value} {site.url}

Site Proxy Configurations

gp stack nginx proxy -site-cache-valid {accepted.value} {site.url}
gp stack nginx redis -site-cache-valid {accepted.value} {site.url}

Nginx Hardening

Full article: Nginx Site Hardening with GP CLI

gp site {site.url} -disable-xmlrpc 
gp site {site.url} -enable-xmlrpc
gp site {site.url} -disable-concatenate-load-scripts
gp site {site.url} -enable-concatenate-load-scripts
gp site {site.url} -block-wp-content.php
gp site {site.url} -unblock-wp-content.php
gp site {site.url} -block-wp-comments-post.php
gp site {site.url} -unblock-wp-comments-post.php
gp site {site.url} -block-wp-links-opml.php
gp site {site.url} -unblock-wp-links-opml.php
gp site {site.url} -block-wp-trackbacks.php
gp site {site.url} -unblock-wp-trackbacks.php
gp site {site.url} -block-upgrade.php
gp site {site.url} -unblock-upgrade.php
gp site {site.url} -block-install.php
gp site {site.url} -unblock-install.php

PHP

PHP Services

Full article: Service Management: PHP

gp php $version -stop 
gp php $version -start
gp php $version -reload 
gp php $version -restart 

PHP Stack

The GP-CLI commands below are thoroughly detailed in our Configure PHP article. If you’re unsure about how or if you should use any of these commands, please read this before running any of them on your servers. They’re included here only for reference purposes.

Full article: Configure PHP

Configure PHP by Version

gp stack php {php.version} -allow-url-fopen {accepted.value}
gp stack php {php.version} -allow-url-include {accepted.value}
gp stack php {php.version} -date-timezone {supported.timezone}
gp stack php {php.version} -default-socket-timeout {integer}
gp stack php {php.version} -max-exec-time {integer}
gp stack php {php.version} -max-file-uploads {integer}
gp stack php {php.version} -max-input-time {integer}
gp stack php {php.version} -max-input-vars {integer}
gp stack php {php.version} -post-max-size {integer}
gp stack php {php.version} -mem-limit {integer}
gp stack php {php.version} -session-cookie-lifetime {integer}
gp stack php {php.version} -session-gc-maxlifetime {integer}
gp stack php {php.version} -short-open-tag {on.off}
gp stack php {php.version} -upload-max-filesize {integer}

Configure PHP Opcache by Version

gp stack php {php.version} -opcache-enable
gp stack php {php.version} -opcache-disable
gp stack php {php.version} -opcache-enable-cli
gp stack php {php.version} -opcache-disable-cli
gp stack php {php.version} -opcache-max-accel-files {integer}
gp stack php {php.version} -opcache-memory {integer}
gp stack php {php.version} -opcache-reval-freq $int

Site PHP General Settings

gp stack php -site-date-timezone {supported.timezone} {site.url}
gp stack php -site-default-socket-timeout {integer} {site.url}
gp stack php -site-max-exec-time {integer} {site.url}
gp stack php -site-max-file-uploads {integer} {site.url}
gp stack php -site-max-input-time {integer} {site.url}
gp stack php -site-max-input-vars {site.ur;} {site.url}
gp stack php -site-mem-limit {integer} {site.url}
gp stack php -site-post-max-size {integer} {site.url}
gp stack php -site-session-cookie-lifetime {integer} {site.url}
gp stack php -site-session-gc-maxlifetime {integer} {site.url}
gp stack php -site-short-open-tag {on.off} {site.url}
gp stack php -site-upload-max-filesize {integer} {site.url}

Configure PHP Process Manager/Workers by Site

gp stack php -site-pm {accepted.value} {site.url}
gp stack php -site-pm-max-children {accepted.value} {site.url}
gp stack php -site-pm-max-requests {integer} {site.url}
gp stack php -site-pm-max-spare-servers {accepted.value} {site.url}
gp stack php -site-pm-min-spare-servers {accepted.value} {site.url}
gp stack php -site-pm-process-idle-timeout {integer} {site.url}
gp stack php -site-pm-start-servers {accepted.value} {site.url}

Switch PHP Version

gp site {site.url} -switch-php $version

MySQL

MySQL Services

Full article: Service Management: MySQL
gp mysql -stop 
gp mysql -start
gp mysql -reload
gp mysql -restart

MySQL Stack

The GP-CLI commands below are thoroughly detailed in our Configure MySQL article. If you’re unsure about how or if you should use any of these commands, please read this before running any of them on your servers. They’re included here only for reference purposes. Full article: Configure MySQL
gp stack mysql -binlog-expire-logs-seconds {accepted.value}
gp stack mysql -binlog-space-limit {accepted.value}
gp stack mysql -innodb-autoinc-lock-mode {accepted.value}
gp stack mysql -innodb-buffer-pool-instances {accepted.value}
gp stack mysql -innodb-buffer-pool-size {accepted.value}
gp stack mysql -innodb-flush-log-at-trx-commit {accepted.value}
gp stack mysql -innodb-flush-method {accepted.value}
gp stack mysql -innodb-io-capacity {accepted.value}
gp stack mysql -innodb-io-capacity-max {accepted.value}
gp stack mysql -innodb-log-file-size {accepted.value}
gp stack mysql -join-buffer-size {accepted.value}
gp stack mysql -long-query-time {accepted.value}
gp stack mysql -max-binlog-size {accepted.value}
gp stack mysql -max-connections {accepted.value}
gp stack mysql -slow-query-log {accepted.value}
gp stack mysql -thread-handling {accepted.value}
gp stack mysql -thread-pool-high-prio-mode {accepted.value}
gp stack mysql -thread-pool-high-prio-tickets {accepted.value}
gp stack mysql -thread-pool-idle-timeout {accepted.value}
gp stack mysql -thread-pool-max-threads {accepted.value}
gp stack mysql -thread-pool-size {accepted.value}
gp stack mysql -thread-pool-stall-limit {accepted.value}

Redis

Redis Services

Full article: Service Management: Redis

gp redis -stop 
gp redis -start
gp redis -reload 
gp redis -restart

Redis Stack

The GP-CLI commands below are thoroughly detailed in our Configure Redis article. If you’re unsure about how or if you should use any of these commands, please read this before running any of them on your servers. They’re included here only for reference purposes.

Full article: Configure Redis

gp stack redis -evic-policy $key_eviction_policy $optional_max_memory
gp stack redis -evic-policy-reset
gp stack redis -max-memory $integer_max_memory
gp stack redis -max-memory-reset
gp stack redis -enable-persistence
gp stack redis -disable-persistence
gp stack redis -reset

Domain Routing

NOTE: We recommend you use toggle inside your site settings.

Full article: Manage Site Domains and Site Routing (non www vs www)

gp site {site.url} -route-domain-www
gp site {site.url} -route-domain-root
gp site {site.url} -route-domain-off

Caching

Learn all about Server Caching here.
NOTE: We recommend you use toggle inside your site settings.

The activation/deactivation commands below are for page caching. The number at the end indicates the default time-to-live (TTL) in seconds:

gp site {site.url} -redis-cache -ttl 2592000
gp site {site.url} -fastcgi-cache -ttl 1
gp site {site.url} -cache-off

You can activate/deactivate Redis Object caching for a specific site with:

gp site {site.url} -redis-object-caching on
gp site {site.url} -redis-object-caching off

You can clear ALL the caches for a specific site with:

gp fix cached {site.url}

If you would like to clear ALL caches for ALL websites on the server you can run:

gp fix cached

6G WAF

Full article: Using the GridPane 6G WAF

gp site {site.url} -6g-on
gp site {site.url} -6g-off
gp site {site.url} 6g -bad-bots on
gp site {site.url} 6g -bad-bots off
gp site {site.url} 6g -bad-query-string on
gp site {site.url} 6g -bad-query-string off
gp site {site.url} 6g -bad-referer on
gp site {site.url} 6g -bad-referer off
gp site {site.url} 6g -bad-request on
gp site {site.url} 6g -bad-request off
gp site {site.url} 6g -bad-methods on
gp site {site.url} 6g -bad-methods off

7G WAF

Full article: Using the GridPane 7G WAF

gp site {site.url} -7g-on
gp site {site.url} -7g-off
gp site {site.url} 7g -bad-bots on
gp site {site.url} 7g -bad-bots off
gp site {site.url} 7g -bad-query-string on
gp site {site.url} 7g -bad-query-string off
gp site {site.url} 7g -bad-referer on
gp site {site.url} 7g -bad-referer off
gp site {site.url} 7g -bad-request on
gp site {site.url} 7g -bad-request off
gp site {site.url} 7g -bad-methods on
gp site {site.url} 7g -bad-methods off

Modsec WAF (ModSecurity)

Full article: Using the GridPane ModSec Web Application Firewall

gp site {site.url} -modsec-on
gp site {site.url} -modsec-off
gp site {site.url} -modsec -paranoia-level {1-4}
gp site {site.url} -modsec -anomaly-threshold {integer}

Fail2Ban

Full article: Configuring Fail2Ban to Prevent Brute Force Attacks

gp site {site.url} -enable-wp-fail2ban 
gp site {site.url} -enable-wp-fail2ban -default-off
gp site {site.url} -disable-wp-fail2ban
gp site {site.url} -configure-wp-fail2ban -block-user-enumeration
gp site {site.url} -configure-wp-fail2ban -unblock-user-enumeration
gp site {site.url} -configure-wp-fail2ban -block-stupid-usernames
gp site {site.url} -configure-wp-fail2ban -unblock-stupid-usernames
gp site {site.url} -configure-wp-fail2ban -guard-comments
gp site {site.url} -configure-wp-fail2ban -unguard-comments
gp site {site.url} -configure-wp-fail2ban -guard-password-resets
gp site {site.url} -configure-wp-fail2ban -unguard-password-resets
gp site {site.url} -configure-wp-fail2ban -guard-pingbacks
gp site {site.url} -configure-wp-fail2ban -unguard-pingbacks
gp site {site.url} -configure-wp-fail2ban -guard-spam
gp site {site.url} -configure-wp-fail2ban -unguard-spam
gp site {site.url} -configure-wp-fail2ban -default

GP-Cron

Full article: WP-Cron and GridPane’s GP-Cron

gp site {site.url} -gpcron-on {minute.interval}
gp site {site.url} -gpcron-off

Brotli

Full article: Brotli Compression and GridPane

gp site {site.url} -brotli-on
gp site {site.url} -brotli-off

HTTP Auth

NOTE: We recommend you use toggle inside your site settings.

Full article: Activating HTTP Authentication on Your Website

gp site {site.url} -http-auth
gp site {site.url} -http-auth-off

Content Security Policy (CSP) Headers

Full article: How to create a Content Security Policy (CSP Header)

gp site {site.url} -csp-header-on 
gp site {site.url} -csp-header-off

Suspend/Disable a Site

Full article: Suspend/Disable a Site with GP-CLI

gp site {site.url} -suspend
gp site {site.url} -unsuspend
gp site {site.url} -suspend -use-server-custom
gp site {site.url} -suspend -use-site-custom

GP WP-CLI

Full article: GridPane and WP-CLI

gp wp {site.url} {wp.cli.command} {arg} {arg} {arg} {arg.n}