Skip to content

Commit d83ae76

Browse files
committed
Merge branch 'fixes' into generate-offlinedocs
2 parents 5d9a2c9 + fe59e69 commit d83ae76

21 files changed

Lines changed: 61 additions & 56 deletions

File tree

content/cumulus-linux-511/Monitoring-and-Troubleshooting/Open-Telemetry-Export.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,15 +142,15 @@ cumulus@switch:~$ nv config apply
142142
```
143143

144144
{{< /tab >}}
145-
{{< tab "Environment sensors">}}
145+
{{< tab "Environment sensor">}}
146146

147147
```
148-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors state enabled
148+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor state enabled
149149
cumulus@switch:~$ nv config apply
150150
```
151151

152152
```
153-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors sample-interval 100
153+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor sample-interval 100
154154
cumulus@switch:~$ nv config apply
155155
```
156156

@@ -697,7 +697,7 @@ CPU statistics include the CPU core number and operation mode (user, system, idl
697697
| `node_memory_Zswapped_bytes` | `/proc/meminfo` Zswapped bytes. |
698698

699699
{{< /tab >}}
700-
{{< tab "Environment Sensors ">}}
700+
{{< tab "Environment Sensor ">}}
701701

702702
| Name | Description |
703703
|----- | ----------- |

content/cumulus-linux-512/Monitoring-and-Troubleshooting/Open-Telemetry-Export.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,15 +180,15 @@ cumulus@switch:~$ nv config apply
180180
```
181181

182182
{{< /tab >}}
183-
{{< tab "Environment sensors">}}
183+
{{< tab "Environment sensor">}}
184184

185185
```
186-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors state enabled
186+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor state enabled
187187
cumulus@switch:~$ nv config apply
188188
```
189189

190190
```
191-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors sample-interval 100
191+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor sample-interval 100
192192
cumulus@switch:~$ nv config apply
193193
```
194194

