|
| 1 | +--- |
| 2 | +title: Common Options |
| 3 | +author: Cumulus Networks |
| 4 | +weight: 60 |
| 5 | + |
| 6 | +type: nojsscroll |
| 7 | +--- |
| 8 | +<style> |
| 9 | +h { color: RGB(118,185,0)} |
| 10 | +</style> |
| 11 | + |
| 12 | +All NVUE commands include the `-h` option that provides command description and usage. |
| 13 | + |
| 14 | +The NVUE `nv show` commands have these common options. |
| 15 | + |
| 16 | +## Revision Options |
| 17 | + |
| 18 | +| <div style="width:200px">Option | Description | |
| 19 | +| ------ | ----------- | |
| 20 | +|`--rev <revision>` | Shows a detached pending configuration. `<revsion>` is the ID. For example, `nv show --rev 4`. | |
| 21 | +|`--pending` | Shows configuration that is `set` and `unset` but not yet applied or saved. For example, `nv show --pending interface bond1`. | |
| 22 | +|`--applied` | Shows configuration applied with the `nv config apply` command. For example, `nv show --applied interface bond1`.| |
| 23 | +|`--startup` | Shows the saved configuration.| |
| 24 | +|`--operational` | Shows the running configuration (the actual system state). For example, `nv show --operational interface bond1` shows the running configuration for bond1. The running and applied configuration should be the same. If different, inspect the logs.| |
| 25 | + |
| 26 | +## Show Options |
| 27 | + |
| 28 | +| <div style="width:200px">Option | Description | |
| 29 | +| ------ | ----------- | |
| 30 | +|`--view <view>`<br>`-w <view>` | Shows different views. A view is a subset of information provided by certain `nv show` commands. To see the views available for an `nv show` command, run the command with `--view` and press TAB (for example `nv show interface --view <<press tab>>`). | |
| 31 | +| `--filter <filter>` | Filters on column output data. For example, the `nv show interface --filter mtu=1500` shows only the interfaces with MTU set to 1500.</br>To filter on multiple column outputs, enclose the filter types in parentheses; for example, `nv show interface --filter "type=bridge&mtu=9216"` shows data for bridges with MTU 9216.</br>You can use wildcards; for example, `nv show interface swp1 --filter "ip.address=1*"` shows all IP addresses that start with 1 for swp1.</br>You can filter on all revisions (operational, applied, and pending); for example, `nv show interface --filter "ip.address=1*" --rev=applied` shows all IP addresses that start with 1 for swp1 in the applied revision. | |
| 32 | + |
| 33 | +## Output Options |
| 34 | + |
| 35 | +| <div style="width:200px">Option | Description | |
| 36 | +| ------ | ----------- | |
| 37 | +| `--output <format>`<br> `-o <format>`| Shows command output in table (`auto`), `json`, `yaml`, or plain text (`native`) format such as vtysh native output. 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`| |
| 38 | +| `--color` (`on`, `off`, or `auto`) | Turns colored output on or off. The default is auto. For example<br>`nv show interface bond1 --color on`. | |
| 39 | +| `--paginate` (`on`, `off`, or `auto`) | Paginates the output. The default is `off`. For example<br>`nv show interface bond1 --paginate on`. | |
0 commit comments