forked from sonic-net/SONiC
-
Notifications
You must be signed in to change notification settings - Fork 0
Command Reference
Joe LeVeque edited this page May 12, 2017
·
57 revisions
-
Default credential: admin/YourPaSsWoRd
-
Example:
user@debug:~$ ssh admin@sonic
-
show version- Displays the SONiC image and Docker image versions. You can find image version format here.
- Example:
admin@SONiC:~$ show version SONiC Software Version: SONiC.HEAD.769-147b89f Distribution: Debian 8.7 Kernel: 3.16.0-4-amd64 Build commit: 147b89f Build date: Tue Apr 25 23:17:13 UTC 2017 Built by: build@jenkins-worker-internal-1 Docker images: REPOSITORY TAG IMAGE ID SIZE docker-syncd-brcm latest e0718ff09fa9 282.8 MB docker-orchagent-brcm latest 2e66189adf3e 252.8 MB docker-dhcp-relay latest 708ffe9c382e 248.4 MB docker-database latest ce1157a4c32e 216.4 MB docker-snmp-sv2 latest dfd1ea263f76 289.9 MB docker-teamd latest b70c8c266250 250.3 MB docker-platform-monitor latest 13dd1d45c31e 273.5 MB docker-lldp-sv2 latest 5792e34980cc 254.9 MB docker-fpm latest c611a97cf5fa 256.8 MB
-
show environment- Displays platform environmentals, such as voltages, temperatures and fan speeds
- Example:
admin@sonic:~$ show environment max6620-i2c-11-29 Adapter: i2c-2-mux (chan_id 1) fan1: 15360 RPM (div = 2) fan2: 14894 RPM (div = 2) fan3: 15855 RPM (div = 2) fan4: 15855 RPM (div = 2) tmp75-i2c-11-4c Adapter: i2c-2-mux (chan_id 1) temp1: +31.6 C (high = +50.0 C, hyst = +25.0 C) tmp75-i2c-11-4d Adapter: i2c-2-mux (chan_id 1) temp1: +29.4 C (high = +50.0 C, hyst = +25.0 C) tmp75-i2c-11-4e Adapter: i2c-2-mux (chan_id 1) temp1: +27.4 C (high = +50.0 C, hyst = +25.0 C) -
show platform summary- Displays a summary of the device's hardware platform
- Example:
admin@sonic:~$ show platform summary Platform: x86_64-dell_s6000_s1220-r0 HwSKU: Force10-S6000 ASIC: broadcom -
show platform syseeprom- Decodes and displays system information stored on the EEPROM.
- Example:
admin@sonic:~$ show platform syseeprom lsTLV Name Len Value -------------------- --- ----- PPID 20 XX-XXXXXX-00000-000-0000 DPN Rev 3 XXX Service Tag 7 XXXXXXX Part Number 10 XXXXXX Part Number Rev 3 XXX Mfg Test Results 2 FF Card ID 2 0x0000 Module ID 2 0 Base MAC Address 12 FE:EC:BA:AB:CD:EF (checksum valid) -
sfputil- Decodes and displays SFP information stored on the SFP EEPROM.
- Example:
admin@sonic:~$ sfputil --port Ethernet0 --dom Ethernet0: SFP detected Connector : No separable connector Encoding : Unspecified Extended Identifier : Unknown Extended RateSelect Compliance : QSFP+ Rate Select Version 1 Identifier : QSFP+ Length Cable Assembly(m) : 1 Specification compliance : 10/40G Ethernet Compliance Code : 40GBASE-CR4 Fibre Channel Speed : 1200 Mbytes/Sec Fibre Channel link length/Transmitter Technology : Electrical inter-enclosure (EL) Fibre Channel transmission media : Twin Axial Pair (TW) Vendor Date Code(YYYY-MM-DD Lot) : 2015-10-31 Vendor Name : XXXXX Vendor OUI : XX-XX-XX Vendor PN : 1111111111 Vendor Rev : Vendor SN : 111111111 ChannelMonitorValues : RX1Power : -infdBm RX2Power : -infdBm RX3Power : -infdBm RX4Power : -infdBm TX1Bias : 0.0000mA TX2Bias : 0.0000mA TX3Bias : 0.0000mA TX4Bias : 0.0000mA ModuleMonitorValues : Temperature : 1.1111C Vcc : 0.0000Volts
-
show arp- Displays the entire ARP table
- Example:
admin@sonic:~$ show arp Address HWtype HWaddress Flags Mask Iface 192.168.1.183 ether 88:5a:92:fb:bf:41 C Ethernet44 192.168.1.175 ether 88:5a:92:fc:95:81 C Ethernet28 192.168.1.181 ether e4:c7:22:c1:07:7c C Ethernet40 192.168.1.179 ether 88:5a:92:de:a8:bc C Ethernet36 192.168.1.118 ether 00:1c:73:3c:de:43 C Ethernet64 192.168.1.11 ether 00:1c:73:3c:e1:38 C Ethernet88 192.168.1.161 ether 24:e9:b3:71:3a:01 C Ethernet0 192.168.1.189 ether 24:e9:b3:9d:57:41 C Ethernet56 192.168.1.187 ether 74:26:ac:8b:8f:c1 C Ethernet52 192.168.1.165 ether 88:5a:92:de:a0:7c C Ethernet8- Optionally, you can specify an IP address in order to display only that particular entry
- Example:
admin@sonic:~$ show arp 192.168.1.181 Address HWtype HWaddress Flags Mask Iface 192.168.1.181 ether e4:c7:22:c1:07:7c C Ethernet40
-
brctl- This utility is used for Ethernet bridge administration. (Ref: http://linuxcommand.org/man_pages/brctl8.html)
- Example:
admin@sonic:~$ brctl show bridge name bridge id STP enabled interfaces Vlan1000 8000.ecf4bbfe880a no Ethernet12 Ethernet16 Ethernet20 Ethernet24 Ethernet28 Ethernet32 Ethernet36 Ethernet4 Ethernet40 Ethernet44 Ethernet48 Ethernet52 Ethernet56 Ethernet60 Ethernet64 Ethernet68 Ethernet72 Ethernet76 Ethernet8 Ethernet80 Ethernet84 Ethernet88 Ethernet92 Ethernet96
-
show interfaces portchannel- Displays information regarding port-channel interfaces
- Example:
admin@sonic:~$ show interfaces portchannel Flags: A - active, I - inactive, Up - up, Dw - Down, N/A - not available, S - selected, D - deselected No. Team Dev Protocol Ports ----- ------------- ----------- --------------------------- 24 PortChannel24 LACP(A)(Up) Ethernet28(S) Ethernet24(S) 48 PortChannel48 LACP(A)(Up) Ethernet52(S) Ethernet48(S) 16 PortChannel16 LACP(A)(Up) Ethernet20(S) Ethernet16(S) 32 PortChannel32 LACP(A)(Up) Ethernet32(S) Ethernet36(S) 56 PortChannel56 LACP(A)(Up) Ethernet60(S) Ethernet56(S) 40 PortChannel40 LACP(A)(Up) Ethernet44(S) Ethernet40(S) 0 PortChannel0 LACP(A)(Up) Ethernet0(S) Ethernet4(S) 8 PortChannel8 LACP(A)(Up) Ethernet8(S) Ethernet12(S)
-
show lldp table- Displays a summary of all LLDP neighbors in a pretty one-shot command.
- Example:
admin@sonic:~$ show lldp table Capability codes: (R) Router, (B) Bridge, (O) Other LocalPort RemoteDevice RemotePortID Capability RemotePortDescr ----------- ---------------------- -------------- ------------ ---------------------------------------- Ethernet0 SONIC01MS Ethernet1 BR Ethernet0 Ethernet4 SONIC02MS Ethernet1 BR Ethernet4 Ethernet8 SONIC03MS Ethernet1 BR Ethernet8 Ethernet12 SONIC04MS Ethernet1 BR Ethernet12 -------------------------------------------------- Total entries displayed: 4 -
show lldp neighbors- Displays more detail about all LLDP neighbors
- Example:
admin@sonic:~$ show lldp neighbors ------------------------------------------------------------------------------- LLDP neighbors: ------------------------------------------------------------------------------- Interface: Ethernet96, via: LLDP, RID: 36, Time: 12 days, 00:30:13 Chassis: ChassisID: mac 00:1c:73:3c:e1:36 SysName: SONIC01SPINE SysDescr: Arista Networks EOS version 4.16.6M running on an Arista Networks DCS-7508 TTL: 120 MgmtIP: 192.168.1.139 Capability: Bridge, on Capability: Router, on Port: PortID: ifname Ethernet4/24/1 PortDescr: SONIC01LEAF:Ethernet1/25 MFS: 9236 ------------------------------------------------------------------------------- Interface: Ethernet72, via: LLDP, RID: 42, Time: 10 days, 13:41:27 Chassis: ChassisID: mac 00:1c:73:3c:e1:51 SysName: SONIC02SPINE SysDescr: Arista Networks EOS version 4.16.6M running on an Arista Networks DCS-7508 TTL: 120 MgmtIP: 192.168.1.133 Capability: Bridge, on Capability: Router, on Port: PortID: ifname Ethernet4/24/1 PortDescr: SONIC01LEAF:Ethernet1/19 MFS: 9236 -------------------------------------------------------------------------------- Optionally, you can specify an interface name in order to display only that particular interface
- Example:
admin@sonic:~$ show lldp neighbors Ethernet72
-
show interfaces summary- Displays information regarding the network interfaces
- Example:
admin@sonic:~$ show interfaces summary Ethernet0 Link encap:Ethernet HWaddr ec:f4:bb:fe:88:0a inet addr:192.168.1.100 Bcast:192.168.1.31 Mask:255.255.255.224 inet6 addr: fe80::eef4:bbff:fefe:880a/64 Scope:Link UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:0 errors:0 dropped:0 overruns:0 frame:0 TX packets:1991 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:1000 RX bytes:0 (0.0 B) TX bytes:489338 (477.8 KiB) Ethernet4 Link encap:Ethernet HWaddr ec:f4:bb:fe:88:0a inet addr:192.168.1.102 Bcast:192.168.1.31 Mask:255.255.255.224 inet6 addr: fe80::eef4:bbff:fefe:880a/64 Scope:Link UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:0 errors:0 dropped:0 overruns:0 frame:0 TX packets:1991 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:1000 RX bytes:0 (0.0 B) TX bytes:489338 (477.8 KiB) Ethernet8 Link encap:Ethernet HWaddr ec:f4:bb:fe:88:0a inet addr:192.168.1.104 Bcast:192.168.1.31 Mask:255.255.255.224 inet6 addr: fe80::eef4:bbff:fefe:880a/64 Scope:Link UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:0 errors:0 dropped:0 overruns:0 frame:0 TX packets:1991 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:1000 RX bytes:0 (0.0 B) TX bytes:493312 (481.7 KiB) Ethernet12 Link encap:Ethernet HWaddr ec:f4:bb:fe:88:0a inet addr:192.168.1.106 Bcast:192.168.1.31 Mask:255.255.255.224 inet6 addr: fe80::eef4:bbff:fefe:880a/64 Scope:Link UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:0 errors:0 dropped:0 overruns:0 frame:0 TX packets:1991 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:1000 RX bytes:0 (0.0 B) TX bytes:493312 (481.7 KiB)- Optionally, you can specify an interface name in order to display only that particular interface
- Example:
admin@sonic:~$ show interfaces summary Ethernet8 Ethernet8 Link encap:Ethernet HWaddr ec:f4:bb:fe:88:0a inet addr:192.168.1.104 Bcast:192.168.1.31 Mask:255.255.255.224 inet6 addr: fe80::eef4:bbff:fefe:880a/64 Scope:Link UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:0 errors:0 dropped:0 overruns:0 frame:0 TX packets:1991 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:1000 RX bytes:0 (0.0 B) TX bytes:493312 (481.7 KiB) -
show interfaces counters- Displays packet counters for all interfaces over a period of 30 seconds
- NOTE: This command takes 30 seconds to execute
- Example:
admin@sonic:~$ show interfaces counters Iface RX_OK RX_RATE RX_UTIL RX_ERR RX_DRP RX_OVR TX_OK TX_RATE TX_UTIL TX_ERR TX_DRP TX_OVR ----------- --------------- ----------- --------- -------- -------- -------- --------------- ----------- --------- -------- -------- -------- Ethernet0 471,729,839,997 653.87 MB/s 12.77% 0 18,682 0 409,682,385,925 556.84 MB/s 10.88% 0 0 0 Ethernet4 453,838,006,636 632.97 MB/s 12.36% 0 1,636 0 388,299,875,056 529.34 MB/s 10.34% 0 0 0 Ethernet8 549,034,764,539 761.15 MB/s 14.87% 0 18,274 0 457,603,227,659 615.20 MB/s 12.02% 0 0 0 Ethernet12 458,052,204,029 636.84 MB/s 12.44% 0 17,614 0 388,341,776,615 527.37 MB/s 10.30% 0 0 0 Ethernet16 16,679,692,972 13.83 MB/s 0.27% 0 17,605 0 18,206,586,265 17.51 MB/s 0.34% 0 0 0 Ethernet20 47,983,339,172 35.89 MB/s 0.70% 0 2,174 0 58,986,354,359 51.83 MB/s 1.01% 0 0 0 Ethernet24 33,543,533,441 36.59 MB/s 0.71% 0 1,613 0 43,066,076,370 49.92 MB/s 0.97% 0 0 0 - Displays packet counters for all interfaces over a period of 30 seconds
-
show route- Displays the IP routing table
- Example:
admin@sonic:~$ show route Codes: K - kernel route, C - connected, S - static, R - RIP, O - OSPF, I - IS-IS, B - BGP, P - PIM, A - Babel, > - selected route, * - FIB route C>* 10.0.0.0/31 is directly connected, Ethernet0 C>* 10.0.0.2/31 is directly connected, Ethernet4 C>* 10.0.0.4/31 is directly connected, Ethernet8 C>* 10.0.0.6/31 is directly connected, Ethernet12 C>* 10.0.0.8/31 is directly connected, Ethernet16 C>* 10.0.0.10/31 is directly connected, Ethernet20 C>* 10.0.0.12/31 is directly connected, Ethernet24 C>* 10.0.0.14/31 is directly connected, Ethernet28 C>* 10.0.0.16/31 is directly connected, Ethernet32 C>* 10.0.0.18/31 is directly connected, Ethernet36 C>* 10.0.0.20/31 is directly connected, Ethernet40 C>* 10.0.0.22/31 is directly connected, Ethernet44 C>* 10.0.0.24/31 is directly connected, Ethernet48 C>* 10.0.0.26/31 is directly connected, Ethernet52 C>* 10.0.0.28/31 is directly connected, Ethernet56 C>* 10.0.0.30/31 is directly connected, Ethernet60 C>* 10.0.0.32/31 is directly connected, Ethernet64 -
Optionally, you can specify an IP address in order to display only routes to that particular IP address
-
Example:
admin@sonic:~$ show route 10.0.0.12
-
show bgp summary- Displays a summary of BGP sessions
- Example:
admin@sonic:~$ show bgp summary BGP router identifier 1.2.3.4, local AS number 65061 RIB entries 6124, using 670 KiB of memory Peers 16, using 143 KiB of memory Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd 192.168.1.161 4 65501 88698 102781 0 0 0 08w5d14h 2 192.168.1.163 4 65502 88698 102780 0 0 0 08w5d14h 2 192.168.1.165 4 65503 88699 102781 0 0 0 08w5d14h 2 192.168.1.167 4 65504 88698 102780 0 0 0 08w5d14h 2 192.168.1.169 4 65505 88698 102781 0 0 0 08w5d14h 2 192.168.1.171 4 65506 88698 102780 0 0 0 08w5d14h 2 192.168.1.173 4 65507 88698 102780 0 0 0 08w5d14h 2 192.168.1.175 4 65508 88698 102780 0 0 0 08w5d14h 2 192.168.1.177 4 65509 88698 102781 0 0 0 08w5d14h 2 192.168.1.179 4 65510 88698 102780 0 0 0 08w5d14h 2 192.168.1.181 4 65511 88698 102780 0 0 0 08w5d14h 2 192.168.1.183 4 65512 88698 102780 0 0 0 08w5d14h 2 192.168.1.185 4 65513 88698 102781 0 0 0 08w5d14h 2 192.168.1.187 4 65514 88698 102781 0 0 0 08w5d14h 2 192.168.1.189 4 65515 88698 102781 0 0 0 08w5d14h 2 192.168.1.191 4 65516 88698 102781 0 0 0 08w5d14h 2 Total number of neighbors 16 -
show bgp neighbor- Displays details of BGP neighbors
- Example:
admin@sonic:~$ show bgp neighbor BGP neighbor is 192.168.1.161, remote AS 65501, local AS 65061, external link Description: ARISTA01T0 BGP version 4, remote router ID 1.2.3.4 BGP state = Established, up for 08w5d14h Last read 00:00:46, hold time is 180, keepalive interval is 60 seconds Neighbor capabilities: 4 Byte AS: advertised and received Dynamic: received Route refresh: advertised and received(old & new) Address family IPv4 Unicast: advertised and received Graceful Restart Capabilty: advertised and received Remote Restart timer is 120 seconds Address families by peer: IPv4 Unicast(not preserved) Graceful restart informations: End-of-RIB send: IPv4 Unicast End-of-RIB received: IPv4 Unicast Message statistics: Inq depth is 0 Outq depth is 0 Sent Rcvd Opens: 1 1 Notifications: 0 0 Updates: 14066 3 Keepalives: 88718 88698 Route Refresh: 0 0 Capability: 0 0 Total: 102785 88702 Minimum time between advertisement runs is 30 seconds For address family: IPv4 Unicast Community attribute sent to this neighbor(both) 2 accepted prefixes Connections established 1; dropped 0 Last reset never Local host: 192.168.1.160, Local port: 32961 Foreign host: 192.168.1.161, Foreign port: 179 Nexthop: 192.168.1.160 Nexthop global: fe80::f60f:1bff:fe89:bc00 Nexthop local: :: BGP connection: non shared network Read thread: on Write thread: off- Optionally, you can specify an IP address in order to display only that particular neighbor
- Example:
admin@sonic:~$ show bgp neighbor 192.168.1.161
-
show ntp- Displays a list of NTP peers known to the server as well as a summary of their state
- Example:
admin@sonic:~$ show ntp remote refid st t when poll reach delay offset jitter ============================================================================== *ns2.example.com 10.193.2.20 2 u 936 1024 377 31.234 3.353 3.096
-
show processes cpu- Displays the current CPU usage by process
- Example:
admin@SONiC:~$ show processes cpu top - 23:50:08 up 1:18, 1 user, load average: 0.25, 0.29, 0.25 Tasks: 161 total, 1 running, 160 sleeping, 0 stopped, 0 zombie %Cpu(s): 3.8 us, 1.0 sy, 0.0 ni, 95.1 id, 0.1 wa, 0.0 hi, 0.0 si, 0.0 st KiB Mem: 8181216 total, 1161060 used, 7020156 free, 105656 buffers KiB Swap: 0 total, 0 used, 0 free. 557560 cached Mem PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND 2047 root 20 0 683772 109288 39652 S 23.8 1.3 7:44.79 syncd 1351 root 20 0 43360 5616 2844 S 11.9 0.1 1:41.56 redis-server 10093 root 20 0 21944 2476 2088 R 5.9 0.0 0:00.03 top 1 root 20 0 28992 5508 3236 S 0.0 0.1 0:06.42 systemd 2 root 20 0 0 0 0 S 0.0 0.0 0:00.00 kthreadd 3 root 20 0 0 0 0 S 0.0 0.0 0:00.56 ksoftirqd/0 5 root 0 -20 0 0 0 S 0.0 0.0 0:00.00 kworker/0:0H
-
show logging- Displays the all currently stored log messages
- Example:
admin@SONiC:~$ show logging- Optionally, you can specify a process name in order to display only log messages mentioning that process
- Example:
admin@SONiC:~$ show logging sensord- Optionally, you can specify a number of lines to display using the
-l' or--lines` option. Only the most recent N lines will be displayed. Also note that this option can be combined with a process name. - Examples:
admin@SONiC:~$ show logging --lines 50admin@SONiC:~$ show logging sensord --lines 50- Optionally, you can follow the log live as entries are written to it by specifying the
-for--followflag - Example:
admin@SONiC:~$ show logging --follow
-
show startupconfiguration bgp- Displays the startup configuration for BGP
- Example:
admin@sonic:~$ show startupconfiguration bgp
-
show runningconfiguration bgp- Displays the current running configuration for BGP
- Example:
admin@sonic:~$ show runningconfiguration bgp -
show runningconfiguration interfaces- Displays the current running configuration for the interfaces
- Example:
admin@sonic:~$ show runningconfiguration interfaces -
show runningconfiguration ntp- Displays the current running configuration for NTP
- Example:
admin@sonic:~$ show runningconfiguration ntp -
show runningconfiguration snmp- Displays the current running configuration for SNMP
- Example:
admin@sonic:~$ show runningconfiguration snmp
-
show techsupport- Gathers pertinent information about the state of the device and compresses it into an archive file. This archive file can be sent to the SONiC development team for examination.
- Example:
admin@sonic:~$ show techsupport
-
sonic_installer install- Takes a path to an installable SONiC image or URL and installs the image.
- Example:
admin@sonic:~$ sonic_installer install https://sonic-jenkins.westus.cloudapp.azure.com/job/xxxx/job/buildimage-xxxx-all/xxx/artifact/target/sonic-xxxx.bin New image will be installed, continue? [y/N]: y Downloading image... ...100%, 480 MB, 3357 KB/s, 146 seconds passed Command: /tmp/sonic_image Verifying image checksum ... OK. Preparing image archive ... OK. ONIE Installer: platform: XXXX onie_platform: Installing SONiC in SONiC Installing SONiC to /host/image-xxxx Directory /host/image-xxxx/ already exists. Cleaning up... Archive: fs.zip creating: /host/image-xxxx/boot/ inflating: /host/image-xxxx/boot/vmlinuz-3.16.0-4-amd64 inflating: /host/image-xxxx/boot/config-3.16.0-4-amd64 inflating: /host/image-xxxx/boot/System.map-3.16.0-4-amd64 inflating: /host/image-xxxx/boot/initrd.img-3.16.0-4-amd64 creating: /host/image-xxxx/platform/ extracting: /host/image-xxxx/platform/firsttime inflating: /host/image-xxxx/fs.squashfs inflating: /host/image-xxxx/dockerfs.tar.gz Log file system already exists. Size: 4096MB Installed SONiC base image SONiC-OS successfully Command: cp /etc/sonic/minigraph.xml /host/ Command: grub-set-default --boot-directory=/host 0 Done -
sonic_installer list- Displays information about currently installed images. It displays a list of installed images, currently running image and image set to be loaded after reboot.
- Example:
admin@sonic:~$ sonic_installer list Current: SONiC-OS-HEAD.XXXX Next: SONiC-OS-HEAD.XXXX Available: SONiC-OS-HEAD.XXXX SONiC-OS-HEAD.YYYY -
sonic_installer set_default- Changes which image will be loaded by default after all subsequent reboots
- Example:
admin@sonic:~$ sonic_installer set_default SONiC-OS-HEAD.XXXX -
sonic_installer set_next_boot- Changes which image will be loaded after the next reboot only
- Example:
admin@sonic:~$ sonic_installer set_next_boot SONiC-OS-HEAD.XXXX -
sonic_installer remove- Removes an unused SONiC image from the disk. Note that it's not allowed to remove currently running image.
- Example:
admin@sonic:~$ sonic_installer remove SONiC-OS-HEAD.YYYY Image will be removed, continue? [y/N]: y Updating GRUB... Done Removing image root filesystem... Done Command: grub-set-default --boot-directory=/host 0 Image removed
- Home
- FAQ
- For Users
- For Developers
- Features and Roadmap
- Report Issues
- Presentations
- Community Meetings
- Join Us