Skip to content

Commit 1011859

Browse files
committed
cli: use infintive form of verb, interfaces -> interface
We use the infinitive, or basic form, in configure context, as do most other network vendors, so let's do the same in admin exec context. Also, drop the 'name' qualifier, it is not needed in configure context so we shouldn't have to use it in admin exec either. Signed-off-by: Joachim Wiberg <[email protected]>
1 parent 4b45fff commit 1011859

File tree

3 files changed

+18
-20
lines changed

3 files changed

+18
-20
lines changed

doc/networking.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ In addition to basic status shown in the interface overview, detailed
562562
LAG status can be inspected:
563563

564564
```
565-
admin@example:/> show interfaces name lag0
565+
admin@example:/> show interface lag0
566566
name : lag0
567567
index : 25
568568
mtu : 1500
@@ -582,7 +582,7 @@ out-octets : 2142
582582
Same aggregate, but in LACP mode:
583583

584584
```
585-
admin@example:/> show interfaces name lag0
585+
admin@example:/> show interface lag0
586586
name : lag0
587587
index : 24
588588
mtu : 1500
@@ -624,7 +624,7 @@ Member ports provide additional status information:
624624
Example member port status:
625625

626626
```
627-
admin@example:/> show interfaces name eth7
627+
admin@example:/> show interface eth7
628628
name : eth7
629629
index : 8
630630
mtu : 1500
@@ -755,7 +755,7 @@ The speed and duplex status for the links can be listed as shown
755755
below, assuming the link operational status is 'up'.
756756

757757
```
758-
admin@example:/> show interfaces name eth1
758+
admin@example:/> show interface eth1
759759
name : eth1
760760
index : 2
761761
mtu : 1500
@@ -769,7 +769,7 @@ ipv6 addresses :
769769
in-octets : 75581
770770
out-octets : 43130
771771
...
772-
admin@example:/> show interfaces name eth4
772+
admin@example:/> show interface eth4
773773
name : eth4
774774
index : 5
775775
mtu : 1500
@@ -827,7 +827,7 @@ require auto-negotiation to be enabled.
827827
Ethernet packet statistics[^6] can be listed as shown below.
828828

829829
```
830-
admin@example:/> show interfaces name eth1
830+
admin@example:/> show interface eth1
831831
name : eth1
832832
index : 2
833833
mtu : 1500
@@ -1525,10 +1525,10 @@ currently supported, namely `ipv4` and `ipv6`.
15251525
[^3]: For example, IPv4 groups are mapped to MAC multicast addresses by
15261526
mapping the low-order 23-bits of the IP address in the low-order 23
15271527
bits of the Ethernet address 01:00:5E:00:00:00. Meaning, more than
1528-
one IP multicast group maps to the same MAC multicast group.
1528+
one IP multicast group maps to the same MAC multicast group.
15291529
[^4]: A YANG deviation was previously used to make it possible to set
15301530
`phys-address`, but this has been replaced with the more flexible
1531-
`custom-phys-address`.
1531+
`custom-phys-address`.
15321532
[^5]: MAC bridges on Marvell Linkstreet devices are currently limited to
15331533
a single MAC database, this may be a problem if the same MAC address
15341534
appears in different MAC bridges.

doc/wifi.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Wi-Fi support is primarily tested with Realtek chipset-based adapters.
2727
## Configuration
2828

2929
Add a supported Wi-Fi network device. To verify that it has been
30-
detected, look for `wifi0` in `show interfaces`
30+
detected, look for `wifi0` in `show interface`
3131

3232
```
33-
admin@example:/> show interfaces
33+
admin@example:/> show interface
3434
INTERFACE PROTOCOL STATE DATA
3535
lo loopback UP
3636
ipv4 127.0.0.1/8 (static)
@@ -52,7 +52,7 @@ see the result read the operational datastore for interface `wifi0` or
5252
use the CLI
5353

5454
```
55-
admin@infix-00-00-00:/> show interfaces name wifi0
55+
admin@infix-00-00-00:/> show interface wifi0
5656
name : wifi0
5757
type : wifi
5858
index : 3
@@ -119,11 +119,11 @@ admin@example:/config/interface/wifi0/> leave
119119

120120
The Wi-Fi negotiation should now start immediately, provided that the
121121
SSID and pre-shared key are correct. You can verify the connection by
122-
running `show interfaces` again.
122+
running `show interface` again.
123123

124124

125125
```
126-
admin@example:/> show interfaces
126+
admin@example:/> show interface
127127
INTERFACE PROTOCOL STATE DATA
128128
lo loopback UP
129129
ipv4 127.0.0.1/8 (static)
@@ -139,14 +139,14 @@ admin@example:/>
139139

140140
## Troubleshooting Connection Issues
141141

142-
Use `show wifi scan wifi0` and `show interfaces` to verify signal strength
142+
Use `show wifi scan wifi0` and `show interface` to verify signal strength
143143
and connection status. If issues arise, try the following
144144
troubleshooting steps:
145145

146146
1. **Verify signal strength**: Check that the target network shows "good" or "excellent" signal
147147
2. **Check credentials**: Verify the preshared key in `ietf-keystore`
148148
3. **Review logs**: Check system logs with `show log` for Wi-Fi related errors
149149
4. **Regulatory compliance**: Ensure the country-code matches your location
150-
5. **Hardware detection**: Confirm the adapter appears in `show interfaces`
150+
5. **Hardware detection**: Confirm the adapter appears in `show interface`
151151

152152
If issues persist, check the system log for specific error messages that can help identify the root cause.

src/klish-plugin-infix/xml/infix.xml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -441,14 +441,12 @@
441441
</COMMAND>
442442

443443
<!-- https://www.cisco.com/c/en/us/td/docs/wireless/access_point/mob_exp/83/cmd-ref/me_cr_book/me_ports_and_interfaces_cli.html -->
444-
<COMMAND name="interfaces" help="Show interface info">
444+
<COMMAND name="interface" help="Show interface info, default an overview of all">
445445
<SWITCH name="optional" min="0" max="1">
446-
<COMMAND name="name" help="Show detailed info about NAME">
447-
<PARAM name="name" ptype="/IFACES" help="Interface." />
448-
</COMMAND>
446+
<PARAM name="ifname" ptype="/IFACES" help="Interface name" />
449447
</SWITCH>
450448
<ACTION sym="script" in="tty" out="tty" interrupt="true">
451-
show interface "$KLISH_PARAM_name" |pager
449+
show interface "$KLISH_PARAM_ifname" |pager
452450
</ACTION>
453451
</COMMAND>
454452

0 commit comments

Comments
 (0)