Skip to content

Commit 55de4f6

Browse files
troglobittroglobit
committed
doc: replace 'show interfaces' with 'show interface'
The CLI command was renamed long ago when the plural form was removed from klish (now only `show interface [name]` exists), but docs and the landing page still showed the old plural form. Update all user-facing examples to match. Internal subcommand names (cli_pretty's `-t show-interfaces`, test fixture filenames) and historical ChangeLog entries are intentionally left as-is. Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
1 parent 9edef49 commit 55de4f6

9 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎doc/cli/introduction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ interfaces {
164164
}
165165
}
166166
admin@host-12-34-56:/config/interface/eth0/> leave
167-
admin@host-12-34-56:/> show interfaces
167+
admin@host-12-34-56:/> show interface
168168
INTERFACE PROTOCOL STATE DATA
169169
lo loopback UNKNOWN 00:00:00:00:00:00
170170
ipv4 127.0.0.1/8 (static)

‎doc/dhcp.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ When configuring, e.g., `dns-server`, or `router` options with the value
109109
`auto`, the system uses the IP address from the interface matching the
110110
subnet. For example:
111111

112-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
112+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
113113
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
114114
eth0 ethernet UP mac:02:00:00:00:00:00
115115
ipv4 192.168.1.1/24 (static)

‎doc/iface.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ admin@example:/config/interface/eth0/> <b>leave</b>
6161
The operational status can be inspected to see both administrative and
6262
actual link state:
6363

64-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
64+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
6565
INTERFACE PROTOCOL STATE DATA
6666
eth0 ethernet <b>DISABLED</b> mac:02:00:00:00:00:00
6767
eth1 ethernet UP mac:02:00:00:00:00:01 speed:1G-FDX

‎doc/ip.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ will be ignored. For details on how to enable the NTP client, see the
117117

118118
![Switch example (eth0 and lo)](img/ip-address-example-switch.svg)
119119

120-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
120+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
121121
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
122122
eth0 ethernet UP mac:02:00:00:00:00:00
123123
ipv6 fe80::ff:fe00:0/64 (link-layer)
@@ -153,7 +153,7 @@ admin@example:/config/interface/eth0/ipv4/> <b>diff</b>
153153
+ }
154154
+}
155155
admin@example:/config/interface/eth0/ipv4/> <b>leave</b>
156-
admin@example:/> <b>show interfaces</b>
156+
admin@example:/> <b>show interface</b>
157157
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
158158
eth0 ethernet UP mac:02:00:00:00:00:00
159159
ipv4 169.254.1.3/16 (random)
@@ -188,7 +188,7 @@ admin@example:/config/interface/eth0/ipv4/autoconf/> <b>leave</b>
188188
admin@example:/config/> <b>edit interface eth0 ipv4</b>
189189
admin@example:/config/interface/eth0/ipv4/> <b>set dhcp</b>
190190
admin@example:/config/interface/eth0/ipv4/> <b>leave</b>
191-
admin@example:/> <b>show interfaces</b>
191+
admin@example:/> <b>show interface</b>
192192
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
193193
eth0 ethernet UP mac:02:00:00:00:00:00
194194
ipv4 10.1.2.100/24 (dhcp)
@@ -291,7 +291,7 @@ on the interface.
291291
admin@example:/config/> <b>edit interface eth0 ipv6</b>
292292
admin@example:/config/interface/eth0/ipv6/> <b>set enabled false</b>
293293
admin@example:/config/interface/eth0/ipv6/> <b>leave</b>
294-
admin@example:/> <b>show interfaces</b>
294+
admin@example:/> <b>show interface</b>
295295
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
296296
eth0 ethernet UP mac:02:00:00:00:00:00
297297
lo ethernet UP mac:00:00:00:00:00:00
@@ -308,7 +308,7 @@ admin@example:/>
308308
admin@example:/config/> <b>edit interface eth0 ipv6</b>
309309
admin@example:/config/interface/eth0/ipv6/> <b>set address 2001:db8::1 prefix-length 64</b>
310310
admin@example:/config/interface/eth0/ipv6/> <b>leave</b>
311-
admin@example:/> <b>show interfaces</b>
311+
admin@example:/> <b>show interface</b>
312312
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
313313
eth0 ethernet UP mac:02:00:00:00:00:00
314314
ipv6 2001:db8::1/64 (static)
@@ -330,7 +330,7 @@ advertised by the router (here 2001:db8:0:1::0/64) and the interface
330330
identifier. The resulting address is of type *link-layer*, as it is
331331
formed based on the interface identifier ([ietf-ip.yang][2]).
332332

333-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
333+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
334334
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
335335
eth0 ethernet UP mac:02:00:00:00:00:00
336336
ipv6 2001:db8:0:1:0:ff:fe00:0/64 (link-layer)
@@ -348,7 +348,7 @@ below.
348348
admin@example:/config/> <b>edit interface eth0 ipv6</b>
349349
admin@example:/config/interface/eth0/ipv6/> <b>set autoconf create-global-addresses false</b>
350350
admin@example:/config/interface/eth0/ipv6/> <b>leave</b>
351-
admin@example:/> <b>show interfaces</b>
351+
admin@example:/> <b>show interface</b>
352352
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
353353
eth0 ethernet UP mac:02:00:00:00:00:00
354354
ipv6 fe80::ff:fe00:0/64 (link-layer)
@@ -366,7 +366,7 @@ admin@example:/>
366366
By default, the auto-configured link-local and global IPv6 addresses
367367
are formed from a link-identifier based on the MAC address.
368368

