Merge pull request #263872 from DanCrank/main

Add documentation for ipmitool and racadm commands

Author: v-shils

articles/operator-nexus/howto-baremetal-run-read.md

@@ -24,36 +24,176 @@ The command execution produces an output file containing the results that can be
 
 ## Executing a run-read command
 
-The run-read command executes a read-only command on the specified BMM.
+The run-read command lets you run a command on the BMM that does not change anything. Some commands have more
+than one word, or need an argument to work. These commands are made like this to separate them from the ones
+that can change things. For example, run-read-command can use `kubectl get` but not `kubectl apply`. When you
+use these commands, you have to put all the words in the “command” field. For example,
+`{"command":"kubectl get","arguments":["nodes"]}` is right; `{"command":"kubectl","arguments":["get","nodes"]}`
+is wrong.
 
-The current list of supported commands are:
+Also note that some commands begin with `nc-toolbox nc-toolbox-runread` and must be entered as shown.
+`nc-toolbox-runread` is a special container image that includes more tools that aren't installed on the
+baremetal host, such as `ipmitool` and `racadm`.
+
+The list below shows the commands you can use. Commands in `*italics*` cannot have `arguments`; the rest can.
 
-- `traceroute`
-- `ping`
 - `arp`
-- `tcpdump`
 - `brctl show`
 - `dmidecode`
+- *`fdisk -l`*
 - `host`
-- `ip link show`
+- *`hostname`*
+- *`ifconfig -a`*
+- *`ifconfig -s`*
 - `ip address show`
+- `ip link show`
 - `ip maddress show`
 - `ip route show`
 - `journalctl`
-- `kubectl logs`
-- `kubectl describe`
-- `kubectl get`
 - `kubectl api-resources`
 - `kubectl api-versions`
+- `kubectl describe`
+- `kubectl get`
+- `kubectl logs`
+- *`mount`*
+- `ping`
+- *`ss`*
+- `tcpdump`
+- `traceroute`
 - `uname`
+- *`ulimit -a`*
 - `uptime`
