Reference

help

Display a list of available Runtime API commands.

Description Jump to heading

The help command displays a list of Runtime API commands that are available, with a short description of each.

As of version 2.4r1, you can specify an argument to list matching or relevant commands.

Examples Jump to heading

List the Runtime API commands Jump to heading

bash
echo "help" | \
sudo socat stdio tcp4-connect:127.0.0.1:9999
bash
echo "help" | \
sudo socat stdio tcp4-connect:127.0.0.1:9999
output
bash
The following commands are valid at this level:
abort ssl cert <certfile> : abort a transaction for a certificate file
abort ssl crl-file <crlfile> : abort a transaction for a CRL file
add acl <acl> <pattern> : add an acl entry
add map <map> <key> <val> : add a map entry (payload supported instead of key/val)
...
output
bash
The following commands are valid at this level:
abort ssl cert <certfile> : abort a transaction for a certificate file
abort ssl crl-file <crlfile> : abort a transaction for a CRL file
add acl <acl> <pattern> : add an acl entry
add map <map> <key> <val> : add a map entry (payload supported instead of key/val)
...

Here we will list all commands related to the string agent:

bash
echo "help agent" | \
sudo socat stdio tcp4-connect:127.0.0.1:9999
bash
echo "help agent" | \
sudo socat stdio tcp4-connect:127.0.0.1:9999
output
bash
The following commands are valid at this level:
disable agent : disable agent checks
enable agent : enable agent checks
get acl <acl> <value> : report the patterns matching a sample for an ACL
get map <acl> <value> : report the keys and values matching a sample for a map
get var <name> : retrieve contents of a process-wide variable
help [<command>] : list matching or all commands
prompt : toggle interactive mode with prompt
quit : disconnect
output
bash
The following commands are valid at this level:
disable agent : disable agent checks
enable agent : enable agent checks
get acl <acl> <value> : report the patterns matching a sample for an ACL
get map <acl> <value> : report the keys and values matching a sample for a map
get var <name> : retrieve contents of a process-wide variable
help [<command>] : list matching or all commands
prompt : toggle interactive mode with prompt
quit : disconnect

See also Jump to heading

If this page was useful, please, Leave the feedback.