The full list of commands is provided in Command List .
The command syntax for input is:
-
CMD PARAM1 PARAM2 PARAM3(with any number of parameters) - Commands and parameters are separated by an ASCII space
- Commands and parameters are human readable, i.e., sent in ASCII format
- Receive end of line is
\n
The output return format is:
- If an input command is not recognized, the parser errors out and sends
ERROR: CMD: Invalid Command\n - If an input command is recognized, the parser checks the number of arguments,
and sends
ERROR: CMD: Invalid Number of Arguments\n - If execution succeeds, the result is returned
CMD param1 param2 ... paramX value1 value2 ... valueY\n - Commands that are not expected to return values return their name if
execution succeeds:
[CMD] - CMD and values are separated by a space
- Receive end of line is
\n - Any log or messages from metal-log can be returned via the
getlogcommand; the\r\ncharacters are replaced from any log messages with "|" and a single\nappended at the end