-- `fdisk -l`
-- `hostname`
-- `ifconfig -a`
-- `ifconfig -s`
-- `mount`
-- `ss`
-- `ulimit -a`
+- `nc-toolbox nc-toolbox-runread ipmitool channel authcap`
+- `nc-toolbox nc-toolbox-runread ipmitool channel info`
+- `nc-toolbox nc-toolbox-runread ipmitool chassis status`
+- `nc-toolbox nc-toolbox-runread ipmitool chassis power status`
+- `nc-toolbox nc-toolbox-runread ipmitool chassis restart cause`
+- `nc-toolbox nc-toolbox-runread ipmitool chassis poh`
+- `nc-toolbox nc-toolbox-runread ipmitool dcmi power get_limit`
+- `nc-toolbox nc-toolbox-runread ipmitool dcmi sensors`
+- `nc-toolbox nc-toolbox-runread ipmitool dcmi asset_tag`
+- `nc-toolbox nc-toolbox-runread ipmitool dcmi get_mc_id_string`
+- `nc-toolbox nc-toolbox-runread ipmitool dcmi thermalpolicy get`
+- `nc-toolbox nc-toolbox-runread ipmitool dcmi get_temp_reading`
+- `nc-toolbox nc-toolbox-runread ipmitool dcmi get_conf_param`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem lcd info`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem lcd status`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem mac list`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem mac get`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem lan get`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem powermonitor powerconsumption`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem powermonitor powerconsumptionhistory`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem powermonitor getpowerbudget`
+- `nc-toolbox nc-toolbox-runread ipmitool delloem vflash info card`
+- `nc-toolbox nc-toolbox-runread ipmitool echo`
+- `nc-toolbox nc-toolbox-runread ipmitool ekanalyzer print`
+- `nc-toolbox nc-toolbox-runread ipmitool ekanalyzer summary`
+- `nc-toolbox nc-toolbox-runread ipmitool fru print`
+- `nc-toolbox nc-toolbox-runread ipmitool fwum info`
+- `nc-toolbox nc-toolbox-runread ipmitool fwum status`
+- `nc-toolbox nc-toolbox-runread ipmitool fwum tracelog`
+- `nc-toolbox nc-toolbox-runread ipmitool gendev list`
+- `nc-toolbox nc-toolbox-runread ipmitool hpm rollbackstatus`
+- `nc-toolbox nc-toolbox-runread ipmitool hpm selftestresult`
+- `nc-toolbox nc-toolbox-runread ipmitool ime help`
+- `nc-toolbox nc-toolbox-runread ipmitool ime info`
+- `nc-toolbox nc-toolbox-runread ipmitool isol info`
+- `nc-toolbox nc-toolbox-runread ipmitool lan print`
+- `nc-toolbox nc-toolbox-runread ipmitool lan alert print`
+- `nc-toolbox nc-toolbox-runread ipmitool lan stats get`
+- `nc-toolbox nc-toolbox-runread ipmitool mc bootparam get`
+- `nc-toolbox nc-toolbox-runread ipmitool mc chassis poh`
+- `nc-toolbox nc-toolbox-runread ipmitool mc chassis policy list`
+- `nc-toolbox nc-toolbox-runread ipmitool mc chassis power status`
+- `nc-toolbox nc-toolbox-runread ipmitool mc chassis status`
+- `nc-toolbox nc-toolbox-runread ipmitool mc getenables`
+- `nc-toolbox nc-toolbox-runread ipmitool mc getsysinfo`
+- `nc-toolbox nc-toolbox-runread ipmitool mc guid`
+- `nc-toolbox nc-toolbox-runread ipmitool mc info`
+- `nc-toolbox nc-toolbox-runread ipmitool mc restart cause`
+- `nc-toolbox nc-toolbox-runread ipmitool mc watchdog get`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc bootparam get`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc chassis poh`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc chassis policy list`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc chassis power status`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc chassis status`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc getenables`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc getsysinfo`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc guid`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc info`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc restart cause`
+- `nc-toolbox nc-toolbox-runread ipmitool bmc watchdog get`
+- `nc-toolbox nc-toolbox-runread ipmitool nm alert get`
+- `nc-toolbox nc-toolbox-runread ipmitool nm capability`
+- `nc-toolbox nc-toolbox-runread ipmitool nm discover`
+- `nc-toolbox nc-toolbox-runread ipmitool nm policy get policy_id`
+- `nc-toolbox nc-toolbox-runread ipmitool nm policy limiting`
+- `nc-toolbox nc-toolbox-runread ipmitool nm statistics`
+- `nc-toolbox nc-toolbox-runread ipmitool nm suspend get`
+- `nc-toolbox nc-toolbox-runread ipmitool nm threshold get`
+- `nc-toolbox nc-toolbox-runread ipmitool pef`
+- `nc-toolbox nc-toolbox-runread ipmitool picmg addrinfo`
+- `nc-toolbox nc-toolbox-runread ipmitool picmg policy get`
+- `nc-toolbox nc-toolbox-runread ipmitool power status`
+- `nc-toolbox nc-toolbox-runread ipmitool sdr elist`
+- `nc-toolbox nc-toolbox-runread ipmitool sdr get`
+- `nc-toolbox nc-toolbox-runread ipmitool sdr info`
+- `nc-toolbox nc-toolbox-runread ipmitool sdr list`
+- `nc-toolbox nc-toolbox-runread ipmitool sdr type`
+- `nc-toolbox nc-toolbox-runread ipmitool sel elist`
+- `nc-toolbox nc-toolbox-runread ipmitool sel get`
+- `nc-toolbox nc-toolbox-runread ipmitool sel info`
+- `nc-toolbox nc-toolbox-runread ipmitool sel list`
+- `nc-toolbox nc-toolbox-runread ipmitool sel time get`
+- `nc-toolbox nc-toolbox-runread ipmitool sensor get`
+- `nc-toolbox nc-toolbox-runread ipmitool sensor list`
+- `nc-toolbox nc-toolbox-runread ipmitool session info`
+- `nc-toolbox nc-toolbox-runread ipmitool sol info`
+- `nc-toolbox nc-toolbox-runread ipmitool sol payload status`
+- `nc-toolbox nc-toolbox-runread ipmitool user list`
+- `nc-toolbox nc-toolbox-runread ipmitool user summary`
+- *`nc-toolbox nc-toolbox-runread racadm arp`*
+- *`nc-toolbox nc-toolbox-runread racadm coredump`*
+- `nc-toolbox nc-toolbox-runread racadm diagnostics`
+- `nc-toolbox nc-toolbox-runread racadm eventfilters get`
+- `nc-toolbox nc-toolbox-runread racadm fcstatistics`
+- `nc-toolbox nc-toolbox-runread racadm get`
+- `nc-toolbox nc-toolbox-runread racadm getconfig`
+- `nc-toolbox nc-toolbox-runread racadm gethostnetworkinterfaces`
+- *`nc-toolbox nc-toolbox-runread racadm getled`*
+- `nc-toolbox nc-toolbox-runread racadm getniccfg`
+- `nc-toolbox nc-toolbox-runread racadm getraclog`
+- `nc-toolbox nc-toolbox-runread racadm getractime`
+- `nc-toolbox nc-toolbox-runread racadm getsel`
+- `nc-toolbox nc-toolbox-runread racadm getsensorinfo`
+- `nc-toolbox nc-toolbox-runread racadm getssninfo`
+- `nc-toolbox nc-toolbox-runread racadm getsvctag`
+- `nc-toolbox nc-toolbox-runread racadm getsysinfo`
+- `nc-toolbox nc-toolbox-runread racadm gettracelog`
+- `nc-toolbox nc-toolbox-runread racadm getversion`
+- `nc-toolbox nc-toolbox-runread racadm hwinventory`
+- *`nc-toolbox nc-toolbox-runread racadm ifconfig`*
+- *`nc-toolbox nc-toolbox-runread racadm inlettemphistory get`*
+- `nc-toolbox nc-toolbox-runread racadm jobqueue view`
+- `nc-toolbox nc-toolbox-runread racadm lclog view`
+- `nc-toolbox nc-toolbox-runread racadm lclog viewconfigresult`
+- `nc-toolbox nc-toolbox-runread racadm license view`
+- *`nc-toolbox nc-toolbox-runread racadm netstat`*
+- `nc-toolbox nc-toolbox-runread racadm nicstatistics`
+- `nc-toolbox nc-toolbox-runread racadm ping`
+- `nc-toolbox nc-toolbox-runread racadm ping6`
+- *`nc-toolbox nc-toolbox-runread racadm racdump`*
+- `nc-toolbox nc-toolbox-runread racadm sslcertview`
+- *`nc-toolbox nc-toolbox-runread racadm swinventory`*
+- *`nc-toolbox nc-toolbox-runread racadm systemconfig getbackupscheduler`*
+- `nc-toolbox nc-toolbox-runread racadm systemperfstatistics` (PeakReset argument NOT allowed)
+- *`nc-toolbox nc-toolbox-runread racadm techsupreport getupdatetime`*
+- `nc-toolbox nc-toolbox-runread racadm traceroute`
+- `nc-toolbox nc-toolbox-runread racadm traceroute6`
+- `nc-toolbox nc-toolbox-runread racadm usercertview`
+- *`nc-toolbox nc-toolbox-runread racadm vflashsd status`*
+- *`nc-toolbox nc-toolbox-runread racadm vflashpartition list`*
+- *`nc-toolbox nc-toolbox-runread racadm vflashpartition status -a`*
 
 The command syntax is:
 