369-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
369+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
370370
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
371371
eth0 ethernet UP mac:02:00:00:00:00:00
372372
ipv6 2001:db8:0:1:0:ff:fe00:0/64 (link-layer)
@@ -385,7 +385,7 @@ possible to specify use of a random identifier ([ietf-ip.yang][2] and
385385
admin@example:/config/> <b>edit interface eth0 ipv6</b>
386386
admin@example:/config/interface/eth0/ipv6/> <b>set autoconf create-temporary-addresses true</b>
387387
admin@example:/config/interface/eth0/ipv6/> <b>leave</b>
388-
admin@example:/> <b>show interfaces</b>
388+
admin@example:/> <b>show interface</b>
389389
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
390390
eth0 ethernet UP mac:02:00:00:00:00:00
391391
ipv6 2001:db8:0:1:b705:8374:638e:74a8/64 (random)

‎doc/lag.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Like other interfaces, link aggregates are also available in the general
8787
interfaces overview in the CLI admin-exec context. Here is the above
8888
static mode aggregate:
8989

90-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
90+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
9191
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
9292
lo ethernet UP mac:00:00:00:00:00:00
9393
ipv4 127.0.0.1/8 (static)
@@ -103,7 +103,7 @@ lag0 lag UP static: balance-xor, hash: layer2
103103

104104
Same aggregate, but in LACP mode:
105105

106-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
106+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
107107
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
108108
lo ethernet UP mac:00:00:00:00:00:00
109109
ipv4 127.0.0.1/8 (static)

‎doc/management.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ CLI can be entered from shell in the same way as for SSH.
109109

110110
See the 'help' command for an introduction to the system
111111

112-
admin@example:/> <b>show interfaces</b>
112+
admin@example:/> <b>show interface</b>
113113
<span class="header">INTERFACE PROTOCOL STATE DATA </span>
114114
lo ethernet UP mac:00:00:00:00:00:00
115115
ipv4 127.0.0.1/8 (static)

‎doc/scripting-prod.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Starting out, we assume a configuration where all ports are network
3939
interfaces (possibly with IPv6 enabled).
4040

4141
```
42-
admin@example:/> show interfaces
42+
admin@example:/> show interface
4343
lo ethernet UP mac:00:00:00:00:00:00
4444
ipv4 127.0.0.1/8 (static)
4545
ipv6 ::1/128 (static)
@@ -80,7 +80,7 @@ admin@example:/config/> set interface e10 bridge-port bridge br0
8080
admin@example:/config/>
8181
```
8282

83-
The interface status can be viewed using `show interfaces` after leaving
83+
The interface status can be viewed using `show interface` after leaving
8484
configuration context. When configuring via SSH, first assign an IP
8585
address to `br0` *before leaving* configuration context, e.g.
8686

@@ -95,7 +95,7 @@ setup, including [setting IP address](#set-ip-address).
9595
```
9696
admin@example:/config/> leave
9797
admin@example:/>
98-
admin@example:/> show interfaces
98+
admin@example:/> show interface
9999
INTERFACE PROTOCOL STATE DATA
100100
br0 bridge
101101
│ ethernet UP mac:00:53:00:06:11:01
@@ -154,7 +154,7 @@ admin@example:/>
154154
Interface status would now should something like the following
155155

156156
```
157-
admin@example:/> show interfaces
157+
admin@example:/> show interface
158158
INTERFACE PROTOCOL STATE DATA
159159
br0 bridge
160160
│ ethernet UP mac:00:53:00:06:11:01
@@ -181,7 +181,7 @@ patched according to [above](#vlan-snake). We should see link up and
181181
*FORWARDING* on all ports in the bridge.
182182

183183
```
184-
admin@example:/> show interfaces
184+
admin@example:/> show interface
185185
INTERFACE PROTOCOL STATE DATA
186186
br0 bridge
187187
│ ethernet UP mac:00:53:00:06:11:01
@@ -284,7 +284,7 @@ admin@example:/>
284284
Interface *vlan10* with an auto-configured IPv6 address should appear.
285285

286286
```
287-
admin@example:/> show interfaces
287+
admin@example:/> show interface
288288
INTERFACE PROTOCOL STATE DATA
289289
br0 bridge vlan:10t
290290
│ ethernet UP mac:00:53:00:06:11:01

‎doc/vpn-wireguard.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -345,12 +345,12 @@ tunnel endpoints use IPv4 or IPv6.
345345

346346
Check WireGuard interface status and peer connections:
347347

348-
<pre class="cli"><code>admin@example:/> <b>show interfaces</b>
348+
<pre class="cli"><code>admin@example:/> <b>show interface</b>
349349
wg0 wireguard UP 2 peers (1 up)
350350
ipv4 10.0.0.1/24 (static)
351351
ipv6 fd00::1/64 (static)
352352

353-
admin@example:/> <b>show interfaces wg0</b>
353+
admin@example:/> <b>show interface wg0</b>
354354
name : wg0
355355
type : wireguard
356356
index : 12

‎src/landing/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ <h1>Welcome to Infix :-)</h1>
106106
}
107107
}
108108
admin@infix-12-34-56:/config/interface/eth0/&gt; leave
109-
admin@infix-12-34-56:/&gt; show interfaces
109+
admin@infix-12-34-56:/&gt; show interface
110110
INTERFACE PROTOCOL STATE DATA
111111
eth0 ethernet UP 52:54:00:12:34:56
112112
ipv4 192.168.2.200/24 (static)

0 commit comments

Comments
 (0)