help - Print command’s usage and description
help [<command-name>]
Without any argument the help command displays a brief description of all available commands (this manual). If a <command-name> is given as argument, the manual of the given command is displayed.
When typing commands in a terminal the <TAB> key allow you to complete the typing keyword and to display allowed arguments. Us it always to remember the syntax of commands.
In manuals, the syntax of command utilisation is given using some simple rules. When different choices are available the character | is used to separate choices. Parenthesis ( and ) are used to specify without any ambiguity the order of keywords and arguments. They are not part of the command. Optional arguments are given inside brackets [ and ].
Command names and keywords are given in bold. Arguments are in italic.
After reading an online command help, type "q" to quit the help command.
Here are a brief description of all available commands:
access - Manage the Access policy
admin - Manage administration services
antivirus - Configure the antivirus
apply - Apply the new setting
authenticate - Manage the authentication module
cache - Manage the persistent cache memory
cancel - Cancel the new configuration
clear - Clear the terminal screen
clock - Set or get the internal clock’s date & time
conf - Manage a configuration set
countrylist - Display valid country codes
dhcp - Display, add or delete DHCP IP ranges
dns - Display, add or delete DNS (Domain Name Service) servers
domainname - Set or get the local domain name
email - Set or get administration e-mail addresses
exit - Exit the administration login
firewall - Configure the firewall
guard - Manage the URL guarding (URL filtering)
ha - Manage the High Availability
halt - Halt the Operating System
help - Print command’s usage and description
history - Display the command history list
hostname - Set or get the hostname
ip - IP address and routing configuration
job - Print a report on the current running operation in background
keyboard - Set the key map for the console keyboard
ldap - Perform LDAP actions
license - Display the CacheGuard-OS License Agreement
link - Configure L2 network interface
log - Manage Log Reports
mode - Set or get general modes (features)
ntp - Display, add or delete NTP (Network Time Protocol) servers
password - Manage passwords
peer - Display, add or delete peer appliances
ping - Send ICMP packets to network hosts
port - Set or get built-in service network IP ports
qos - Configure the network QoS (Quality of Service)
reboot - Reboot the system
register - Appliance and License Key Registration
rweb - Manage the reverse Web mode (reverse proxy)
setup - Performs a basic startup configuration
sslmediate - Manage the SSL mediation
system - Manage the operating system
timezone - Set or get the local time zone
timezonelist - Display valid time zone codes
tls - Manage TLS (SSL) certificates
transaction - Perform a set of commands in a transaction
transparent - Manage the transparent mode
urllist - Manage URL lists
usleep - Suspends execution of the calling thread for <usec> microseconds
vlan - Configure 802.1Q VLANs (Virtual LANs)
vpnipsec - Manage IPsec VPN tunnels and networks
vrrp - Manage the VRRP configuration in HA mode
waf - Configure the Web Application Firewall (WAF)
CacheGuard Technologies Ltd <www.cacheguard.com>
Send bug reports or comments to the above author.
Copyright (C) 2009-2021 CacheGuard - All rights reserved