Skip to content

Commit 80ec2c6

Browse files
Merge pull request #270139 from gedrivera/eduardori/update-mst-docs
Update list of run-read commands to documentation
2 parents de893be + 7c6aa63 commit 80ec2c6

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Also note that some commands begin with `nc-toolbox nc-toolbox-runread` and must
3535
`nc-toolbox-runread` is a special container image that includes more tools that aren't installed on the
3636
baremetal host, such as `ipmitool` and `racadm`.
3737

38+
Some of the run-read commands require specific arguments be supplied to enforce read-only capabilities of the commands.
39+
An example of run-read commands that require specific arguments is the allowed Mellanox command `mstconfig`,
40+
which requires the `query` argument be provided to enforce read-only.
41+
3842
The list below shows the commands you can use. Commands in `*italics*` cannot have `arguments`; the rest can.
3943

4044
- `arp`
@@ -194,11 +198,16 @@ The list below shows the commands you can use. Commands in `*italics*` cannot ha
194198
- *`nc-toolbox nc-toolbox-runread racadm vflashsd status`*
195199
- *`nc-toolbox nc-toolbox-runread racadm vflashpartition list`*
196200
- *`nc-toolbox nc-toolbox-runread racadm vflashpartition status -a`*
201+
- `nc-toolbox nc-toolbox-runread mstregdump`
202+
- `nc-toolbox nc-toolbox-runread mstconfig` (requires `query` arg )
203+
- `nc-toolbox nc-toolbox-runread mstflint` (requires `query` arg )
204+
- `nc-toolbox nc-toolbox-runread mstlink` (requires `query` arg )
205+
- `nc-toolbox nc-toolbox-runread mstfwmanager` (requires `query` arg )
206+
- `nc-toolbox nc-toolbox-runread mlx_temp`
197207

198208
The command syntax is:
199-
200209
```azurecli
201-
az networkcloud baremetalmachine run-read-command --name "<machine-name>"
210+
az networkcloud baremetalmachine run-read-command --name <machine-name>
202211
--limit-time-seconds <timeout> \
203212
--commands '[{"command":"<command1>"},{"command":"<command2>","arguments":["<arg1>","<arg2>"]}]' \
204213
--resource-group "<resourceGroupName>" \
@@ -268,4 +277,4 @@ This guide walks you through accessing the output file that is created in the Cl
268277

269278
1. Select the output file from the run-read command. The file name can be identified from the `az rest --method get` command. Additionally, the **Last modified** timestamp aligns with when the command was executed.
270279

271-
1. You can manage & download the output file from the **Overview** pop-out.
280+
1. You can manage & download the output file from the **Overview** pop-out.

0 commit comments

Comments
 (0)