Skip to content

Commit 5f69b62

Browse files
author
Cumulus Docs Auto Merge
committed
Merge remote-tracking branch 'origin/stage'
2 parents d2032cf + 55a65ae commit 5f69b62

11 files changed

Lines changed: 25 additions & 10 deletions

File tree

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/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. |

content/cumulus-linux-516/Network-Virtualization/Ethernet-Virtual-Private-Network-EVPN/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Cumulus Linux fully supports EVPN as the control plane for VXLAN, including for
3333
- MAC (host) mobility.
3434
- PIM multicast-based BUM handling.
3535
- Interoperability with IPv4 and IPv6 VTEPs in the fabric.
36-
- Dual stack VXLAN mode (with both an IPv4 and IPv6 VTEP source address)
36+
- Dual stack VXLAN mode (with both an IPv4 and IPv6 VTEP source address).
3737
- MLAG.
3838
- Static VXLAN tunnels.
3939
- Downstream VNIs.

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

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

1913+
{{%notice note%}}
1914+
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.
1915+
{{%/notice%}}
1916+
19131917
### Use Filters in a Query
19141918

19151919
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-516/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. |

content/cumulus-linux-517/Network-Virtualization/Ethernet-Virtual-Private-Network-EVPN/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Cumulus Linux fully supports EVPN as the control plane for VXLAN, including for
3333
- MAC (host) mobility.
3434
- PIM multicast-based BUM handling.
3535
- Interoperability with IPv4 and IPv6 VTEPs in the fabric.
36-
- Dual stack VXLAN mode (with both an IPv4 and IPv6 VTEP source address)
36+
- Dual stack VXLAN mode (with both an IPv4 and IPv6 VTEP source address).
3737
- MLAG.
3838
- Static VXLAN tunnels.
3939
- Downstream VNIs.

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

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

1913+
{{%notice note%}}
1914+
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.
1915+
{{%/notice%}}
1916+
19131917
### Use Filters in a Query
19141918

19151919
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-517/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)