Help

This is a NuoDB Manager command. See NuoDB Manager.

Description

Displays help for the specified command. If no command is specified, all commands are listed. The dollar sign ($) is used to specify a required argument along with its value, so $host means the keyword host followed by a host_name. Required values are designated with brackets, "{}" as in {key} which means a value key must be specified. Optional parameters are specified in square brackets "[]".

Syntax

help [ cmd ]

Parameters

Interactive Example

nuodb [domain] > help
help  add | agent | apply | capture | create | delete | diagnose | disable
domainstate | echo | enable | hotcopy | log | manage | monitor | prune
quiesce | remove | restart | restore | set | show | shutdown | start
tags | unquiesce | unset | update | verify
nuodb [domain] > help agent 
agent unreachable $host 
agent deprovision $serverId

Scripting Example

The same command command can be executed with --command as follows:

nuodbmgr --broker host --password password --command "help"nuodbmgr --broker host --password password --command "help agent"