@@ -921,7 +921,7 @@ CPU statistics include the CPU core number and operation mode (user, system, idl
921921
| `node_memory_Zswapped_bytes` | `/proc/meminfo` Zswapped bytes. |
922922

923923
{{< /tab >}}
924-
{{< tab "Environment Sensors ">}}
924+
{{< tab "Environment Sensor ">}}
925925

926926
| Name | Description |
927927
|----- | ----------- |

content/cumulus-linux-513/Monitoring-and-Troubleshooting/Open-Telemetry-Export.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -256,19 +256,19 @@ cumulus@switch:~$ nv config apply
256256
```
257257

258258
{{< /tab >}}
259-
{{< tab "Environment sensors">}}
259+
{{< tab "Environment sensor">}}
260260

261261
To enable environment sensor statistics:
262262

263263
```
264-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors state enabled
264+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor state enabled
265265
cumulus@switch:~$ nv config apply
266266
```
267267

268268
To adjust the sample interval for environment sensor statistics:
269269

270270
```
271-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors sample-interval 100
271+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor sample-interval 100
272272
cumulus@switch:~$ nv config apply
273273
```
274274

@@ -2392,7 +2392,7 @@ CPU statistics include the CPU core number and operation mode (user, system, idl
23922392
| `node_memory_Zswapped_bytes` | `/proc/meminfo` Zswapped bytes. |
23932393

23942394
{{< /tab >}}
2395-
{{< tab "Environment Sensors ">}}
2395+
{{< tab "Environment Sensor ">}}
23962396

23972397
| Name | Description |
23982398
|----- | ----------- |

content/cumulus-linux-514/Monitoring-and-Troubleshooting/Open-Telemetry-Export.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,19 +258,19 @@ cumulus@switch:~$ nv config apply
258258
```
259259

260260
{{< /tab >}}
261-
{{< tab "Environment sensors">}}
261+
{{< tab "Environment sensor">}}
262262

263263
To enable environment sensor statistics:
264264

265265
```
266-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors state enabled
266+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor state enabled
267267
cumulus@switch:~$ nv config apply
268268
```
269269

270270
To adjust the sample interval for environment sensor statistics:
271271

272272
```
273-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors sample-interval 100
273+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor sample-interval 100
274274
cumulus@switch:~$ nv config apply
275275
```
276276

@@ -2793,7 +2793,7 @@ CPU statistics include the CPU core number and operation mode (user, system, idl
27932793
| `node_memory_Zswapped_bytes` | `/proc/meminfo` Zswapped bytes. |
27942794

27952795
{{< /tab >}}
2796-
{{< tab "Environment Sensors ">}}
2796+
{{< tab "Environment Sensor ">}}
27972797

27982798
| Name | Description |
27992799
|----- | ----------- |

content/cumulus-linux-514/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-API.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1853,6 +1853,10 @@ cumulus@switch:~$ curl -u 'cumulus:CumulusLinux!' --insecure -X GET https://127.
18531853
}
18541854
```
18551855

1856+
{{%notice note%}}
1857+
The API `GET` operation output matches the operational revision view (equivalent to `nv show --rev=operational`) and omits unset fields that are shown in the default `nv show` output.
1858+
{{%/notice%}}
1859+
18561860
### Use Filters in a Query
18571861

18581862
You can use filters to show specific information in a query with the `curl -u '<username>:<password>' -k -X GET http://path?filter=<filter>` syntax. The following example is the equivalent REST API method for the NVUE `nv show interface --filter type=svi` command, which shows all SVIs configured on the switch:

content/cumulus-linux-514/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Additional options are available for certain `nv show` commands. For example, yo
190190
| `--filter` | Filters show command output on column data. For example, the `nv show interface --filter mtu=1500` shows only the interfaces with MTU set to 1500. For more information, see {{<link url="#filter-nv-show-command-output" text="Filter nv show Command Output">}} below.|
191191
| `--hostname`| Shows system configuration for the switch with the specified hostname. For example, `nv show --hostname leaf01`.|
192192
| `--operational` | Shows the running configuration (the actual system state). For example, `nv show interface swp1 --operational` shows the running configuration for swp1. The running and applied configuration should be the same. If different, inspect the logs. |
193-
| `--output` | Shows command output in table (`auto`), `json`, `yaml`, or `native` format. Use `native` format for {{<link url="FRRouting/#nvue-show-commands-and-vtysh-output" text="certain routing">}} `nv show` commands to see the output that vtysh provides. For example:<br>`nv show interface bond1 --output auto`<br>`nv show interface bond1 --output json`<br>`nv show interface bond1 --output yaml`<br>`nv show evpn multihoming esi --output native`<br>|
193+
| `--output` | Shows command output in table (`auto`), `json`, `yaml`, or `native` format. Use `native` format for {{<link url="FRRouting/#nvue-show-commands-and-vtysh-output" text="certain routing">}} `nv show` commands to see the output that vtysh provides. For example:<br>`nv show interface bond1 --output auto`<br>`nv show interface bond1 --output json`<br>`nv show interface bond1 --output yaml`<br>`nv show evpn multihoming esi --output native`<br>{{%notice note%}}The `--output json` option matches the output in `--rev=operational` and omits unset fields that are shown in the default `nv show` command output.{{%/notice%}}|
194194
| `--paginate` | Paginates the output. For example, `nv show interface bond1 --paginate on`. |
195195
| `--pending` | Shows the last applied configuration and any pending set or unset configuration that you have not yet applied. For example, `nv show interface bond1 --pending`.|
196196
| `--rev <revision>`| Shows a detached pending configuration. See the `nv config detach` configuration management command below. For example, `nv show --rev 1`. You can also show only applied or only operational information in the `nv show` output. For example, to show only the applied settings for swp1 configuration, run the `nv show interface swp1 --rev=applied` command. To show only the operational settings for swp1 configuration, run the `nv show interface swp1 --rev=operational` command. |

content/cumulus-linux-515/Monitoring-and-Troubleshooting/Open-Telemetry-Export.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -280,19 +280,19 @@ cumulus@switch:~$ nv config apply
280280
```
281281

282282
{{< /tab >}}
283-
{{< tab "Environment sensors">}}
283+
{{< tab "Environment sensor">}}
284284

285285
To enable environment sensor statistics:
286286

287287
```
288-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors state enabled
288+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor state enabled
289289
cumulus@switch:~$ nv config apply
290290
```
291291

292292
To adjust the sample interval for environment sensor statistics:
293293

294294
```
295-
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensors sample-interval 100
295+
cumulus@switch:~$ nv set system telemetry platform-stats class environment-sensor sample-interval 100
296296
cumulus@switch:~$ nv config apply
297297
```
298298

@@ -2785,7 +2785,7 @@ CPU statistics include the CPU core number and operation mode (user, system, idl
27852785
| `node_memory_Zswapped_bytes` | `/proc/meminfo` Zswapped bytes. |
27862786
27872787
{{< /tab >}}
2788-
{{< tab "Environment Sensors ">}}
2788+
{{< tab "Environment Sensor ">}}
27892789
27902790
| Name | Description |
27912791
|----- | ----------- |

content/cumulus-linux-515/System-Configuration/Authentication-Authorization-and-Accounting/TACACS.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -398,18 +398,13 @@ TACACS+ per-command authorization lets you configure the commands that TACACS+ u
398398
399399
The following command allows TACACS+ users at privilege level 0 to run the `nv` and `ip` commands.
400400
401-
{{%notice note%}}
402-
After configuring TACACS+ per-command authorization, you must restart the NVUE service.
403-
{{%/notice%}}
404-
405401
{{< tabs "TabID392 ">}}
406402
{{< tab "NVUE Commands ">}}
407403
408404
```
409405
cumulus@switch:~$ nv set system aaa tacacs authorization 0 command ip
410406
cumulus@switch:~$ nv set system aaa tacacs authorization 0 command nv
411407
cumulus@switch:~$ nv config apply
412-
cumulus@switch:~$ sudo systemctl restart nvued.service
413408
```
414409
415410
To show the per-command authorization settings, run the `nv show system aaa tacacs authorization` command:
@@ -431,7 +426,6 @@ When you configure per-command authorization on the switch, only define the init
431426
432427
```
433428
cumulus@switch:~$ sudo tacplus-restrict -i -u tacacs0 -a ip nv
434-
cumulus@switch:~$ sudo systemctl restart nvued.service
435429
```
436430
437431
The `tacplus-auth` command handles authorization for each command. To make this an enforced authorization, change the TACACS+ log in to use a restricted shell, with a very limited executable search path. Otherwise, the user can bypass the authorization. The `tacplus-restrict` utility simplifies setting up the restricted environment.

content/cumulus-linux-515/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-API.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1875,6 +1875,10 @@ cumulus@switch:~$ curl -u 'cumulus:CumulusLinux!' --insecure -X GET https://127.
18751875
}
18761876
```
18771877

1878+
{{%notice note%}}
1879+
The API `GET` operation output matches the operational revision view (equivalent to `nv show --rev=operational`) and omits unset fields that are shown in the default `nv show` output.
1880+
{{%/notice%}}
1881+
18781882
### Use Filters in a Query
18791883

18801884
You can use filters to show specific information in a query with the `curl -u '<username>:<password>' -k -X GET http://path?filter=<filter>` syntax. The following example is the equivalent REST API method for the NVUE `nv show interface --filter type=svi` command, which shows all SVIs configured on the switch:

content/cumulus-linux-515/System-Configuration/NVIDIA-User-Experience-NVUE/NVUE-CLI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Additional options are available for certain `nv show` commands. For example, yo
192192
| `--filter` | Filters show command output on column data. For example, the `nv show interface --filter mtu=1500` shows only the interfaces with MTU set to 1500. For more information, see {{<link url="#filter-nv-show-command-output" text="Filter nv show Command Output">}} below.|
193193
| `--hostname`| Shows system configuration for the switch with the specified hostname. For example, `nv show --hostname leaf01`.|
194194
| `--operational` | Shows the running configuration (the actual system state). For example, `nv show interface swp1 --operational` shows the running configuration for swp1. The running and applied configuration should be the same. If different, inspect the logs. |
195-
| `--output` | Shows command output in table (`auto`), `json`, `yaml`, or `native` format. Use `native` format for {{<link url="FRRouting/#nvue-show-commands-and-vtysh-output" text="certain routing">}} `nv show` commands to see the output that vtysh provides. For example:<br>`nv show interface bond1 --output auto`<br>`nv show interface bond1 --output json`<br>`nv show interface bond1 --output yaml`<br>`nv show evpn multihoming esi --output native`<br>|
195+
| `--output` | Shows command output in table (`auto`), `json`, `yaml`, or `native` format. Use `native` format for {{<link url="FRRouting/#nvue-show-commands-and-vtysh-output" text="certain routing">}} `nv show` commands to see the output that vtysh provides. For example:<br>`nv show interface bond1 --output auto`<br>`nv show interface bond1 --output json`<br>`nv show interface bond1 --output yaml`<br>`nv show evpn multihoming esi --output native`<br>{{%notice note%}}The `--output json` option matches the output in `--rev=operational` and omits unset fields that are shown in the default `nv show` command output.{{%/notice%}}|
196196
| `--paginate` | Paginates the output. For example, `nv show interface bond1 --paginate on`. |
197197
| `--pending` | Shows the last applied configuration and any pending set or unset configuration that you have not yet applied. For example, `nv show interface bond1 --pending`.|
198198
| `--rev <revision>`| Shows a detached pending configuration. See the `nv config detach` configuration management command below. For example, `nv show --rev 1`. You can also show only applied or only operational information in the `nv show` output. For example, to show only the applied settings for swp1 configuration, run the `nv show interface swp1 --rev=applied` command. To show only the operational settings for swp1 configuration, run the `nv show interface swp1 --rev=operational` command. |

0 commit comments

Comments
 (0)