@@ -62,21 +202,9 @@ az networkcloud baremetalmachine run-read-command --name "<machine-name>"
     --limit-time-seconds <timeout> \
     --commands '[{"command":"<command1>"},{"command":"<command2>","arguments":["<arg1>","<arg2>"]}]' \
     --resource-group "<resourceGroupName>" \
-    --subscription "<subscription>" 
+    --subscription "<subscription>"
 ```
 
-These commands don't require `arguments`:
-
-- `fdisk -l`
-- `hostname`
-- `ifconfig -a`
-- `ifconfig -s`
-- `mount`
-- `ss`
-- `ulimit -a`
-
-All other inputs are required. 
-
 Multiple commands can be provided in json format to `--commands` option.
 
 For a command with multiple arguments, provide as a list to `arguments` parameter. See [Azure CLI Shorthand](https://github.com/Azure/azure-cli/blob/dev/doc/shorthand_syntax.md) for instructions on constructing the `--commands` structure.
@@ -87,21 +215,29 @@ This command runs synchronously. If you wish to skip waiting for the command to
 
 When an optional argument `--output-directory` is provided, the output result is downloaded and extracted to the local directory.
 
-### This example executes the `hostname` command and a `ping` command.
+### This example executes the `hostname` command and a `ping` command
 
 ```azurecli
-az networkcloud baremetalmachine run-read-command --name "bareMetalMachineName" \
+az networkcloud baremetalmachine run-read-command --name "<bareMetalMachineName>" \
     --limit-time-seconds 60 \
-    --commands '[{"command":"hostname"],"arguments":["198.51.102.1","-c","3"]},{"command":"ping"}]' \
-    --resource-group "resourceGroupName" \
-    --subscription "<subscription>" 
+    --commands '[{"command":"hostname"},{"command":"ping","arguments":["198.51.102.1","-c","3"]}]' \
+    --resource-group "<resourceGroupName>" \
+    --subscription "<subscription>"
 ```
 
-In the response, an HTTP status code of 202 is returned as the operation is performed asynchronously. 
+### This example executes the `racadm getsysinfo -c` command
+
+```azurecli
+az networkcloud baremetalmachine run-read-command --name "<bareMetalMachineName>" \
+    --limit-time-seconds 60 \
+    --commands '[{"command":"nc-toolbox nc-toolbox-runread racadm getsysinfo","arguments":["-c"]}]' \
+    --resource-group "<resourceGroupName>" \
+    --subscription "<subscription>"
+```
 
 ## Checking command status and viewing output
 
-Sample output looks something as below. It prints the top 4K characters of the result to the screen for convenience and provides a short-lived link to the storage blob containing the command execution result. You can use the link to download the zipped output file (tar.gz).
+Sample output is shown. It prints the top 4,000 characters of the result to the screen for convenience and provides a short-lived link to the storage blob containing the command execution result. You can use the link to download the zipped output file (tar.gz).
 
 ```output
   ====Action Command Output====