Command-Reference.md

# SONiC Command Line Interface Guide

## Table of Contents

* [Document History](#document-history)
* [Introduction](#introduction)
* [Basic Tasks](#basic-tasks)
  * [SSH Login](#ssh-login)
  * [Configuring Management Interface](#configuring-management-interface)
* [Getting Help](#getting-help)
  * [Help for Config Commands](#help-for-config-commands)
  * [Help for Show Commands](#help-for-show-commands)
* [Basic Show Commands](#basic-show-commands)
  * [Show Versions](#show-versions)
  * [Show System Status](#show-system-status)
  * [Show Hardware Platform](#show-hardware-platform)
    * [Transceivers](#transceivers)
* [AAA & TACACS+](#aaa--tacacs)
  * [AAA](#aaa)
    * [AAA show commands](#aaa-show-commands)
    * [AAA config commands](#aaa-config-commands)
  * [TACACS+](#tacacs)
    * [TACACS+ show commands](#tacacs-show-commands)
    * [TACACS+ config commands](#tacacs-config-commands)
* [ACL](#acl)
  * [ACL show commands](#acl-show-commands)
  * [ACL config commands](#acl-config-commands)
* [ARP & NDP](#arp--ndp)
  * [ARP show commands](#arp-show-commands)
  * [NDP show commands](#ndp-show-commands)
* [BGP](#bgp)
  * [BGP show commands](#bgp-show-commands)
  * [BGP config commands](#bgp-config-commands)
* [Console](#console)
  * [Console show commands](#console-show-commands)
  * [Console config commands](#console-config-commands)
  * [Console connect commands](#console-connect-commands)
  * [Console clear commands](#console-clear-commands)
* [DHCP Relay](#dhcp-relay)
  * [DHCP Relay config commands](#dhcp-relay-config-commands)
* [Drop Counters](#drop-counters)
  * [Drop Counter show commands](#drop-counters-show-commands)
  * [Drop Counter config commands](#drop-counters-config-commands)
  * [Drop Counter clear commands](#drop-counters-clear-commands)
* [Dynamic Buffer Management](#dynamic-buffer-management)
  * [Configuration commands](#configuration-commands)
  * [Show commands](#show-commands)
* [ECN](#ecn)
  * [ECN show commands](#ecn-show-commands)
  * [ECN config commands](#ecn-config-commands)
* [Feature](#feature)
  * [Feature show commands](#feature-show-commands)
  * [Feature config commands](#feature-config-commands)
* [Gearbox](#gearbox)
  * [Gearbox show commands](#gearbox-show-commands)
* [Interfaces](#interfaces)
  * [Interface Show Commands](#interface-show-commands)
  * [Interface Config Commands](#interface-config-commands)
* [Interface Naming Mode](#interface-naming-mode)
  * [Interface naming mode show commands](#interface-naming-mode-show-commands)
  * [Interface naming mode config commands](#interface-naming-mode-config-commands)
 * [Interface Vrf binding](#interface-vrf-binding)
      * [Interface vrf bind & unbind config commands](#interface-vrf-bind-&-unbind-config-commands)
      * [Interface vrf binding show commands](#interface-vrf-binding-show-commands)
* [IP / IPv6](#ip--ipv6)
  * [IP show commands](#ip-show-commands)
  * [IPv6 show commands](#ipv6-show-commands)
* [Kubernetes](#Kubernetes)
  * [Kubernetes show commands](#Kubernetes-show-commands)
  * [Kubernetes config commands](#Kubernetes-config-commands)
* [LLDP](#lldp)
  * [LLDP show commands](#lldp-show-commands)
* [Loading, Reloading And Saving Configuration](#loading-reloading-and-saving-configuration)
  * [Loading configuration from JSON file](#loading-configuration-from-json-file)
  * [Loading configuration from minigraph (XML) file](#loading-configuration-from-minigraph-xml-file)
  * [Reloading Configuration](#reloading-configuration)
  * [Loading Management Configuration](#loading-management-configuration)
  * [Saving Configuration to a File for Persistence](saving-configuration-to-a-file-for-persistence)
 * [Loopback Interfaces](#loopback-interfaces)
    * [Loopback config commands](#loopback-config-commands)
* [VRF Configuration](#vrf-configuration)
    * [VRF show commands](#vrf-show-commands)
    * [VRF config commands](#vrf-config-commands)
* [Management VRF](#Management-VRF)
  * [Management VRF Show commands](#management-vrf-show-commands)
  * [Management VRF Config commands](#management-vrf-config-commands)
* [Mirroring](#mirroring)
  * [Mirroring Show commands](#mirroring-show-commands)
  * [Mirroring Config commands](#mirroring-config-commands)
* [Muxcable](#muxcable)
  * [Muxcable Show commands](#muxcable-show-commands)
  * [Muxcable Config commands](#muxcable-config-commands)
* [NAT](#nat)
  * [NAT Show commands](#nat-show-commands)
  * [NAT Config commands](#nat-config-commands)
  * [NAT Clear commands](#nat-clear-commands)
* [NTP](#ntp)
  * [NTP show commands](#ntp-show-commands)
  * [NTP config commands](#ntp-config-commands)
* [PFC Watchdog Commands](#pfc-watchdog-commands)
* [Platform Component Firmware](#platform-component-firmware)
  * [Platform Component Firmware show commands](#platform-component-firmware-show-commands)
  * [Platform Component Firmware config commands](#platform-component-firmware-config-commands)
  * [Platform Component Firmware vendor specific behaviour](#platform-component-firmware-vendor-specific-behaviour)
* [Platform Specific Commands](#platform-specific-commands)
* [PortChannels](#portchannels)
  * [PortChannel Show commands](#portchannel-show-commands)
  * [PortChannel Config commands](#portchannel-config-commands)
* [QoS](#qos)
  * [QoS Show commands](#qos-show-commands)
    * [PFC](#pfc)
    * [Queue And Priority-Group](#queue-and-priority-group)
    * [Buffer Pool](#buffer-pool)
  * [QoS config commands](#qos-config-commands)
* [sFlow](#sflow)
  * [sFlow Show commands](#sflow-show-commands)
  * [sFlow Config commands](#sflow-config-commands)
* [Startup & Running Configuration](#startup--running-configuration)
  * [Startup Configuration](#startup-configuration)
  * [Running Configuration](#running-configuration)
* [Syslog](#syslog)
  * [Syslog config commands](#syslog-config-commands)
* [System State](#system-state)
  * [Processes](#processes)
  * [Services & Memory](#services--memory)
* [System-Health](#System-Health)
* [VLAN & FDB](#vlan--fdb)
  * [VLAN](#vlan)
    * [VLAN show commands](#vlan-show-commands)
    * [VLAN Config commands](#vlan-config-commands)
  * [FDB](#fdb)
    * [FDB show commands](#fdb-show-commands)
* [VxLAN & Vnet](#vxlan--vnet)
  * [VxLAN](#vxlan)
    * [VxLAN show commands](#vxlan-show-commands)
  * [Vnet](#vnet)
    * [Vnet show commands](#vnet-show-commands)
* [Warm Reboot](#warm-reboot)
* [Warm Restart](#warm-restart)
  * [Warm Restart show commands](#warm-restart-show-commands)
  * [Warm Restart Config commands](#warm-restart-config-commands)
* [Watermark](#watermark)
  * [Watermark Show commands](#watermark-show-commands)
  * [Watermark Config commands](#watermark-config-commands)
* [Software Installation and Management](#software-installation-and-management)
  * [SONiC Package Manager](#sonic-package-manager)
  * [SONiC Installer](#sonic-installer)
* [Troubleshooting Commands](#troubleshooting-commands)
* [Routing Stack](#routing-stack)
* [Quagga BGP Show Commands](#Quagga-BGP-Show-Commands)
* [ZTP Configuration And Show Commands](#ztp-configuration-and-show-commands)
  * [ ZTP show commands](#ztp-show-commands)
  * [ZTP configuration commands](#ztp-configuration-commands)

## Document History

| Version | Modification Date | Details |
| --- | --- | --- |
| v5 | Nov-05-2020 | Add document for console commands |
| v4 | Oct-17-2019 | Unify usage statements and other formatting; Replace tabs with spaces; Modify heading sizes; Fix spelling, grammar and other errors; Fix organization of new commands |
| v3 | Jun-26-2019 | Update based on 201904 (build#19) release, "config interface" command changes related to interfacename order, FRR/Quagga show command changes, platform specific changes, ACL show changes and few formatting changes |
| v2 | Apr-22-2019 | CLI Guide for SONiC 201811 version (build#32) with complete "config" command set |
| v1 | Mar-23-2019 | Initial version of CLI Guide with minimal command set |

## Introduction
SONiC is an open source network operating system based on Linux that runs on switches from multiple vendors and ASICs. SONiC offers a full-suite of network functionality, like BGP and RDMA, that has been production-hardened in the data centers of some of the largest cloud-service providers. It offers teams the flexibility to create the network solutions they need while leveraging the collective strength of a large ecosystem and community.

SONiC software shall be loaded in these [supported devices](https://github.com/Azure/SONiC/wiki/Supported-Devices-and-Platforms) and this CLI guide shall be used to configure the devices as well as to display the configuration, state and status.

Follow the [Quick Start Guide](https://github.com/Azure/SONiC/wiki/Quick-Start) to boot the device in ONIE mode, install the SONiC software using the steps specified in the document and login to the device using the default username and password.

After logging into the device, SONiC software can be configured in following three methods.
  1. Command Line Interface (CLI)
  2. [config_db.json](https://github.com/Azure/SONiC/wiki/Configuration)
  3. [minigraph.xml](https://github.com/Azure/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))

This document explains the first method and gives the complete list of commands that are supported in SONiC 201904 version (build#19).
All the configuration commands need root privileges to execute them. Note that show commands can be executed by all users without the root privileges.
Root privileges can be obtained either by using "sudo" keyword in front of all config commands, or by going to root prompt using "sudo -i".
Note that all commands are case sensitive.

- Example:
  ```
  admin@sonic:~$ sudo config aaa authentication login tacacs+

  OR

  admin@sonic:~$ sudo -i
  root@sonic:~#  config aaa authentication login tacacs+
  ```

Note that the command list given in this document is just a subset of all possible configurations in SONiC.
Please follow config_db.json based configuration for the complete list of configuration options.

**Scope of this Document**

It is assumed that all configuration commands start with the keyword “config” as prefix.
Any other scripts/utilities/commands  that need user configuration control are wrapped as sub-commands under the “config” command.
The direct scripts/utilities/commands (examples given below) that are not wrapped under the "config" command are not in the scope of this document.
  1. acl_loader – This script is already wrapped inside “config acl” command; i.e. any ACL configuration that user is allowed to do is already part of “config acl” command; users are not expected to use the acl_loader script directly and hence this document need not explain the “acl_loader” script.
  2. crm – this command is not explained in this document.
  3. sonic-clear, sfputil, etc., This document does not explain these scripts also.

## Basic Tasks

This section covers the basic configurations related to the following:
  1. [SSH login](#SSH-Login)
  2. [Configuring the Management Interface](#Configuring-Management-Interface)

### SSH Login

All SONiC devices support both the serial console based login and the SSH based login by default.
The default credential (if not modified at image build time) for login is `admin/YourPaSsWoRd`.
In case of SSH login, users can login to the management interface (eth0) IP address after configuring the same using serial console.
Refer the following section for configuring the IP address for management interface.

- Example:
  ```
  At Console:
  Debian GNU/Linux 9 sonic ttyS1

  sonic login: admin
  Password: YourPaSsWoRd

  SSH from any remote server to sonic can be done by connecting to SONiC IP
  user@debug:~$ ssh admin@sonic_ip_address(or SONIC DNS Name)
  admin@sonic's password:
  ```

By default, login takes the user to the default prompt from which all the show commands can be executed.

Go Back To [Beginning of the document](#) or [Beginning of this section](#basic-tasks)

### Configuring Management Interface

The management interface (eth0) in SONiC is configured (by default) to use DHCP client to get the IP address from the DHCP server. Connect the management interface to the same network in which your DHCP server is connected and get the IP address from DHCP server.
The IP address received from DHCP server can be verified using the `/sbin/ifconfig eth0` Linux command.

SONiC provides a CLI to configure the static IP for the management interface. There are few ways by which a static IP address can be configured for the management interface.
  1. Use the `config interface ip add eth0` command.
  - Example:
  ```
  admin@sonic:~$ sudo config interface ip add eth0 20.11.12.13/24 20.11.12.254
  ```
  2. Use config_db.json and configure the MGMT_INTERFACE key with the appropriate values. Refer [here](https://github.com/Azure/SONiC/wiki/Configuration#Management-Interface)
  3. Use minigraph.xml and configure "ManagementIPInterfaces" tag inside "DpgDesc" tag as given at the [page](https://github.com/Azure/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))

Once the IP address is configured, the same can be verified using either `show management_interface address` command or the `/sbin/ifconfig eth0` linux command.
Users can SSH login to this management interface IP address from their management network.

- Example:
 ```
 admin@sonic:~$ /sbin/ifconfig eth0
 eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
       inet 10.11.11.13  netmask 255.255.255.0  broadcast 10.11.12.255
 ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#basic-tasks)

## Getting Help

Subsections:
  1. [Help for Config Commands](#Config-Help)
  2. [Help for Show Commands](#Show-Help)
  3. [Show Versions](#Show-Versions)
  4. [Show System Status](#Show-System-Status)
  5. [Show Hardware Platform](#Show-Hardware-Platform)

### Help for Config Commands

All commands have in-built help that aids the user in understanding the command as well as the possible sub-commands and options.
"--help" can be used at any level of the command; i.e. it can be used at the command level, or sub-command level or at argument level. The in-built help will display the available possibilities corresponding to that particular command/sub-command.

**config --help**

This command lists all the possible configuration commands at the top level.

- Usage:
  ```
  config --help
  ```

- Example:
  ```
  admin@sonic:~$ config --help
  Usage: config [OPTIONS] COMMAND [ARGS]
  SONiC command line - 'config' command

  Options:
    --help  Show this message and exit.

  Commands:
    aaa                    AAA command line
    acl                    ACL-related configuration tasks
    bgp                    BGP-related configuration tasks
    ecn                    ECN-related configuration tasks
    feature                Modify configuration of features
    hostname               Change device hostname without impacting traffic
    interface              Interface-related configuration tasks
    interface_naming_mode  Modify interface naming mode for interacting...
    kubernetes             Kubernetes server related configuration
    load                   Import a previous saved config DB dump file.
    load_mgmt_config       Reconfigure hostname and mgmt interface based...
    load_minigraph         Reconfigure based on minigraph.
    loopback               Loopback-related configuration tasks.
    mirror_session
    nat                    NAT-related configuration tasks
    platform               Platform-related configuration tasks
    portchannel
    qos
    reload                 Clear current configuration and import a...
    route                  route-related configuration tasks
    save                   Export current config DB to a file on disk.
    tacacs                 TACACS+ server configuration
    vlan                   VLAN-related configuration tasks
    vrf                    VRF-related configuration tasks
    warm_restart           warm_restart-related configuration tasks
    watermark              Configure watermark
  ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#getting-help)

### Help For Show Commands

**show help**

This command displays the full list of show commands available in the software; the output of each of those show commands can be used to analyze, debug or troubleshoot the network node.

- Usage:
  ```
  show (-?|-h|--help)
  ```

- Example:
  ```
  admin@sonic:~$ show -?
  Usage: show [OPTIONS] COMMAND [ARGS]...
    SONiC command line - 'show' command

  Options:
    -?, -h, --help  Show this message and exit.

  Commands:
    aaa                   Show AAA configuration
    acl                   Show ACL related information
    arp                   Show IP ARP table
    buffer_pool           Show details of the Buffer-pools
    clock                 Show date and time
    ecn                   Show ECN configuration
    environment           Show environmentals (voltages, fans, temps)
    feature               Show feature status
    interfaces            Show details of the network interfaces
    ip                    Show IP (IPv4) commands
    ipv6                  Show IPv6 commands
    kubernetes            Show kubernetes commands
    line                  Show all /dev/ttyUSB lines and their info
    lldp                  LLDP (Link Layer Discovery Protocol)...
    logging               Show system log
    mac                   Show MAC (FDB) entries
    mirror_session        Show existing everflow sessions
    mmu                   Show mmu configuration
    muxcable              Show muxcable information
    nat                   Show details of the nat
    ndp                   Show IPv6 Neighbour table
    ntp                   Show NTP information
    pfc                   Show details of the priority-flow-control...
    platform              Show platform-specific hardware info
    priority-group        Show details of the PGs
    processes             Display process information
    queue                 Show details of the queues
    reboot-cause          Show cause of most recent reboot
    route-map             show route-map
    runningconfiguration  Show current running configuration...
    services              Show all daemon services
    startupconfiguration  Show startup configuration information
    system-memory         Show memory information
    tacacs                Show TACACS+ configuration
    techsupport           Gather information for troubleshooting
    uptime                Show system uptime
    users                 Show users
    version               Show version information
    vlan                  Show VLAN information
    vrf                   Show vrf config
    warm_restart          Show warm restart configuration and state
    watermark             Show details of watermark
  ```

The same syntax applies to all subgroups of `show` which themselves contain subcommands, and subcommands which accept options/arguments.

- Example:
  ```
  admin@sonic:~$ show interfaces -?

    Show details of the network interfaces

  Options:
    -?, -h, --help  Show this message and exit.

  Commands:
    counters     Show interface counters
    description  Show interface status, protocol and...
    naming_mode  Show interface naming_mode status
    neighbor     Show neighbor related information
    portchannel  Show PortChannel information
    status       Show Interface status information
    transceiver  Show SFP Transceiver information
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#getting-help)

## Basic Show Commands

Subsections:
  1. [Show Versions](#Show-Versions)
  2. [Show System Status](#Show-System-Status)
  3. [Show Hardware Platform](#Show-Hardware-Platform)

### Show Versions

**show version**

This command displays software component versions of the currently running SONiC image. This includes the SONiC image version as well as Docker image versions.
This command displays relevant information as the SONiC and Linux kernel version being utilized, as well as the ID of the commit used to build the SONiC image. The second section of the output displays the various docker images and their associated IDs.

- Usage:
  ```
  show version
  ```

- Example:
  ```
  admin@sonic:~$ show version
  SONiC Software Version: SONiC.HEAD.32-21ea29a
  Distribution: Debian 9.8
  Kernel: 4.9.0-8-amd64
  Build commit: 21ea29a
  Build date: Fri Mar 22 01:55:48 UTC 2019
  Built by: johnar@jenkins-worker-4

  Docker images:
  REPOSITORY                 TAG                 IMAGE ID            SIZE
  docker-syncd-brcm          HEAD.32-21ea29a     434240daff6e        362MB
  docker-syncd-brcm          latest              434240daff6e        362MB
  docker-orchagent-brcm      HEAD.32-21ea29a     e4f9c4631025        287MB
  docker-orchagent-brcm      latest              e4f9c4631025        287MB
  docker-nat                 HEAD.32-21ea29a     46075edc1c69        305MB
  docker-nat                 latest              46075edc1c69        305MB
  docker-lldp-sv2            HEAD.32-21ea29a     9681bbfea3ac        275MB
  docker-lldp-sv2            latest              9681bbfea3ac        275MB
  docker-dhcp-relay          HEAD.32-21ea29a     2db34c7bc6f4        257MB
  docker-dhcp-relay          latest              2db34c7bc6f4        257MB
  docker-database            HEAD.32-21ea29a     badc6fc84cdb        256MB
  docker-database            latest              badc6fc84cdb        256MB
  docker-snmp-sv2            HEAD.32-21ea29a     e2776e2a30b7        295MB
  docker-snmp-sv2            latest              e2776e2a30b7        295MB
  docker-teamd               HEAD.32-21ea29a     caf957cd2ad1        275MB
  docker-teamd               latest              caf957cd2ad1        275MB
  docker-router-advertiser   HEAD.32-21ea29a     b1a62023958c        255MB
  docker-router-advertiser   latest              b1a62023958c        255MB
  docker-platform-monitor    HEAD.32-21ea29a     40b40a4b2164        287MB
  docker-platform-monitor    latest              40b40a4b2164        287MB
  docker-fpm-quagga          HEAD.32-21ea29a     546036fe6838        282MB
  docker-fpm-quagga          latest              546036fe6838        282MB
  ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#basic-show-commands)


### Show System Status
This sub-section explains some set of sub-commands that are used to display the status of various parameters pertaining to the physical state of the network node.

**show clock**

This command displays the current date and time configured on the system

- Usage:
  ```
  show clock
  ```

- Example:
  ```
  admin@sonic:~$ show clock
  Mon Mar 25 20:25:16 UTC 2019
  ```

**show boot**

This command displays the current OS image, the image to be loaded on next reboot, and lists all the available images installed on the device

- Usage:
  ```
  show boot
  ```

- Example:
  ```
  admin@sonic:~$ show boot
  Current: SONiC-OS-20181130.31
  Next: SONiC-OS-20181130.31
  Available:
  SONiC-OS-20181130.31
  ```

**show environment**

This command displays the platform environmentals, such as voltages, temperatures and fan speeds

- Usage:
  ```
  show environment
  ```

- Example:
  ```
  admin@sonic:~$ show environment
  coretemp-isa-0000
  Adapter: ISA adapter
  Core 0:       +28.0 C  (high = +98.0 C, crit = +98.0 C)
  Core 1:       +28.0 C  (high = +98.0 C, crit = +98.0 C)
  Core 2:       +28.0 C  (high = +98.0 C, crit = +98.0 C)
  Core 3:       +28.0 C  (high = +98.0 C, crit = +98.0 C)
  SMF_Z9100_ON-isa-0000
  Adapter: ISA adapter
  CPU XP3R3V_EARLY:              +3.22 V
  <... few more things ...>

  Onboard Temperature Sensors:
  CPU:                             30 C
  BCM56960 (PSU side):             35 C
  <... few more things ...>

  Onboard Voltage Sensors:
    CPU XP3R3V_EARLY                 3.22 V
  <... few more things ...>

  Fan Trays:
  Fan Tray 1:
    Fan1 Speed:     6192 RPM
    Fan2 Speed:     6362 RPM
    Fan1 State:        Normal
    Fan2 State:        Normal
    Air Flow:            F2B
  <... few more things ...>

  PSUs:
    PSU 1:
      Input:           AC
  <... few more things ...>
  ```
NOTE: The show output has got lot of information; only the sample output is given in the above example.
Though the displayed output slightly differs from one platform to another platform, the overall content will be similar to the example mentioned above.

**show reboot-cause**

This command displays the cause of the previous reboot

- Usage:
  ```
  show reboot-cause
  ```

- Example:
  ```
  admin@sonic:~$ show reboot-cause
  User issued reboot command [User: admin, Time: Mon Mar 25 01:02:03 UTC 2019]
  ```

**show reboot-cause history**

This command displays the history of the previous reboots up to 10 entry

- Usage:
  ```
  show reboot-cause history
  ```

- Example:
  ```
  admin@sonic:~$ show reboot-cause history
  Name                 Cause        Time                          User    Comment
  -------------------  -----------  ----------------------------  ------  ---------
  2020_10_09_02_33_06  reboot       Fri Oct  9 02:29:44 UTC 2020  admin
  2020_10_09_01_56_59  reboot       Fri Oct  9 01:53:49 UTC 2020  admin
  2020_10_09_02_00_53  fast-reboot  Fri Oct  9 01:58:04 UTC 2020  admin
  2020_10_09_04_53_58  warm-reboot  Fri Oct  9 04:51:47 UTC 2020  admin
  ```

**show uptime**

This command displays the current system uptime

- Usage:
  ```
  show uptime
  ```

- Example:
  ```
  admin@sonic:~$ show uptime
  up 2 days, 21 hours, 30 minutes
  ```

**show logging**

This command displays all the currently stored log messages.
All the latest processes and corresponding transactions are stored in the "syslog" file.
This file is saved in the path `/var/log` and can be viewed by giving the command ` sudo cat syslog` as this requires root login.

- Usage:
  ```
  show logging [(<process_name> [-l|--lines <number_of_lines>]) | (-f|--follow)]
  ```

- Example:
  ```
  admin@sonic:~$ show logging
  ```

It can be useful to pipe the output from `show logging` to the command `more` in order to examine one screenful of log messages at a time

- Example:
  ```
  admin@sonic:~$ show logging | more
  ```

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 50
  ```
  ```
  admin@sonic:~$ show logging sensord --lines 50
  ```

Optionally, you can follow the log live as entries are written to it by specifying the `-f` or `--follow` flag

- Example:
  ```
  admin@sonic:~$ show logging --follow
  ```

**show users**

This command displays a list of users currently logged in to the device

- Usage:
  ```
  show users
  ```

- Examples:
  ```
  admin@sonic:~$ show users
  admin    pts/9        Mar 25 20:31 (100.127.20.23)

  admin@sonic:~$ show users
  admin    ttyS1        2019-03-25 20:31
  ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#basic-show-commands)

### Show Hardware Platform

The information displayed in this set of commands partially overlaps with the one generated by “show envinronment” instruction. In this case though, the information is presented in a more succinct fashion. In the future these two CLI stanzas may end up getting combined.

**show platform summary**

This command displays a summary of the device's hardware platform

- Usage:
  ```
  show platform summary
  ```

- Example:
  ```
  admin@sonic:~$ show platform summary
  Platform: x86_64-dell_s6000_s1220-r0
  HwSKU: Force10-S6000
  ASIC: broadcom
  ```

**show platform syseeprom**

This command displays information stored on the system EEPROM.
Note that the output of this command is not the same for all vendor's platforms.
Couple of example outputs are given below.

- Usage:
  ```
  show platform syseeprom
  ```

- 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)
  ```

  ```
  admin@sonic:~$ show platform syseeprom
  TlvInfo Header:
    Id String:    TlvInfo
    Version:      1
    Total Length: 527
  TLV Name             Code Len Value
  ---- --- -----
  Product Name         0x21  64 MSN2700
  Part Number          0x22  20 MSN2700-CS2FO
  Serial Number        0x23  24 MT1822K07815
  Base MAC Address     0x24   6 50:6B:4B:8F:CE:40
  Manufacture Date     0x25  19 05/28/2018 23:56:02
  Device Version       0x26   1 16
  MAC Addresses        0x2A   2 128
  Manufacturer         0x2B   8 Mellanox
  Vendor Extension     0xFD  36
  Vendor Extension     0xFD 164
  Vendor Extension     0xFD  36
  Vendor Extension     0xFD  36
  Vendor Extension     0xFD  36
  Platform Name        0x28  18 x86_64-mlnx_x86-r0
  ONIE Version         0x29  21 2018.08-5.2.0006-9600
  CRC-32               0xFE   4 0x11C017E1

  (checksum valid)
  ```

**show platform ssdhealth**

This command displays health parameters of the device's SSD

- Usage:
  ```
  show platform ssdhealth [--vendor]
  ```

- Example:
  ```
  admin@sonic:~$ show platform ssdhealth
  Device Model : M.2 (S42) 3IE3
  Health       : 99.665%
  Temperature  : 30C
  ```

**show platform psustatus**

This command displays the status of the device's power supply units

- Usage:
  ```
  show platform psustatus
  ```

- Example:
  ```
  admin@sonic:~$ show platform psustatus
  PSU    Status
  -----  --------
  PSU 1  OK
  PSU 2  OK
  ```

**show platform fan**

This command displays the status of the device's fans

- Usage:
  ```
  show platform fan
  ```

- Example:
  ```
  admin@sonic:~$ show platform fan
          FAN     Speed    Direction    Presence    Status          Timestamp
  -----------  --------  -----------  ----------  --------  -----------------
         fan1       34%       intake     Present        OK  20200302 06:58:56
         fan2       43%       intake     Present        OK  20200302 06:58:56
         fan3       38%       intake     Present        OK  20200302 06:58:56
         fan4       49%       intake     Present        OK  20200302 06:58:57
         fan5       38%      exhaust     Present        OK  20200302 06:58:57
         fan6       48%      exhaust     Present        OK  20200302 06:58:57
         fan7       39%      exhaust     Present        OK  20200302 06:58:57
         fan8       48%      exhaust     Present        OK  20200302 06:58:57
  ```

**show platform temperature**

This command displays the status of the device's thermal sensors

- Usage:
  ```
  show platform temperature
  ```

- Example:
  ```
  admin@sonic:~$ show platform temperature
                    NAME    Temperature    High Th    Low Th    Crit High Th    Crit Low Th    Warning          Timestamp
  ----------------------  -------------  ---------  --------  --------------  -------------  ---------  -----------------
       Ambient ASIC Temp           37.0      100.0       N/A           120.0            N/A      False  20200302 06:58:57
   Ambient Fan Side Temp           28.5      100.0       N/A           120.0            N/A      False  20200302 06:58:57
  Ambient Port Side Temp           31.0      100.0       N/A           120.0            N/A      False  20200302 06:58:57
         CPU Core 0 Temp           36.0       87.0       N/A           105.0            N/A      False  20200302 06:59:57
         CPU Core 1 Temp           38.0       87.0       N/A           105.0            N/A      False  20200302 06:59:57
           CPU Pack Temp           38.0       87.0       N/A           105.0            N/A      False  20200302 06:59:57
              PSU-1 Temp           28.0      100.0       N/A           120.0            N/A      False  20200302 06:59:58
              PSU-2 Temp           28.0      100.0       N/A           120.0            N/A      False  20200302 06:59:58
      xSFP module 1 Temp           31.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 2 Temp           35.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 3 Temp           32.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 4 Temp           33.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 5 Temp           34.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 6 Temp           36.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 7 Temp           33.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 8 Temp           33.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
      xSFP module 9 Temp           32.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 10 Temp           38.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 11 Temp           38.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 12 Temp           39.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 13 Temp           35.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 14 Temp           37.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 15 Temp           36.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 16 Temp           36.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 17 Temp           32.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 18 Temp           34.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 19 Temp           30.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 20 Temp           31.5       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 21 Temp           34.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 22 Temp           34.4       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 23 Temp           34.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 24 Temp           35.6       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 25 Temp           38.0       70.0       N/A            90.0            N/A      False  20200302 06:59:57
     xSFP module 26 Temp           32.2       70.0       N/A            90.0            N/A      False  20200302 06:59:58
     xSFP module 27 Temp           39.0       70.0       N/A            90.0            N/A      False  20200302 06:59:58
     xSFP module 28 Temp           30.1       70.0       N/A            90.0            N/A      False  20200302 06:59:58
     xSFP module 29 Temp           32.0       70.0       N/A            90.0            N/A      False  20200302 06:59:58
     xSFP module 30 Temp           35.3       70.0       N/A            90.0            N/A      False  20200302 06:59:58
     xSFP module 31 Temp           31.0       70.0       N/A            90.0            N/A      False  20200302 06:59:58
     xSFP module 32 Temp           39.5       70.0       N/A            90.0            N/A      False  20200302 06:59:58
  ```

#### Transceivers
Displays diagnostic monitoring information of the transceivers

**show interfaces transceiver**

This command displays information for all the interfaces for the transceiver requested or a specific interface if the optional "interface_name" is specified.

- Usage:
  ```
  show interfaces transceiver (eeprom [-d|--dom] | lpmode | presence) [<interface_name>]
  ```

- Example (Decode and display information stored on the EEPROM of SFP transceiver connected to Ethernet0):
  ```
  admin@sonic:~$ show interfaces transceiver eeprom --dom Ethernet0
  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: -1.1936dBm
                RX2Power: -1.1793dBm
                RX3Power: -0.9388dBm
                RX4Power: -1.0729dBm
                TX1Bias: 4.0140mA
                TX2Bias: 4.0140mA
                TX3Bias: 4.0140mA
                TX4Bias: 4.0140mA
          ModuleMonitorValues :
                  Temperature : 1.1111C
                  Vcc : 0.0000Volts
  ```

- Example (Display status of low-power mode of SFP transceiver connected to Ethernet100):
  ```
  admin@sonic:~$ show interfaces transceiver lpmode Ethernet100
  Port         Low-power Mode
  -----------  ----------------
  Ethernet100  On
  ```


- Example (Display presence of SFP transceiver connected to Ethernet100):
  ```
  admin@sonic:~$ show interfaces transceiver presence Ethernet100
  Port         Presence
  -----------  ----------
  Ethernet100  Present
  ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#basic-show-commands)

## AAA & TACACS+
This section captures the various show commands & configuration commands that are applicable for the AAA (Authentication, Authorization, and Accounting) module.
Admins can configure the type of authentication (local or remote tacacs based) required for the users and also the authentication failthrough and fallback options.
Following show command displays the current running configuration related to the AAA.

### AAA

#### AAA show commands

This command is used to view the Authentication, Authorization & Accounting settings that are configured in the network node.

**show aaa**

This command displays the AAA settings currently present in the network node

- Usage:
  ```
  show aaa
  ```

- Example:
   ```
   admin@sonic:~$ show aaa
   AAA authentication login local (default)
   AAA authentication failthrough True (default)
   AAA authentication fallback True (default)
   ```

#### AAA config commands

This sub-section explains all the possible CLI based configuration options for the AAA module. The list of commands/sub-commands possible for aaa is given below.

  Command: aaa authentication
    sub-commands:
      - aaa authentication failthrough
      - aaa authentication fallback
      - aaa authentication login

**aaa authentication failthrough**

This command is used to either enable or disable the failthrough option.
This command is useful when user has configured more than one tacacs+ server and when user has enabled tacacs+ authentication.
When authentication request to the first server fails, this configuration allows to continue the request to the next server.
When this configuration is enabled, authentication process continues through all servers configured.
When this is disabled and if the authentication request fails on first server, authentication process will stop and the login will be disallowed.


- Usage:
  ```
  config aaa authentication failthrough (enable | disable | default)
  ```

  - Parameters:
    - enable: This allows the AAA module to process with local authentication if remote authentication fails.
    - disable: This disallows the AAA module to proceed further if remote authentication fails.
    - default: This re-configures the default value, which is "enable".


- Example:
  ```
  admin@sonic:~$ sudo config aaa authentication failthrough enable
  ```
**aaa authentication fallback**

The command is not used at the moment.
When the tacacs+ authentication fails, it falls back to local authentication by default.

- Usage:
  ```
  config aaa authentication fallback (enable | disable | default)
  ```

- Example:
  ```
  admin@sonic:~$ sudo config aaa authentication fallback enable
  ```

**aaa authentication login**

This command is used to either configure whether AAA should use local database or remote tacacs+ database for user authentication.
By default, AAA uses local database for authentication. New users can be added/deleted using the linux commands (Note that the configuration done using linux commands are not preserved during reboot).
Admin can enable remote tacacs+ server based authentication by selecting the AUTH_PROTOCOL as tacacs+ in this command.
Admins need to configure the tacacs+ server accordingly and ensure that the connectivity to tacacas+ server is available via the management interface.
Once if the admins choose the remote authentication based on tacacs+ server, all user logins will be authenticated by the tacacs+ server.
If the authentication fails, AAA will check the "failthrough" configuration and authenticates the user based on local database if failthrough is enabled.

- Usage:
  ```
  config aaa authentication (tacacs+ | local | default)
  ```

  - Parameters:
    - tacacs+: Enables remote authentication based on tacacs+
    - local: Disables remote authentication and uses local authentication
    - default: Reset back to default value, which is only "local" authentication


- Example:
  ```
  admin@sonic:~$ sudo config aaa authentication login tacacs+
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#aaa--tacacs)

### TACACS+

#### TACACS+ show commands

**show tacacs**

This command displays the global configuration fields and the list of all tacacs servers and their correponding configurations.

- Usage:
  ```
  show tacacs
  ```

- Example:
  ```
  admin@sonic:~$ show tacacs
  TACPLUS global auth_type pap (default)
  TACPLUS global timeout 99
  TACPLUS global passkey <EMPTY_STRING> (default)

  TACPLUS_SERVER address 10.11.12.14
                         priority 9
                         tcp_port 50
                         auth_type mschap
                         timeout 10
                         passkey testing789

  TACPLUS_SERVER address 10.0.0.9
                         priority 1
                         tcp_port 49
  ```

#### TACACS+ config commands

This sub-section explains the command "config tacacs" and its sub-commands that are used to configure the following tacacs+ parameters.
Some of the parameters like authtype, passkey and timeout can be either configured at per server level or at global level (global value will be applied if there no server level configuration)

1) Add/Delete the tacacs+ server details.
2) authtype - global configuration that is applied to all servers if there is no server specific configuration.
3) default - reset the authtype or passkey or timeout to the default values.
4) passkey - global configuration that is applied to all servers if there is no server specific configuration.
5) timeout - global configuration that is applied to all servers if there is no server specific configuration.

**config tacacs add**

This command is used to add a TACACS+ server to the tacacs server list.
Note that more than one tacacs+ (maximum of seven) can be added in the device.
When user tries to login, tacacs client shall contact the servers one by one.
When any server times out, device will try the next server one by one based on the priority value configured for that server.
When this command is executed, the configured tacacs+ server addresses are updated in /etc/pam.d/common-auth-sonic configuration file which is being used by tacacs service.

- Usage:
  ```
  config tacacs add <ip_address> [-t|--timeout <seconds>] [-k|--key <secret>] [-a|--type <type>] [-o|--port <port>] [-p|--pri <priority>] [-m|--use-mgmt-vrf]
  ```

  - Parameters:
    - ip_address: TACACS+ server IP address.
    - timeout: Transmission timeout interval in seconds, range 1 to 60, default 5
    - key: Shared secret
    - type: Authentication type, "chap" or "pap" or "mschap" or "login", default is "pap".
    - port: TCP port range is 1 to 65535, default 49
    - pri: Priority, priority range 1 to 64, default 1.
    - use-mgmt-vrf: This means that the server is part of Management vrf, default is "no vrf"


- Example:
  ```
  admin@sonic:~$ sudo config tacacs add 10.11.12.13 -t 10 -k testing789 -a mschap -o 50 -p 9
  ```

  - Example Server Configuration in /etc/pam.d/common-auth-sonic configuration file:
    ```
    auth    [success=done new_authtok_reqd=done default=ignore]     pam_tacplus.so server=10.11.12.14:50 secret=testing789 login=mschap timeout=10  try_first_pass
    auth    [success=done new_authtok_reqd=done default=ignore]     pam_tacplus.so server=10.11.12.24:50 secret=testing789 login=mschap timeout=987654321098765433211
    0987  try_first_pass
    auth    [success=done new_authtok_reqd=done default=ignore]     pam_tacplus.so server=10.0.0.9:49 secret= login=mschap timeout=5  try_first_pass
    auth    [success=done new_authtok_reqd=done default=ignore]     pam_tacplus.so server=10.0.0.8:49 secret= login=mschap timeout=5  try_first_pass
    auth    [success=done new_authtok_reqd=done default=ignore]     pam_tacplus.so server=10.11.12.13:50 secret=testing789 login=mschap timeout=10  try_first_pass
    auth    [success=1 default=ignore]      pam_unix.so nullok try_first_pass
    ```

    *NOTE: In the above example, the servers are stored (sorted) based on the priority value configured for the server.*

**config tacacs delete**

This command is used to delete the tacacs+ servers configured.

- Usage:
  ```
  config tacacs delete <ip_address>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config tacacs delete 10.11.12.13
  ```

**config tacacs authtype**

This command is used to modify the global value for the TACACS+ authtype.
When user has not configured server specific authtype, this global value shall be used for that server.

- Usage:
  ```
  config tacacs authtype (chap | pap | mschap | login)
  ```

- Example:
  ```
  admin@sonic:~$ sudo config tacacs authtype mschap
  ```

**config tacacs default**

This command is used to reset the global value for authtype or passkey or timeout to default value.
Default for authtype is "pap", default for passkey is EMPTY_STRING and default for timeout is 5 seconds.

- Usage:
  ```
  config tacacs default (authtype | passkey | timeout)
  ```

- Example (This will reset the global authtype back to the default value "pap"):
  ```
  admin@sonic:~$ sudo config tacacs default authtype
  ```

**config tacacs passkey**

This command is used to modify the global value for the TACACS+ passkey.
When user has not configured server specific passkey, this global value shall be used for that server.

- Usage:
  ```
  config tacacs passkey <pass_key>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config tacacs passkey testing123
  ```

**config tacacs timeout**

This command is used to modify the global value for the TACACS+ timeout.
When user has not configured server specific timeout, this global value shall be used for that server.


- Usage:
  ```
  config tacacs [default] timeout [<timeout_value_in_seconds>]
  ```

  - Options:
    - Valid values for timeout is 1 to 60 seconds.
    - When the optional keyword "default" is specified, timeout_value_in_seconds parameter wont be used; default value of 5 is used.
    - Configuration using the keyword "default" is introduced in 201904 release.

- Example: To configure non-default timeout value
  ```
  admin@sonic:~$ sudo config tacacs timeout 60
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#aaa--tacacs)



## ACL

This section explains the various show commands and configuration commands available for users.

### ACL show commands

**show acl table**

This command displays either all the ACL tables that are configured or only the specified "TABLE_NAME".
Output from the command displays the table name, type of the table, the list of interface(s) to which the table is bound and the description about the table.

- Usage:
  ```
  show acl table [<table_name>]
  ```

- Example:
  ```
  admin@sonic:~$ show acl table
  Name      Type       Binding          Description      Stage
  --------  ---------  ---------------  ---------------- -------
  EVERFLOW  MIRROR     Ethernet16       EVERFLOW         ingress
                       Ethernet96
                       Ethernet108
                       Ethernet112
                       PortChannel0001
                       PortChannel0002
  SNMP_ACL  CTRLPLANE  SNMP             SNMP_ACL         ingress
  DT_ACL_T1 L3         Ethernet0        DATA_ACL_TABLE_1 egress
                       Ethernet4
                       Ethernet112
                       Ethernet116
  SSH_ONLY  CTRLPLANE  SSH              SSH_ONLY         ingress
  ```

**show acl rule**

This command displays all the ACL rules present in all the ACL tables or only the rules present in specified table "TABLE_NAME" or only the rule matching the RULE_ID option.
Output from the command gives the following information about the rules
1) Table name - ACL table name to which the rule belongs to.
2) Rule name - ACL rule name
3) Priority - Priority for this rule.
4) Action - Action to be performed if the packet matches with this ACL rule.

It can be:
- "DROP"/"FORWARD"("ACCEPT" for control plane ACL)
- "REDIRECT: redirect-object" for redirect rule, where "redirect-object" is either:
    -  physical interface name, e.g. "Ethernet10"
    -  port channel name, e.g. "PortChannel0002"
    -  next-hop IP address, e.g. "10.0.0.1"
    -  next-hop group set of IP addresses with comma seperator, e.g. "10.0.0.1,10.0.0.3"
- "MIRROR INGRESS|EGRESS: session-name" for mirror rules, where "session-name" refers to mirror session

Users can choose to have a default permit rule or default deny rule. In case of default "deny all" rule, add the permitted rules on top of the deny rule. In case of the default "permit all" rule, users can add the deny rules on top of it. If users have not confgured any rule, SONiC allows all traffic (which is "permit all").

5) Match  - The fields from the packet header that need to be matched against the same present in the incoming traffic.

- Usage:
  ```
  show acl rule [<table_name>] [<rule_id>]
  ```

- Example:
  ```
  admin@sonic:~$ show acl rule
  Table     Rule          Priority    Action                     Match
  --------  ------------  ----------  -------------------------  ----------------------------
  SNMP_ACL  RULE_1        9999        ACCEPT                     IP_PROTOCOL: 17
                                                                 SRC_IP: 1.1.1.1/32
  SSH_ONLY  RULE_2        9998        ACCEPT                     IP_PROTOCOL: 6
                                                                 SRC_IP: 1.1.1.1/32
  EVERFLOW  RULE_3        9997        MIRROR INGRESS: everflow0  SRC_IP: 20.0.0.2/32
  EVERFLOW  RULE_4        9996        MIRROR EGRESS : everflow1  L4_SRC_PORT: 4621
  DATAACL   RULE_5        9995        REDIRECT: Ethernet8        IP_PROTOCOL: 126
  DATAACL   RULE_6        9994        FORWARD                    L4_SRC_PORT: 179
  DATAACL   RULE_7        9993        FORWARD                    L4_DST_PORT: 179
  SNMP_ACL  DEFAULT_RULE  1           DROP                       ETHER_TYPE: 2048
  SSH_ONLY  DEFAULT_RULE  1           DROP                       ETHER_TYPE: 2048
  ```


### ACL config commands
This sub-section explains the list of configuration options available for ACL module.
Note that there is no direct command to add or delete or modify the ACL table and ACL rule.
Existing ACL tables and ACL rules can be updated by specifying the ACL rules in json file formats and configure those files using this CLI command.

**config acl update full**

This command is to update the rules in all the tables or in one specific table in full. If a table_name is provided, the operation will be restricted in the specified table. All existing rules in the specified table or all tables will be removed. New rules loaded from file will be installed. If the table_name is specified, only rules within that table will be removed and new rules in that table will be installed. If the table_name is not specified, all rules from all tables will be removed and only the rules present in the input file will be added.

The command does not modify anything in the list of acl tables. It modifies only the rules present in those pre-existing tables.

In order to create acl tables, either follow the config_db.json method or minigraph method to populate the list of ACL tables.

After creating tables, either the config_db.json method or the minigraph method or the CLI method (explained here) can be used to populate the rules in those ACL tables.

This command updates only the ACL rules and it does not disturb the ACL tables; i.e. the output of "show acl table" is not alterted by using this command; only the output of "show acl rule" will be changed after this command.

When "--session_name" optional argument is specified, command sets the session_name for the ACL table with this mirror session name. It fails if the specified mirror session name does not exist.

When "--mirror_stage" optional argument is specified, command sets the mirror action to ingress/egress based on this parameter. By default command sets ingress mirror action in case argument is not specified.

When the optional argument "max_priority"  is specified, each rule’s priority is calculated by subtracting its “sequence_id” value from the “max_priority”. If this value is not passed, the default “max_priority” 10000 is used.

- Usage:
  ```
  config acl update full [--table_name <table_name>] [--session_name <session_name>] [--mirror_stage (ingress | egress)] [--max_priority <priority_value>] <acl_json_file_name>
  ```

  - Parameters:
    - table_name: Specifiy the name of the ACL table to load. Example: config acl update full "--table_name DT_ACL_T1  /etc/sonic/acl_table_1.json"
    - session_name: Specifiy the name of the ACL session to load. Example: config acl update full "--session_name mirror_ses1 /etc/sonic/acl_table_1.json"
    - priority_value: Specify the maximum priority to use when loading ACL rules. Example: config acl update full "--max-priority 100  /etc/sonic/acl_table_1.json"

    *NOTE 1: All these optional parameters should be inside double quotes. If none of the options are provided, double quotes are not required for specifying filename alone.*
    *NOTE 2: Any number of optional parameters can be configured in the same command.*

- Examples:
  ```
  admin@sonic:~$ sudo config acl update full /etc/sonic/acl_full_snmp_1_2_ssh_4.json
  admin@sonic:~$ sudo config acl update full "--table_name SNMP-ACL /etc/sonic/acl_full_snmp_1_2_ssh_4.json"
  admin@sonic:~$ sudo config acl update full "--session_name everflow0 /etc/sonic/acl_full_snmp_1_2_ssh_4.json"
  ```

  This command will remove all rules from all the ACL tables and insert all the rules present in this input file.
  Refer the example file [acl_full_snmp_1_2_ssh_4.json](#) that adds two rules for SNMP (Rule1 and Rule2) and one rule for SSH (Rule4)
  Refer an example for input file format [here](https://github.com/Azure/sonic-mgmt/blob/master/ansible/roles/test/files/helpers/config_service_acls.sh)
  Refer another example [here](https://github.com/Azure/sonic-mgmt/blob/master/ansible/roles/test/tasks/acl/acltb_test_rules_part_1.json)

**config acl update incremental**

This command is used to perform incremental update of ACL rule table. This command gets existing rules from Config DB and compares with rules specified in input file and performs corresponding modifications.

With respect to DATA ACLs, the command does not assume that new dataplane ACLs can be inserted in betweeen by shifting existing ACLs in all ASICs. Therefore, this command performs a full update on dataplane ACLs.
With respect to control plane ACLs, this command performs an incremental update.
If we assume that "file1.json" is the already loaded ACL rules file and if "file2.json" is the input file that is passed as parameter for this command, the following requirements are valid for the input file.
1) First copy the file1.json to file2.json.
2) Remove the unwanted ACL rules from file2.json
3) Add the newly required ACL rules into file2.json.
4) Modify the existing ACL rules (that require changes) in file2.json.

NOTE: If any ACL rule that is already available in file1.json is required even after this command execution, such rules should remain unalterted in file2.json. Don't remove them.
Note that "incremental" is working like "full".

When "--session_name" optional argument is specified, command sets the session_name for the ACL table with this mirror session name. It fails if the specified mirror session name does not exist.

When "--mirror_stage" optional argument is specified, command sets the mirror action to ingress/egress based on this parameter. By default command sets ingress mirror action in case argument is not specified.

When the optional argument "max_priority"  is specified, each rule’s priority is calculated by subtracting its “sequence_id” value from the “max_priority”. If this value is not passed, the default “max_priority” 10000 is used.

- Usage:
  ```
  config acl update incremental [--session_name <session_name>] [--mirror_stage (ingress | egress)] [--max_priority <priority_value>] <acl_json_file_name>
  ```

  - Parameters:
    - table_name: Specifiy the name of the ACL table to load. Example: config acl update full "--table_name DT_ACL_T1  /etc/sonic/acl_table_1.json"
    - session_name: Specifiy the name of the ACL session to load. Example: config acl update full "--session_name mirror_ses1 /etc/sonic/acl_table_1.json"
    - priority_value: Specify the maximum priority to use when loading ACL rules. Example: config acl update full "--max-priority 100  /etc/sonic/acl_table_1.json"

    *NOTE 1: All these optional parameters should be inside double quotes. If none of the options are provided, double quotes are not required for specifying filename alone.*
    *NOTE 2: Any number of optional parameters can be configured in the same command.*

- Examples:
  ```
  admin@sonic:~$ sudo config acl update incremental /etc/sonic/acl_incremental_snmp_1_3_ssh_4.json
  ```
  ```
  admin@sonic:~$ sudo config acl update incremental "--session_name everflow0 /etc/sonic/acl_incremental_snmp_1_3_ssh_4.json"
  ```

  Refer the example file [acl_incremental_snmp_1_3_ssh_4.json](#) that adds two rules for SNMP (Rule1 and Rule3) and one rule for SSH (Rule4)
  When this "incremental" command is executed after "full" command, it has removed SNMP Rule2 and added SNMP Rule3 in the example.
  File "acl_full_snmp_1_2_ssh_4.json" has got SNMP Rule1, SNMP Rule2 and SSH Rule4.
  File "acl_incremental_snmp_1_3_ssh_4.json" has got SNMP Rule1, SNMP Rule3 and SSH Rule4.
  This file is created by copying the file "acl_full_snmp_1_2_ssh_4.json" to "acl_incremental_snmp_1_3_ssh_4.json" and then removing SNMP Rule2 and adding SNMP Rule3.

Go Back To [Beginning of the document](#) or [Beginning of this section](#acl)

**config acl add table**

This command is used to create new ACL tables.

- Usage:
  ```
  config acl add table [OPTIONS] <table_name> <table_type> [-d <description>] [-p <ports>] [-s (ingress | egress)]
  ```

- Parameters:
  - table_name: The name of the ACL table to create.
  - table_type: The type of ACL table to create (e.g. "L3", "L3V6", "MIRROR")
  - description: A description of the table for the user. (default is the table_name)
  - ports: A comma-separated list of ports/interfaces to add to the table. The behavior is as follows:
    - Physical ports will be bound as physical ports
    - Portchannels will be bound as portchannels - passing a portchannel member is invalid
    - VLANs will be expanded into their members (e.g. "Vlan1000" will become "Ethernet0,Ethernet2,Ethernet4...")
  - stage: The stage this ACL table will be applied to, either ingress or egress. (default is ingress)

- Examples:
  ```
  admin@sonic:~$ sudo config acl add table EXAMPLE L3 -p Ethernet0,Ethernet4 -s ingress
  ```
  ```
  admin@sonic:~$ sudo config acl add table EXAMPLE_2 L3V6 -p Vlan1000,PortChannel0001,Ethernet128 -s egress
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#acl)


## ARP & NDP

### ARP show commands

**show arp**

This command displays the ARP entries in the device with following options.
1) Display the entire table.
2) Display the ARP entries learnt on a specific interface.
3) Display the ARP of a specific ip-address.

- Usage:
  ```
  show arp [-if <interface_name>] [<ip_address>]
  ```

- Details:
  - show arp: Displays all entries
  - show arp -if <ifname>: Displays the ARP specific to the specified interface.
  - show arp <ip-address>: Displays the ARP specific to the specicied ip-address.


- Example:
  ```
  admin@sonic:~$ show arp
   Address          MacAddress            Iface         Vlan
  -------------     -----------------     -------       ------
  192.168.1.183     88:5a:92:fb:bf:41     Ethernet44    -
  192.168.1.175     88:5a:92:fc:95:81     Ethernet28    -
  192.168.1.181     e4:c7:22:c1:07:7c     Ethernet40    -
  192.168.1.179     88:5a:92:de:a8:bc     Ethernet36    -
  192.168.1.118     00:1c:73:3c:de:43     Ethernet64    -
  192.168.1.11      00:1c:73:3c:e1:38     Ethernet88    -
  192.168.1.161     24:e9:b3:71:3a:01     Ethernet0     -
  192.168.1.189     24:e9:b3:9d:57:41     Ethernet56    -
  192.168.1.187     74:26:ac:8b:8f:c1     Ethernet52    -
  192.168.1.165     88:5a:92:de:a0:7c     Ethernet8     -

  Total number of entries 10
  ```

Optionally, you can specify the interface in order to display the ARPs learnt on that particular interface

- Example:
  ```
  admin@sonic:~$ show arp -if Ethernet40
  Address          MacAddress          Iface        Vlan
  -------------    -----------------   ----------   ------
  192.168.1.181    e4:c7:22:c1:07:7c   Ethernet40   -
  Total number of entries 1
  ```

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          MacAddress          Iface        Vlan
  -------------    -----------------   ----------   ------
  192.168.1.181    e4:c7:22:c1:07:7c   Ethernet40   -
  Total number of entries 1
  ```

### NDP show commands

**show ndp**

This command displays either all the IPv6 neighbor mac addresses, or for a particular IPv6 neighbor, or for all IPv6 neighbors reachable via a specific interface.

- Usage:
  ```
  show ndp [-if|--iface <interface_name>] <ipv6_address>
  ```

- Example (show all IPv6 neighbors):
  ```
  admin@sonic:~$ show ndp
  Address                   MacAddress         Iface    Vlan    Status
  ------------------------  -----------------  -------  ------  ---------
  fe80::20c:29ff:feb8:b11e  00:0c:29:b8:b1:1e  eth0     -       REACHABLE
  fe80::20c:29ff:feb8:cff0  00:0c:29:b8:cf:f0  eth0     -       REACHABLE
  fe80::20c:29ff:fef9:324   00:0c:29:f9:03:24  eth0     -       REACHABLE
  Total number of entries 3
  ```

- Example (show specific IPv6 neighbor):
  ```
  admin@sonic:~$ show ndp fe80::20c:29ff:feb8:b11e
  Address                   MacAddress         Iface    Vlan    Status
  ------------------------  -----------------  -------  ------  ---------
  fe80::20c:29ff:feb8:b11e  00:0c:29:b8:b1:1e  eth0     -       REACHABLE
  Total number of entries 1
  ```

- Example (show IPv6 neighbors learned on a specific interface):
  ```
  admin@sonic:~$ show ndp -if eth0
  Address                   MacAddress         Iface    Vlan    Status
  ------------------------  -----------------  -------  ------  ---------
  fe80::20c:29ff:feb8:b11e  00:0c:29:b8:b1:1e  eth0     -       REACHABLE
  fe80::20c:29ff:feb8:cff0  00:0c:29:b8:cf:f0  eth0     -       REACHABLE
  fe80::20c:29ff:fef9:324   00:0c:29:f9:03:24  eth0     -       REACHABLE
  Total number of entries 3
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#arp--ndp)


## BGP

This section explains all the BGP show commands and BGP configuation commands in both "Quagga" and "FRR" routing software that are supported in SONiC.
In 201811 and older verisons "Quagga" was enabled by default. In current version "FRR" is enabled by default.
Most of the FRR show commands start with "show bgp". Similar commands in Quagga starts with "show ip bgp". All sub-options supported in all these show commands are common for FRR and Quagga.
Detailed show commands examples for Quagga are provided at the end of this document.This section captures only the commands supported by FRR.

### BGP show commands


**show bgp summary (Versions >= 201904 using default FRR routing stack)**

**show ip bgp summary (Versions <= 201811 using Quagga routing stack)**

This command displays the summary of all IPv4 & IPv6 bgp neighbors that are configured and the corresponding states.

- Usage:

  *Versions >= 201904 using default FRR routing stack*
  ```
  show bgp summary
  ```
  *Versions <= 201811 using Quagga routing stack*
  ```
  show ip bgp summary
  ```

- Example:
  ```
  admin@sonic:~$ show ip bgp summary

  IPv4 Unicast Summary:
  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 6465
  RIB entries 12807, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd NeighborName
  10.0.0.57       4      64600    3995    4001        0    0    0 00:39:32         6400 Lab-T1-01
  10.0.0.59       4      64600    3995    3998        0    0    0 00:39:32         6400 Lab-T1-02
  10.0.0.61       4      64600    3995    4001        0    0    0 00:39:32         6400 Lab-T1-03
  10.0.0.63       4      64600    3995    3998        0    0    0 00:39:32         6400 NotAvailable

  Total number of neighbors 4
  ```

- Example:
  ```
  admin@sonic:~$ show bgp summary

  IPv4 Unicast Summary:
  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 6465
  RIB entries 12807, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd
  10.0.0.57       4      64600    3995    4001        0    0    0 00:39:32         6400
  10.0.0.59       4      64600    3995    3998        0    0    0 00:39:32         6400
  10.0.0.61       4      64600    3995    4001        0    0    0 00:39:32         6400
  10.0.0.63       4      64600    3995    3998        0    0    0 00:39:32         6400

  Total number of neighbors 4

  IPv6 Unicast Summary:
  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 12803
  RIB entries 12805, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd
  fc00::72        4      64600    3995    5208        0    0    0 00:39:30         6400
  fc00::76        4      64600    3994    5208        0    0    0 00:39:30         6400
  fc00::7a        4      64600    3993    5208        0    0    0 00:39:30         6400
  fc00::7e        4      64600    3993    5208        0    0    0 00:39:30         6400

  Total number of neighbors 4
  ```
  Click [here](#Quagga-BGP-Show-Commands) to see the example for "show ip bgp summary" for Quagga.



**show bgp neighbors (Versions >= 201904 using default FRR routing stack)**

**show ip bgp neighbors (Versions <= 201811 using Quagga routing stack)**

This command displays all the details of IPv4 & IPv6 BGP neighbors when no optional argument is specified.

When the optional argument IPv4_address is specified, it displays the detailed neighbor information about that specific IPv4 neighbor.

Command has got additional optional arguments to display only the advertised routes, or the received routes, or all routes.

In order to get details for an IPv6 neigbor, use "show bgp ipv6 neighbor <ipv6_address>" command.


- Usage:

  *Versions >= 201904 using default FRR routing stack*
  ```
  show bgp neighbors [<ipv4-address> [advertised-routes | received-routes | routes]]
  ```
  *Versions <= 201811 using Quagga routing stack*
  ```
  show ip bgp neighbors [<ipv4-address> [advertised-routes | received-routes | routes]]
  ```

- Example:
  ```
  admin@sonic:~$ show bgp neighbors
  BGP neighbor is 10.0.0.57, remote AS 64600, local AS 65100, external link
  Description: ARISTA01T1
  BGP version 4, remote router ID 100.1.0.29, local router ID 10.1.0.32
  BGP state = Established, up for 00:42:15
  Last read 00:00:00, Last write 00:00:03
  Hold time is 10, keepalive interval is 3 seconds
  Configured hold time is 10, keepalive interval is 3 seconds
  Neighbor capabilities:
    4 Byte AS: advertised and received
    AddPath:
      IPv4 Unicast: RX advertised IPv4 Unicast and received
    Route refresh: advertised and received(new)
    Address Family IPv4 Unicast: advertised and received
    Hostname Capability: advertised (name: sonic-z9264f-9251,domain name: n/a) not received
    Graceful Restart Capabilty: advertised and received
      Remote Restart timer is 300 seconds
      Address families by peer:
        none
  Graceful restart information:
    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:                  2          1
    Notifications:          2          0
    Updates:             3206       3202
    Keepalives:           845        847
    Route Refresh:          0          0
    Capability:             0          0
    Total:               4055       4050
  Minimum time between advertisement runs is 0 seconds

  For address family: IPv4 Unicast
   Update group 1, subgroup 1
   Packet Queue length 0
   Inbound soft reconfiguration allowed
   Community attribute sent to this neighbor(all)
   6400 accepted prefixes

   Connections established 1; dropped 0
   Last reset 00:42:37, due to NOTIFICATION sent (Cease/Connection collision resolution)
   Local host: 10.0.0.56, Local port: 179
   Foreign host: 10.0.0.57, Foreign port: 46419
   Nexthop: 10.0.0.56
   Nexthop global: fc00::71
   Nexthop local: fe80::2204:fff:fe36:9449
   BGP connection: shared network
   BGP Connect Retry Timer in Seconds: 120
   Read thread: on  Write thread: on
  ```

Optionally, you can specify an IP address in order to display only that particular neighbor. In this mode, you can optionally specify whether you want to display all routes advertised to the specified neighbor, all routes received from the specified neighbor or all routes (received and accepted) from the specified neighbor.

- Example:
  ```
  admin@sonic:~$ show bgp neighbors 10.0.0.57

  admin@sonic:~$ show bgp neighbors 10.0.0.57 advertised-routes

  admin@sonic:~$ show bgp neighbors 10.0.0.57 received-routes

  admin@sonic:~$ show bgp neighbors 10.0.0.57 routes
  ```

  Click [here](#Quagga-BGP-Show-Commands) to see the example for "show ip bgp neighbors" for Quagga.


**show ip bgp network [[<ipv4-address>|<ipv4-prefix>] [(bestpath | multipath | longer-prefixes | json)]]

This command displays all the details of IPv4 Border Gateway Protocol (BGP) prefixes.

- Usage:


  ```
  show ip bgp network [[<ipv4-address>|<ipv4-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
  ```

- Example:

  NOTE: The "longer-prefixes" option is only available when a network prefix with a "/" notation is used.

  ```
  admin@sonic:~$ show ip bgp network

  admin@sonic:~$ show ip bgp network 10.1.0.32 bestpath

  admin@sonic:~$ show ip bgp network 10.1.0.32 multipath

  admin@sonic:~$ show ip bgp network 10.1.0.32 json

  admin@sonic:~$ show ip bgp network 10.1.0.32/32 bestpath

  admin@sonic:~$ show ip bgp network 10.1.0.32/32 multipath

  admin@sonic:~$ show ip bgp network 10.1.0.32/32 json

  admin@sonic:~$ show ip bgp network 10.1.0.32/32 longer-prefixes
  ```

**show bgp ipv6 summary (Versions >= 201904 using default FRR routing stack)**

**show ipv6 bgp summary (Versions <= 201811 using Quagga routing stack)**

This command displays the summary of all IPv6 bgp neighbors that are configured and the corresponding states.

- Usage:

  *Versions >= 201904 using default FRR routing stack*
  ```
  show bgp ipv6 summary
  ```
  *Versions <= 201811 using Quagga routing stack*
  ```
  show ipv6 bgp summary
  ```

- Example:
  ```
  admin@sonic:~$ show bgp ipv6 summary
  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 12803
  RIB entries 12805, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd NeighborName
  fc00::72        4      64600    3995    5208        0    0    0 00:39:30         6400 Lab-T1-01
  fc00::76        4      64600    3994    5208        0    0    0 00:39:30         6400 Lab-T1-02
  fc00::7a        4      64600    3993    5208        0    0    0 00:39:30         6400 Lab-T1-03
  fc00::7e        4      64600    3993    5208        0    0    0 00:39:30         6400 Lab-T1-04

  Total number of neighbors 4
  ```
  Click [here](#Quagga-BGP-Show-Commands) to see the example for "show ipv6 bgp summary" for Quagga.



**show bgp ipv6 neighbors (Versions >= 201904 using default FRR routing stack)**

**show ipv6 bgp neighbors (Versions <= 201811 using Quagga routing stack)**

This command displays all the details of one particular IPv6 Border Gateway Protocol (BGP) neighbor. Option is also available to display only the advertised routes, or the received routes, or all routes.


- Usage:

  *Versions >= 201904 using default FRR routing stack*
  ```
  show bgp ipv6 neighbors [<ipv6-address> [(advertised-routes | received-routes | routes)]]
  ```
  *Versions <= 201811 using Quagga routing stack*
  ```
  show ipv6 bgp neighbors [<ipv6-address> [(advertised-routes | received-routes | routes)]]
  ```

- Example:
  ```
  admin@sonic:~$ show bgp ipv6 neighbors fc00::72 advertised-routes

  admin@sonic:~$ show bgp ipv6 neighbors fc00::72 received-routes

  admin@sonic:~$ show bgp ipv6 neighbors fc00::72 routes
  ```
  Click [here](#Quagga-BGP-Show-Commands) to see the example for "show ip bgp summary" for Quagga.


**show ipv6 bgp network [[<ipv6-address>|<ipv6-prefix>] [(bestpath | multipath | longer-prefixes | json)]]

This command displays all the details of IPv6 Border Gateway Protocol (BGP) prefixes.  

- Usage: 

  
  ```
  show ipv6 bgp network [[<ipv6-address>|<ipv6-prefix>] [(bestpath | multipath | longer-prefixes | json)]]   
  ```

- Example:

  NOTE: The "longer-prefixes" option is only available when a network prefix with a "/" notation is used.
 
  ```
  admin@sonic:~$ show ipv6 bgp network

  admin@sonic:~$ show ipv6 bgp network fc00::72 bestpath 

  admin@sonic:~$ show ipv6 bgp network fc00::72 multipath

  admin@sonic:~$ show ipv6 bgp network fc00::72 json 

  admin@sonic:~$ show ipv6 bgp network fc00::72/64 bestpath

  admin@sonic:~$ show ipv6 bgp network fc00::72/64 multipath

  admin@sonic:~$ show ipv6 bgp network fc00::72/64 json 

  admin@sonic:~$ show ipv6 bgp network fc00::72/64 longer-prefixes
  ```
 
  


**show route-map**

This command displays the routing policy that takes precedence over the other route processes that are configured.

- Usage:
  ```
  show route-map
  ```

- Example:
  ```
  admin@sonic:~$ show route-map
  ZEBRA:
  route-map RM_SET_SRC, permit, sequence 10
    Match clauses:
    Set clauses:
      src 10.12.0.102
    Call clause:
    Action:
      Exit routemap
  ZEBRA:
  route-map RM_SET_SRC6, permit, sequence 10
    Match clauses:
    Set clauses:
      src fc00:1::102
    Call clause:
    Action:
      Exit routemap
  BGP:
  route-map FROM_BGP_SPEAKER_V4, permit, sequence 10
    Match clauses:
    Set clauses:
    Call clause:
    Action:
      Exit routemap
  BGP:
  route-map TO_BGP_SPEAKER_V4, deny, sequence 10
    Match clauses:
    Set clauses:
    Call clause:
    Action:
      Exit routemap
  BGP:
  route-map ISOLATE, permit, sequence 10
    Match clauses:
    Set clauses:
      as-path prepend 65000
    Call clause:
    Action:
      Exit routemap
  ```


### BGP config commands

This sub-section explains the list of configuration options available for BGP module for both IPv4 and IPv6 BGP neighbors.

**config bgp shutdown all**

This command is used to shutdown all the BGP IPv4 & IPv6 sessions.
When the session is shutdown using this command, BGP state in "show ip bgp summary" is displayed as "Idle (Admin)"

- Usage:
  ```
  config bgp shutdown all
  ```

- Example:
  ```
  admin@sonic:~$ sudo config bgp shutdown all
  ```

**config bgp shutdown neighbor**

This command is to shut down a BGP session with a neighbor by that neighbor's IP address or hostname

- Usage:
  ```
  sudo config bgp shutdown neighbor (<ip_address> | <hostname>)
  ```

- Examples:
  ```
  admin@sonic:~$ sudo config bgp shutdown neighbor 192.168.1.124
  ```
  ```
  admin@sonic:~$ sudo config bgp shutdown neighbor SONIC02SPINE
  ```


**config bgp startup all**

This command is used to start up all the IPv4 & IPv6 BGP neighbors

- Usage:
  ```
  config bgp startup all
  ```

- Example:
  ```
  admin@sonic:~$ sudo config bgp startup all
  ```


**config bgp startup neighbor**

This command is used to start up the particular IPv4 or IPv6 BGP neighbor using either the IP address or hostname.

- Usage:
  ```
  config bgp startup neighbor (<ip-address> | <hostname>)
  ```

- Examples:
  ```
  admin@sonic:~$ sudo config bgp startup neighbor 192.168.1.124
  ```
  ```
  admin@sonic:~$ sudo config bgp startup neighbor SONIC02SPINE
  ```


**config bgp remove neighbor**

This command is used to remove particular IPv4 or IPv6 BGP neighbor configuration using either the IP address or hostname.

- Usage:
  ```
  config bgp remove neighbor <neighbor_ip_or_hostname>
  ```

- Examples:
  ```
  admin@sonic:~$ sudo config bgp remove neighbor 192.168.1.124
  ```
  ```
  admin@sonic:~$ sudo config bgp remove neighbor 2603:10b0:b0f:346::4a
  ```
  ```
  admin@sonic:~$ sudo config bgp remove neighbor SONIC02SPINE
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#bgp)

## Console

This section explains all Console show commands and configuration options that are supported in SONiC.

All commands are used only when SONiC is used as console switch.

All commands under this section are not applicable when SONiC used as regular switch.

### Console show commands

**show line**

This command displays serial port or a virtual network connection status.

- Usage:
  ```
  show line (-b|--breif)
  ```

- Example:
  ```
  admin@sonic:~$ show line
    Line    Baud    Flow Control    PID    Start Time    Device
  ------  ------  --------------  -----  ------------  --------
       1    9600         Enabled      -             -   switch1
       2       -        Disabled      -             -
       3       -        Disabled      -             -
       4       -        Disabled      -             -
       5       -        Disabled      -             -
  ```

Optionally, you can display configured console ports only by specifying the `-b` or `--breif` flag.

- Example:
  ```
  admin@sonic:~$ show line -b
    Line    Baud    Flow Control    PID    Start Time    Device
  ------  ------  --------------  -----  ------------  --------
       1    9600         Enabled      -             -   switch1
  ```

## Console config commands

This sub-section explains the list of configuration options available for console management module.

**config console enable**

This command is used to enable SONiC console switch feature.

- Usage:
  ```
  config console enable
  ```

- Example:
  ```
  admin@sonic:~$ sudo config console enable
  ```

**config console disable**

This command is used to disable SONiC console switch feature.

- Usage:
  ```
  config console disable
  ```

- Example:
  ```
  admin@sonic:~$ sudo config console disable
  ```

**config console add**

This command is used to add a console port setting.

- Usage:
  ```
  config console add <port_name> [--baud|-b <baud_rate>] [--flowcontrol|-f] [--devicename|-d <remote_device>]
  ```

- Example:
  ```
  admin@sonic:~$ config console add 1 --baud 9600 --devicename switch1
  ```

**config console del**

This command is used to remove a console port setting.

- Usage:
  ```
  config console del <port_name>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config console del 1
  ```

**config console remote_device**

This command is used to update the remote device name for a console port.

- Usage:
  ```
  config console remote_device <port_name> <remote_device>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config console remote_device 1 switch1
  ```

**config console baud**

This command is used to update the baud rate for a console port.

- Usage:
  ```
  config console baud <port_name> <baud_rate>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config console baud 1 9600
  ```

**config console flow_control**

This command is used to enable or disable flow control feature for a console port.

- Usage:
  ```
  config console flow_control {enable|disable} <port_name>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config console flow_control enable 1
  ```

### Console connect commands

**connect line**

This command allows user to connect to a remote device via console line with an interactive cli.

- Usage:
  ```
  connect line <target> (-d|--devicename)
  ```

By default, the target is `port_name`.

- Example:
  ```
  admin@sonic:~$ connect line 1
  Successful connection to line 1
  Press ^A ^X to disconnect
  ```

Optionally, you can connect with a remote device name by specifying the `-d` or `--devicename` flag.

- Example:
  ```
  admin@sonic:~$ connect line --devicename switch1
  Successful connection to line 1
  Press ^A ^X to disconnect
  ```

**connect device**

This command allows user to connect to a remote device via console line with an interactive cli.

- Usage:
  ```
  connect device <devicename>
  ```

The command is same with `connect line --devicename <devicename>`

- Example:
  ```
  admin@sonic:~$ connect line 1
  Successful connection to line 1
  Press ^A ^X to disconnect
  ```

### Console clear commands

**sonic-clear line**

This command allows user to connect to a remote device via console line with an interactive cli.

- Usage:
  ```
  sonc-clear line <target> (-d|--devicename)
  ```

By default, the target is `port_name`.

- Example:
  ```
  admin@sonic:~$ sonic-clear line 1
  ```

Optionally, you can clear with a remote device name by specifying the `-d` or `--devicename` flag.

- Example:
  ```
  admin@sonic:~$ sonic-clear --devicename switch1
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#console)


## DHCP Relay

### DHCP Relay config commands

This sub-section of commands is used to add or remove the DHCP Relay Destination IP address(es) for a VLAN interface.

**config vlan dhcp_relay add**

This command is used to add a DHCP Relay Destination IP address to the a VLAN.  Note that more that one DHCP Relay Destination IP address can be added on a VLAN interface.

- Usage:
  ```
  config vlan dhcp_relay add <vlan_id> <dhcp_relay_destination_ip>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config vlan dhcp_relay add 1000 7.7.7.7
  Added DHCP relay destination address 7.7.7.7 to Vlan1000
  Restarting DHCP relay service...
  ```

**config vlan dhcp_relay delete**

This command is used to delete a configured DHCP Relay Destination IP address from a VLAN interface.

- Usage:
  ```
  config vlan dhcp_relay del <vlan-id> <dhcp_relay_destination_ip>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config vlan dhcp_relay del 1000 7.7.7.7
  Removed DHCP relay destination address 7.7.7.7 from Vlan1000
  Restarting DHCP relay service...
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#dhcp-relay)


## Drop Counters

This section explains all the Configurable Drop Counters show commands and configuration options that are supported in SONiC.

### Drop Counters show commands

**show dropcounters capabilities**

This command is used to show the drop counter capabilities that are available on this device. It displays the total number of drop counters that can be configured on this device as well as the drop reasons that can be configured for the counters.

- Usage:
  ```
  show dropcounters capabilities
  ```

- Examples:
  ```
  admin@sonic:~$ show dropcounters capabilities
  Counter Type            Total
  --------------------  -------
  PORT_INGRESS_DROPS          3
  SWITCH_EGRESS_DROPS         2

  PORT_INGRESS_DROPS:
        L2_ANY
        SMAC_MULTICAST
        SMAC_EQUALS_DMAC
        INGRESS_VLAN_FILTER
        EXCEEDS_L2_MTU
        SIP_CLASS_E
        SIP_LINK_LOCAL
        DIP_LINK_LOCAL
        UNRESOLVED_NEXT_HOP
        DECAP_ERROR

  SWITCH_EGRESS_DROPS:
        L2_ANY
        L3_ANY
        A_CUSTOM_REASON
  ```

**show dropcounters configuration**

This command is used to show the current running configuration of the drop counters on this device.

- Usage:
  ```
  show dropcounters configuration [-g <group name>]
  ```

- Examples:
  ```
  admin@sonic:~$ show dropcounters configuration
  Counter   Alias     Group  Type                 Reasons              Description
  --------  --------  -----  ------------------   -------------------  --------------
  DEBUG_0   RX_LEGIT  LEGIT  PORT_INGRESS_DROPS   SMAC_EQUALS_DMAC     Legitimate port-level RX pipeline drops
                                                  INGRESS_VLAN_FILTER
  DEBUG_1   TX_LEGIT  None   SWITCH_EGRESS_DROPS  EGRESS_VLAN_FILTER   Legitimate switch-level TX pipeline drops

  admin@sonic:~$ show dropcounters configuration -g LEGIT
  Counter   Alias     Group  Type                 Reasons              Description
  --------  --------  -----  ------------------   -------------------  --------------
  DEBUG_0   RX_LEGIT  LEGIT  PORT_INGRESS_DROPS   SMAC_EQUALS_DMAC     Legitimate port-level RX pipeline drops
                                                  INGRESS_VLAN_FILTER
  ```

**show dropcounters counts**

This command is used to show the current statistics for the configured drop counters. Standard drop counters are displayed as well for convenience.

Because clear (see below) is handled on a per-user basis different users may see different drop counts.

- Usage:
  ```
  show dropcounters counts [-g <group name>] [-t <counter type>]
  ```

- Example:
  ```
  admin@sonic:~$ show dropcounters counts
      IFACE    STATE    RX_ERR    RX_DROPS    TX_ERR    TX_DROPS   RX_LEGIT
  ---------  -------  --------  ----------  --------  ----------  ---------
  Ethernet0        U        10         100         0           0         20
  Ethernet4        U         0        1000         0           0        100
  Ethernet8        U       100          10         0           0          0

  DEVICE  TX_LEGIT
  ------  --------
  sonic       1000

  admin@sonic:~$ show dropcounters counts -g LEGIT
      IFACE    STATE    RX_ERR    RX_DROPS    TX_ERR    TX_DROPS   RX_LEGIT
  ---------  -------  --------  ----------  --------  ----------  ---------
  Ethernet0        U        10         100         0           0         20
  Ethernet4        U         0        1000         0           0        100
  Ethernet8        U       100          10         0           0          0

  admin@sonic:~$ show dropcounters counts -t SWITCH_EGRESS_DROPS
  DEVICE  TX_LEGIT
  ------  --------
  sonic       1000
  ```

### Drop Counters config commands

**config dropcounters install**

This command is used to initialize a new drop counter. The user must specify a name, type, and initial list of drop reasons.

This command will fail if the given name is already in use, if the type of counter is not supported, or if any of the specified drop reasons are not supported. It will also fail if all avaialble counters are already in use on the device.

- Usage:
  ```
  config dropcounters install <counter name> <counter type> <reasons list> [-d <description>] [-g <group>] [-a <alias>]
  ```

- Example:
  ```
  admin@sonic:~$ sudo config dropcounters install DEBUG_2 PORT_INGRESS_DROPS [EXCEEDS_L2_MTU,DECAP_ERROR] -d "More port ingress drops" -g BAD -a BAD_DROPS
  ```

**config dropcounters add_reasons**

This command is used to add drop reasons to an already initialized counter.

This command will fail if any of the specified drop reasons are not supported.

- Usage:
  ```
  config dropcounters add_reasons <counter name> <reasons list>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config dropcounters add_reasons DEBUG_2 [SIP_CLASS_E]
  ```

**config dropcounters remove_reasons**

This command is used to remove drop reasons from an already initialized counter.

- Usage:
  ```
  config dropcounters remove_reasons <counter name> <reasons list>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config dropcounters remove_reasons DEBUG_2 [SIP_CLASS_E]
  ```

**config dropcounters delete**

This command is used to delete a drop counter.

- Usage:
  ```
  config dropcounters delete <counter name>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config dropcounters delete DEBUG_2
  ```

### Drop Counters clear commands

**sonic-clear dropcounters**

This comnmand is used to clear drop counters. This is done on a per-user basis.

- Usage:
  ```
  sonic-clear dropcounters
  ```

- Example:
  ```
  admin@sonic:~$ sonic-clear dropcounters
  Cleared drop counters
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](##drop-counters)

## Dynamic Buffer Management

This section explains all the show and configuration commands regarding the dynamic buffer management.

Dynamic buffer management is responsible for calculating buffer size according to the ports' configured speed and administrative state. In order to enable dynamic buffer management feature, the ports' speed must be configured. For this please refer [Interface naming mode config commands](#interface-naming-mode-config-commands)

### Configuration commands

**configure shared headroom pool**

This command is used to configure the shared headroom pool. The shared headroom pool can be enabled in the following ways:

- Configure the over subscribe ratio. In this case, the size of shared headroom pool is calculated as the accumulative xoff of all of the lossless PG divided by the over subscribe ratio.
- Configure the size.

In case both of the above parameters have been configured, the `size` will take effect. To disable shared headroom pool, configure both parameters to zero.

- Usage:

  ```
  config buffer shared-headroom-pool over-subscribe-ratio <over-subscribe-ratio>
  config buffer shared-headroom-pool size <size>
  ```

  The range of over-subscribe-ratio is from 1 to number of ports inclusive.

- Example:

  ```
  admin@sonic:~$ sudo config shared-headroom-pool over-subscribe-ratio 2
  admin@sonic:~$ sudo config shared-headroom-pool size 1024000
  ```

**configure a lossless buffer profile**

This command is used to configure a lossless buffer profile.

- Usage:

  ```
  config buffer profile add <profile_name> --xon <xon_threshold> --xoff <xoff_threshold> [-size <size>] [-dynamic_th <dynamic_th_value>] [-pool <ingress_lossless_pool_name>]
  config buffer profile set <profile_name> --xon <xon_threshold> --xoff <xoff_threshold> [-size <size>] [-dynamic_th <dynamic_th_value>] [-pool <ingress_lossless_pool_name>]
  config buffer profile remove <profile_name>
  ```

  All the parameters are devided to two groups, one for headroom and one for dynamic_th. For any command at lease one group of parameters should be provided.
  For headroom parameters:

  - `xon` is madantory.
  - If shared headroom pool is disabled:
    - At lease one of `xoff` and `size` should be provided and the other will be optional and conducted via the formula `xon + xoff = size`.
    - `xon` + `xoff` <= `size`; For Mellanox platform xon + xoff == size
  - If shared headroom pool is enabled:
    - `xoff` should be provided.
    - `size` = `xoff` if it is not provided.

  If only headroom parameters are provided, the `dynamic_th` will be taken from `CONFIG_DB.DEFAULT_LOSSLESS_BUFFER_PARAMETER.default_dynamic_th`.

  If only dynamic_th parameter is provided, the `headroom_type` will be set as `dynamic` and `xon`, `xoff` and `size` won't be set. This is only used for non default dynamic_th. In this case, the profile won't be deployed to ASIC directly. It can be configured to a lossless PG and then a dynamic profile will be generated based on the port's speed, cable length, and MTU and deployed to the ASIC.

  The subcommand `add` is designed for adding a new buffer profile to the system.

  The subcommand `set` is designed for modifying an existing buffer profile in the system.
  For a profile with dynamically calculated headroom information, only `dynamic_th` can be modified. 

  The subcommand `remove` is designed for removing an existing buffer profile from the system. When removing a profile, it shouldn't be referenced by any entry in `CONFIG_DB.BUFFER_PG`.

- Example:

  ```
  admin@sonic:~$ sudo config buffer profile add profile1 --xon 18432 --xoff 18432
  admin@sonic:~$ sudo config buffer profile remove profile1
  ```

**config interface cable_length**

This command is used to configure the length of the cable connected to a port. The cable_length is in unit of meters and must be suffixed with "m".

- Usage:

  ```
  config interface cable_length <interface_name> <cable_length>
  ```

- Example:

  ```
  admin@sonic:~$ sudo config interface cable_length Ethernet0 40m
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#dynamic-buffer-management)

**config interface buffer priority-group lossless**

This command is used to configure the priority groups on which lossless traffic runs.

- Usage:

  ```
  config interface buffer priority-group lossless add <interface_name> <pg_map> [profile]
  config interface buffer priority-group lossless set <interface_name> <pg_map> [profile]
  config interface buffer priority-group lossless remove <interface_name> [<pg_map>]
  ```

  The <pg_map> can be in one of the following two forms:

  - For a range of priorities, the lower bound and upper bound connected by a dash, like `3-4`
  - For a single priority, the number, like `6`

  The `pg-map` represents the map of priorities for lossless traffic. It should be a string and in form of a bit map like `3-4`. The `-` connects the lower bound and upper bound of a range of priorities.

  The subcommand `add` is designed for adding a new lossless PG on top of current PGs. The new PG range must be disjoint with all existing PGs.

  For example, currently the PG range 3-4 exist on port Ethernet4, to add PG range 4-5 will fail because it isn't disjoint with 3-4. To add PG range 5-6 will succeed. After that both range 3-4 and 5-6 will work as lossless PG.

  The `override-profile` parameter is optional. When provided, it represents the predefined buffer profile for headroom override.

  The subcommand `set` is designed for modifying an existing PG from dynamic calculation to headroom override or vice versa. The `pg-map` must be an existing PG.

  The subcommand `remove` is designed for removing an existing PG. The option `pg-map` must be an existing PG. All lossless PGs will be removed in case no `pg-map` provided.

- Example:

  To configure lossless_pg on a port:

  ```
  admin@sonic:~$ sudo config interface buffer priority-group lossless add Ethernet0 3-4
  ```

  To change the profile used for lossless_pg on a port:

  ```
  admin@sonic:~$ sudo config interface buffer priority-group lossless set Ethernet0 3-4 new-profile
  ```

  To remove one lossless priority from a port:

  ```
  admin@sonic:~$ sudo config interface buffer priority-group lossless remove Ethernet0 6
  ```

  To remove all lossless priorities from a port:

  ```
  admin@sonic:~$ sudo config interface buffer priority-group lossless remove Ethernet0
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#dynamic-buffer-management)

### Show commands

**show buffer information**

This command is used to display the status of buffer pools and profiles currently deployed to the ASIC.

- Usage:

  ```
  show buffer information
  ```

- Example:

  ```
  admin@sonic:~$ show buffer information
  Pool: ingress_lossless_pool
  ----  --------
  type  ingress
  mode  dynamic
  size  17170432
  ----  --------

  Pool: egress_lossless_pool
  ----  --------
  type  egress
  mode  dynamic
  size  34340822
  ----  --------

  Pool: ingress_lossy_pool
  ----  --------
  type  ingress
  mode  dynamic
  size  17170432
  ----  --------

  Pool: egress_lossy_pool
  ----  --------
  type  egress
  mode  dynamic
  size  17170432
  ----  --------

  Profile: pg_lossless_100000_5m_profile
  ----------  -----------------------------------
  xon         18432
  dynamic_th  0
  xoff        18432
  pool        [BUFFER_POOL:ingress_lossless_pool]
  size        36864
  ----------  -----------------------------------

  Profile: q_lossy_profile
  ----------  -------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL:egress_lossy_pool]
  size        0
  ----------  -------------------------------

  Profile: egress_lossy_profile
  ----------  -------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL:egress_lossy_pool]
  size        4096
  ----------  -------------------------------

  Profile: egress_lossless_profile
  ----------  ----------------------------------
  dynamic_th  7
  pool        [BUFFER_POOL:egress_lossless_pool]
  size        0
  ----------  ----------------------------------

  Profile: ingress_lossless_profile
  ----------  -----------------------------------
  dynamic_th  0
  pool        [BUFFER_POOL:ingress_lossless_pool]
  size        0
  ----------  -----------------------------------

  Profile: pg_lossless_100000_79m_profile
  ----------  -----------------------------------
  xon         18432
  dynamic_th  0
  xoff        60416
  pool        [BUFFER_POOL:ingress_lossless_pool]
  size        78848
  ----------  -----------------------------------

  Profile: pg_lossless_100000_40m_profile
  ----------  -----------------------------------
  xon         18432
  dynamic_th  0
  xoff        38912
  pool        [BUFFER_POOL:ingress_lossless_pool]
  size        57344
  ----------  -----------------------------------

  Profile: ingress_lossy_profile
  ----------  --------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL:ingress_lossy_pool]
  size        0
  ----------  --------------------------------
  ```

**show buffer configuration**

This command is used to display the status of buffer pools and profiles currently configured.

- Usage:

  ```
  show buffer configuration
  ```

- Example:

  ```
  admin@sonic:~$ show buffer configuration
  Lossless traffic pattern:
  --------------------  -
  default_dynamic_th    0
  over_subscribe_ratio  0
  --------------------  -

  Pool: ingress_lossless_pool
  ----  --------
  type  ingress
  mode  dynamic
  ----  --------

  Pool: egress_lossless_pool
  ----  --------
  type  egress
  mode  dynamic
  size  34340822
  ----  --------

  Pool: ingress_lossy_pool
  ----  --------
  type  ingress
  mode  dynamic
  ----  --------

  Pool: egress_lossy_pool
  ----  --------
  type  egress
  mode  dynamic
  ----  --------

  Profile: q_lossy_profile
  ----------  -------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL:egress_lossy_pool]
  size        0
  ----------  -------------------------------

  Profile: egress_lossy_profile
  ----------  -------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL:egress_lossy_pool]
  size        4096
  ----------  -------------------------------

  Profile: egress_lossless_profile
  ----------  ----------------------------------
  dynamic_th  7
  pool        [BUFFER_POOL:egress_lossless_pool]
  size        0
  ----------  ----------------------------------

  Profile: ingress_lossless_profile
  ----------  -----------------------------------
  dynamic_th  0
  pool        [BUFFER_POOL:ingress_lossless_pool]
  size        0
  ----------  -----------------------------------

  Profile: ingress_lossy_profile
  ----------  --------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL:ingress_lossy_pool]
  size        0
  ----------  --------------------------------
  ```

## ECN

This section explains all the Explicit Congestion Notification (ECN) show commands and ECN configuation options that are supported in SONiC.

### ECN show commands
This sub-section contains the show commands that are supported in ECN.

**show ecn**

This command displays all the WRED profiles that are configured in the device.

- Usage:
  ```
  show ecn
  ```

- Example:
  ```
  admin@sonic:~$ show ecn
  Profile: **AZURE_LOSSLESS**
  -----------------------  -------
  red_max_threshold        2097152
  red_drop_probability     5
  yellow_max_threshold     2097152
  ecn                      ecn_all
  green_min_threshold      1048576
  red_min_threshold        1048576
  wred_yellow_enable       true
  yellow_min_threshold     1048576
  green_max_threshold      2097152
  green_drop_probability   5
  wred_green_enable        true
  yellow_drop_probability  5
  wred_red_enable          true
  -----------------------  -------

  Profile: **wredprofileabcd**
  -----------------  ---
  red_max_threshold  100
  -----------------  ---
  ```

### ECN config commands

This sub-section contains the configuration commands that can configure the WRED profiles.

**config ecn**

This command configures the possible fields in a particular WRED profile that is specified using "-profile <profilename>" argument.
The list of the WRED profile fields that are configurable is listed in the below "Usage".

- Usage:
  ```
  config ecn -profile <profile_name> [-rmax <red_threshold_max>] [-rmin <red_threshold_min>] [-ymax <yellow_threshold_max>] [-ymin <yellow_threshold_min>] [-gmax <green_threshold_max>] [-gmin <green_threshold_min>] [-v|--verbose]
  ```

  - Parameters:
    - profile_name          Profile name
    - red_threshold_max     Set red max threshold
    - red_threshold_min     Set red min threshold
    - yellow_threshold_max  Set yellow max threshold
    - yellow_threshold_min  Set yellow min threshold
    - green_threshold_max   Set green max threshold
    - green_threshold_min   Set green min threshold

- Example (Configures the "red max threshold" for the WRED profile name "wredprofileabcd". It will create the WRED profile if it does not exist.):
  ```
  admin@sonic:~$ sudo config ecn -profile wredprofileabcd -rmax 100
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#ecn)

## Feature 

SONiC includes a capability in which Feature state can be enabled/disabled
which will make corresponding feature docker container to start/stop.

Also SONiC provide capability in which Feature docker container can be automatically shut
down and restarted if one of critical processes running in the container exits
unexpectedly. Restarting the entire feature container ensures that configuration is 
reloaded and all processes in the feature container get restarted, thus increasing the
likelihood of entering a healthy state.

### Feature show commands

**show feature config**

Shows the config of given feature or all if no feature is given. The "fallback" is shown only if configured. The fallback defaults to "true" when not configured.

- Usage:
  ```
  show feature config [<feature name>]
  ```

- Example:
  ```
  admin@sonic:~$ show feature config
  Feature         State     AutoRestart    Owner    fallback
  --------------  --------  -------------  -------  ----------
  bgp             enabled   enabled        local
  database        enabled   disabled       local
  dhcp_relay      enabled   enabled        kube
  lldp            enabled   enabled        kube     true
  mgmt-framework  enabled   enabled        local
  nat             disabled  enabled        local
  pmon            enabled   enabled        kube
  radv            enabled   enabled        kube
  sflow           disabled  enabled        local
  snmp            enabled   enabled        kube
  swss            enabled   enabled        local
  syncd           enabled   enabled        local
  teamd           enabled   enabled        local
  telemetry       enabled   enabled        kube
  ```

**show feature status**

Shows the status of given feature or all if no feature is given. The "fallback" defaults to "true" when not configured.
The subset of features are configurable for remote management and only those report additional data.

- Usage:
  ```
  show feature status [<feature name>]
  ```

- Example:
  ```
  admin@sonic:~$ show feature status
  Feature         State     AutoRestart    SystemState    UpdateTime           ContainerId    ContainerVersion    SetOwner    CurrentOwner    RemoteState
  --------------  --------  -------------  -------------  -------------------  -------------  ------------------  ----------  --------------  -------------
  bgp             enabled   enabled        up                                                                     local       local           none
  database        enabled   disabled                                                                              local
  dhcp_relay      enabled   enabled        up             2020-11-15 18:21:09  249e70102f55   20201230.100        kube        local
  lldp            enabled   enabled        up             2020-11-15 18:21:09  779c2d55ee12   20201230.100        kube        local
  mgmt-framework  enabled   enabled        up                                                                     local       local           none
  nat             disabled  enabled                                                                               local
  pmon            enabled   enabled        up             2020-11-15 18:20:27  a2b9ffa8aba3   20201230.100        kube        local
  radv            enabled   enabled        up             2020-11-15 18:21:05  d8ff27dcfe46   20201230.100        kube        local
  sflow           disabled  enabled                                                                               local
  snmp            enabled   enabled        up             2020-11-15 18:25:51  8b7d5529e306   20201230.111        kube        kube            running
  swss            enabled   enabled        up                                                                     local       local           none
  syncd           enabled   enabled        up                                                                     local       local           none
  teamd           enabled   enabled        up                                                                     local       local           none
  telemetry       enabled   enabled        down           2020-11-15 18:24:59                 20201230.100        kube        none
  ```

**config feature owner**

Configures the owner for a feature as "local" or  "kube". The "local" implies starting the feature container from local image. The "kube" implies that kubernetes server is made eligible to deploy the feature. The deployment of a feature by kubernetes is conditional based on many factors like, whether the kube server is configured or not, connected-to-kube-server or not and if that master has manifest for this feature for this switch or not and more. At some point in future, the deployment *could* happen and till that point the feature can run from local image, called "fallback". The fallback is allowed by default and it could be toggled to "not allowed". When fallback is not allowed, the feature would run only upon deployment by kubernetes master.

- Usage:
  ```
  config feature owner [<feature name>] [local/kube]
  ```

- Example:
  ```
  admin@sonic:~$ sudo config feature owner snmp kube
  ```

**config feature fallback**

Features configured for "kube" deployment could be allowed to fallback to using local image, until the point of successful kube deployment. The fallback is allowed by default.

- Usage:
  ```
  config feature fallback [<feature name>] [on/off]
  ```

- Example:
  ```
  admin@sonic:~$ sudo config feature fallback snmp on
  ```

**show feature autorestart**

This command will display the status of auto-restart for feature container.

- Usage:
  ```
  show feature autorestart [<feature_name>]
  admin@sonic:~$ show feature autorestart
  Feature     AutoRestart
  ----------  --------------
  bgp         enabled
  database    always_enabled
  dhcp_relay  enabled
  lldp        enabled
  pmon        enabled
  radv        enabled
  snmp        enabled
  swss        enabled
  syncd       enabled
  teamd       enabled
  telemetry   enabled
  ```

Optionally, you can specify a feature name in order to display
status for that feature

### Feature config commands

**config feature state <feature_name> <state>**

This command will configure the state for a specific feature.

- Usage:
  ```
  config feature state <feature_name> (enabled | disabled)
  admin@sonic:~$ sudo config feature state bgp disabled
  ``` 

**config feature autorestart <feature_name> <autorestart_status>**

This command will configure the status of auto-restart for a specific feature container.

- Usage:
  ```
  config feature autorestart <feature_name> (enabled | disabled)
  admin@sonic:~$ sudo config feature autorestart bgp disabled
  ``` 
NOTE: If the existing state or auto-restart value for a feature is "always_enabled" then config
commands are don't care and will not update state/auto-restart value.

Go Back To [Beginning of the document](#) or [Beginning of this section](#feature)

## Gearbox

This section explains all the Gearbox PHY show commands that are supported in SONiC.

### Gearbox show commands
This sub-section contains the show commands that are supported for gearbox phy.

**show gearbox interfaces status**

This command displays information about the gearbox phy interface lanes, speeds and status. Data is displayed for both MAC side and line side of the gearbox phy

- Usage:
  ```
  show gearbox interfaces status
  ```

- Example:

```
home/admin# show gearbox interfaces status
  PHY Id    Interface    MAC Lanes    MAC Lane Speed    PHY Lanes    PHY Lane Speed    Line Lanes    Line Lane Speed    Oper    Admin
--------  -----------  -----------  ----------------  -----------  ----------------  ------------  -----------------  ------  -------
       1    Ethernet0  25,26,27,28               10G      200,201               20G           206                40G      up       up
       1    Ethernet4  29,30,31,32               10G      202,203               20G           207                40G      up       up
       1    Ethernet8  33,34,35,36               10G      204,205               20G           208                40G      up       up

  ```

**show gearbox phys status**

This command displays basic information about the gearbox phys configured on the switch. 

- Usage:
  ```
  show gearbox phys status
  ```

- Example:

```
/home/admin# show gearbox phys status
  PHY Id     Name    Firmware
--------  -------  ----------
       1  sesto-1        v0.1

  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#gearbox)


## Update Device Hostname Configuration Commands

This sub-section of commands is used to change device hostname without traffic being impacted.

**config hostname**

This command is used to change device hostname without traffic being impacted.

- Usage:
  ```
  config hostname <new_hostname>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config hostname CSW06
  Please note loaded setting will be lost after system reboot. To preserve setting, run `config save`.
  ```

## Interfaces

### Interface Show Commands

This sub-section lists all the possible show commands for the interfaces available in the device. Following example gives the list of possible shows on interfaces.
Subsequent pages explain each of these commands in detail.

- Example:
  ```
  admin@sonic:~$ show interfaces -?

  Show details of the network interfaces

  Options:
    -?, -h, --help  Show this message and exit.

  Commands:
  breakout     Show Breakout Mode information by interfaces
  counters     Show interface counters
  description  Show interface status, protocol and...
  naming_mode  Show interface naming_mode status
  neighbor     Show neighbor related information
  portchannel  Show PortChannel information
  status       Show Interface status information
  transceiver  Show SFP Transceiver information
  ```

**show interfaces breakout**

This show command displays the port capability for all interfaces i.e. index, lanes, default_brkout_mode, breakout_modes(i.e. all the available breakout modes) and brkout_mode (i.e. current breakout mode). To display current breakout mode, "current-mode" subcommand can be used.For a single interface, provide the interface name with the sub-command.

- Usage:
  ```
  show interfaces breakout
  show interfaces breakout current-mode
  show interfaces breakout current-mode <interface_name>
  ```

- Example:
  ```
  admin@lnos-x1-a-fab01:~$ show interfaces  breakout
  {
      "Ethernet0": {
          "index": "1,1,1,1",
          "default_brkout_mode": "1x100G[40G]",
          "child ports": "Ethernet0",
          "child port speed": "100G",
          "breakout_modes": "1x100G[40G],2x50G,4x25G[10G]",
          "Current Breakout Mode": "1x100G[40G]",
          "lanes": "65,66,67,68",
          "alias_at_lanes": "Eth1/1, Eth1/2, Eth1/3, Eth1/4"
      },... continue
  }
  ```
The "current-mode" subcommand is used to display current breakout mode for all interfaces.
  ```
  admin@lnos-x1-a-fab01:~$ show interfaces  breakout current-mode
  +-------------+-------------------------+
  | Interface   | Current Breakout Mode   |
  +=============+=========================+
  | Ethernet0   | 4x25G[10G]              |
  +-------------+-------------------------+
  | Ethernet4   | 4x25G[10G]              |
  +-------------+-------------------------+
  | Ethernet8   | 4x25G[10G]              |
  +-------------+-------------------------+
  | Ethernet12  | 4x25G[10G]              |
  +-------------+-------------------------+

  admin@lnos-x1-a-fab01:~$ show interfaces  breakout current-mode Ethernet0
  +-------------+-------------------------+
  | Interface   | Current Breakout Mode   |
  +=============+=========================+
  | Ethernet0   | 4x25G[10G]              |
  +-------------+-------------------------+
  ```

**show interfaces counters**

This show command displays packet counters for all interfaces since the last time the counters were cleared. To display l3 counters "rif" subcommand can be used. There is no facility to display counters for one specific l2 interface. For l3 interfaces a single interface output mode is present. Optional argument "-a" provides two additional columns - RX-PPS and TX_PPS.
Optional argument "-p" specify a period (in seconds) with which to gather counters over.

- Usage:
  ```
  show interfaces counters [-a|--printall] [-p|--period <period>]
  show interfaces counters errors
  show interfaces counters rates 
  show interfaces counters rif [-p|--period <period>] [-i <interface_name>]
  ```

- Example:
  ```
  admin@sonic:~$ show interfaces counters
        IFACE    STATE            RX_OK       RX_BPS    RX_UTIL    RX_ERR    RX_DRP    RX_OVR            TX_OK       TX_BPS    TX_UTIL    TX_ERR    TX_DRP    TX_OVR
  -----------  -------  ---------------  -----------  ---------  --------  --------  --------  ---------------  -----------  ---------  --------  --------  --------
    Ethernet0        U  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        U  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        U  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        U  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        U   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        U   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        U   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

  admin@sonic:~$ show interfaces counters -i Ethernet4,Ethernet12-16
        IFACE    STATE            RX_OK       RX_BPS    RX_UTIL    RX_ERR    RX_DRP    RX_OVR            TX_OK       TX_BPS    TX_UTIL    TX_ERR    TX_DRP    TX_OVR
  -----------  -------  ---------------  -----------  ---------  --------  --------  --------  ---------------  -----------  ---------  --------  --------  --------
    Ethernet4        U  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
   Ethernet12        U  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        U   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
  ```

The "errors" subcommand is used to display the interface errors. 

- Example:
  ```
  admin@str-s6000-acs-11:~$ show interface counters errors
      IFACE    STATE    RX_ERR    RX_DRP    RX_OVR    TX_ERR    TX_DRP    TX_OVR
  -----------  -------  --------  --------  --------  --------  --------  --------
    Ethernet0        U         0         4         0         0         0         0
    Ethernet4        U         0         0         0         0         0         0
    Ethernet8        U         0         1         0         0         0         0
   Ethernet12        U         0         0         0         0         0         0
   ```

The "rates" subcommand is used to disply only the interface rates. 

- Exmaple: 
  ```
  admin@str-s6000-acs-11:/usr/bin$ show int counters rates
      IFACE    STATE    RX_OK    RX_BPS    RX_PPS    RX_UTIL    TX_OK    TX_BPS    TX_PPS    TX_UTIL
  -----------  -------  -------  --------  --------  ---------  -------  --------  --------  ---------
    Ethernet0        U   467510       N/A       N/A        N/A   466488       N/A       N/A        N/A
    Ethernet4        U   469679       N/A       N/A        N/A   469245       N/A       N/A        N/A
    Ethernet8        U   466660       N/A       N/A        N/A   465982       N/A       N/A        N/A
   Ethernet12        U   466579       N/A       N/A        N/A   466318       N/A       N/A        N/A
   ```


The "rif" subcommand is used to display l3 interface counters. Layer 3 interfaces include router interfaces, portchannels and vlan interfaces.

- Example:

```
  admin@sonic:~$ show interfaces counters rif
          IFACE    RX_OK      RX_BPS    RX_PPS    RX_ERR    TX_OK    TX_BPS    TX_PPS    TX_ERR
---------------  -------  ----------  --------  --------  -------  --------  --------  --------
PortChannel0001   62,668  107.81 B/s    1.34/s         3        6  0.02 B/s    0.00/s         0
PortChannel0002   62,645  107.77 B/s    1.34/s         3        2  0.01 B/s    0.00/s         0
PortChannel0003   62,481  107.56 B/s    1.34/s         3        3  0.01 B/s    0.00/s         0
PortChannel0004   62,732  107.88 B/s    1.34/s         2        3  0.01 B/s    0.00/s         0
       Vlan1000        0    0.00 B/s    0.00/s         0        0  0.00 B/s    0.00/s         0
```


Optionally, you can specify a layer 3 interface name to display the counters in single interface mode.

- Example:

```
  admin@sonic:~$ show interfaces counters rif PortChannel0001
  PortChannel0001
  ---------------

          RX:
                3269 packets
              778494 bytesq
                   3 error packets
                 292 error bytes
          TX:
                   0 packets
                   0 bytes
                   0 error packets
                   0 error bytes
```


Optionally, you can specify a period (in seconds) with which to gather counters over. Note that this function will take `<period>` seconds to execute.

- Example:

```
  admin@sonic:~$ show interfaces counters -p 5
        IFACE    STATE    RX_OK       RX_BPS    RX_UTIL    RX_ERR    RX_DRP    RX_OVR    TX_OK       TX_BPS    TX_UTIL    TX_ERR    TX_DRP    TX_OVR
  -----------  -------  -------  -----------  ---------  --------  --------  --------  -------  -----------  ---------  --------  --------  --------
  Ethernet0         U      515   59.14 KB/s      0.00%         0         0         0    1,305  127.60 KB/s      0.00%         0         0         0
  Ethernet4         U      305   26.54 KB/s      0.00%         0         0         0      279   39.12 KB/s      0.00%         0         0         0
  Ethernet8         U      437   42.96 KB/s      0.00%         0         0         0      182   18.37 KB/s      0.00%         0         0         0
  Ethernet12        U      284   40.79 KB/s      0.00%         0         0         0      160   13.03 KB/s      0.00%         0         0         0
  Ethernet16        U      377   32.64 KB/s      0.00%         0         0         0      214   18.01 KB/s      0.00%         0         0         0
  Ethernet20        U      284   36.81 KB/s      0.00%         0         0         0      138  8758.25 B/s      0.00%         0         0         0
  Ethernet24        U      173   16.09 KB/s      0.00%         0         0         0      169   11.39 KB/s      0.00%         0         0         0
```

- NOTE: Interface counters can be cleared by the user with the following command:

  ```
  admin@sonic:~$ sonic-clear counters
  ```

- NOTE: Layer 3 interface counters can be cleared by the user with the following command:

  ```
  admin@sonic:~$ sonic-clear rifcounters
  ```

**show interfaces description**

This command displays the key fields of the interfaces such as Operational Status, Administrative Status, Alias and Description.

- Usage:
  ```
  show interfaces description [<interface_name>]
  ```

- Example:
  ```
  admin@sonic:~$ show interfaces description
  Interface    Oper    Admin            Alias           Description
  -----------  ------  -------  ---------------  --------------------
  Ethernet0    down       up   hundredGigE1/1  T0-1:hundredGigE1/30
  Ethernet4    down       up   hundredGigE1/2  T0-2:hundredGigE1/30
  Ethernet8    down     down   hundredGigE1/3        hundredGigE1/3
  Ethernet12   down     down   hundredGigE1/4        hundredGigE1/4
  ```

- Example (to only display the description for interface Ethernet4):

  ```
  admin@sonic:~$ show interfaces description Ethernet4
  Interface    Oper    Admin           Alias           Description
  -----------  ------  -------  --------------  --------------------
  Ethernet4    down       up  hundredGigE1/2  T0-2:hundredGigE1/30
  ```

**show interfaces naming_mode**

Refer sub-section [Interface-Naming-Mode](#Interface-Naming-Mode)


**show interfaces neighbor**

This command is used to display the list of expected neighbors for all interfaces (or for a particular interface) that is configured.

- Usage:
  ```
  show interfaces neighbor expected [<interface_name>]
  ```

- Example:
  ```
  admin@sonic:~$ show interfaces neighbor expected
  LocalPort    Neighbor    NeighborPort    NeighborLoopback    NeighborMgmt    NeighborType
  -----------  ----------  --------------  ------------------  --------------  --------------
  Ethernet112  ARISTA01T1  Ethernet1       None                10.16.205.100   ToRRouter
  Ethernet116  ARISTA02T1  Ethernet1       None                10.16.205.101   SpineRouter
  Ethernet120  ARISTA03T1  Ethernet1       None                10.16.205.102   LeafRouter
  Ethernet124  ARISTA04T1  Ethernet1       None                10.16.205.103   LeafRouter
  ```

**show interfaces portchannel**

This command displays information regarding port-channel interfaces

- Usage:
  ```
  show interfaces portchannel
  ```

- 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)
     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 interface status**

This command displays some more fields such as Lanes, Speed, MTU, Type, Asymmetric PFC status and also the operational and administrative status of the interfaces

- Usage:
  ```
  show interfaces status [<interface_name>]
  ```

- Example (show interface status of all interfaces):
  ```
  admin@sonic:~$ show interfaces status
  Interface            Lanes    Speed    MTU            Alias    Oper    Admin    Type    Asym PFC
  -----------  ---------------  -------  -----  ---------------  ------  -------  ------  ----------
  Ethernet0      49,50,51,52     100G   9100   hundredGigE1/1    down       up     N/A         off
  Ethernet4      53,54,55,56     100G   9100   hundredGigE1/2    down       up     N/A         off
  Ethernet8      57,58,59,60     100G   9100   hundredGigE1/3    down     down     N/A         off
  <contiues to display all the interfaces>
  ```

- Example (to only display the status for interface Ethernet0):
  ```
  admin@sonic:~$ show interface status Ethernet0
  Interface     Lanes    Speed    MTU            Alias    Oper    Admin
  -----------  --------  -------  -----   --------------  ------  -------
  Ethernet0   101,102      40G   9100   fortyGigE1/1/1      up       up
  ```

- Example (to only display the status for range of interfaces):
  ```
  admin@sonic:~$ show interfaces status Ethernet8,Ethernet168-180
  Interface              Lanes    Speed    MTU            Alias     Oper    Admin    Type   Asym PFC
  -----------  -----------------  -------  -----  ---------------  ------  -------  ------  ----------
    Ethernet8      49,50,51,52     100G    9100    hundredGigE3     down     down     N/A         N/A
  Ethernet168       9,10,11,12     100G    9100    hundredGigE43    down     down     N/A         N/A
  Ethernet172      13,14,15,16     100G    9100    hundredGigE44    down     down     N/A         N/A
  Ethernet176  109,110,111,112     100G    9100    hundredGigE45    down     down     N/A         N/A
  Ethernet180  105,106,107,108     100G    9100    hundredGigE46    down     down     N/A         N/A
  ```

**show interfaces transceiver**

This command is already explained [here](#Transceivers)

### Interface Config Commands
This sub-section explains the following list of configuration on the interfaces.
1) ip - To add or remove IP address for the interface
2) pfc - to set the PFC configuration for the interface
3) shutdown - to administratively shut down the interface
4) speed - to set the interface speed
5) startup - to bring up the administratively shutdown interface
6) breakout - to set interface breakout mode

From 201904 release onwards, the “config interface” command syntax is changed and the format is as follows:

- config interface interface_subcommand <interface_name>
i.e Interface name comes after the subcommand
- Ex: config interface startup Ethernet63

The syntax for all such interface_subcommands are given below under each command

NOTE: In older versions of SONiC until 201811 release, the command syntax was `config interface <interface_name> interface_subcommand`


**config interface ip add <interface_name> <ip_addr> [default_gw] (Versions >= 201904)**

**config interface <interface_name> ip add <ip_addr> (Versions <= 201811)**

This command is used for adding the IP address for an interface.
IP address for either physical interface or for portchannel or for VLAN interface or for Loopback interface can be configured using this command. 
While configuring the IP address for the management interface "eth0", users can provide the default gateway IP address as an optional parameter from release 201911. 


- Usage:

  *Versions >= 201904*
  ```
  config interface ip add <interface_name> <ip_addr>
  ```
  *Versions <= 201811*
  ```
  config interface <interface_name> ip add <ip_addr>
  ```

- Example:

  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface ip add Ethernet63 10.11.12.13/24
  admin@sonic:~$ sudo config interface ip add eth0 20.11.12.13/24 20.11.12.254
  ```
  *Versions <= 201811*
  ```
  admin@sonic:~$ sudo config interface Ethernet63 ip add 10.11.12.13/24
  ```

VLAN interface names take the form of `vlan<vlan_id>`. E.g., VLAN 100 will be named `vlan100`

- Example:

  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface ip add Vlan100 10.11.12.13/24
  ```
  *Versions <= 201811*
  ```
  admin@sonic:~$ sudo config interface vlan100 ip add 10.11.12.13/24
  ```


**config interface ip remove <interface_name> <ip_addr> (Versions >= 201904)**

**config interface <interface_name> ip remove <ip_addr> (Versions <= 201811)**

- Usage:

  *Versions >= 201904*
  ```
  config interface ip remove <interface_name> <ip_addr>
  ```
  *Versions <= 201811*
  ```
  config interface ip remove <interface_name> <ip_addr>
  ```

- Example:

  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface ip remove Ethernet63 10.11.12.13/24
  admin@sonic:~$ sudo config interface ip remove eth0 20.11.12.13/24
  ```
  *Versions <= 201811*
  ```
  admin@sonic:~$ sudo config interface Ethernet63 ip remove 10.11.12.13/24
  ```

VLAN interface names take the form of `vlan<vlan_id>`. E.g., VLAN 100 will be named `vlan100`

- Example:

  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface ip remove vlan100 10.11.12.13/24
  ```
  *Versions <= 201811*
  ```
  admin@sonic:~$ sudo config interface vlan100 ip remove 10.11.12.13/24
  ```

**config interface pfc priority <interface_name> <priority> (on | off)**

This command is used to set PFC on a given priority of a given interface to either "on" or "off". Once it is successfully configured, it will show current losses priorities on the given interface. Otherwise, it will show error information 

- Example: 
  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface pfc priority Ethernet0 3 off

  Interface      Lossless priorities
  -----------  ---------------------
  Ethernet0                        4

  admin@sonic:~$ sudo config interface pfc priority Ethernet0 8 off
  Usage: pfc config priority [OPTIONS] STATUS INTERFACE PRIORITY

  Error: Invalid value for "priority": invalid choice: 8. (choose from 0, 1, 2, 3, 4, 5, 6, 7)

  admin@sonic:~$ sudo config interface pfc priority Ethernet101 3 off
  Cannot find interface Ethernet101

  admin@sonic:~$ sudo config interface pfc priority Ethernet0 3 on
  
  Interface    Lossless priorities
  -----------  ---------------------
  Ethernet0    3,4
  ```

**config interface pfc asymmetric <interface_name> (Versions >= 201904)**

**config interface <interface_name> pfc asymmetric (Versions <= 201811)**

This command is used for setting the asymmetric PFC for an interface to either "on" or "off". Once if it is configured, use "show interfaces status" to check the same.

- Usage:

  *Versions >= 201904*
  ```
  config interface pfc asymmetric <interface_name> on/off (for 201904+ version)
  ```
  *Versions <= 201811*
  ```
  config interface <interface_name> pfc asymmetric on/off (for 201811- version)
  ```

- Example:

  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface pfc asymmetric Ethernet60 on
  ```
  *Versions <= 201811*
  ```
  admin@sonic:~$ sudo config interface Ethernet60 pfc asymmetric on
  ```

**config interface shutdown <interface_name> (Versions >= 201904)**

**config interface <interface_name> shutdown (Versions <= 201811)**

This command is used to administratively shut down either the Physical interface or port channel interface. Once if it is configured, use "show interfaces status" to check the same.

- Usage:

  *Versions >= 201904*
  ```
  config interface shutdown <interface_name> (for 201904+ version)
  ```
  *Versions <= 201811*
  ```
  config interface <interface_name> shutdown (for 201811- version)
  ```

- Example:

  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface shutdown Ethernet63
  ```
  *Versions <= 201811*
  ```
  admin@sonic:~$ sudo config interface Ethernet63 shutdown
  ```

  shutdown multiple interfaces
  ```
  admin@sonic:~$ sudo config interface shutdown Ethernet8,Ethernet16-20,Ethernet32
  ```

**config interface startup <interface_name> (Versions >= 201904)**

**config interface <interface_name> startup (Versions <= 201811)**

This command is used for administratively bringing up the Physical interface or port channel interface.Once if it is configured, use "show interfaces status" to check the same.

- Usage:

  *Versions >= 201904*
  ```
  config interface startup <interface_name> (for 201904+ version)
  ```
  *Versions <= 201811*
  ```
  config interface <interface_name> startup (for 201811- version)
  ```

- Example:

  *Versions >= 201904*
  ```
  admin@sonic:~$ sudo config interface startup Ethernet63
  ```
  *Versions <= 201811*
  ```
  admin@sonic:~$ sudo config interface Ethernet63 startup
  ```

  startup multiple interfaces
  ```
  admin@sonic:~$ sudo config interface startup Ethernet8,Ethernet16-20,Ethernet32
  ```

**config interface speed <interface_name> (Versions >= 201904)**

**config interface <interface_name> speed (Versions <= 201811)**

This command is used to configure the speed for the Physical interface. Use the value 40000 for setting it to 40G and 100000 for 100G. Users need to know the device to configure it properly.
Dynamic breakout feature is yet to be supported in SONiC and hence uses cannot configure any values other than 40G and 100G.

- Usage:

  *Versions >= 201904*
  ```
  config interface speed <interface_name> <speed_value>
  ```
  *Versions <= 201811*
  ```
  config interface <interface_name> speed <speed_value>
  ```

- Example (Versions >= 201904):
  ```
  admin@sonic:~$ sudo config interface speed Ethernet63 40000
  ```

- Example (Versions <= 201811):
  ```
  admin@sonic:~$ sudo config interface Ethernet63 speed 40000

  ```

**config interface transceiver lpmode**

This command is used to enable or disable low-power mode for an SFP transceiver

- Usage:

  ```
  config interface transceiver lpmode <interface_name> (enable | disable)
  ```

- Examples:

  ```
  user@sonic~$ sudo config interface transceiver lpmode Ethernet0 enable
  Enabling low-power mode for port Ethernet0...  OK

  user@sonic~$ sudo config interface transceiver lpmode Ethernet0 disable
  Disabling low-power mode for port Ethernet0...  OK
  ```

**config interface transceiver reset**

This command is used to reset an SFP transceiver

- Usage:

  ```
  config interface transceiver reset <interface_name>
  ```

- Examples:

  ```
  user@sonic~$ sudo config interface transceiver reset Ethernet0
  Resetting port Ethernet0...  OK
  ```

**config interface mtu <interface_name> (Versions >= 201904)**

This command is used to configure the mtu for the Physical interface. Use the value 1500 for setting max transfer unit size to 1500 bytes.

- Usage:

  *Versions >= 201904*
  ```
  config interface mtu <interface_name> <mtu_value>
  ```

- Example (Versions >= 201904):
  ```
  admin@sonic:~$ sudo config interface mtu Ethernet64 1500
  ```

**config interface breakout**

This command is used to set breakout mode available for user-specified interface.
kindly use, double tab i.e. <tab><tab> to see the available breakout option customized for each interface provided by the user.

- Usage:
  ```
  sudo config interface breakout  --help
  Usage: config interface breakout [OPTIONS] <interface_name> MODE

    Set interface breakout mode

    Options:
      -f, --force-remove-dependencies
                                      Clear all depenedecies internally first.
      -l, --load-predefined-config    load predefied user configuration (alias,
                                      lanes, speed etc) first.
      -y, --yes
      -v, --verbose                   Enable verbose output
      -?, -h, --help                  Show this message and exit.
  ```
- Example :
  ```
  admin@sonic:~$ sudo config interface breakout  Ethernet0 <tab><tab>
  <tab provides option for breakout mode>
  1x100G[40G]  2x50G        4x25G[10G]

  admin@sonic:~$ sudo config interface breakout  Ethernet0 4x25G[10G] -f -l -v -y
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#interfaces)

**config interface cable_length (Versions >= 202006)**

This command is used to configure the length of the cable connected to a port. The cable_length is in unit of meters and must be suffixed with "m".

For details please refer [dynamic buffer management](#dynamic-buffer-management)

Go Back To [Beginning of the document](#) or [Beginning of this section](#interfaces)

**config interface lossless_pg (Versions >= 202006)**

This command is used to configure the priority groups on which lossless traffic runs.

For details please refer [dynamic buffer management](#dynamic-buffer-management)

Go Back To [Beginning of the document](#) or [Beginning of this section](#interfaces)

**config interface headroom_override (Versions >= 202006)**

This command is used to configure a static buffer profile on a port's lossless priorities. There shouldn't be any `lossless_pg` configured on the port when configuring `headroom_override`. The port's headroom won't be updated after `headroom_override` has been configured on the port.

For details please refer [dynamic buffer management](#dynamic-buffer-management)

Go Back To [Beginning of the document](#) or [Beginning of this section](#interfaces)

## Interface Naming Mode

### Interface naming mode show commands
This command displays the current interface naming mode. Interface naming mode originally set to 'default'. Interfaces are referenced by default SONiC interface names.
Users can change the naming_mode using "config interface_naming_mode" command.

**show interfaces naming_mode**

This command displays the current interface naming mode

- Usage:
  ```
  show interfaces naming_mode
  ```

- Examples:
  ```
  admin@sonic:~$ show interfaces naming_mode
  default
  ```

  - "default" naming mode will display all SONiC interface names in 'show' commands and accept SONiC interface names as parameters in 'config commands

  ```
  admin@sonic:~$ show interfaces naming_mode
  alias
  ```

  - "alias" naming mode will display all hardware vendor interface aliases in 'show' commands and accept hardware vendor interface aliases as parameters in 'config commands


### Interface naming mode config commands

**config interface_naming_ mode**

This command is used to change the interface naming mode.
Users can select between default mode (SONiC interface names) or alias mode (Hardware vendor names).
The user must log out and log back in for changes to take effect. Note that the newly-applied interface mode will affect all interface-related show/config commands.


*NOTE: Some platforms do not support alias mapping. In such cases, this command is not applicable. Such platforms always use the same SONiC interface names.*

- Usage:
  ```
  config interface_naming_mode (default | alias)
  ```

  - Interface naming mode is originally set to 'default'. Interfaces are referenced by default SONiC interface names:

- Example:
  ```
  admin@sonic:~$ show interfaces naming_mode
  default

  admin@sonic:~$ show interface status Ethernet0
    Interface     Lanes    Speed    MTU            Alias    Oper    Admin
  -----------  --------  -------  -----   --------------  ------  -------
    Ethernet0   101,102      40G   9100   fortyGigE1/1/1      up       up

  admin@sonic:~$ sudo config interface_naming_mode alias
  Please logout and log back in for changes take effect.
  ```

  - After user logs out and logs back in again, interfaces will then referenced by hardware vendor aliases:

  ```
  admin@sonic:~$ show interfaces naming_mode
  alias

  admin@sonic:~$ sudo config interface fortyGigE1/1/1 shutdown
  admin@sonic:~$ show interface status fortyGigE1/1/1
    Interface     Lanes    Speed    MTU            Alias    Oper    Admin
  -----------  --------  -------  -----   --------------  ------  -------
    Ethernet0   101,102      40G   9100   fortyGigE1/1/1    down     down
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#interface-naming-mode)

## Interface Vrf binding

### Interface vrf bind & unbind config commands

**config interface vrf bind**

This command is used to bind a interface to a vrf.
By default, all L3 interfaces will be in default vrf. Above vrf bind command will let users bind interface to a vrf.

- Usage:
  ```
  config interface vrf bind <interface_name> <vrf_name>
  ```

**config interface vrf unbind**

This command is used to ubind a interface from a vrf.
This will move the interface to default vrf.

- Usage:
  ```
  config interface vrf unbind <interface_name> <vrf_name>
  ```
  
  ### Interface vrf binding show commands
  
  To display interface vrf binding information, user can use show vrf command.  Please refer sub-section [Vrf-show-command](#vrf-show-commands).
  
Go Back To [Beginning of the document](#) or [Beginning of this section](#interface-vrf-binding)

## IP / IPv6

### IP show commands

This sub-section explains the various IP protocol specific show commands that are used to display the following.
1) routes
2) bgp details - Explained in the [bgp section](#show-bgp)
3) IP interfaces
4) prefix-list
5) protocol

**show ip route**

This command displays either all the route entries from the routing table or a specific route.

- Usage:
  ```
  show ip route [<vrf-name>] [<ip_address>]
  ```

- Example:
  ```
  admin@sonic:~$ show ip 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
  S>* 0.0.0.0/0 [200/0] via 10.11.162.254, eth0
  C>* 1.1.0.0/16 is directly connected, Vlan100
  C>* 10.1.1.0/31 is directly connected, Ethernet112
  C>* 10.1.1.2/31 is directly connected, Ethernet116
  C>* 10.11.162.0/24 is directly connected, eth0
  C>* 127.0.0.0/8 is directly connected, lo
  C>* 240.127.1.0/24 is directly connected, docker0
  ```

  - Optionally, you can specify an IP address in order to display only routes to that particular IP address

- Example:
  ```
  admin@sonic:~$ show ip route 10.1.1.0
  Routing entry for 10.1.1.0/31
    Known via "connected", distance 0, metric 0, best
    * directly connected, Ethernet112
  ```

  - Vrf-name can also be specified to get IPv4 routes programmed in the vrf.

  - Example:
     ```
     admin@sonic:~$ show ip route vrf Vrf-red
       Codes: K - kernel route, C - connected, S - static, R - RIP,
       O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP,
       T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP,
       F - PBR, f - OpenFabric,
       > - selected route, * - FIB route
       VRF Vrf-red:
       C>*  11.1.1.1/32 is directly connected, Loopback11, 21:50:47
       C>*  100.1.1.0/24 is directly connected, Vlan100, 03w1d06h
       
     admin@sonic:~$ show ip route vrf Vrf-red 11.1.1.1/32
       Routing entry for 11.1.1.1/32
       Known via "connected", distance 0, metric 0, vrf Vrf-red, best
       Last update 21:57:53 ago
       * directly connected, Loopback11
   ```

**show ip interfaces**

This command displays the details about all the Layer3 IP interfaces in the device for which IP address has been assigned.
The type of interfaces include the following.
1) Front panel physical ports.
2) PortChannel.
3) VLAN interface.
4) Loopback interfaces
5) docker interface and
6) management interface

- Usage:
  ```
  show ip interfaces
  ```

- Example:
  ```
  admin@sonic:~$ show ip interfaces
  Interface       Master          IPv4 address/mask     Admin/Oper      BGP Neighbor     Neighbor IP     Flags
  -------------   ------------    ------------------    --------------  -------------    -------------   -------
  Loopback0                       1.0.0.1/32            up/up           N/A              N/A
  Loopback11      Vrf-red         11.1.1.1/32           up/up           N/A              N/A
  Loopback100     Vrf-blue        100.0.0.1/32          up/up           N/A              N/A
  PortChannel01                   10.0.0.56/31          up/down         DEVICE1          10.0.0.57
  PortChannel02                   10.0.0.58/31          up/down         DEVICE2          10.0.0.59
  PortChannel03                   10.0.0.60/31          up/down         DEVICE3          10.0.0.61
  PortChannel04                   10.0.0.62/31          up/down         DEVICE4          10.0.0.63
  Vlan100         Vrf-red         1001.1.1/24           up/up           N/A              N/A
  Vlan1000                        192.168.0.1/27        up/up           N/A              N/A
  docker0                         240.127.1.1/24        up/down         N/A              N/A
  eth0                            10.3.147.252/23       up/up           N/A              N/A
  lo                              127.0.0.1/8           up/up           N/A              N/A
  ```

**show ip protocol**

This command displays the route-map that is configured for the routing protocol.
Refer the routing stack [Quagga Command Reference](https://www.quagga.net/docs/quagga.pdf) or [FRR Command Reference](https://buildmedia.readthedocs.org/media/pdf/frrouting/latest/frrouting.pdf) to know more about this command.

- Usage:
  ```
  show ip protocol
  ```

- Example:
  ```
  admin@sonic:~$ show ip protocol
  Protocol    : route-map
  ------------------------
  system      : none
  kernel      : none
  connected   : none
  static      : none
  rip         : none
  ripng       : none
  ospf        : none
  ospf6       : none
  isis        : none
  bgp         : RM_SET_SRC
  pim         : none
  hsls        : none
  olsr        : none
  babel       : none
  any         : none
  ```

### IPv6 show commands

This sub-section explains the various IPv6 protocol specific show commands that are used to display the following.
1) routes
2) IPv6 bgp details - Explained in the [bgp section](#show-bgp)
3) IP interfaces
4) protocol

**show ipv6 route**

This command displays either all the IPv6 route entries from the routing table or a specific IPv6 route.

- Usage:
  ```
  show ipv6 route [<vrf-name>] [<ipv6_address>]
  ```

- Example:
  ```
  admin@sonic:~$ show ipv6 route
  Codes: K - kernel route, C - connected, S - static, R - RIPng,
         O - OSPFv6, I - IS-IS, B - BGP, A - Babel,
         > - selected route, * - FIB route

  C>* ::1/128 is directly connected, lo
  C>* 2018:2001::/126 is directly connected, Ethernet112
  C>* 2018:2002::/126 is directly connected, Ethernet116
  C>* fc00:1::32/128 is directly connected, lo
  C>* fc00:1::102/128 is directly connected, lo
  C>* fc00:2::102/128 is directly connected, eth0
  C * fe80::/64 is directly connected, Vlan100
  C * fe80::/64 is directly connected, Ethernet112
  C * fe80::/64 is directly connected, Ethernet116
  C * fe80::/64 is directly connected, Bridge
  C * fe80::/64 is directly connected, PortChannel0011
  C>* fe80::/64 is directly connected, eth0
  ```
 - Optionally, you can specify an IPv6 address in order to display only routes to that particular IPv6 address


- Example:
  ```
  admin@sonic:~$ show ipv6 route  fc00:1::32
  Routing entry for fc00:1::32/128
    Known via "connected", distance 0, metric 0, best
    * directly connected, lo
  ```

 Vrf-name can also be specified to get IPv6 routes programmed in the vrf.

  - Example:
     ```
     admin@sonic:~$ show ipv6 route vrf Vrf-red
       Codes: K - kernel route, C - connected, S - static, R - RIP,
       O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP,
       T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP,
       F - PBR, f - OpenFabric,
       > - selected route, * - FIB route
       VRF Vrf-red:
            C>*  1100::1/128 is directly connected, Loopback11, 21:50:47           
            C>*  100::/112 is directly connected, Vlan100, 03w1d06h
            C>*  fe80::/64 is directly connected, Loopback11, 21:50:47
            C>*  fe80::/64 is directly connected, Vlan100, 03w1d06h
            
      admin@sonic:~$ show ipv6 route vrf Vrf-red 1100::1/128
        Routing entry for 1100::1/128
        Known via "connected", distance 0, metric 0, vrf Vrf-red, best
        Last update 21:57:53 ago
        * directly connected, Loopback11
     ```

**show ipv6 interfaces**

This command displays the details about all the Layer3 IPv6 interfaces in the device for which IPv6 address has been assigned.
The type of interfaces include the following.
1) Front panel physical ports.
2) PortChannel.
3) VLAN interface.
4) Loopback interfaces
5) management interface

- Usage:
  ```
  show ipv6 interfaces
  ```

- Example:
  ```
  admin@sonic:~$ show ipv6 interfaces
  Interface        Master     IPv6 address/mask                          Admin/Oper    BGP Neighbor    Neighbor IP
  -----------      --------   ----------------------------------------   ------------  --------------  -------------
  Bridge                      fe80::7c45:1dff:fe08:cdd%Bridge/64         up/up         N/A             N/A
  Loopback11       Vrf-red    1100::1/128                                up/up
  PortChannel01               fc00::71/126                               up/down       DEVICE1         fc00::72
  PortChannel02               fc00::75/126                               up/down       DEVICE2         fc00::76
  PortChannel03               fc00::79/126                               up/down       DEVICE3         fc00::7a
  PortChannel04               fc00::7d/126                               up/down       DEVICE4         fc00::7e
  Vlan100          Vrf-red    100::1/112                                 up/up         N/A             N/A
                              fe80::eef4:bbff:fefe:880a%Vlan100/64
  eth0                        fe80::eef4:bbff:fefe:880a%eth0/64          up/up         N/A             N/A
  lo                          fc00:1::32/128                             up/up         N/A             N/A
  ```

**show ipv6 protocol**

This command displays the route-map that is configured for the IPv6 routing protocol.
Refer the routing stack [Quagga Command Reference](https://www.quagga.net/docs/quagga.pdf) or [FRR Command Reference](https://buildmedia.readthedocs.org/media/pdf/frrouting/latest/frrouting.pdf) to know more about this command.


- Usage:
  ```
  show ipv6 protocol
  ```

- Example:
  ```
  admin@sonic:~$ show ipv6 protocol
  Protocol    : route-map
  ------------------------
  system      : none
  kernel      : none
  connected   : none
  static      : none
  rip         : none
  ripng       : none
  ospf        : none
  ospf6       : none
  isis        : none
  bgp         : RM_SET_SRC6
  pim         : none
  hsls        : none
  olsr        : none
  babel       : none
  any         : none
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#ip--ipv6)


## Kubernetes

### Kubernetes show commands

**show kubernetes server config**

This command displays the kubernetes server configuration, if any, else would report as not configured.

- Usage:
  ```
  show kubernetes server config
  ```

- Example:
  ```
  admin@sonic:~$ show kubernetes server config
  ip           port    insecure    disable
  -----------  ------  ----------  ---------
  10.3.157.24  6443    True        False
  ```

**show kubernetes server status**

This command displays the kubernetes server status.

- Usage:
  ```
  show kubernetes server status
  ```

- Example:
  ```
  admin@sonic:~$ show kubernetes server status
  ip           port    connected    update-time
  -----------  ------  -----------  -------------------
  10.3.157.24  6443    true         2020-11-15 18:25:05
  ```

## LLDP

### LLDP show commands

**show lldp table**

This command displays the brief summary of all LLDP neighbors.

- Usage:
  ```
  show lldp table
  ```

- Example:
  ```
  admin@sonic:~$ show lldp table
  Capability codes: (R) Router, (B) Bridge, (O) Other
  LocalPort    RemoteDevice       RemotePortID         Capability    RemotePortDescr
  -----------  -----------------  -------------------  ------------  --------------------
  Ethernet112  T1-1               hundredGigE1/2       BR            T0-2:hundredGigE1/29
  Ethernet116  T1-2               hundredGigE1/2       BR            T0-2:hundredGigE1/30
  eth0         swtor-b2lab2-1610  GigabitEthernet 0/2  OBR
  --------------------------------------------------
  Total entries displayed:  3
  ```

**show lldp neighbors**

This command displays more details about all LLDP neighbors or only the neighbors connected to a specific interface.

- Usage:
  ```
  show lldp neighbors <interface_name>
  ```

- Example1: To display all neighbors in all interfaces
  ```
  admin@sonic:~$ show lldp neighbors
  -------------------------------------------------------------------------------
  LLDP neighbors:
  -------------------------------------------------------------------------------
  Interface:    eth0, via: LLDP, RID: 1, Time: 0 day, 12:21:21
    Chassis:
      ChassisID:    mac 00:01:e8:81:e3:45
      SysName:      swtor-b2lab2-1610
      SysDescr:     Dell Force10 Networks Real Time Operating System Software. Dell Force10 Operating System Version: 1.0. Dell Force10 Application Software Version: 8.3.3.10d. Copyright (c) 1999-2012 by Dell Inc. All Rights Reserved.Build Time: Tue Sep 22 11:21:54 PDT 2015
      TTL:          20
      Capability:   Repeater, on
      Capability:   Bridge, on
      Capability:   Router, on
    Port:
      PortID:       ifname GigabitEthernet 0/2
    VLAN:         162, pvid: yes
  -------------------------------------------------------------------------------
  Interface:    Ethernet116, via: LLDP, RID: 3, Time: 0 day, 12:20:49
    Chassis:
      ChassisID:    mac 4c:76:25:e7:f0:c0
      SysName:      T1-2
      SysDescr:     Debian GNU/Linux 8 (jessie) Linux 4.9.0-8-amd64 #1 SMP Debian 4.9.110-3+deb9u6 (2015-12-19) x86_64
      TTL:          120
      MgmtIP:       10.11.162.40
      Capability:   Bridge, on
      Capability:   Router, on
      Capability:   Wlan, off
      Capability:   Station, off
    Port:
      PortID:       local hundredGigE1/2
      PortDescr:    T0-2:hundredGigE1/30
  -------------------------------------------------------------------------------
  ```

Optionally, you can specify an interface name in order to display only that particular interface

- Example2:
  ```
  admin@sonic:~$ show lldp neighbors Ethernet112
  show lldp neighbors Ethernet112
  -------------------------------------------------------------------------------
  LLDP neighbors:
  -------------------------------------------------------------------------------
  Interface:    Ethernet112, via: LLDP, RID: 2, Time: 0 day, 19:24:17
    Chassis:
      ChassisID:    mac 4c:76:25:e5:e6:c0
      SysName:      T1-1
      SysDescr:     Debian GNU/Linux 8 (jessie) Linux 4.9.0-8-amd64 #1 SMP Debian 4.9.110-3+deb9u6 (2015-12-19) x86_64
      TTL:          120
      MgmtIP:       10.11.162.41
      Capability:   Bridge, on
      Capability:   Router, on
      Capability:   Wlan, off
      Capability:   Station, off
    Port:
      PortID:       local hundredGigE1/2
      PortDescr:    T0-2:hundredGigE1/29
  -------------------------------------------------------------------------------
  ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#lldp)


## Loading, Reloading And Saving Configuration

This section explains the commands that are used to load the configuration from either the ConfigDB or from the minigraph.

### Loading configuration from JSON file

**config load**

This command is used to load the configuration from a JSON file like the file which SONiC saves its configuration to, `/etc/sonic/config_db.json`
This command loads the configuration from the input file (if user specifies this optional filename, it will use that input file. Otherwise, it will use the default `/etc/sonic/config_db.json` file as the input file) into CONFIG_DB.
The configuration present in the input file is applied on top of the already running configuration.
This command does not flush the config DB before loading the new configuration (i.e., If the configuration present in the input file is same as the current running configuration, nothing happens)
If the config present in the input file is not present in running configuration, it will be added.
If the config present in the input file differs (when key matches) from that of the running configuration, it will be modified as per the new values for those keys.

When user specifies the optional argument "-y" or "--yes", this command forces the loading without prompting the user for confirmation.
If the argument is not specified, it prompts the user to confirm whether user really wants to load this configuration file.

- Usage:
  ```
  config load [-y|--yes] [<filename>]
  ```

- Example:
  ```
  admin@sonic:~$ sudo config load
  Load config from the file /etc/sonic/config_db.json? [y/N]: y
  Running command: /usr/local/bin/sonic-cfggen -j /etc/sonic/config_db.json --write-to-db
  ```

### Loading configuration from minigraph (XML) file

**config load_minigraph**

This command is used to load the configuration from /etc/sonic/minigraph.xml.
When users do not want to use configuration from config_db.json, they can copy the minigraph.xml configuration file to the device and load it using this command.
This command restarts various services running in the device and it takes some time to complete the command.

NOTE: If the user had logged in using SSH, users might get disconnected and some configuration failures might happen which might be hard to recover. Users need to reconnect their SSH sessions after configuring the management IP address. It is recommended to execute this command from console port
NOTE: Management interface IP address and default route (or specific route) may require reconfiguration in case if those parameters are not part of the minigraph.xml.

When user specifies the optional argument "-y" or "--yes", this command forces the loading without prompting the user for confirmation.
If the argument is not specified, it prompts the user to confirm whether user really wants to load this configuration file.

When user specifies the optional argument "-n" or "--no-service-restart", this command loads the configuration without restarting dependent services
running on the device. One use case for this option is during boot time when config-setup service loads minigraph configuration and there is no services
running on the device.

- Usage:
  ```
  config load_minigraph [-y|--yes] [-n|--no-service-restart]
  ```

- Example:
  ```
  admin@sonic:~$ sudo config load_minigraph
  Reload config from minigraph? [y/N]: y
  Running command: /usr/local/bin/sonic-cfggen -j /etc/sonic/config_db.json --write-to-db
  ```

### Reloading Configuration

**config reload**

This command is used to clear current configuration and import new configurationn from the input file or from /etc/sonic/config_db.json.
This command shall stop all services before clearing the configuration and it then restarts those services.

This command restarts various services running in the device and it takes some time to complete the command.
NOTE: If the user had logged in using SSH, users **might get disconnected** depending upon the new management IP address. Users need to reconnect their SSH sessions.
In general, it is recommended to execute this command from console port after disconnecting all SSH sessions to the device.
When users to do “config reload” the newly loaded config may have management IP address, or it may not have management IP address.
If mgmtIP is there in the newly loaded config file, that mgmtIP might be same as previously configured value or it might be different.
This difference in mgmtIP address values results in following possible behaviours.

Case1: Previously configured mgmtIP is same as newly loaded mgmtIP. The SSH session may not be affected at all, but it’s possible that there will be a brief interruption in the SSH session. But, assuming the client’s timeout value isn’t on the order of a couple of seconds, the session would most likely just resume again as soon as the interface is reconfigured and up with the same IP.
Case2: Previously configured mgmtIP is different from newly loaded mgmtIP. Users will lose their SSH connections.
Case3: Newly loaded config does not have any mgmtIP. Users will lose their SSH connections.

NOTE: Management interface IP address and default route (or specific route) may require reconfiguration in case if those parameters are not part of the minigraph.xml.

When user specifies the optional argument "-y" or "--yes", this command forces the loading without prompting the user for confirmation.
If the argument is not specified, it prompts the user to confirm whether user really wants to load this configuration file.

When user specifies the optional argument "-n" or "--no-service-restart", this command clear and loads the configuration without restarting dependent services
running on the device. One use case for this option is during boot time when config-setup service loads existing old configuration and there is no services
running on the device.

- Usage:
  ```
  config reload [-y|--yes] [-l|--load-sysinfo] [<filename>] [-n|--no-service-restart]
  ```

- Example:
  ```
  admin@sonic:~$ sudo config reload
  Clear current config and reload config from the file /etc/sonic/config_db.json? [y/N]: y
  Running command: systemctl stop dhcp_relay
  Running command: systemctl stop swss
  Running command: systemctl stop snmp
  Warning: Stopping snmp.service, but it can still be activated by:
    snmp.timer
  Running command: systemctl stop lldp
  Running command: systemctl stop pmon
  Running command: systemctl stop bgp
  Running command: systemctl stop teamd
  Running command: /usr/local/bin/sonic-cfggen -H -k Force10-Z9100-C32 --write-to-db
  Running command: /usr/local/bin/sonic-cfggen -j /etc/sonic/config_db.json --write-to-db
  Running command: systemctl restart hostname-config
  Running command: systemctl restart interfaces-config
  Timeout, server 10.11.162.42 not responding.
  ```


### Loading Management Configuration

**config load_mgmt_config**

This command is used to reconfigure hostname and mgmt interface based on device description file.
This command either uses the optional file specified as arguement or looks for the file "/etc/sonic/device_desc.xml".
If the file does not exist or if the file does not have valid fields for "hostname" and "ManagementAddress", it fails.

When user specifies the optional argument "-y" or "--yes", this command forces the loading without prompting the user for confirmation.
If the argument is not specified, it prompts the user to confirm whether user really wants to load this configuration file.

- Usage:
  ```
  config load_mgmt_config [-y|--yes] [<filename>]
  ```

- Example:
  ```
  admin@sonic:~$ sudo config load_mgmt_config
  Reload config from minigraph? [y/N]: y
  Running command: /usr/local/bin/sonic-cfggen -M /etc/sonic/device_desc.xml --write-to-db
  ```


### Saving Configuration to a File for Persistence

**config save**

This command is to save the config DB configuration into the user-specified filename or into the default /etc/sonic/config_db.json. This saves the configuration into the disk which is available even after reboots.
Saved file can be transferred to remote machines for debugging. If users wants to load the configuration from this new file at any point of time, they can use "config load" command and provide this newly generated file as input. If users wants this newly generated file to be used during reboot, they need to copy this file to /etc/sonic/config_db.json.

- Usage:
  ```
  config save [-y|--yes] [<filename>]
  ```

- Example (Save configuration to /etc/sonic/config_db.json):
  ```
  admin@sonic:~$ sudo config save -y
  ```

- Example (Save configuration to a specified file):
  ```
  admin@sonic:~$ sudo config save -y /etc/sonic/config2.json
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#loading-reloading-and-saving-configuration)

## Loopback Interfaces

### Loopback Config commands

This sub-section explains how to create and delete loopback interfaces.

**config interface loopback**

This command is used to add or delete loopback interfaces.
It is recommended to use loopback names in the format "Loopbackxxx", where "xxx" is number of 1 to 3 digits. Ex: "Loopback11".

- Usage:
  ```
  config loopback (add | del) <loopback_name>
  ```

- Example (Create the loopback with name "Loopback11"):
  ```
  admin@sonic:~$ sudo config loopback add Loopback11
  ```

## VRF Configuration

### VRF show commands

**show vrf**

This command displays all vrfs configured on the system along with interface binding to the vrf.
If vrf-name is also provided as part of the command, if the vrf is created it will display all interfaces binding to the vrf, if vrf is not created nothing will be displayed.

- Usage:
  ```
  show vrf [<vrf_name>]
  ```

- Example:
  ````
     admin@sonic:~$ show vrf
     VRF        Interfaces
     -------    ------------
     default    Vlan20
     Vrf-red    Vlan100
                Loopback11
     Vrf-blue   Loopback100
                Loopback102
  ````  

### VRF config commands

**config vrf add **

This command creates vrf in SONiC system with provided vrf-name.

- Usage:
 ```
config vrf add <vrf-name>
```
Note: vrf-name should always start with keyword "Vrf"

**config vrf del <vrf-name>**

This command deletes vrf with name vrf-name.

- Usage:
 ```
config vrf del <vrf-name>
```

## Management VRF

### Management VRF Show commands

**show mgmt-vrf**

This command displays whether the management VRF is enabled or disabled. It also displays the details about the the links (eth0, mgmt, lo-m) that are related to management VRF. 

- Usage:
  ```
  show mgmt-vrf
  ```

- Example:
  ```
    admin@sonic:~$ show mgmt-vrf 

    ManagementVRF : Enabled

    Management VRF interfaces in Linux:
    348: mgmt: <NOARP,MASTER,UP,LOWER_UP> mtu 65536 qdisc noqueue state UP mode DEFAULT group default qlen 1000
        link/ether f2:2a:d9:bc:e8:f0 brd ff:ff:ff:ff:ff:ff
    2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq master mgmt state UP mode DEFAULT group default qlen 1000
        link/ether 4c:76:25:f4:f9:f3 brd ff:ff:ff:ff:ff:ff
    350: lo-m: <BROADCAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc noqueue master mgmt state UNKNOWN mode DEFAULT group default qlen 1000
        link/ether b2:4c:c6:f3:e9:92 brd ff:ff:ff:ff:ff:ff

    NOTE: The management interface "eth0" shows the "master" as "mgmt" since it is part of management VRF.
  ```

**show mgmt-vrf routes**

This command displays the routes that are present in the routing table 5000 that is meant for management VRF.

- Usage:
  ```
  show mgmt-vrf routes
  ```

- Example:
  ```
    admin@sonic:~$ show mgmt-vrf routes
    
    Routes in Management VRF Routing Table:
    default via 10.16.210.254 dev eth0 metric 201 
    broadcast 10.16.210.0 dev eth0 proto kernel scope link src 10.16.210.75 
    10.16.210.0/24 dev eth0 proto kernel scope link src 10.16.210.75 
    local 10.16.210.75 dev eth0 proto kernel scope host src 10.16.210.75 
    broadcast 10.16.210.255 dev eth0 proto kernel scope link src 10.16.210.75 
    broadcast 127.0.0.0 dev lo-m proto kernel scope link src 127.0.0.1 
    127.0.0.0/8 dev lo-m proto kernel scope link src 127.0.0.1 
    local 127.0.0.1 dev lo-m proto kernel scope host src 127.0.0.1 
    broadcast 127.255.255.255 dev lo-m proto kernel scope link src 127.0.0.1 
  ```

**show management_interface address**

This command displays the IP address(es) configured for the management interface "eth0" and the management network default gateway.

- Usage:
  ```
  show management_interface address
  ```

- Example:
  ```
    admin@sonic:~$ show management_interface address 
    Management IP address = 10.16.210.75/24
    Management NetWork Default Gateway = 10.16.210.254
    Management IP address = FC00:2::32/64
    Management Network Default Gateway = fc00:2::1
  ```

**show snmpagentaddress**

This command displays the configured SNMP agent IP addresses.

- Usage:
  ```
  show snmpagentaddress
  ```

- Example:
  ```
    admin@sonic:~$ show snmpagentaddress 
    ListenIP      ListenPort  ListenVrf
    ----------  ------------  -----------
    1.2.3.4              787  mgmt
  ```

**show snmptrap**

This command displays the configured SNMP Trap server IP addresses.

- Usage:
  ```
  show snmptrap
  ```

- Example:
  ```
    admin@sonic:~$ show snmptrap 
      Version  TrapReceiverIP      Port  VRF    Community
    ---------  ----------------  ------  -----  -----------
            2  31.31.31.31          456  mgmt   public
  ```

### Management VRF Config commands

**config vrf add mgmt**

This command enables the management VRF in the system. This command restarts the "interfaces-config" service which in turn regenerates the /etc/network/interfaces file and restarts the "networking" service. This creates a new interface and l3mdev CGROUP with the name as "mgmt" and enslaves the management interface "eth0" into this master interface "mgmt". Note that the VRFName "mgmt" (or "management") is reserved for management VRF. i.e. Data VRFs should not use these reserved VRF names.

- Usage:
  ```
  config vrf add mgmt
  ```

- Example:
  ```
  admin@sonic:~$ sudo config vrf add mgmt
  ```

**config vrf del mgmt**

This command disables the management VRF in the system. This command restarts the "interfaces-config" service which in turn regenerates the /etc/network/interfaces file and restarts the "networking" service. This deletes the interface "mgmt" and deletes the l3mdev CGROUP named "mgmt" and puts back the management interface "eth0" into the default VRF. Note that the VRFName "mgmt" (or "management") is reserved for management VRF. i.e. Data VRFs should not use these reserved VRF names.

- Usage:
  ```
  config vrf del mgmt
  ```

- Example:
  ```
  admin@sonic:~$ sudo config vrf del mgmt
  ```

**config snmpagentaddress add**

This command adds the SNMP agent IP address on which the SNMP agent is expected to listen. When SNMP agent is expected to work as part of management VRF, users should specify the optional vrf_name parameter as "mgmt". This configuration goes into snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.

- Usage:
  ```
  config snmpagentaddress add [-p <port_num>] [-v <vrf_name>] agentip
  ```

- Example:
  ```
   admin@sonic:~$ sudo config snmpagentaddress add -v mgmt -p 123 21.22.13.14

  Note: For this example, configuration goes into /etc/snmp/snmpd.conf inside snmp docker as follows. When "-v" parameter is not used, the additional "%" in the following line will not be present.

   agentAddress 21.22.13.14:123%mgmt
  ```

**config snmpagentaddress del**

This command deletes the SNMP agent IP address on which the SNMP agent is expected to listen. When users had added the agent IP as part of "mgmt" VRF, users should specify the optional vrf_name parameter as "mgmt" while deleting as well. This configuration is removed from snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.

- Usage:
  ```
  config snmpagentaddress del [-p <port_num>] [-v <vrf_name>] agentip
  ```

- Example:
  ```
   admin@sonic:~$ sudo config snmpagentaddress del -v mgmt -p 123 21.22.13.14

  ```

**config snmptrap modify**

This command modifies the SNMP trap server IP address to which the SNMP agent is expected to send the traps. Users can configure one server IP addrss for each SNMP version to send the traps. When SNMP agent is expected to send traps as part of management VRF, users should specify the optional vrf_name parameter as "mgmt". This configuration goes into snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.

- Usage:
  ```
  config snmptrap modify <snmp_version> [-p <port_num>] [-v <vrf_name>] [-c <community>] trapserverip
  ```

- Example:
  ```
   admin@sonic:~$ sudo config snmptrap modify 2 -p 456 -v mgmt 21.21.21.21

   For this example, configuration goes into /etc/snmp/snmpd.conf inside snmp docker as follows. When "-v" parameter is not used, the additional "%" in the following line will not be present. In case of SNMPv1, "trapsink" will be updated, in case of v2, "trap2sink" will be updated and in case of v3, "informsink" will be updated.

   trap2sink 31.31.31.31:456%mgmt public

  ```

**config snmptrap del**

This command deletes the SNMP Trap server IP address to which SNMP agent is expected to send TRAPs. When users had added the trap server IP as part of "mgmt" VRF, users should specify the optional vrf_name parameter as "mgmt" while deleting as well. This configuration is removed from snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.

- Usage:
  ```
  config snmptrap del [-p <port_num>] [-v <vrf_name>] [-c <community>] trapserverip
  ```

- Example:
  ```
   admin@sonic:~$ sudo config snmptrap del -v mgmt -p 123 21.22.13.14

  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#management-vrf)

## Muxcable

### Muxcable Show commands

**show muxcable status**

This command displays all the status of either all the ports which are connected to muxcable or any individual port selected by the user. The resultant table or json output will show the current status of muxcable on the port (auto/active) and also the health of the muxcable.

- Usage:
  ```
  show muxcable status [OPTIONS] [PORT]
  ```

While displaying the muxcable status, users can configure the following fields  

- PORT     optional - Port name should be a valid port  
- --json   optional - -- option to display the result in json format. By default output will be in tabular format.  

With no optional argument, all the ports muxcable status will be displayed in tabular form, or user can pass --json option to display in json format  

- Example:
    ```
      admin@sonic:~$ show muxcable status  
      PORT        STATUS    HEALTH  
      ----------  --------  --------  
      Ethernet32  active    HEALTHY  
      Ethernet0   auto      HEALTHY  
    ```  
    ```
      admin@sonic:~$ show muxcable status --json  
    ```
    ```json
           {  
               "MUX_CABLE": {  
                     "Ethernet32": {  
                         "STATUS": "active",  
                         "HEALTH": "HEALTHY"  
                    },  
                    "Ethernet0": {  
                          "STATUS": "auto",  
                          "HEALTH": "HEALTHY"  
                     }   
                }  
           }  

    ```  
    ```
      admin@sonic:~$ show muxcable status Ethernet0  
      PORT       STATUS    HEALTH  
      ---------  --------  --------  
      Ethernet0  auto      HEALTHY  
    ```  
    ```
      admin@sonic:~$ show muxcable status Ethernet0 --json  
    ```
    ```json
           {  
                "MUX_CABLE": {  
                    "Ethernet0": {  
                         "STATUS": "auto",  
                         "HEALTH": "HEALTHY"  
                     }  
                }  
          }  
    ```

**show muxcable config**

This command displays all the configurations of either all the ports which are connected to muxcable or any individual port selected by the user. The resultant table or json output will show the current configurations of muxcable on the port(active/standby) and also the ipv4 and ipv6 address of the port as well as peer TOR ip address with the hostname.

- Usage:
  ```
  show muxcable config [OPTIONS] [PORT]
  ```

With no optional argument, all the ports muxcable configuration will be displayed in tabular form  
While displaying the muxcable configuration, users can configure the following fields 
 
- PORT   optional - Port name should be a valid port
- --json optional -  option to display the result in json format. By default output will be in tabular format.

- Example:
    ```
        admin@sonic:~$ show muxcable config
        SWITCH_NAME    PEER_TOR
        -------------  ----------
        sonic          10.1.1.1
        port       state    ipv4      ipv6
        ---------  -------  --------  --------
        Ethernet0  active  10.1.1.1  fc00::75
    ```
    ```
        admin@sonic:~$ show muxcable config --json
    ```
    ```json
	{
            "MUX_CABLE": {
                "PEER_TOR": "10.1.1.1",
                "PORTS": {
                    "Ethernet0": {
                        "STATE": "active",
                        "SERVER": {
                            "IPv4": "10.1.1.1",
                            "IPv6": "fc00::75"
                         }
                     }
                 }
             }
        }
    ```
    ```
        admin@sonic:~$ show muxcable config Ethernet0
        SWITCH_NAME    PEER_TOR
        -------------  ----------
        sonic          10.1.1.1
        port       state    ipv4      ipv6
        ---------  -------  --------  --------
        Ethernet0  active  10.1.1.1  fc00::75
    ```
    ```
        admin@sonic:~$ show muxcable config Ethernet0 --json
    ```
    ```json
           {
              "MUX_CABLE": {
                  "PORTS": {
                       "Ethernet0": {
                           "STATE": "active",
                           "SERVER": {
                                "IPv4": "10.1.1.1",
                                "IPv6": "fc00::75"
                            }
                        }
                    }
               }
          }
    ```

**show muxcable ber-info**

This command displays the ber(Bit error rate) of the port user provides on the target user provides. The target provided as an integer corresponds to actual target as.
0 -> local
1 -> tor 1
2 -> tor 2
3 -> nic

- Usage:
  ```
  Usage: show muxcable ber-info [OPTIONS] PORT TARGET
  ```


- PORT   required - Port number should be a valid port
- TARGET required - the actual target to get the ber info of.

- Example:
    ```
        admin@sonic:~$ show muxcable ber-info 1 1
        Lane1    Lane2
        -------  -------
        0       0
    ```

**show muxcable ber-info**

This command displays the eye info in mv(milli volts) of the port user provides on the target user provides. The target provided as an integer corresponds to actual target as.
0 -> local
1 -> tor 1
2 -> tor 2
3 -> nic

- Usage:
  ```
  Usage: show muxcable eye-info [OPTIONS] PORT TARGET
  ```

- PORT   required - Port number should be a valid port
- TARGET required - the actual target to get the eye info of.

- Example:
    ```
        admin@sonic:~$ show muxcable ber-info 1 1
        Lane1    Lane2
        -------  -------
        632      622
    ```

### Muxcable Config commands


**config muxcable mode**

This command is used for setting the configuration of a muxcable Port/all ports to be active or auto. The user has to enter a port number or else all to make the muxcable config operation on all the ports. Depending on the status of the muxcable port state the resultant output could be OK or INPROGRESS . OK would imply no change on the state, INPROGRESS would mean the toggle is happening in the background.

- Usage:
  ```
  config muxcable mode [OPTIONS] <operation_status> <port_name>
  ```

While configuring the muxcable, users needs to configure the following fields for the operation  

- <auto/active> operation_state, permitted operation to be configured which can only be auto or active  
- PORT   optional - Port name should be a valid port
-  --json optional -  option to display the result in json format. By default output will be in tabular format.
  

- Example:
    ```
        admin@sonic:~$ sudo config muxcable  mode active Ethernet0  
        port       state  
        ---------  -------  
        Ethernet0  OK
    ```
    ```
        admin@sonic:~$ sudo config muxcable  mode --json active Ethernet0
    ```
    ```json
           {  
               "Ethernet0": "OK"  
           }
    ```    
    ```
        admin@sonic:~$ sudo config muxcable  mode active all  
        port        state  
        ----------  ----------  
        Ethernet0   OK  
        Ethernet32  INPROGRESS    
    ```
    ```
        admin@sonic:~$ sudo config muxcable  mode active all --json  
    ```
    ```json
           {  
                "Ethernet32": "INPROGRESS",  
                "Ethernet0": "OK"
           }
    ```
**config muxcable prbs enable/disable**

This command is used for setting the configuration and enable/diable of prbs on a port user provides. While enabling in addition to port the user also needs to provides the target, prbs mode and lane map on which the user intends to run prbs on. The target reflects where the enable/dsiable will happen.

- Usage:
  ```
  config muxcable prbs enable [OPTIONS] PORT TARGET MODE_VALUE LANE_MAP
  config muxcable prbs disable [OPTIONS] PORT TARGET
  ```

While configuring the muxcable, users needs to configure the following fields for the operation

- PORT   required - Port number should be a valid port
- TARGET  required - the actual target to run the prbs on
                         0 -> local side,
                         1 -> TOR 1
                         2 -> TOR 2
                         3 -> NIC
- MODE_VALUE  required - the mode/type for configuring the PRBS mode.
             0x00 = PRBS 9, 0x01 = PRBS 15, 0x02 = PRBS 23, 0x03 = PRBS 31
- LANE_MAP  required - an integer representing the lane_map to be run PRBS on
             0bit for lane 0, 1bit for lane1 and so on.
             for example 3 -> 0b'0011 , means running on lane0 and lane1
- Example:
    ```
        admin@sonic:~$ sudo config muxcable prbs enable 1 1 3 3
        PRBS config sucessful
        admin@sonic:~$  sudo config muxcable prbs disable 1 0
        PRBS disable sucessful
    ```

**config muxcable loopback enable/disable**

This command is used for setting the configuration and enable/disable of loopback on a port user provides. While enabling in addition to port the user also needs to provides the target and lane map on which the user intends to run loopback on. The target reflects where the enable/dsiable will happen.

- Usage:
  ```
  config muxcable loopback enable [OPTIONS] PORT TARGET LANE_MAP
  config muxcable loopback disable [OPTIONS] PORT TARGET
  ```

While configuring the muxcable, users needs to configure the following fields for the operation

- PORT   required - Port number should be a valid port
- TARGET  required - the actual target to run the loopback on
                         0 -> local side,
                         1 -> TOR 1
                         2 -> TOR 2
                         3 -> NIC
- LANE_MAP  required - an integer representing the lane_map to be run loopback on
             0bit for lane 0, 1bit for lane1 and so on.
             for example 3 -> 0b'0011 , means running on lane0 and lane1

- Example:
    ```
        admin@sonic:~$ sudo config muxcable loopback enable 1 1 3
        loopback config sucessful
        admin@sonic:~$  sudo config muxcable loopback disable 1 0
        loopback disable sucessfull
    ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#muxcable)

## Mirroring

### Mirroring Show commands

**show mirror_session**

This command displays all the mirror sessions that are configured.

- Usage:
  ```
  show mirror_session
  ```

- Example:
  ```
  admin@sonic:~$ show mirror_session
  ERSPAN Sessions
  Name       Status    SRC IP     DST IP    GRE    DSCP    TTL    Queue    Policer    Monitor Port    SRC Port    Direction
  ------     --------  --------   --------  -----  ------  -----  -------  ---------  --------------  ----------  -----------
  everflow0  active    10.1.0.32  10.0.0.7

  SPAN Sessions
  Name    Status    DST Port    SRC Port       Direction
  ------  --------  ----------  -------------  -----------
  port0   active    Ethernet0   PortChannel10  rx
  ```

### Mirroring Config commands

**config mirror_session**

This command is used to add or remove mirroring sessions. Mirror session is identified by "session_name".
This command supports configuring both SPAN/ERSPAN sessions.
In SPAN user can configure mirroring of list of source ports/LAG to destination port in ingress/egress/both directions.
In ERSPAN user can configure mirroring of list of source ports/LAG to a destination IP.
Both SPAN/ERSPAN support ACL based mirroring and can be used in ACL configurations.

While adding a new ERSPAN session, users need to configure the following fields that are used while forwarding the mirrored packets.

1) source IP address,
2) destination IP address,
3) DSCP (QoS) value with which mirrored packets are forwarded
4) TTL value
5) optional - GRE Type in case if user wants to send the packet via GRE tunnel. GRE type could be anything; it could also be left as empty; by default, it is 0x8949 for Mellanox; and 0x88be for the rest of the chips.
6) optional - Queue in which packets shall be sent out of the device. Valid values 0 to 7 for most of the devices. Users need to know their device and the number of queues supported in that device.
7) optional - Policer which will be used to control the rate at which frames are mirrored.
8) optional - List of source ports which can have both Ethernet and LAG ports.
9) optional - Direction - Mirror session direction when configured along with Source port. (Supported rx/tx/both. default direction is both)

- Usage:
  ```
  config mirror_session erspan add <session_name> <src_ip> <dst_ip> <dscp> <ttl> [gre_type] [queue] [policer <policer_name>] [source-port-list] [direction]
  ```

  The following command is also supported to be backward compatible.
  This command will be deprecated in future releases.
  ```
  config mirror_session add <session_name> <src_ip> <dst_ip> <dscp> <ttl> [gre_type] [queue]
  ```

- Example:
  ```
  root@T1-2:~# config mirror_session add mrr_legacy 1.2.3.4 20.21.22.23 8 100 0x6558 0
  root@T1-2:~# show mirror_session
  Name         Status    SRC IP     DST IP       GRE     DSCP    TTL    Queue    Policer    Monitor Port    SRC Port    Direction
  ---------    --------  --------   -----------  ------  ------  -----  -------  ---------  --------------  ----------  -----------
  mrr_legacy   inactive  1.2.3.4    20.21.22.23  0x6558  8       100    0


  root@T1-2:~# config mirror_session erspan add mrr_abcd 1.2.3.4 20.21.22.23 8 100 0x6558 0
  root@T1-2:~# show mirror_session
  Name       Status    SRC IP     DST IP       GRE     DSCP    TTL    Queue    Policer    Monitor Port    SRC Port    Direction
  ---------  --------  --------   -----------  ------  ------  -----  -------  ---------  --------------  ----------  -----------
  mrr_abcd   inactive  1.2.3.4    20.21.22.23  0x6558  8       100    0
  root@T1-2:~#

  root@T1-2:~# config mirror_session erspan add mrr_port 1.2.3.4 20.21.22.23 8 100 0x6558 0 Ethernet0
  root@T1-2:~# show mirror_session
  Name       Status    SRC IP     DST IP       GRE     DSCP    TTL    Queue    Policer    Monitor Port    SRC Port    Direction
  ---------  --------  --------   -----------  ------  ------  -----  -------  ---------  --------------  ----------  -----------
  mrr_port   inactive  1.2.3.4    20.21.22.23  0x6558  8       100    0                                   Ethernet0   both
  root@T1-2:~#
  ```

While adding a new SPAN session, users need to configure the following fields that are used while forwarding the mirrored packets.
1) destination port,
2) optional - List of source ports- List of source ports which can have both Ethernet and LAG ports.
3) optional - Direction - Mirror session direction when configured along with Source port. (Supported rx/tx/both. default direction is both)
4) optional - Queue in which packets shall be sent out of the device. Valid values 0 to 7 for most of the devices. Users need to know their device and the number of queues supported in that device.
5) optional - Policer which will be used to control the rate at which frames are mirrored.

- Usage:
  ```
  config mirror_session span add <session_name> <dst_port> [source-port-list] [direction] [queue] [policer <policer_name>]
  ```

- Example:
  ```
  root@T1-2:~# config mirror_session span add port0 Ethernet0 Ethernet4,PortChannel001,Ethernet8
  root@T1-2:~# show mirror_session
  Name    Status    DST Port    SRC Port                           Direction
  ------  --------  ----------  ---------------------------------  -----------
  port0   active    Ethernet0   Ethernet4,PortChannel10,Ethernet8  both
  root@T1-2:~#
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#mirroring)

## NAT

### NAT Show commands

**show nat config**

This command displays the NAT configuration. 

- Usage:
  ```
  show nat config [static | pool | bindings | globalvalues | zones]
  ```

With no optional arguments, the whole NAT configuration is displayed.

- Example:
  ```
  admin@sonic:~$ show nat config static

  Nat Type  IP Protocol Global IP      Global L4 Port  Local IP       Local L4 Port  Twice-Nat Id
  --------  ----------- ------------   --------------  -------------  -------------  ------------
  dnat      all         65.55.45.5     ---             10.0.0.1       ---            ---
  dnat      all         65.55.45.6     ---             10.0.0.2       ---            ---
  dnat      tcp         65.55.45.7     2000            20.0.0.1       4500           1
  snat      tcp         20.0.0.2       4000            65.55.45.8     1030           1

  admin@sonic:~$ show nat config pool

  Pool Name      Global IP Range             Global L4 Port Range
  ------------   -------------------------   --------------------
  Pool1          65.55.45.5                  1024-65535
  Pool2          65.55.45.6-65.55.45.8       ---
  Pool3          65.55.45.10-65.55.45.15     500-1000

  admin@sonic:~$ show nat config bindings

  Binding Name   Pool Name      Access-List    Nat Type  Twice-Nat Id
  ------------   ------------   ------------   --------  ------------
  Bind1          Pool1          ---            snat      ---
  Bind2          Pool2          1              snat      1
  Bind3          Pool3          2              snat      --

  admin@sonic:~$ show nat config globalvalues

  Admin Mode     : enabled
  Global Timeout : 600 secs
  TCP Timeout    : 86400 secs
  UDP Timeout    : 300 secs

  admin@sonic:~$ show nat config zones

  Port       Zone
  ----       ----
  Ethernet2  0
  Vlan100    1
  ```

**show nat statistics**

This command displays the NAT translation statistics for each entry. 

- Usage:
  ```
  show nat statistics
  ```

- Example:
  ```
  admin@sonic:~$ show nat statistics

  Protocol Source           Destination          Packets          Bytes
  -------- ---------        --------------       -------------    -------------
  all      10.0.0.1         ---                            802          1009280     
  all      10.0.0.2         ---                             23             5590            
  tcp      20.0.0.1:4500    ---                            110            12460         
  udp      20.0.0.1:4000    ---                           1156           789028            
  tcp      20.0.0.1:6000    ---                             30            34800         
  tcp      20.0.0.1:5000    65.55.42.1:2000                128           110204     
  tcp      20.0.0.1:5500    65.55.42.1:2000                  8             3806
  ```

**show nat translations**

This command displays the NAT translation entries. 

- Usage:
  ```
  show nat translations [count]
  ```
Giving the optional count argument displays only the details about the number of translation entries. 
- Example:
  ```
  admin@sonic:~$ show nat translations

  Static NAT Entries        ................. 4
  Static NAPT Entries       ................. 2
  Dynamic NAT Entries       ................. 0
  Dynamic NAPT Entries      ................. 4
  Static Twice NAT Entries  ................. 0
  Static Twice NAPT Entries ................. 4
  Dynamic Twice NAT Entries  ................ 0
  Dynamic Twice NAPT Entries ................ 0
  Total SNAT/SNAPT Entries   ................ 9
  Total DNAT/DNAPT Entries   ................ 9
  Total Entries              ................ 14

  Protocol Source           Destination       Translated Source  Translated Destination
  -------- ---------        --------------    -----------------  ----------------------
  all      10.0.0.1         ---               65.55.42.2         ---
  all      ---              65.55.42.2        ---                10.0.0.1
  all      10.0.0.2         ---               65.55.42.3         ---
  all      ---              65.55.42.3        ---                10.0.0.2
  tcp      20.0.0.1:4500    ---               65.55.42.1:2000    ---
  tcp      ---              65.55.42.1:2000   ---                20.0.0.1:4500
  udp      20.0.0.1:4000    ---               65.55.42.1:1030    ---
  udp      ---              65.55.42.1:1030   ---                20.0.0.1:4000
  tcp      20.0.0.1:6000    ---               65.55.42.1:1024    ---
  tcp      ---              65.55.42.1:1024   ---                20.0.0.1:6000
  tcp      20.0.0.1:5000    65.55.42.1:2000   65.55.42.1:1025    20.0.0.1:4500
  tcp      20.0.0.1:4500    65.55.42.1:1025   65.55.42.1:2000    20.0.0.1:5000
  tcp      20.0.0.1:5500    65.55.42.1:2000   65.55.42.1:1026    20.0.0.1:4500
  tcp      20.0.0.1:4500    65.55.42.1:1026   65.55.42.1:2000    20.0.0.1:5500

  admin@sonic:~$ show nat translations count

  Static NAT Entries        ................. 4
  Static NAPT Entries       ................. 2
  Dynamic NAT Entries       ................. 0
  Dynamic NAPT Entries      ................. 4
  Static Twice NAT Entries  ................. 0
  Static Twice NAPT Entries ................. 4
  Dynamic Twice NAT Entries  ................ 0
  Dynamic Twice NAPT Entries ................ 0
  Total SNAT/SNAPT Entries   ................ 9
  Total DNAT/DNAPT Entries   ................ 9
  Total Entries              ................ 14
  ```

### NAT Config commands

**config nat add static**

This command is used to add a static NAT or NAPT entry.
When configuring the Static NAT entry, user has to specify the following fields with 'basic' keyword.

1. Global IP address,
2. Local IP address,
3. NAT type (snat / dnat) to be applied on the Global IP address. Default value is dnat. This is optinoal argument.
4. Twice NAT Id. This is optional argument used in case of twice nat configuration.

When configuring the Static NAPT entry, user has to specify the following fields.

1. IP protocol type (tcp / udp)
2. Global IP address + Port
3. Local IP address + Port
4. NAT type (snat / dnat) to be applied on the Global IP address + Port. Default value is dnat. This is optional argument.
5. Twicw NAT Id. This is optional argument used in case of twice nat configuration.

- Usage:
  ```
  config nat add static {{basic (global-ip) (local-ip)} | {{tcp | udp} (global-ip) (global-port) (local-ip) (local-port)}} [-nat_type {snat | dnat}] [-twice_nat_id (value)]
  ```

To delete a static NAT or NAPT entry, use the command below. Giving the all argument deletes all the configured static NAT and NAPT entries.
```
config nat remove static {{basic (global-ip) (local-ip)} | {{tcp | udp} (global-ip) (global-port) (local-ip) (local-port)} | all}
```
- Example:
  ```
  admin@sonic:~$ sudo config nat add static basic 65.55.45.1 12.12.12.14 -nat_type dnat
  admin@sonic:~$ sudo config nat add static tcp 65.55.45.2 100 12.12.12.15 200 -nat_type dnat

  admin@sonic:~$ show nat translations

  Static NAT Entries        ................. 2
  Static NAPT Entries       ................. 2
  Dynamic NAT Entries       ................. 0
  Dynamic NAPT Entries      ................. 0
  Static Twice NAT Entries  ................. 0
  Static Twice NAPT Entries ................. 0
  Dynamic Twice NAT Entries  ................ 0
  Dynamic Twice NAPT Entries ................ 0
  Total SNAT/SNAPT Entries   ................ 2
  Total DNAT/DNAPT Entries   ................ 2
  Total Entries              ................ 4

  Protocol Source           Destination       Translated Source  Translated Destination
  -------- ---------        --------------    -----------------  ----------------------
  all      12.12.12.14      ---               65.55.42.1         ---
  all      ---              65.55.42.1        ---                12.12.12.14
  tcp      12.12.12.15:200  ---               65.55.42.2:100     ---
  tcp      ---              65.55.42.2:100    ---                12.12.12.15:200
  ```

**config nat add pool**

This command is used to create a NAT pool used for dynamic Source NAT or NAPT translations.
Pool can be configured in one of the following combinations.

1. Global IP address range (or)
2. Global IP address + L4 port range (or)
3. Global IP address range + L4 port range.

- Usage:
  ```
  config nat add pool (pool-name) (global-ip-range) (global-port-range)
  ```
To delete a NAT pool, use the command. Pool cannot be removed if it is referenced by a NAT binding. Giving the pools argument removes all the configured pools.
```
config nat remove {pool (pool-name) | pools}
```
- Example:
  ```
  admin@sonic:~$ sudo config nat add pool pool1 65.55.45.2-65.55.45.10
  admin@sonic:~$ sudo config nat add pool pool2 65.55.45.3 100-1024

  admin@sonic:~$ show nat config pool

  Pool Name    Global IP Range         Global Port Range
  -----------  ----------------------  -------------------
  pool1        65.55.45.2-65.55.45.10  ---
  pool2        65.55.45.3              100-1024
  ```

**config nat add binding**

This command is used to create a NAT binding between a pool and an ACL. The following fields are needed for configuring the binding.

  1. ACL is an optional argument. If ACL argument is not given, the NAT binding is applicable to match all traffic.
  2. NAT type is an optional argument. Only DNAT type is supoprted for binding.
  3. Twice NAT Id is an optional argument. This Id is used to form a twice nat grouping with the static NAT/NAPT entry configured with the same Id.

- Usage:
  ```
  config nat add binding (binding-name) [(pool-name)] [(acl-name)] [-nat_type {snat | dnat}] [-twice_nat_id (value)]
  ```
To delete a NAT binding, use the command below. Giving the bindings argument removes all the configured bindings.
```
config nat remove {binding (binding-name) | bindings}
```
- Example:
  ```
  admin@sonic:~$ sudo config nat add binding bind1 pool1 acl1
  admin@sonic:~$ sudo config nat add binding bind2 pool2

  admin@sonic:~$ show nat config bindings

  Binding Name    Pool Name    Access-List    Nat Type    Twice-NAT Id
  --------------  -----------  -------------  ----------  --------------
  bind1           pool1        acl1           snat        ---
  bind2           pool2                       snat        ---
  ```  

**config nat add interface**

This command is used to configure NAT zone on an L3 interface. Default value of NAT zone on an L3 interface is 0. Valid range of zone values is 0-3.

- Usage:
  ```
  config nat add interface (interface-name) -nat_zone (value)
  ```
To reset the NAT zone on an interface, use the command below. Giving the interfaces argument resets the NAT zone on all the L3 interfaces to 0.
```
config nat remove {interface (interface-name) | interfaces}
```
- Example:
  ```
  admin@sonic:~$ sudo config nat add interface Ethernet28 -nat_zone 1

  admin@sonic:~$ show nat config zones

  Port          Zone
  ----------  ------
  Ethernet0        0
  Ethernet28       1
  Ethernet22       0
  Vlan2091         0
  ```  

**config nat set**

This command is used to set the NAT timeout values. Different timeout values can be configured for the NAT entry timeout, NAPT TCP entry timeout, NAPT UDP entry timeout.
Range for Global NAT entry timeout is 300 sec to 432000 sec, default value is 600 sec.
Range for TCP NAT/NAPT entry timeout is 300 sec to 432000 sec, default value is 86400 sec.
Range for UDP NAT/NAPT entry timeout is 120 sec to 600 sec, default value is 300 sec.

- Usage:
  ```
  config nat set {tcp-timeout (value) | timeout (value) | udp-timeout (value)}
  ```
To reset the timeout values to the default values, use the command
```
config nat reset {tcp-timeout | timeout | udp-timeout}
```
- Example:
  ```
  admin@sonic:~$ sudo config nat add set tcp-timeout 3600

  admin@sonic:~$ show nat config globalvalues 

  Admin Mode     : enabled
  Global Timeout : 600 secs
  TCP Timeout    : 600 secs
  UDP Timeout    : 300 secs
  ```

**config nat feature**

This command is used to enable or disable the NAT feature.

- Usage:
  ```
  config nat feature {enable | disable}
  ```

- Example:
  ```
  admin@sonic:~$ sudo config nat feature enable
  admin@sonic:~$ sudo config nat feature disable
  ```

### NAT Clear commands

**sonic-clear nat translations**

This command is used to clear the dynamic NAT and NAPT translation entries.

- Usage:
  ```
  sonic-clear nat translations
  ```

**sonic-clear nat statistics**

This command is used to clear the statistics of all the NAT and NAPT entries.

- Usage:
  ```
  sonic-clear nat statistics
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#nat)


## NTP

### NTP show commands

**show ntp**

This command displays a list of NTP peers known to the server as well as a summary of their state.

- Usage:
  ```
  show ntp
  ```

- Example:
  ```
  admin@sonic:~$ show ntp
  synchronised to NTP server (204.2.134.164) at stratum 3
     time correct to within 326797 ms
     polling server every 1024 s

       remote           refid      st t when poll reach   delay   offset  jitter
  ==============================================================================
   23.92.29.245    .XFAC.          16 u    - 1024    0    0.000    0.000   0.000
  *204.2.134.164   46.233.231.73    2 u  916 1024  377    3.079    0.394   0.128
  ```


### NTP Config Commands

This sub-section of commands is used to add or remove the configured NTP servers.

**config ntp add**

This command is used to add a NTP server IP address to the NTP server list.  Note that more that one NTP server IP address can be added in the device.

- Usage:
  ```
  config ntp add <ip_address>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config ntp add 9.9.9.9
  NTP server 9.9.9.9 added to configuration
  Restarting ntp-config service...
  ```

**config ntp delete**

This command is used to delete a configured NTP server IP address.

- Usage:
  ```
  config ntp del <ip_address>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config ntp del 9.9.9.9
  NTP server 9.9.9.9 removed from configuration
  Restarting ntp-config service...
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#NTP)

# PFC Watchdog Commands
Detailed description of the PFC Watchdog could be fount on the [this wiki page](https://github.com/Azure/SONiC/wiki/PFC-Watchdog)

**config pfcwd start \<arguments\>**

This command starts PFC Watchdog

- Usage:
  ```
  config pfcwd start --action drop ports all detection-time 400 --restoration-time 400
  config pfcwd start --action forward ports Ethernet0 Ethernet8 detection-time 400
  ```

**config pfcwd stop**

This command stops PFC Watchdog

- Usage:
  ```
  config pfcwd stop
  ```

**config pfcwd interval \<interval_in_ms\>**

This command sets PFC Watchdog counter polling interval (in ms)

- Usage:
  ```
  config pfcwd interval 200
  ```

**config pfcwd counter_poll \<enable/disable\>**

This command enables or disables PFCWD related counters polling

- Usage:
  ```
  config pfcwd counter_poll disable
  ```

**config pfcwd big_red_switch \<enable/disable\>**

This command enables or disables PFCWD's "BIG RED SWITCH"(BRS). After enabling BRS PFC Watchdog will be activated on all ports/queues it is configured for no matter whether the storm was detected or not

- Usage:
  ```
  config pfcwd big_red_switch enable
  ```

**config pfcwd start_default**

This command starts PFC Watchdog with the default settings.

- Usage:
  ```
  config pfcwd start_default
  ```

Default values are the following:  

   - detection time - 200ms
   - restoration time - 200ms
   - polling interval - 200ms
   - action - 'drop'

Additionally if number of ports in the system exceeds 32, all times will be multiplied by roughly <num_ports\>/32.


**show pfcwd config**

This command shows current PFC Watchdog configuration

- Usage:
  ```
  show pfcwd config
  ```

**show pfcwd stats**

This command shows current PFC Watchdog statistics (storms detected, packets dropped, etc)

- Usage:
  ```
  show pfcwd stats
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#pfc-watchdog-commands)

## Platform Component Firmware

### Platform Component Firmware show commands

**show platform firmware**

This command displays platform components firmware status information.

- Usage:
```bash
show platform firmware
```

- Example:
```bash
admin@sonic:~$ show platform firmware
Chassis    Module    Component    Version                  Description
---------  --------  -----------  -----------------------  ---------------------------------------
Chassis1   N/A       BIOS         0ACLH004_02.02.007_9600  BIOS - Basic Input/Output System
                     CPLD         5.3.3.1                  CPLD - includes all CPLDs in the switch
```

### Platform Component Firmware config commands

**config platform firmware install**

This command is used to install a platform component firmware.  
Both modular and non modular chassis platforms are supported.

- Usage:
```bash
config platform firmware install chassis component <component_name> fw <fw_path> [-y|--yes]
config platform firmware install module <module_name> component <component_name> fw <fw_path> [-y|--yes]
```

- Example:
```bash
admin@sonic:~$ sudo config platform firmware install chassis component BIOS fw /etc/mlnx/fw/sn3800/chassis1/bios.bin
New firmware will be installed, continue? [y/N]: y
Installing firmware:
    /etc/mlnx/fw/sn3800/chassis1/bios.bin

admin@sonic:~$ sudo config platform firmware install module Module1 component BIOS fw http://mellanox.com/fw/sn3800/module1/bios.bin
New firmware will be installed, continue? [y/N]: y
Downloading firmware:
    [##################################################]  100%
Installing firmware:
    /tmp/bios.bin
```

Supported options:
1. -y|--yes - automatic yes to prompts. Assume "yes" as answer to all prompts and run non-interactively

**config platform firmware update**

This command is used for automatic FW update of all available platform components.  
Both modular and non modular chassis platforms are supported.

Automatic FW update requires `platform_components.json` to be created and placed at:  
sonic-buildimage/device/<platform_name>/<onie_platform>/platform_components.json

Example:
1. Non modular chassis platform
```json
{
    "chassis": {
        "Chassis1": {
            "component": {
                "BIOS": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/bios.bin",
                    "version": "0ACLH003_02.02.010",
                    "info": "Cold reboot is required"
                },
                "CPLD": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/cpld.bin",
                    "version": "10",
                    "info": "Power cycle is required"
                },
                "FPGA": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/fpga.bin",
                    "version": "5",
                    "info": "Power cycle is required"
                }
            }
        }
    }
}
```

2. Modular chassis platform
```json
{
    "chassis": {
        "Chassis1": {
            "component": {
                "BIOS": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/bios.bin",
                    "version": "0ACLH003_02.02.010",
                    "info": "Cold reboot is required"
                },
                "CPLD": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/cpld.bin",
                    "version": "10",
                    "info": "Power cycle is required"
                },
                "FPGA": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/chassis1/fpga.bin",
                    "version": "5",
                    "info": "Power cycle is required"
                }
            }
        }
    },
    "module": {
        "Module1": {
            "component": {
                "CPLD": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/module1/cpld.bin",
                    "version": "10",
                    "info": "Power cycle is required"
                },
                "FPGA": {
                    "firmware": "/etc/<platform_name>/fw/<onie_platform>/module1/fpga.bin",
                    "version": "5",
                    "info": "Power cycle is required"
                }
            }
        }
    }
}
```

Note: FW update will be skipped if component definition is not provided (e.g., 'BIOS': { })

- Usage:
```bash
config platform firmware update [-y|--yes] [-f|--force] [-i|--image=current|next]
```

- Example:
```bash
admin@sonic:~$ sudo config platform firmware update
Chassis    Module    Component    Firmware                               Version                                            Status              Info
---------  --------  -----------  -------------------------------------  -------------------------------------------------  ------------------  -----------------------
Chassis1   N/A       BIOS         /etc/mlnx/fw/sn3800/chassis1/bios.bin  0ACLH004_02.02.007_9600 / 0ACLH004_02.02.007_9600  up-to-date          Cold reboot is required
                     CPLD         /etc/mlnx/fw/sn3800/chassis1/cpld.bin  5.3.3.1 / 5.3.3.2                                  update is required  Power cycle is required
New firmware will be installed, continue? [y/N]: y

Summary:

Chassis    Module    Component    Status
---------  --------  -----------  ----------
Chassis1   N/A       BIOS         up-to-date
                     CPLD         success
```

Supported options:
1. -y|--yes - automatic yes to prompts. Assume "yes" as answer to all prompts and run non-interactively
2. -f|--force - install FW regardless the current version
3. -i|--image - update FW using current/next SONiC image

Note: the default option is --image=current (current/next values are taken from `sonic-installer list`)

### Platform Component Firmware vendor specific behaviour

#### Mellanox

**CPLD update**

On Mellanox platforms CPLD update can be done either for single or for all components at once.  
The second approach is preferred. In this case an aggregated `vme` binary is used and  
CPLD component can be specified arbitrary.

- Example:
```bash
root@sonic:/home/admin# show platform firmware
Chassis                 Module    Component    Version                  Description
----------------------  --------  -----------  -----------------------  ----------------------------------------
x86_64-mlnx_msn3800-r0  N/A       BIOS         0ACLH004_02.02.007_9600  BIOS - Basic Input/Output System
                                  CPLD1        CPLD000000_REV0400       CPLD - Complex Programmable Logic Device
                                  CPLD2        CPLD000000_REV0300       CPLD - Complex Programmable Logic Device
                                  CPLD3        CPLD000000_REV0300       CPLD - Complex Programmable Logic Device
                                  CPLD4        CPLD000000_REV0100       CPLD - Complex Programmable Logic Device

root@sonic:/home/admin# BURN_VME="$(pwd)/FUI000091_Burn_SN3800_CPLD000120_REV0600_CPLD000165_REV0400_CPLD000166_REV0300_CPLD000167_REV0100.vme"
root@sonic:/home/admin# REFRESH_VME="$(pwd)/FUI000091_Refresh_SN3800_CPLD000120_REV0600_CPLD000165_REV0400_CPLD000166_REV0300_CPLD000167_REV0100.vme"

root@sonic:/home/admin# config platform firmware install chassis component CPLD1 fw -y ${BURN_VME}
root@sonic:/home/admin# config platform firmware install chassis component CPLD1 fw -y ${REFRESH_VME}

root@sonic:/home/admin# show platform firmware
Chassis                 Module    Component    Version                  Description
----------------------  --------  -----------  -----------------------  ----------------------------------------
x86_64-mlnx_msn3800-r0  N/A       BIOS         0ACLH004_02.02.007_9600  BIOS - Basic Input/Output System
                                  CPLD1        CPLD000000_REV0600       CPLD - Complex Programmable Logic Device
                                  CPLD2        CPLD000000_REV0400       CPLD - Complex Programmable Logic Device
                                  CPLD3        CPLD000000_REV0300       CPLD - Complex Programmable Logic Device
                                  CPLD4        CPLD000000_REV0100       CPLD - Complex Programmable Logic Device
```

Note: the update will have the same effect if any of CPLD1/CPLD2/CPLD3/CPLD4 will be used

Go Back To [Beginning of the document](#) or [Beginning of this section](#platform-component-firmware)


## Platform Specific Commands

There are few commands that are platform specific. Mellanox has used this feature and implemented Mellanox specific commands as follows.

**show platform mlnx sniffer**

This command shows the SDK sniffer status

- Usage:
  ```
  show platform mlnx sniffer
  ```

- Example:
  ```
  admin@sonic:~$ show platform mlnx sniffer
  sdk sniffer is disabled
  ```

**show platform mlnx sniffer**

Another show command available on ‘show platform mlnx’ which is the issu status.
This means if ISSU is enabled on this SKU or not. A warm boot command can be executed only when ISSU is enabled on the SKU.

- Usage:
  ```
  show platform mlnx issu
  ```

- Example:
  ```
  admin@sonic:~$ show platform mlnx issu
  ISSU is enabled
  ```

In the case ISSU is disabled and warm-boot is called, the user will get a notification message explaining that the command cannot be invoked.

- Example:
  ```
  admin@sonic:~$ sudo warm-reboot
  ISSU is not enabled on this HWSKU
  Warm reboot is not supported
  ```

**config platform mlnx**

This command is valid only on mellanox devices. The sub-commands for "config platform" gets populated only on mellanox platforms.
There are no other subcommands on non-Mellanox devices and hence this command appears empty and useless in other platforms.
The platform mellanox command currently includes a single sub command which is the SDK sniffer.
The SDK sniffer is a troubleshooting tool which records the RPC calls from the Mellanox SDK user API library to the sx_sdk task into a .pcap file.
This .pcap file can be replayed afterward to get the exact same configuration state on SDK and FW to reproduce and investigate issues.

A new folder will be created to store the sniffer files: "/var/log/mellanox/sniffer/". The result file will be stored in a .pcap file, which includes a time stamp of the starting time in the file name, for example, "sx_sdk_sniffer_20180224081306.pcap"
In order to have a complete .pcap file with all the RPC calls, the user should disable the SDK sniffer. Swss service will be restarted and no capturing is taken place from that moment.
It is recommended to review the .pcap file while sniffing is disabled.
Once SDK sniffer is enabled/disabled, the user is requested to approve that swss service will be restarted.
For example: To change SDK sniffer status, swss service will be restarted, continue? [y/N]:
In order to avoid that confirmation the -y / --yes option should be used.

- Usage:
  ```
  config platform mlnx sniffer sdk [-y|--yes]
  ```

- Example:
  ```
  admin@sonic:~$ config platform mlnx sniffer sdk
  To change SDK sniffer status, swss service will be restarted, continue? [y/N]: y
  NOTE: In order to avoid that confirmation the -y / --yes option should be used.
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#platform-specific-commands)


## PortChannels

### PortChannel Show commands

**show interfaces portchannel**

This command displays all the port channels that are configured in the device and its current status.

- Usage:
  ```
  show interfaces portchannel
  ```

- 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)
     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)
  ```


### PortChannel Config commands

This sub-section explains how to configure the portchannel and its member ports.

**config portchannel**

This command is used to add or delete the portchannel.
It is recommended to use portchannel names in the format "PortChannelxxxx", where "xxxx" is number of 1 to 4 digits. Ex: "PortChannel0002".

NOTE: If users specify any other name like "pc99", command will succeed, but such names are not supported. Such names are not printed properly in the "show interface portchannel" command. It is recommended not to use such names.

When any port is already member of any other portchannel and if user tries to add the same port in some other portchannel (without deleting it from the current portchannel), the command fails internally. But, it does not print any error message. In such cases, remove the member from current portchannel and then add it to new portchannel.

Command takes two optional arguements given below.
1) min-links  - minimum number of links required to bring up the portchannel
2) fallback - true/false. LACP fallback feature can be enabled / disabled.  When it is set to true, only one member port will be selected as active per portchannel during fallback mode. Refer https://github.com/Azure/SONiC/blob/master/doc/lag/LACP%20Fallback%20Feature%20for%20SONiC_v0.5.md for more details about fallback feature.

A port channel can be deleted only if it does not have any members or the members are already deleted. When a user tries to delete a port channel and the port channel still has one or more members that exist, the deletion of port channel is blocked. 

- Usage:
  ```
  config portchannel (add | del) <portchannel_name> [min-links <num_min_links>] [fallback (true | false)]
  ```

- Example (Create the portchannel with name "PortChannel0011"):
  ```
  admin@sonic:~$ sudo config portchannel add PortChannel0011
  ```

**config portchannel member**

This command adds or deletes a member port to/from the already created portchannel.

- Usage:
  ```
  config portchannel member (add | del) <portchannel_name> <member_portname>
  ```

- Example (Add interface Ethernet4 as member of the portchannel "PortChannel0011"):
  ```
  admin@sonic:~$ sudo config portchannel member add PortChannel0011 Ethernet4
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#portchannels)

## QoS

### QoS Show commands

#### PFC

**show pfc counters**

This command displays the details of Rx & Tx priority-flow-control (pfc) for all ports. This command can be used to clear the counters using -c option.

- Usage:
  ```
  show pfc counters
  ```

- Example:
   ```
   admin@sonic:~$ show pfc counters
      Port Rx    PFC0    PFC1    PFC2    PFC3    PFC4    PFC5    PFC6    PFC7
    -----------  ------  ------  ------  ------  ------  ------  ------  ------
    Ethernet0       0       0       0       0       0       0       0       0
    Ethernet4       0       0       0       0       0       0       0       0
    Ethernet8       0       0       0       0       0       0       0       0
   Ethernet12       0       0       0       0       0       0       0       0

      Port Tx    PFC0    PFC1    PFC2    PFC3    PFC4    PFC5    PFC6    PFC7
    -----------  ------  ------  ------  ------  ------  ------  ------  ------
    Ethernet0       0       0       0       0       0       0       0       0
    Ethernet4       0       0       0       0       0       0       0       0
    Ethernet8       0       0       0       0       0       0       0       0
   Ethernet12       0       0       0       0       0       0       0       0

   ...
   ```


- NOTE: PFC counters can be cleared by the user with the following command:
  ```
  admin@sonic:~$ sonic-clear pfccounters
  ```

**show pfc asymmetric**

This command displays the status of asymmetric PFC for all interfaces or a given interface.

- Usage:
  ```
  show pfc asymmetric [<interface>]
  ```

- Example:
  ```
  admin@sonic:~$ show pfc asymmetric
  
  Interface    Asymmetric
  -----------  ------------
  Ethernet0    off
  Ethernet2    off
  Ethernet4    off
  Ethernet6    off
  Ethernet8    off
  Ethernet10   off
  Ethernet12   off
  Ethernet14   off

  admin@sonic:~$ show pfc asymmetric Ethernet0

  Interface    Asymmetric
  -----------  ------------
  Ethernet0    off
  ```

**show pfc priority**

This command displays the lossless priorities for all interfaces or a given interface.

- Usage:
  ```
  show pfc priority [<interface>]
  ```

- Example:
  ```
  admin@sonic:~$ show pfc priority
  
  Interface    Lossless priorities
  -----------  ---------------------
  Ethernet0    3,4
  Ethernet2    3,4
  Ethernet8    3,4
  Ethernet10   3,4
  Ethernet16   3,4

  admin@sonic:~$ show pfc priority Ethernet0
  
  Interface    Lossless priorities
  -----------  ---------------------
  Ethernet0    3,4
  ```

#### Queue And Priority-Group

This sub-section explains the following queue parameters that can be displayed using "show queue" command.
1) queue counters
2) queue watermark
3) priority-group  watermark
4) queue persistent-watermark


**show queue counters**

This command displays packet and byte counters for all queues of all ports or one specific-port given as arguement.
This command can be used to clear the counters for all queues of all ports. Note that port specific clear is not supported.

- Usage:
  ```
  show queue counters [<interface_name>]
  ```

- Example:
  ```
  admin@sonic:~$ show queue counters
       Port    TxQ    Counter/pkts    Counter/bytes    Drop/pkts    Drop/bytes
  ---------  -----  --------------  ---------------  -----------  ------------
  Ethernet0    UC0               0                0            0             0
  Ethernet0    UC1               0                0            0             0
  Ethernet0    UC2               0                0            0             0
  Ethernet0    UC3               0                0            0             0
  Ethernet0    UC4               0                0            0             0
  Ethernet0    UC5               0                0            0             0
  Ethernet0    UC6               0                0            0             0
  Ethernet0    UC7               0                0            0             0
  Ethernet0    UC8               0                0            0             0
  Ethernet0    UC9               0                0            0             0
  Ethernet0    MC0               0                0            0             0
  Ethernet0    MC1               0                0            0             0
  Ethernet0    MC2               0                0            0             0
  Ethernet0    MC3               0                0            0             0
  Ethernet0    MC4               0                0            0             0
  Ethernet0    MC5               0                0            0             0
  Ethernet0    MC6               0                0            0             0
  Ethernet0    MC7               0                0            0             0
  Ethernet0    MC8               0                0            0             0
  Ethernet0    MC9               0                0            0             0

       Port    TxQ    Counter/pkts    Counter/bytes    Drop/pkts    Drop/bytes
  ---------  -----  --------------  ---------------  -----------  ------------
  Ethernet4    UC0               0                0            0             0
  Ethernet4    UC1               0                0            0             0
  Ethernet4    UC2               0                0            0             0
  Ethernet4    UC3               0                0            0             0
  Ethernet4    UC4               0                0            0             0
  Ethernet4    UC5               0                0            0             0
  Ethernet4    UC6               0                0            0             0
  Ethernet4    UC7               0                0            0             0
  Ethernet4    UC8               0                0            0             0
  Ethernet4    UC9               0                0            0             0
  Ethernet4    MC0               0                0            0             0
  Ethernet4    MC1               0                0            0             0
  Ethernet4    MC2               0                0            0             0
  Ethernet4    MC3               0                0            0             0
  Ethernet4    MC4               0                0            0             0
  Ethernet4    MC5               0                0            0             0
  Ethernet4    MC6               0                0            0             0
  Ethernet4    MC7               0                0            0             0
  Ethernet4    MC8               0                0            0             0
  Ethernet4    MC9               0                0            0             0

  ...
  ```

Optionally, you can specify an interface name in order to display only that particular interface

- Example:
  ```
  admin@sonic:~$ show queue counters Ethernet72
  ```

- NOTE: Queue counters can be cleared by the user with the following command:
  ```
  admin@sonic:~$ sonic-clear queuecounters
  ```

**show queue watermark**

This command displays the user watermark for the queues (Egress shared pool occupancy per queue) for either the unicast queues or multicast queues for all ports

- Usage:
  ```
  show queue watermark (multicast | unicast)
  ```

- Example:
  ```
  admin@sonic:~$ show queue watermark unicast
  Egress shared pool occupancy per unicast queue:
         Port    UC0    UC1    UC2    UC3    UC4    UC5    UC6    UC7
  -----------  -----  -----  -----  -----  -----  -----  -----  -----
    Ethernet0      0      0      0      0      0      0      0      0
    Ethernet4      0      0      0      0      0      0      0      0
    Ethernet8      0      0      0      0      0      0      0      0
    Ethernet12     0      0      0      0      0      0      0      0

  admin@sonic:~$ show queue watermark multicast (Egress shared pool occupancy per multicast queue)
  ```

**show priority-group**

This command displays:
1) The user watermark or persistent-watermark for the Ingress "headroom" or "shared pool occupancy" per priority-group for all ports.
2) Dropped packets per priority-group for all ports

- Usage:
  ```
  show priority-group (watermark | persistent-watermark) (headroom | shared)
  show priority-group drop counters
  ```

- Example:
  ```
  admin@sonic:~$ show priority-group watermark shared
  Ingress shared pool occupancy per PG:
         Port    PG0    PG1    PG2    PG3    PG4    PG5    PG6    PG7
  -----------  -----  -----  -----  -----  -----  -----  -----  -----
    Ethernet0      0      0      0      0      0      0      0      0
    Ethernet4      0      0      0      0      0      0      0      0
    Ethernet8      0      0      0      0      0      0      0      0
    Ethernet12     0      0      0      0      0      0      0      0
  ```

- Example (Ingress headroom per PG):
  ```
  admin@sonic:~$ show priority-group watermark headroom
  ```

- Example (Ingress shared pool occupancy per PG):
  ```
  admin@sonic:~$ show priority-group persistent-watermark shared
  ```

- Example (Ingress headroom per PG):
  ```
  admin@sonic:~$ show priority-group persistent-watermark headroom
  ```

- Example (Ingress dropped packets per PG):
  ```
  admin@sonic:~$ show priority-group drop counters
  Ingress PG dropped packets:
        Port    PG0    PG1    PG2    PG3    PG4    PG5    PG6    PG7
  -----------  -----  -----  -----  -----  -----  -----  -----  -----
    Ethernet0      0      0      0      0      0      0      0      0
    Ethernet4      0      0      0      0      0      0      0      0
    Ethernet8      0      0      0      0      0      0      0      0
   Ethernet12      0      0      0      0      0      0      0      0
  ```

In addition to user watermark("show queue|priority-group watermark ..."), a persistent watermark is available.
It hold values independently of user watermark. This way user can use "user watermark" for debugging, clear it, etc, but the "persistent watermark" will not be affected.

**show queue persistent-watermark**

This command displays the user persistet-watermark for the queues (Egress shared pool occupancy per queue) for either the unicast queues or multicast queues for all ports

- Usage:
  ```
  show queue persistent-watermark (unicast | multicast)
  ```

- Example:
  ```
  admin@sonic:~$ show queue persistent-watermark unicast
  Egress shared pool occupancy per unicast queue:
         Port    UC0    UC1    UC2    UC3    UC4    UC5    UC6    UC7
  -----------  -----  -----  -----  -----  -----  -----  -----  -----
    Ethernet0    N/A    N/A    N/A    N/A    N/A    N/A    N/A    N/A
    Ethernet4    N/A    N/A    N/A    N/A    N/A    N/A    N/A    N/A
    Ethernet8    N/A    N/A    N/A    N/A    N/A    N/A    N/A    N/A
    Ethernet12   N/A    N/A    N/A    N/A    N/A    N/A    N/A    N/A
  ```

- Example (Egress shared pool occupancy per multicast queue):
  ```
  admin@sonic:~$ show queue persistent-watermark multicast
  ```

- NOTE: "user watermark", "persistent watermark" and "ingress dropped packets" can be cleared by user:

  ```
  admin@sonic:~$ sonic-clear queue persistent-watermark unicast

  admin@sonic:~$ sonic-clear queue persistent-watermark multicast

  admin@sonic:~$ sonic-clear priority-group persistent-watermark shared

  admin@sonic:~$ sonic-clear priority-group persistent-watermark headroom

  admin@sonic:~$ sonic-clear priority-group drop counters
  ```

#### Buffer Pool

This sub-section explains the following buffer pool parameters that can be displayed using "show buffer_pool" command.
1) buffer pool watermark
2) buffer pool persistent-watermark

**show buffer_pool watermark**

This command displays the user watermark for all the buffer pools

- Usage:
  ```
  show buffer_pool watermark
  ```

- Example:
  ```
  admin@sonic:~$ show buffer_pool watermark
  Shared pool maximum occupancy:
                   Pool    Bytes
  ---------------------  -------
  ingress_lossless_pool        0
             lossy_pool     2464
  ```


**show buffer_pool persistent-watermark**

This command displays the user persistent-watermark for all the buffer pools

- Usage:
  ```
  show buffer_pool persistent-watermark
  ```

- Example:
  ```
  admin@sonic:~$ show buffer_pool persistent-watermark
  Shared pool maximum occupancy:
                   Pool    Bytes
  ---------------------  -------
  ingress_lossless_pool        0
             lossy_pool     2464
  ```



### QoS config commands

**config qos clear**

This command is used to clear all the QoS configuration from all the following QOS Tables in ConfigDB.

1) TC_TO_PRIORITY_GROUP_MAP,
2) MAP_PFC_PRIORITY_TO_QUEUE,
3) TC_TO_QUEUE_MAP,
4) DSCP_TO_TC_MAP,
5) SCHEDULER,
6) PFC_PRIORITY_TO_PRIORITY_GROUP_MAP,
7) PORT_QOS_MAP,
8) WRED_PROFILE,
9) QUEUE,
10) CABLE_LENGTH,
11) BUFFER_POOL,
12) BUFFER_PROFILE,
13) BUFFER_PG,
14) BUFFER_QUEUE

- Usage:
  ```
  config qos clear
  ```

- Example:
  ```
  admin@sonic:~$ sudo config qos clear
  ```

**config qos reload**

This command is used to reload the QoS configuration.
QoS configuration has got two sets of configurations.
1) Generic QOS Configuration - This gives complete list of all possible QOS configuration. Its given in the file /usr/share/sonic/templates/qos_config.j2 in the device.
   Reference: https://github.com/Azure/sonic-buildimage/blob/master/files/build_templates/qos_config.j2
   Users have flexibility to have platform specific qos configuration by placing the qos_config.j2 file at /usr/share/sonic/device/<platform>/<hwsku>/.
   If users want to modify any of this loaded QOS configuration, they can modify this file in the device and then issue the "config qos reload" command.

2) Platform specific buffer configuration. Every platform has got platform specific and topology specific (T0 or T1 or T2) buffer configuration at /usr/share/sonic/device/<platform>/<hwsku>/buffers_defaults_tx.j2
   In addition to platform specific configuration file, a generic configuration file is also present at /usr/share/sonic/templates/buffers_config.j2.
   Reference: https://github.com/Azure/sonic-buildimage/blob/master/files/build_templates/buffers_config.j2
   Users can either modify the platform specific configuration file, or the generic configuration file and then issue this "config qos reload" command.

These configuration files are already loaded in the device as part of the reboot process. In case if users wants to modify any of these configurations, they need to modify the appropriate QOS tables and fields in these files and then use this reload command.
This command uses those modified buffers.json.j2 file & qos.json.j2 file and reloads the new QOS configuration.
If users have not made any changes in these configuration files, this command need not be executed.

Some of the example QOS configurations that users can modify are given below.
1) TC_TO_PRIORITY_GROUP_MAP
2) MAP_PFC_PRIORITY_TO_QUEUE
3) TC_TO_QUEUE_MAP
4) DSCP_TO_TC_MAP
5) SCHEDULER
6) PFC_PRIORITY_TO_PRIORITY_GROUP_MAP
7) PORT_QOS_MAP
8) WRED_PROFILE
9) CABLE_LENGTH
10) BUFFER_QUEUE

- Usage:
  ```
  config qos reload
  ```

- Example:
  ```
  admin@sonic:~$ sudo config qos reload
  Running command: /usr/local/bin/sonic-cfggen -d -t /usr/share/sonic/device/x86_64-dell_z9100_c2538-r0/Force10-Z9100-C32/buffers.json.j2 >/tmp/buffers.json
  Running command: /usr/local/bin/sonic-cfggen -d -t /usr/share/sonic/device/x86_64-dell_z9100_c2538-r0/Force10-Z9100-C32/qos.json.j2 -y /etc/sonic/sonic_version.yml >/tmp/qos.json
  Running command: /usr/local/bin/sonic-cfggen -j /tmp/buffers.json --write-to-db
  Running command: /usr/local/bin/sonic-cfggen -j /tmp/qos.json --write-to-db

  In this example, it uses the buffers.json.j2 file and qos.json.j2 file from platform specific folders.
  When there are no changes in the platform specific configutation files, they internally use the file "/usr/share/sonic/templates/buffers_config.j2" and "/usr/share/sonic/templates/qos_config.j2" to generate the configuration.
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#qos)

## sFlow

### sFlow Show commands

**show sflow**

This command displays the global sFlow configuration that includes the admin state, collectors, the Agent ID and counter polling interval.

- Usage:
  ```
  show sflow
  ```

- Example:
  ```
  admin@sonic:~# show sflow
  sFlow Global Information:
  sFlow Admin State:          up
  sFlow Polling Interval:     default
  sFlow AgentID:              lo

  2 Collectors configured:
    Name: collector_A         IP addr: 10.11.46.2 UDP port: 6343
    Name: collector_lo        IP addr: 127.0.0.1  UDP port: 6343
  ```


**show sflow interface**

This command displays the per-interface sflow admin status and the sampling rate.

- Usage:
  ```
  show sflow interface
  ```

- Example:
  ```
  admin@sonic:~# show sflow interface

  sFlow interface configurations
  +-------------+---------------+-----------------+
  | Interface   | Admin State   |   Sampling Rate |
  +=============+===============+=================+
  | Ethernet0   | up            |            4000 |
  +-------------+---------------+-----------------+
  | Ethernet1   | up            |            4000 |
  +-------------+---------------+-----------------+
  ...
  +-------------+---------------+-----------------+
  | Ethernet61  | up            |            4000 |
  +-------------+---------------+-----------------+
  | Ethernet62  | up            |            4000 |
  +-------------+---------------+-----------------+
  | Ethernet63  | up            |            4000 |
  +-------------+---------------+-----------------+

  ```

### sFlow Config commands

**config sflow collector add**

This command is used to add a sFlow collector. Note that a maximum of 2 collectors is allowed.

- Usage:
  ```
  config sflow collector add <collector-name> <ipv4-address | ipv6-address> [port <number>]
  ```

  - Parameters:
    - collector-name: unique name of the sFlow collector
    - ipv4-address : IP address of the collector in dotted decimal format for IPv4
    - ipv6-address : x: x: x: x::x format for IPv6 address of the collector (where :: notation specifies successive hexadecimal fields of zeros)
    - port (OPTIONAL): specifies the UDP port of the collector (the range is from 0 to 65535. The default is 6343.)

- Example:
  ```
  admin@sonic:~# sudo config sflow collector add collector_A 10.11.46.2
  ```

**config sflow collector del**

This command is used to delete a sFlow collector with the given name.

- Usage:
  ```
  config sflow collector del <collector-name>
  ```

  - Parameters:
    - collector-name: unique name of the sFlow collector

- Example:
  ```
  admin@sonic:~# sudo config sflow collector del collector_A
  ```

**config sflow agent-id**

This command is used to add/delete the sFlow agent-id. This setting is global (applicable to both collectors) and optional. Only a single agent-id is allowed. If agent-id is not specified (with this CLI), an appropriate IP that belongs to the switch is used as the agent-id based on some simple heuristics.

- Usage:
  ```
  config sflow agent-id <add|del> <interface-name>
  ```

  - Parameters:
    - interface-name: specify the interface name whose ipv4 or ipv6 address will be used as the agent-id in sFlow datagrams.

- Example:
  ```
  admin@sonic:~# sudo config sflow agent-id add lo
  ```

**config sflow**

Globally, sFlow is disabled by default. When sFlow is enabled globally, the sflow deamon is started and sampling will start on all interfaces which have sFlow enabled at the interface level (see “config sflow interface…”). When sflow is disabled globally, sampling is stopped on all relevant interfaces and sflow daemon is stopped.

- Usage:
  ```
  config sflow <enable|disable>
  ```
- Example:
  ```
  admin@sonic:~# sudo config sflow enable
  ```  
**config sflow interface**

Enable/disable sflow at an interface level. By default, sflow is enabled on all interfaces at the interface level. Use this command to explicitly disable sFlow for a specific interface. An interface is sampled if sflow is enabled globally as well as at the interface level. Note that this configuration deals only with sFlow flow samples and not counter samples.

- Usage:
  ```
  config sflow interface <enable|disable> <interface-name|all>
  ```

  - Parameters:
    - interface-name: specify the interface for which sFlow flow samples have to be enabled/disabled. The “all” keyword is used as a convenience to enable/disable sflow at the interface level for all the interfaces.

- Example:
  ```
  admin@sonic:~# sudo config sflow interface disable Ethernet40
  ```

**config sflow interface sample-rate**

Configure the sample-rate for a specific interface.

The default sample rate for any interface is (ifSpeed / 1e6) where ifSpeed is in bits/sec. So, the default sample rate based on interface speed is:

    1-in-1000 for a 1G link
    1-in-10,000 for a 10G link
    1-in-40,000 for a 40G link
    1-in-50,000 for a 50G link
    1-in-100,000 for a 100G link

It is recommended not to change the defaults. This CLI is to be used only in case of exceptions (e.g., to set the sample-rate to the nearest power-of-2 if there are hardware restrictions in using the defaults)

- Usage:
  ```
  config sflow interface sample-rate <interface-name> <value>
  ```

  - Parameters:
    - interface-name: specify the interface for which the sampling rate value is to be set
    - value: value is the average number of packets skipped before the sample is taken. "The sampling rate specifies random sampling probability as the ratio of packets observed to samples generated. For example a sampling rate of 256 specifies that, on average, 1 sample will be generated for every 256 packets observed." Valid range 256:8388608.

- Example:
  ```
  admin@sonic:~# sudo config sflow interface sample-rate Ethernet32 1000
  ```
**config sflow polling-interval**

This command is used to set the counter polling interval. Default is 20 seconds.

- Usage:
  ```
  config sflow polling-interval <value>
  ```

  - Parameters:
    - value: 0-300 seconds. Set polling-interval to 0 to disable counter polling

- Example:
  ```
  admin@sonic:~# sudo config sflow polling-interval 30
  ```


Go Back To [Beginning of the document](#) or [Beginning of this section](#sflow)

## Startup & Running Configuration

### Startup Configuration

**show startupconfiguration bgp**

This command is used to display the startup configuration for the BGP module.

- Usage:
  ```
  show startupconfiguration bgp
  ```

- Example:
  ```
  admin@sonic:~$ show startupconfiguration bgp
  Routing-Stack is: quagga
  !
  ! =========== Managed by sonic-cfggen DO NOT edit manually! ====================
  ! generated by templates/quagga/bgpd.conf.j2 with config DB data
  ! file: bgpd.conf
  !
  !
  hostname T1-2
  password zebra
  log syslog informational
  log facility local4
  ! enable password !
  !
  ! bgp multiple-instance
  !
  route-map FROM_BGP_SPEAKER_V4 permit 10
  !
  route-map TO_BGP_SPEAKER_V4 deny 10
  !
  router bgp 65000
    bgp log-neighbor-changes
    bgp bestpath as-path multipath-relax
    no bgp default ipv4-unicast
    bgp graceful-restart restart-time 180

  <Only the partial output is shown here. In actual command, more configuration information will be displayed>
  ```

### Running Configuration
This sub-section explains the show commands for displaying the running configuration for the following modules.
1) bgp
2) interfaces
3) ntp
4) snmp
5) all
6) acl
7) ports
8) syslog

**show runningconfiguration all**

This command displays the entire running configuration.

- Usage:
  ```
  show runningconfiguration all
  ```

- Example:
  ```
  admin@sonic:~$ show runningconfiguration all
  ```

**show runningconfiguration bgp**

This command displays the running configuration of the BGP module.

- Usage:
  ```
  show runningconfiguration bgp
  ```

- Example:
  ```
  admin@sonic:~$ show runningconfiguration bgp
  ```

**show runningconfiguration interfaces**

This command displays the running configuration for the "interfaces".

- Usage:
  ```
  show runningconfiguration interfaces
  ```

- Example:
  ```
  admin@sonic:~$ show runningconfiguration interfaces
  ```

**show runningconfiguration ntp**

This command displays the running configuration of the ntp module.

- Usage:
  ```
  show runningconfiguration ntp
  ```

- Example:
  ```
  admin@sonic:~$ show runningconfiguration ntp
  NTP Servers
  -------------
  1.1.1.1
  2.2.2.2
  ```

**show runningconfiguration syslog**

This command displays the running configuration of the syslog module.

- Usage:
  ```
  show runningconfiguration syslog
  ```

- Example:
  ```
  admin@sonic:~$ show runningconfiguration syslog
  Syslog Servers
  ----------------
  4.4.4.4
  5.5.5.5
  ```


**show runningconfiguration snmp**

This command displays the running configuration of the snmp module.

- Usage:
  ```
  show runningconfiguration snmp
  ```

- Example:
  ```
  admin@sonic:~$ show runningconfiguration snmp
  ```

**show runningconfiguration acl**

 This command displays the running configuration of the acls

- Usage:
  ```
  show runningconfiguration acl
  ```

- Example:
  ```
  admin@sonic:~$ show runningconfiguration acl
  ```

 **show runningconfiguration ports**

 This command displays the running configuration of the ports

- Usage:
  ```
  show runningconfiguration ports [<portname>]
  ```

- Examples:
  ```
  admin@sonic:~$ show runningconfiguration ports
  ```

  ```
  admin@sonic:~$ show runningconfiguration ports Ethernet0
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#Startup--Running-Configuration)


## Syslog

### Syslog Config Commands

This sub-section of commands is used to add or remove the configured syslog servers.

**config syslog add**

This command is used to add a SYSLOG server to the syslog server list.  Note that more that one syslog server can be added in the device.

- Usage:
  ```
  config syslog add <ip_address>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config syslog add 1.1.1.1
  Syslog server 1.1.1.1 added to configuration
  Restarting rsyslog-config service...
  ```

**config syslog delete**

This command is used to delete the syslog server configured.

- Usage:
  ```
  config syslog del <ip_address>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config syslog del 1.1.1.1
  Syslog server 1.1.1.1 removed from configuration
  Restarting rsyslog-config service...
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#syslog)

## System State

### Processes

This command is used to determine the CPU utilization. It also lists the active processes along with their corresponding process ID and other relevant parameters.

This sub-section explains the various "processes" specific data that includes the following.
1) cpu      Show processes CPU info
2) memory   Show processes memory info
3) summary  Show processes info

“show processes” commands provide a wrapper over linux’s “top” command. “show process cpu” sorts the processes being displayed by cpu-utilization, whereas “show process memory” does it attending to processes’ memory-utilization.

**show processes cpu**

This command displays the current CPU usage by process. This command uses linux's "top -bn 1 -o %CPU" command to display the output.

- Usage:
  ```
  show processes cpu
  ```

*TIP: Users can pipe the output to "head" to display only the "n" number of lines (e.g., `show processes cpu | head -n 10`)*

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

*TIP: Advanced users can view individual processes using variations of the `ps` command (e.g., `ps -ax | grep <process name>`)*

**show processes memory**

This command displays the current memory usage by processes. This command uses linux's "top -bn 1 -o %MEM" command to display the output.

- Usage:
  ```
  show processes memory
  ```

*NOTE that pipe option can be used using " | head -n" to display only the "n" number of lines*

- Example:
  ```
  admin@sonic:~$ show processes memory
  top - 23:41:24 up 7 days, 39 min,  2 users,  load average: 1.21, 1.19, 1.18
  Tasks: 191 total,   2 running, 189 sleeping,   0 stopped,   0 zombie
  %Cpu(s):  2.8 us, 20.7 sy,  0.0 ni, 76.3 id,  0.0 wa,  0.0 hi,  0.2 si,  0.0 st
  KiB Mem :  8162264 total,  5720412 free,   945516 used,  1496336 buff/cache
  KiB Swap:        0 total,        0 free,        0 used.  6855632 avail Mem

    PID USER      PR  NI    VIRT    RES    SHR S  %CPU %MEM     TIME+ COMMAND
  18051 root      20   0  851540 274784   8344 S   0.0  3.4   0:02.77 syncd
  17760 root      20   0 1293428 259212  58732 S   5.9  3.2  96:46.22 syncd
    508 root      20   0  725364  76244  38220 S   0.0  0.9   4:54.49 dockerd
  30853 root      20   0   96348  56824   7880 S   0.0  0.7   0:00.98 show
  17266 root      20   0  509876  49772  30640 S   0.0  0.6   0:06.36 docker
  24891 admin     20   0  515864  49560  30644 S   0.0  0.6   0:05.54 docker
  17643 admin     20   0  575668  49428  30628 S   0.0  0.6   0:06.29 docker
  23885 admin     20   0  369552  49344  30840 S   0.0  0.6   0:05.57 docker
  18055 root      20   0  509076  49260  30296 S   0.0  0.6   0:06.36 docker
  17268 root      20   0  371120  49052  30372 S   0.0  0.6   0:06.45 docker
   1227 root      20   0  443284  48640  30100 S   0.0  0.6   0:41.91 docker
  23785 admin     20   0  443796  48552  30128 S   0.0  0.6   0:05.58 docker
  17820 admin     20   0  435088  48144  29480 S   0.0  0.6   0:06.33 docker
    506 root      20   0 1151040  43140  23964 S   0.0  0.5   8:51.08 containerd
  18437 root      20   0   84852  26388   7380 S   0.0  0.3  65:59.76 python3.6
  ```


**show processes summary**

This command displays the current summary information about all the processes

- Usage:
  ```
  show processes summary
  ```

- Example:
  ```
  admin@sonic:~$ show processes summary
  PID  PPID CMD                         %MEM %CPU
  1       0 /sbin/init                   0.0  0.0
  2       0 [kthreadd]                   0.0  0.0
  3       2 [ksoftirqd/0]                0.0  0.0
  5       2 [kworker/0:0H]               0.0  0.0
  ...
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#System-State)

### Services & Memory

These commands are used to know the services that are running and the memory that is utilized currently.


**show services**

This command displays the state of all the SONiC processes running inside a docker container. This helps to identify the status of SONiC’s critical processes.

- Usage:
  ```
  show services
  ```

- Example:
  ```
  admin@sonic:~$ show services
  dhcp_relay      docker
  ---------------------------
  UID        PID  PPID  C STIME TTY          TIME CMD
  root         1     0  0 05:26 ?        00:00:12 /usr/bin/python /usr/bin/supervi
  root        24     1  0 05:26 ?        00:00:00 /usr/sbin/rsyslogd -n

  nat     docker
  ---------------------------
  USER       PID PPID  C STIME TTY          TIME CMD
  root         1    0  0 05:26 ?        00:00:12 /usr/bin/python /usr/bin/supervisord
  root        18    1  0 05:26 ?        00:00:00 /usr/sbin/rsyslogd -n               
  root        23    1  0 05:26 ?        00:00:01 /usr/bin/natmgrd                    
  root        34    1  0 05:26 ?        00:00:00 /usr/bin/natsyncd 

  snmp    docker
  ---------------------------
  UID        PID  PPID  C STIME TTY          TIME CMD
  root         1     0  0 05:26 ?        00:00:16 /usr/bin/python /usr/bin/supervi
  root        24     1  0 05:26 ?        00:00:02 /usr/sbin/rsyslogd -n
  Debian-+    29     1  0 05:26 ?        00:00:04 /usr/sbin/snmpd -f -LS4d -u Debi
  root        31     1  1 05:26 ?        00:15:10 python3.6 -m sonic_ax_impl

  syncd   docker
  ---------------------------
  UID        PID  PPID  C STIME TTY          TIME CMD
  root         1     0  0 05:26 ?        00:00:13 /usr/bin/python /usr/bin/supervi
  root        12     1  0 05:26 ?        00:00:00 /usr/sbin/rsyslogd -n
  root        17     1  0 05:26 ?        00:00:00 /usr/bin/dsserve /usr/bin/syncd
  root        27    17 22 05:26 ?        04:09:30 /usr/bin/syncd --diag -p /usr/sh
  root        51    27  0 05:26 ?        00:00:01 /usr/bin/syncd --diag -p /usr/sh

  swss    docker
  ---------------------------
  UID        PID  PPID  C STIME TTY          TIME CMD
  root         1     0  0 05:26 ?        00:00:29 /usr/bin/python /usr/bin/supervi
  root        25     1  0 05:26 ?        00:00:00 /usr/sbin/rsyslogd -n
  root        30     1  0 05:26 ?        00:00:13 /usr/bin/orchagent -d /var/log/s
  root        42     1  1 05:26 ?        00:12:40 /usr/bin/portsyncd -p /usr/share
  root        45     1  0 05:26 ?        00:00:00 /usr/bin/intfsyncd
  root        48     1  0 05:26 ?        00:00:03 /usr/bin/neighsyncd
  root        59     1  0 05:26 ?        00:00:01 /usr/bin/vlanmgrd
  root        92     1  0 05:26 ?        00:00:01 /usr/bin/intfmgrd
  root      3606     1  0 23:36 ?        00:00:00 bash -c /usr/bin/arp_update; sle
  root      3621  3606  0 23:36 ?        00:00:00 sleep 300

  ...
  ```

**show system-memory**

This command displays the system-wide memory utilization information – just a wrapper over linux native “free” command

- Usage:
  ```
  show system-memory
  ```

- Example:
  ```
  admin@sonic:~$ show system-memory
  Command: free -m -h
               total       used       free     shared    buffers     cached
  Mem:          3.9G       2.0G       1.8G        33M       324M       791M
  -/+ buffers/cache:       951M       2.9G
  Swap:           0B         0B         0B
  ```

**show mmu**

This command displays virtual address to the physical address translation status of the Memory Management Unit (MMU).

- Usage:
  ```
  show mmu
  ```

- Example:
  ```
  admin@sonic:~$ show mmu
  Pool: ingress_lossless_pool
  ----  --------
  xoff  4194112
  type  ingress
  mode  dynamic
  size  10875072
  ----  --------

  Pool: egress_lossless_pool
  ----  --------
  type  egress
  mode  static
  size  15982720
  ----  --------

  Pool: egress_lossy_pool
  ----  -------
  type  egress
  mode  dynamic
  size  9243812
  ----  -------

  Profile: egress_lossy_profile
  ----------  -------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL|egress_lossy_pool]
  size        1518
  ----------  -------------------------------

  Profile: pg_lossless_100000_300m_profile
  ----------  -----------------------------------
  xon_offset  2288
  dynamic_th  -3
  xon         2288
  xoff        268736
  pool        [BUFFER_POOL|ingress_lossless_pool]
  size        1248
  ----------  -----------------------------------

  Profile: egress_lossless_profile
  ---------  ----------------------------------
  static_th  3995680
  pool       [BUFFER_POOL|egress_lossless_pool]
  size       1518
  ---------  ----------------------------------

  Profile: pg_lossless_100000_40m_profile
  ----------  -----------------------------------
  xon_offset  2288
  dynamic_th  -3
  xon         2288
  xoff        177632
  pool        [BUFFER_POOL|ingress_lossless_pool]
  size        1248
  ----------  -----------------------------------

  Profile: ingress_lossy_profile
  ----------  -----------------------------------
  dynamic_th  3
  pool        [BUFFER_POOL|ingress_lossless_pool]
  size        0
  ----------  -----------------------------------

  Profile: pg_lossless_40000_40m_profile
  ----------  -----------------------------------
  xon_offset  2288
  dynamic_th  -3
  xon         2288
  xoff        71552
  pool        [BUFFER_POOL|ingress_lossless_pool]
  size        1248
  ----------  -----------------------------------
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#System-State)

Go Back To [Beginning of the document](#) or [Beginning of this section](#System-Health)

### System-Health

These commands are used to monitor the system current running services and hardware state.

**show system-health summary**

This command displays the current status of 'Services' and 'Hardware' under monitoring.
If any of the elements under each of these two sections is 'Not OK' a proper message will appear under the relevant section.

- Usage:
  ```
  show system-health summary
  ```

- Example:
  ```
  admin@sonic:~$ show system-health summary
  System status summary

  System status LED  red
  Services:
    Status: Not OK
    Not Running: 'telemetry', 'sflowmgrd'
  Hardware:
    Status: OK
  ```
  ```
  admin@sonic:~$ show system-health summary
  System status summary

  System status LED  green
  Services:
    Status: OK
  Hardware:
    Status: OK
  ```

**show system-health monitor-list**

This command displays a list of all current 'Services' and 'Hardware' being monitored, their status and type.

- Usage:
  ```
  show system-health monitor-list
  ```

- Example:
  ```
  admin@sonic:~$ show system-health monitor-list
  System services and devices monitor list
  
  Name            Status    Type
  --------------  --------  ----------
  telemetry       Not OK    Process
  orchagent       Not OK    Process
  neighsyncd      OK        Process
  vrfmgrd         OK        Process
  dialout_client  OK        Process
  zebra           OK        Process
  rsyslog         OK        Process
  snmpd           OK        Process
  redis_server    OK        Process
  intfmgrd        OK        Process
  vxlanmgrd       OK        Process
  lldpd_monitor   OK        Process
  portsyncd       OK        Process
  var-log         OK        Filesystem
  lldpmgrd        OK        Process
  syncd           OK        Process
  sonic           OK        System
  buffermgrd      OK        Process
  portmgrd        OK        Process
  staticd         OK        Process
  bgpd            OK        Process
  lldp_syncd      OK        Process
  bgpcfgd         OK        Process
  snmp_subagent   OK        Process
  root-overlay    OK        Filesystem
  fpmsyncd        OK        Process
  sflowmgrd       OK        Process
  vlanmgrd        OK        Process
  nbrmgrd         OK        Process
  PSU 2           OK        PSU
  psu_1_fan_1     OK        Fan
  psu_2_fan_1     OK        Fan
  fan11           OK        Fan
  fan10           OK        Fan
  fan12           OK        Fan
  ASIC            OK        ASIC
  fan1            OK        Fan
  PSU 1           OK        PSU
  fan3            OK        Fan
  fan2            OK        Fan
  fan5            OK        Fan
  fan4            OK        Fan
  fan7            OK        Fan
  fan6            OK        Fan
  fan9            OK        Fan
  fan8            OK        Fan
  ```

**show system-health detail**

This command displays the current status of 'Services' and 'Hardware' under monitoring.
If any of the elements under each of these two sections is 'Not OK' a proper message will appear under the relevant section.
In addition, displays a list of all current 'Services' and 'Hardware' being monitored and a list of ignored elements.

- Usage:
  ```
  show system-health detail
  ```

- Example:
  ```
  admin@sonic:~$ show system-health detail
  System status summary

  System status LED  red
  Services:
    Status: Not OK
    Not Running: 'telemetry', 'orchagent'
  Hardware:
    Status: OK
  
  System services and devices monitor list
  
  Name            Status    Type
  --------------  --------  ----------
  telemetry       Not OK    Process
  orchagent       Not OK    Process
  neighsyncd      OK        Process
  vrfmgrd         OK        Process
  dialout_client  OK        Process
  zebra           OK        Process
  rsyslog         OK        Process
  snmpd           OK        Process
  redis_server    OK        Process
  intfmgrd        OK        Process
  vxlanmgrd       OK        Process
  lldpd_monitor   OK        Process
  portsyncd       OK        Process
  var-log         OK        Filesystem
  lldpmgrd        OK        Process
  syncd           OK        Process
  sonic           OK        System
  buffermgrd      OK        Process
  portmgrd        OK        Process
  staticd         OK        Process
  bgpd            OK        Process
  lldp_syncd      OK        Process
  bgpcfgd         OK        Process
  snmp_subagent   OK        Process
  root-overlay    OK        Filesystem
  fpmsyncd        OK        Process
  sflowmgrd       OK        Process
  vlanmgrd        OK        Process
  nbrmgrd         OK        Process
  PSU 2           OK        PSU
  psu_1_fan_1     OK        Fan
  psu_2_fan_1     OK        Fan
  fan11           OK        Fan
  fan10           OK        Fan
  fan12           OK        Fan
  ASIC            OK        ASIC
  fan1            OK        Fan
  PSU 1           OK        PSU
  fan3            OK        Fan
  fan2            OK        Fan
  fan5            OK        Fan
  fan4            OK        Fan
  fan7            OK        Fan
  fan6            OK        Fan
  fan9            OK        Fan
  fan8            OK        Fan
  
  System services and devices ignore list
  
  Name         Status    Type
  -----------  --------  ------
  psu.voltage  Ignored   Device
  ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#System-Health)

## VLAN & FDB

### VLAN

#### VLAN show commands

**show vlan brief**

This command displays brief information about all the vlans configured in the device. It displays the vlan ID, IP address (if configured for the vlan), list of vlan member ports, whether the port is tagged or in untagged mode, the DHCP Helper Address, and the proxy ARP status

- Usage:
  ```
  show vlan brief
  ```

- Example:
  ```
  admin@sonic:~$ show vlan brief

  +-----------+--------------+-----------+----------------+-----------------------+-------------+
  |   VLAN ID | IP Address   | Ports     | Port Tagging   | DHCP Helper Address   | Proxy ARP   |
  +===========+==============+===========+================+=======================+=============+
  |       100 | 1.1.2.2/16   | Ethernet0 | tagged         | 192.0.0.1             | disabled    |
  |           |              | Ethernet4 | tagged         | 192.0.0.2             |             |
  |           |              |           |                | 192.0.0.3             |             |
  +-----------+--------------+-----------+----------------+-----------------------+-------------+
  ```

**show vlan config**

This command displays all the vlan configuration.

- Usage:
  ```
  show vlan config
  ```

- Example:
  ```
  admin@sonic:~$ show vlan config
  Name       VID  Member     Mode
  -------  -----  ---------  ------
  Vlan100    100  Ethernet0  tagged
  Vlan100    100  Ethernet4  tagged
  ```


#### VLAN Config commands

This sub-section explains how to configure the vlan and its member ports.

**config vlan add/del**

This command is used to add or delete the vlan.

- Usage:
  ```
  config vlan (add | del) <vlan_id>
  ```

- Example (Create the VLAN "Vlan100" if it does not already exist):
  ```
  admin@sonic:~$ sudo config vlan add 100
  ```

**config vlan member add/del**

This command is to add or delete a member port into the already created vlan.

- Usage:
  ```
  config vlan member add/del [-u|--untagged] <vlan_id> <member_portname>
  ```

*NOTE: Adding the -u or --untagged flag will set the member in "untagged" mode*


- Example:
  ```
  admin@sonic:~$ sudo config vlan member add 100 Ethernet0
  This command will add Ethernet0 as member of the vlan 100

  admin@sonic:~$ sudo config vlan member add 100 Ethernet4
  This command will add Ethernet4 as member of the vlan 100.
  ```

**config proxy_arp enabled/disabled**

This command is used to enable or disable proxy ARP for a VLAN interface

- Usage:
  ```
  config vlan proxy_arp <vlan_id> enabled/disabled
  ```

- Example:
  ```
  admin@sonic:~$ sudo config vlan proxy_arp 1000 enabled
  This command will enable proxy ARP for the interface 'Vlan1000'
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#vlan--FDB)

### FDB

#### FDB show commands

**show mac**

This command displays the MAC (FDB) entries either in full or partial as given below.
1) show mac - displays the full table
2) show mac -v <vlanid> - displays the MACs learnt on the particular VLAN ID.
3) show mac -p <port>  - displays the MACs learnt on the particular port.


- Usage:
  ```
  show mac [-v <vlan_id>] [-p <port_name>]
  ```

- Example:
  ```
  admin@sonic:~$ show mac
  No.    Vlan  MacAddress         Port
  -----  ------  -----------------  -----------
    1    1000  E2:8C:56:85:4A:CD  Ethernet192
    2    1000  A0:1B:5E:47:C9:76  Ethernet192
    3    1000  AA:54:EF:2C:EE:30  Ethernet192
    4    1000  A4:3F:F2:17:A3:FC  Ethernet192
    5    1000  0C:FC:01:72:29:91  Ethernet192
    6    1000  48:6D:01:7E:C9:FD  Ethernet192
    7    1000  1C:6B:7E:34:5F:A6  Ethernet192
    8    1000  EE:81:D9:7B:93:A9  Ethernet192
    9    1000  CC:F8:8D:BB:85:E2  Ethernet192
   10    1000  0A:52:B3:9C:FB:6C  Ethernet192
   11    1000  C6:E2:72:02:D1:23  Ethernet192
   12    1000  8A:C9:5C:25:E9:28  Ethernet192
   13    1000  5E:CD:34:E4:94:18  Ethernet192
   14    1000  7E:49:1F:B5:91:B5  Ethernet192
   15    1000  AE:DD:67:F3:09:5A  Ethernet192
   16    1000  DC:2F:D1:08:4B:DE  Ethernet192
   17    1000  50:96:23:AD:F1:65  Ethernet192
   18    1000  C6:C9:5E:AE:24:42  Ethernet192
  Total number of entries 18
  ```

Optionally, you can specify a VLAN ID or interface name in order to display only that particular entries

- Examples:
  ```
  admin@sonic:~$ show mac -v 1000
  No.    Vlan  MacAddress         Port
  -----  ------  -----------------  -----------
    1    1000  E2:8C:56:85:4A:CD  Ethernet192
    2    1000  A0:1B:5E:47:C9:76  Ethernet192
    3    1000  AA:54:EF:2C:EE:30  Ethernet192
    4    1000  A4:3F:F2:17:A3:FC  Ethernet192
    5    1000  0C:FC:01:72:29:91  Ethernet192
    6    1000  48:6D:01:7E:C9:FD  Ethernet192
    7    1000  1C:6B:7E:34:5F:A6  Ethernet192
    8    1000  EE:81:D9:7B:93:A9  Ethernet192
    9    1000  CC:F8:8D:BB:85:E2  Ethernet192
   10    1000  0A:52:B3:9C:FB:6C  Ethernet192
   11    1000  C6:E2:72:02:D1:23  Ethernet192
   12    1000  8A:C9:5C:25:E9:28  Ethernet192
   13    1000  5E:CD:34:E4:94:18  Ethernet192
   14    1000  7E:49:1F:B5:91:B5  Ethernet192
   15    1000  AE:DD:67:F3:09:5A  Ethernet192
   16    1000  DC:2F:D1:08:4B:DE  Ethernet192
   17    1000  50:96:23:AD:F1:65  Ethernet192
   18    1000  C6:C9:5E:AE:24:42  Ethernet192
  Total number of entries 18
  ```
  ```
  admin@sonic:~$ show mac -p Ethernet192
  No.    Vlan  MacAddress         Port
  -----  ------  -----------------  -----------
    1    1000  E2:8C:56:85:4A:CD  Ethernet192
    2    1000  A0:1B:5E:47:C9:76  Ethernet192
    3    1000  AA:54:EF:2C:EE:30  Ethernet192
    4    1000  A4:3F:F2:17:A3:FC  Ethernet192
    5    1000  0C:FC:01:72:29:91  Ethernet192
    6    1000  48:6D:01:7E:C9:FD  Ethernet192
    7    1000  1C:6B:7E:34:5F:A6  Ethernet192
    8    1000  EE:81:D9:7B:93:A9  Ethernet192
    9    1000  CC:F8:8D:BB:85:E2  Ethernet192
   10    1000  0A:52:B3:9C:FB:6C  Ethernet192
   11    1000  C6:E2:72:02:D1:23  Ethernet192
   12    1000  8A:C9:5C:25:E9:28  Ethernet192
   13    1000  5E:CD:34:E4:94:18  Ethernet192
   14    1000  7E:49:1F:B5:91:B5  Ethernet192
   15    1000  AE:DD:67:F3:09:5A  Ethernet192
   16    1000  DC:2F:D1:08:4B:DE  Ethernet192
   17    1000  50:96:23:AD:F1:65  Ethernet192
   18    1000  C6:C9:5E:AE:24:42  Ethernet192
  Total number of entries 18
  ```

**sonic-clear fdb all**

Clear the FDB table

- Usage:
  ```
  sonic-clear fdb all
  ```
- Example:
  ```
  admin@sonic:~$ sonic-clear fdb all
  FDB entries are cleared.
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#vlan--FDB)

## VxLAN & Vnet

### VxLAN

#### VxLAN show commands

**show vxlan tunnel**

This command displays brief information about all the vxlans configured in the device. It displays the vxlan tunnel name, source IP address, destination IP address (if configured), tunnel map name and mapping.

- Usage:

  ```
  show vxlan tunnel
  ```

- Example:

  ```
  admin@sonic:~$ show vxlan tunnel
  vxlan tunnel name    source ip    destination ip    tunnel map name    tunnel map mapping(vni -> vlan)
  -------------------  -----------  ----------------  -----------------  ---------------------------------
  tunnel1              10.10.10.10
  tunnel2              10.10.10.10  20.10.10.10       tmap1              1234 -> 100
  tunnel3              10.10.10.10  30.10.10.10       tmap2              1235 -> 200
  ```

**show vxlan name <vxlan_name>**

This command displays <vlan_name> configuration.

- Usage:

  ```
  show vxlan name <vxlan_name>
  ```

- Example:

  ```
  admin@sonic:~$ show vxlan name tunnel3
  vxlan tunnel name    source ip    destination ip    tunnel map name    tunnel map mapping(vni -> vlan)
  -------------------  -----------  ----------------  -----------------  ---------------------------------
  tunnel3              10.10.10.10  30.10.10.10       tmap2              1235 -> 200
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#vxlan--vnet)

### Vnet

#### Vnet show commands

**show vnet brief**

This command displays brief information about all the vnets configured in the device. It displays the vnet name, vxlan tunnel name, vni and peer list (if configured).

- Usage:

  ```
  show vnet brief
  ```

- Example:

  ```
  admin@sonic:~$ show vnet brief
  vnet name    vxlan tunnel      vni  peer list
  -----------  --------------  -----  ------------------
  Vnet_2000    tunnel1          2000
  Vnet_3000    tunnel1          3000  Vnet_2000,Vnet4000
  ```

**show vnet name <vnet_name>**

This command displays brief information about <vnet_name> configured in the device.

- Usage:

  ```
  show vnet name <vnet_name>
  ```

- Example:

  ```
  admin@sonic:~$ show vnet name Vnet_3000
  vnet name    vxlan tunnel      vni  peer list
  -----------  --------------  -----  ------------------
  Vnet_3000    tunnel1          3000  Vnet_2000,Vnet4000
  ```

**show vnet interfaces**

This command displays vnet interfaces information about all the vnets configured in the device.

- Usage:

  ```
  show vnet interfaces
  ```

- Example:

  ```
  admin@sonic:~$ show vnet interfaces
  vnet name    interfaces
  -----------  ------------
  Vnet_2000    Ethernet1
  Vnet_3000    Vlan2000
  ```

**show vnet neighbors**

This command displays vnet neighbor information about all the vnets configured in the device. It displays the vnet name, neighbor IP address, neighbor mac address (if configured) and interface.

- Usage:

  ```
  show vnet neighbors
  ```

- Example:

  ```
  admin@sonic:~$ show vnet neighbors
  Vnet_2000    neighbor     mac_address    interfaces
  -----------  -----------  -------------  ------------
               11.11.11.11                 Ethernet1
               11.11.11.12                 Ethernet1

  Vnet_3000    neighbor     mac_address        interfaces
  -----------  -----------  -----------------  ------------
               20.20.20.20  aa:bb:cc:dd:ee:ff  Vlan2000
  ```

**show vnet routes all**

This command displays all routes information about all the vnets configured in the device.

- Usage:

  ```
  show vnet routes all
  ```

- Example:

  ```
  admin@sonic:~$ show vnet routes all
  vnet name    prefix          nexthop    interface
  -----------  --------------  ---------  -----------
  Vnet_2000    100.100.3.0/24             Ethernet52
  Vnet_3000    100.100.4.0/24             Vlan2000

  vnet name    prefix          endpoint    mac address        vni
  -----------  --------------  ----------  -----------------  -----
  Vnet_2000    100.100.1.1/32  10.10.10.1
  Vnet_3000    100.100.2.1/32  10.10.10.2  00:00:00:00:03:04
  ```

**show vnet routes tunnel**

This command displays tunnel routes information about all the vnets configured in the device.

- Usage:

  ```
  show vnet routes tunnel
  ```

- Example:

  ```
  admin@sonic:~$ show vnet routes tunnel
  vnet name    prefix          endpoint    mac address        vni
  -----------  --------------  ----------  -----------------  -----
  Vnet_2000    100.100.1.1/32  10.10.10.1
  Vnet_3000    100.100.2.1/32  10.10.10.2  00:00:00:00:03:04
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#vxlan--vnet)

## Warm Reboot

warm-reboot command initiates a warm reboot of the device.

warm-reboot command doesn't require setting warm restart configuration. The
command will setup everything needed to perform warm reboot.

This command requires root privilege.

- Usage:
  ```
  warm-reboot [-h|-?|-v|-f|-r|-k|-x|-c <control plane assistant IP list>|-s]
  ```

- Parameters:
  ```
    -h,-? : get this help
    -v    : turn on verbose mode
    -f    : force execution
    -r    : reboot with /sbin/reboot
    -k    : reboot with /sbin/kexec -e [default]
    -x    : execute script with -x flag
    -c    : specify control plane assistant IP list
    -s    : strict mode: do not proceed without:
            - control plane assistant IP list.
  ```

- Example:
  ```
  admin@sonic:~$ sudo warm-reboot -v
  Tue Oct 22 23:20:53 UTC 2019 Pausing orchagent ...
  Tue Oct 22 23:20:53 UTC 2019 Stopping radv ...
  Tue Oct 22 23:20:54 UTC 2019 Stopping bgp ...
  Tue Oct 22 23:20:54 UTC 2019 Stopped bgp ...
  Tue Oct 22 23:20:57 UTC 2019 Initialize pre-shutdown ...
  Tue Oct 22 23:20:58 UTC 2019 Requesting pre-shutdown ...
  Tue Oct 22 23:20:58 UTC 2019 Waiting for pre-shutdown ...
  Tue Oct 22 23:20:59 UTC 2019 Pre-shutdown succeeded ...
  Tue Oct 22 23:20:59 UTC 2019 Backing up database ...
  Tue Oct 22 23:21:00 UTC 2019 Stopping teamd ...
  Tue Oct 22 23:21:00 UTC 2019 Stopped teamd ...
  Tue Oct 22 23:21:00 UTC 2019 Stopping syncd ...
  Tue Oct 22 23:21:11 UTC 2019 Stopped syncd ...
  Tue Oct 22 23:21:11 UTC 2019 Stopping all remaining containers ...
  Tue Oct 22 23:21:13 UTC 2019 Stopped all remaining containers ...
  Tue Oct 22 23:21:15 UTC 2019 Rebooting with /sbin/kexec -e to SONiC-OS-20191021.01 ...
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#Warm-Reboot)

## Warm Restart

Besides device level warm reboot, SONiC also provides docker based warm restart. This feature is currently supported by following dockers: BGP, teamD,  and SWSS. A user can manage to restart a particular docker, with no interruption on packet forwarding and no effect on other services. This helps to reduce operational costs as well as development efforts. For example, to fix a bug in BGP routing stack, only the BGP docker image needs to be built, tested and upgraded.

To achieve uninterrupted packet forwarding during the restarting stage and database reconciliation at the post restarting stage, warm restart enabled dockers with adjacency state machine facilitate standardized protocols. For example, a BGP restarting switch must have BGP "Graceful Restart" enabled, and its BGP neighbors must be "Graceful Restart Helper Capable", as specified in [IETF RFC4724](https://tools.ietf.org/html/rfc4724). 

Before warm restart BGP docker, the following BGP commands should be enabled: 
  ```
  bgp graceful-restart
  bgp graceful-restart preserve-fw-state
  ```
In current SONiC release, the above two commands are enabled by default.

It should be aware that during a warm restart, certain BGP fast convergence feature and black hole avoidance feature should either be disabled or be set to a lower preference to avoid conflicts with BGP graceful restart.  

For example, BGP BFD could be disabled via:

  ```
  no neighbor <A.B.C.D|X:X::X:X|WORD> bfd
  ```
  
otherwise, the fast failure detection would cause packet drop during warm reboot.

Another commonly deployed blackhole avoidance feature: dynamic route priority adjustment, could be disabled via:

  ```
  no bgp max-med on-peerup
  ```

to avoid large routes churn during BGP restart.


### Warm Restart show commands

**show warm_restart config**

This command displays all the configuration related to warm_restart.

- Usage:
  ```
  show warm_restart config
  ```

- Example:
  ```
  admin@sonic:~$ show warm_restart config
  name    enable    timer_name        timer_duration
  ------  --------  ----------------  ----------------
  bgp     true      bgp_timer         100
  teamd   false     teamsyncd_timer   300
  swss    false     neighsyncd_timer  200
  system  true      NULL              NULL
  ```

**show warm_restart state**

This command displays the warm_restart state.

- Usage:
  ```
  show warm_restart state
  ```

- Example:
  ```
  admin@sonic:~$ show warm_restart state
  name          restore_count  state
  ----------  ---------------  ----------
  orchagent                 0
  vlanmgrd                  0
  bgp                       1  reconciled
  portsyncd                 0
  teammgrd                  1
  neighsyncd                0
  teamsyncd                 1
  syncd                     0
  natsyncd                  0
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#warm-restart)

### Warm Restart Config commands

This sub-section explains the various configuration related to warm restart feature. Following parameters can be configured using this command.
1) bgp_timer
2) disable
3) enable
4) neighsyncd_timer
5) teamsyncd_timer
Each of these sub-commands are explained in the following section.

Users can use an optional parameter "-s" to use the unix domain socket for communicating with the RedisDB which will be faster when compared to using the default network sockets.
All these commands have the following option.

Options:
  -s, --redis-unix-socket-path TEXT
       unix socket path for redis connection


**config warm_restart bgp_timer**

This command is used to set the bgp_timer value for warm_restart of BGP service.
bgp_timer holds the time interval utilized by fpmsyncd during warm-restart episodes.
During this interval fpmsyncd will recover all the routing state previously pushed to AppDB, as well as all the new state coming from zebra/bgpd.
Upon expiration of this timer, fpmsyncd will execute the reconciliation logic to eliminate all the stale entries from AppDB.
This timer should match the BGP-GR restart-timer configured within the elected routing-stack.
Supported range: 1-3600.

- Usage:
  ```
  config warm_restart [-s|--redis-unix-socket-path <socket_path>] bgp_timer <seconds>
  ```

  - Parameters:
    - seconds: Range from 1 to 3600

- Example:
  ```
  admin@sonic:~$ sudo config warm_restart bgp_timer 1000
  ```

**config warm_restart enable/disable**

This command is used to enable or disable the warm_restart for a particular service that supports warm reboot.
Following four services support warm reboot. When user restarts the particular service using "systemctl restart <service_name>", this configured value will be checked for whether it is enabled or disabled.
If this configuration is enabled for that service, it will perform warm reboot for that service. Otherwise, it will do cold restart of the service.

- Usage:
  ```
  config warm_restart [-s|--redis-unix-socket-path <socket_path>] enable [<module_name>]
  ```

  - Parameters:
    - module_name: Can be either system or swss or bgp or teamd. If "module_name" argument is not specified, it will enable "system" module.

- Example (Set warm_restart as "enable" for the "system" service):
  ```
  admin@sonic:~$ sudo config warm_restart enable
  ```

- Example (Set warm_restart as "enable" for the "swss" service. When user does "systemctl restart swss", it will perform warm reboot instead of cold reboot)
  ```
  admin@sonic:~$ sudo config warm_restart enable swss
  ```

- Example (Set warm_restart as "enable" for the "teamd" service. When user does "systemctl restart teamd", it will perform warm reboot instead of cold reboot)
  ```
  admin@sonic:~$ sudo config warm_restart enable teamd
  ```


**config warm_restart neighsyncd_timer**

This command is used to set the neighsyncd_timer value for warm_restart of "swss" service.
neighsyncd_timer is the timer used for "swss" (neighsyncd) service during the warm restart.
Timer is started after the neighborTable is restored to internal data structures.
neighborsyncd then starts to read all Linux kernel entries and mark the entries in the data structures accordingly.
Once the timer is expired, reconciliation is done and the delta is pushed to appDB
Valid value is 1-9999. 0 is invalid.

- Usage:
  ```
  config warm_restart [-s|--redis-unix-socket-path <socket_path>] neighsyncd_timer <seconds>
  ```

  - Parameters:
    - seconds: Range from 1 to 9999

- Example:
  ```
  admin@sonic:~$ sudo config warm_restart neighsyncd_timer 2000
  ```


**config warm_restart bgp_timer**

This command is used to set the bgp_timer value for warm_restart of "bgp" service.
bgp_timer is the timer used for "bgp" service during the warm restart.
Timer is started after the BGP table is restored to internal data structures.
BGP services then start to read all Linux kernel entries and mark the entries in the data structures accordingly.
Once the timer is expired, reconciliation is done and the delta is pushed to appDB
Valid value is 1-9999. 0 is invalid.

- Usage:
  ```
  config warm_restart [-s|--redis-unix-socket-path <socket_path>] bgp_timer <seconds>
  ```

  - Parameters:
    - seconds: Range from 1 to 9999

- Example:
  ```
  admin@sonic:~$ sudo config warm_restart bgp_timer 2000
  ```

**config warm_restart teamsyncd_timer**

This command is used to set the teamsyncd_timer value for warm_restart of teamd service.
teamsyncd_timer holds the time interval utilized by teamsyncd during warm-restart episodes.
The timer is started when teamsyncd starts. During the timer interval, teamsyncd will preserve all LAG interface changes, but it will not apply them.
The changes will only be applied when the timer expires.
When the changes are applied, the stale LAG entries will be removed, the new LAG entries will be created.
Supported range: 1-9999. 0 is invalid

- Usage:
  ```
  config warm_restart teamsyncd_timer <seconds>
  ```

  - Parameters:
    - seconds: Range from 1 to 9999

- Example:
  ```
  admin@sonic:~$ sudo config warm_restart teamsyncd_timer 3000
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#warm-restart)


## Watermark

### Watermark Show commands

**show watermark telemetry interval**

This command displays the configured interval for the telemetry.

- Usage:
  ```
  show watermark telemetry interval
  ```

- Example:
  ```
  admin@sonic:~$ show watermark telemetry interval

  Telemetry interval 120 second(s)
  ```

### Watermark Config commands

**config watermark telemetry interval**

This command is used to configure the interval for telemetry.
The default interval is 120 seconds.
There is no regulation on the valid range of values; it leverages linux timer.

- Usage:
  ```
  config watermark telemetry interval <value>
  ```

- Example:
  ```
  admin@sonic:~$ sudo config watermark telemetry interval 999
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#watermark)



## Software Installation and Management

SONiC images can be installed in one of two methods:
1. From within a running SONiC image using the `sonic-installer` utility
2. From the vendor's bootloader (E.g., ONIE,  Aboot, etc.)

SONiC packages are available as prebuilt Docker images and meant to be installed with the *sonic-package-manager* utility.

### SONiC Package Manager

The *sonic-package-manager* is a command line tool to manage (e.g. install, upgrade or uninstall) SONiC Packages.

**sonic-package-manager list**

This command lists all available SONiC packages, their desription, installed version and installation status.
SONiC package status can be *Installed*, *Not installed* or *Built-In*. "Built-In" status means that a feature is built-in to SONiC image and can't be upgraded or uninstalled.

- Usage:
  ```
  sonic-package-manager list
  ```

- Example:
  ```
  admin@sonic:~$ sonic-package-manager list
  Name            Repository                   Description                   Version    Status
  --------------  ---------------------------  ----------------------------  ---------  --------------
  cpu-report      azure/cpu-report             CPU report package            N/A        Not Installed
  database        docker-database              SONiC database package        1.0.0      Built-In
  dhcp-relay      azure/docker-dhcp-relay      SONiC dhcp-relay package      1.0.0      Installed
  fpm-frr         docker-fpm-frr               SONiC fpm-frr package         1.0.0      Built-In
  lldp            docker-lldp                  SONiC lldp package            1.0.0      Built-In
  macsec          docker-macsec                SONiC macsec package          1.0.0      Built-In
  mgmt-framework  docker-sonic-mgmt-framework  SONiC mgmt-framework package  1.0.0      Built-In
  nat             docker-nat                   SONiC nat package             1.0.0      Built-In
  pmon            docker-platform-monitor      SONiC pmon package            1.0.0      Built-In
  radv            docker-router-advertiser     SONiC radv package            1.0.0      Built-In
  sflow           docker-sflow                 SONiC sflow package           1.0.0      Built-In
  snmp            docker-snmp                  SONiC snmp package            1.0.0      Built-In
  swss            docker-orchagent             SONiC swss package            1.0.0      Built-In
  syncd           docker-syncd-mlnx            SONiC syncd package           1.0.0      Built-In
  teamd           docker-teamd                 SONiC teamd package           1.0.0      Built-In
  telemetry       docker-sonic-telemetry       SONiC telemetry package       1.0.0      Built-In
  ```

**sonic-package-manager repository add**

This command will add a new repository as source for SONiC packages to the database. *NOTE*: requires elevated (root) privileges to run

- Usage:
  ```
  Usage: sonic-package-manager repository add [OPTIONS] NAME REPOSITORY

    Add new repository to database

  Options:
    --default-reference TEXT  Default installation reference
    --description TEXT        Optional package entry description
    --help                    Show this message and exit.
  ```
- Example:
  ```
  admin@sonic:~$ sudo sonic-package-manager repository add \
    cpu-report azure/sonic-cpu-report --default-reference 1.0.0
  ```

**sonic-package-manager repository remove**

This command will remove a repository as source for SONiC packages from the database . The package has to be *Not Installed* in order to be removed from package database. *NOTE*: requires elevated (root) privileges to run

- Usage:
  ```
  Usage: sonic-package-manager repository remove [OPTIONS] NAME

    Remove repository from database

  Options:
    --help  Show this message and exit.
  ```
- Example:
  ```
  admin@sonic:~$ sudo sonic-package-manager repository remove cpu-report
  ```

**sonic-package-manager install**

This command pulls and installs a package on SONiC host. *NOTE*: this command requires elevated (root) privileges to run

- Usage:
  ```
  Usage: sonic-package-manager install [OPTIONS] [PACKAGE_EXPR]

    Install/Upgrade package using [PACKAGE_EXPR] in format
    "<name>[=<version>|@<reference>]"

  Options:
    --enable                      Set the default state of the feature to
                                  enabled and enable feature right after
                                  installation. NOTE: user needs to execute
                                  "config save -y" to make this setting
                                  persistent
    --default-owner [local|kube]  Default owner configuration setting for a
                                  feature
    --from-repository TEXT        Fetch package directly from image registry
                                  repository NOTE: This argument is mutually
                                  exclusive with arguments: [package_expr,
                                  from_tarball].
    --from-tarball FILE           Fetch package from saved image tarball NOTE:
                                  This argument is mutually exclusive with
                                  arguments: [package_expr, from_repository].
    -f, --force                   Force operation by ignoring failures
    -y, --yes                     Automatically answer yes on prompts
    -v, --verbosity LVL           Either CRITICAL, ERROR, WARNING, INFO or DEBUG
    --skip-host-plugins           Do not install host OS plugins provided by the
                                  package (CLI, etc). NOTE: In case when package
                                  host OS plugins are set as mandatory in
                                  package manifest this option will fail the
                                  installation.
    --help                        Show this message and exit.
  ```
- Example:
  ```
  admin@sonic:~$ sudo sonic-package-manager install dhcp-relay=1.0.2
  ```
  ```
  admin@sonic:~$ sudo sonic-package-manager install dhcp-relay@latest
  ```
  ```
  admin@sonic:~$ sudo sonic-package-manager install dhcp-relay@sha256:9780f6d83e45878749497a6297ed9906c19ee0cc48cc88dc63827564bb8768fd
  ```
  ```
  admin@sonic:~$ sudo sonic-package-manager install --from-repository azure/sonic-cpu-report:latest
  ```
  ```
  admin@sonic:~$ sudo sonic-package-manager install --from-tarball sonic-docker-image.gz
  ```

**sonic-package-manager uninstall**

This command uninstalls package from SONiC host. *NOTE*: this command requires elevated (root) privileges to run.

- Usage:
  ```
  Usage: sonic-package-manager uninstall [OPTIONS] NAME

    Uninstall package

  Options:
    -f, --force          Force operation by ignoring failures
    -y, --yes            Automatically answer yes on prompts
    -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
    --help               Show this message and exit.

  ```
- Example:
  ```
  admin@sonic:~$ sudo sonic-package-manager uninstall dhcp-relay
  ```

**sonic-package-manager reset**

This comamnd resets the package by reinstalling it to its default version. *NOTE*: this command requires elevated (root) privileges to run.

- Usage:
  ```
  Usage: sonic-package-manager reset [OPTIONS] NAME

    Reset package to the default version

  Options:
    -f, --force          Force operation by ignoring failures
    -y, --yes            Automatically answer yes on prompts
    -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
    --skip-host-plugins  Do not install host OS plugins provided by the package
                        (CLI, etc). NOTE: In case when package host OS plugins
                        are set as mandatory in package manifest this option
                        will fail the installation.
    --help               Show this message and exit.
  ```
- Example:
  ```
  admin@sonic:~$ sudo sonic-package-manager reset dhcp-relay
  ```

**sonic-package-manager show package versions**

This command will retrieve a list of all available versions for the given package from the configured upstream repository

- Usage:
  ```
  Usage: sonic-package-manager show package versions [OPTIONS] NAME

    Show available versions

  Options:
    --all    Show all available tags in repository
    --plain  Plain output
    --help   Show this message and exit.
  ```
- Example:
  ```
  admin@sonic:~$ sonic-package-manager show package versions dhcp-relay
  • 1.0.0
  • 1.0.2
  • 2.0.0
  ```
  ```
  admin@sonic:~$ sonic-package-manager show package versions dhcp-relay --plain
  1.0.0
  1.0.2
  2.0.0
  ```
  ```
  admin@sonic:~$ sonic-package-manager show package versions dhcp-relay --all
  • 1.0.0
  • 1.0.2
  • 2.0.0
  • latest
  ```

**sonic-package-manager show package changelog**

This command fetches the changelog from the package manifest and displays it. *NOTE*: package changelog can be retrieved from registry or read from image tarball without installing it.

- Usage:
  ```
  Usage: sonic-package-manager show package changelog [OPTIONS] [PACKAGE_EXPR]

    Show package changelog

  Options:
    --from-repository TEXT  Fetch package directly from image registry
                            repository NOTE: This argument is mutually exclusive
                            with arguments: [from_tarball, package_expr].
    --from-tarball FILE     Fetch package from saved image tarball NOTE: This
                            argument is mutually exclusive with arguments:
                            [package_expr, from_repository].
    --help                  Show this message and exit.
  ```
- Example:
  ```
  admin@sonic:~$ sonic-package-manager show package changelog dhcp-relay
  1.0.0:

    • Initial release

        Author (author@email.com) Mon, 25 May 2020 12:25:00 +0300
  ```

**sonic-package-manager show package manifest**

This command fetches the package manifest and displays it. *NOTE*: package manifest can be retrieved from registry or read from image tarball without installing it.

- Usage:
  ```
  Usage: sonic-package-manager show package manifest [OPTIONS] [PACKAGE_EXPR]

    Show package manifest

  Options:
    --from-repository TEXT  Fetch package directly from image registry
                            repository NOTE: This argument is mutually exclusive
                            with arguments: [package_expr, from_tarball].
    --from-tarball FILE     Fetch package from saved image tarball NOTE: This
                            argument is mutually exclusive with arguments:
                            [from_repository, package_expr].
    -v, --verbosity LVL     Either CRITICAL, ERROR, WARNING, INFO or DEBUG
    --help                  Show this message and exit.
  ```
- Example:
  ```
  admin@sonic:~$ sonic-package-manager show package manifest dhcp-relay=2.0.0
  {
    "version": "1.0.0",
    "package": {
      "version": "2.0.0",
      "depends": [
        "database>=1.0.0,<2.0.0"
      ]
    },
    "service": {
      "name": "dhcp_relay"
    }
  }
  ```

### SONiC Installer
This is a command line tool available as part of the SONiC software; If the device is already running the SONiC software, this tool can be used to install an alternate image in the partition.
This tool has facility to install an alternate image, list the available images and to set the next reboot image.
This command requires elevated (root) privileges to run.

**sonic-installer list**

This command displays information about currently installed images. It displays a list of installed images, currently running image and image set to be loaded in next reboot.

- Usage:
  ```
  sonic-installer list
  ```

- Example:
   ```
  admin@sonic:~$ sudo sonic-installer list
  Current: SONiC-OS-HEAD.XXXX
  Next: SONiC-OS-HEAD.XXXX
  Available:
  SONiC-OS-HEAD.XXXX
  SONiC-OS-HEAD.YYYY
  ```

TIP: This output can be obtained without evelated privileges by running the `show boot` command. See [here](#show-system-status) for details.

**sonic-installer install**

This command is used to install a new image on the alternate image partition.  This command takes a path to an installable SONiC image or URL and installs the image.

- Usage:
  ```
  sonic-installer install <image_file_path>
  ```

- Example:
  ```
  admin@sonic:~$ sudo 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
  ```

Installing a new image using the sonic-installer will keep using the packages installed on the currently running SONiC image and automatically migrate those. In order to perform clean SONiC installation use the *--skip-package-migration* option:

- Example:
  ```
  admin@sonic:~$ sudo sonic-installer install https://sonic-jenkins.westus.cloudapp.azure.com/job/xxxx/job/buildimage-xxxx-all/xxx/artifact/target/sonic-xxxx.bin --skip-package-migration
  ```

**sonic-installer set_default**

This command is be used to change the image which can be loaded by default in all the subsequent reboots.

- Usage:
  ```
  sonic-installer set_default <image_name>
  ```

- Example:
  ```
  admin@sonic:~$ sudo sonic-installer set_default SONiC-OS-HEAD.XXXX
  ```

**sonic-installer set_next_boot**

This command is used to change the image that can be loaded in the *next* reboot only. Note that it will fallback to current image in all other subsequent reboots after the next reboot.

- Usage:
  ```
  sonic-installer set_next_boot <image_name>
  ```

- Example:
  ```
  admin@sonic:~$ sudo sonic-installer set_next_boot SONiC-OS-HEAD.XXXX
  ```

**sonic-installer remove**

This command is used to remove the unused SONiC image from the disk. Note that it's *not* allowed to remove currently running image.

- Usage:
  ```
  sonic-installer remove [-y|--yes] <image_name>
  ```

- Example:
  ```
  admin@sonic:~$ sudo 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
  ```

**sonic-installer cleanup**

This command removes all unused images from the device, leaving only the currently active image and the image which will be booted into next (if different) installed. If there are no images which can be removed, the command will output `No image(s) to remove`

- Usage:
  ```
  sonic-installer cleanup [-y|--yes]
  ```

- Example:
  ```
  admin@sonic:~$ sudo sonic-installer cleanup
  Remove images which are not current and next, continue? [y/N]: y
  No image(s) to remove
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#software-installation-and-management)



## Troubleshooting Commands

For troubleshooting and debugging purposes, this command gathers pertinent information about the state of the device; information is as diverse as syslog entries, database state, routing-stack state, etc., It then compresses it into an archive file. This archive file can be sent to the SONiC development team for examination.
Resulting archive file is saved as `/var/dump/<DEVICE_HOST_NAME>_YYYYMMDD_HHMMSS.tar.gz`

- Usage:
  ```
  show techsupport
  ```

- Example:
  ```
  admin@sonic:~$ show techsupport [--since=<time_specifier>]
  ```

If the SONiC system was running for quite some time `show techsupport` will produce a large dump file. To reduce the amount of syslog and core files gathered during system dump use `--since` option:

- Examples:
  ```
  admin@sonic:~$ show techsupport --since=yesterday  # Will collect syslog and core files for the last 24 hours
  ```
  ```
  admin@sonic:~$ show techsupport --since='hour ago' # Will collect syslog and core files for the last one hour
  ```

Go Back To [Beginning of the document](#) or [Beginning of this section](#troubleshooting-commands)

## Routing Stack

SONiC software is agnostic of the routing software that is being used in the device. For example, users can use either Quagga or FRR routing stack as per their requirement.
A separate shell (vtysh) is provided to configure such routing stacks.
Once if users go to "vtysh", they can use the routing stack specific commands as given in the following example.

- Example (Quagga Routing Stack):
  ```
  admin@sonic:~$ vtysh

  Hello, this is Quagga (version 0.99.24.1).
  Copyright 1996-2005 Kunihiro Ishiguro, et al.

  sonic# show route-map (This command displays the route-map that is configured for the routing protocol.)
  ZEBRA:
  route-map RM_SET_SRC, permit, sequence 10
    Match clauses:
    Set clauses:
      src 10.12.0.102
    Call clause:
    Action:
      Exit routemap
  ```

Refer the routing stack [Quagga Command Reference](https://www.quagga.net/docs/quagga.pdf) or [FRR Command Reference](https://buildmedia.readthedocs.org/media/pdf/frrouting/latest/frrouting.pdf) to know more about about the routing stack configuration.


Go Back To [Beginning of the document](#) or [Beginning of this section](#routing-stack)


## Quagga BGP Show Commands

**show ip bgp summary**

This command displays the summary of all IPv4 bgp neighbors that are configured and the corresponding states.

- Usage:
  ```
  show ip bgp summary
  ```

- Example:
  ```
  admin@sonic:~$ show ip bgp summary
  BGP router identifier 1.2.3.4, local AS number 65061
  RIB entries 6124, using 670 KiB of memory
  Peers 2, 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

  Total number of neighbors 2
  ```

**show ip bgp neighbors**

This command displays all the details of IPv4 & IPv6 BGP neighbors when no optional argument is specified.

When the optional argument IPv4_address is specified, it displays the detailed neighbor information about that specific IPv4 neighbor.

Command has got additional optional arguments to display only the advertised routes, or the received routes, or all routes.

In order to get details for an IPv6 neigbor, use "show ipv6 bgp neighbor <ipv6_address>" command.

- Usage:
  ```
  show ip bgp neighbors [<ipv4-address> [advertised-routes | received-routes | routes]]
  ```

- Example:
  ```
  admin@sonic:~$ show ip bgp neighbors
  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. In this mode, you can optionally specify whether you want to display all routes advertised to the specified neighbor, all routes received from the specified neighbor or all routes (received and accepted) from the specified neighbor.


- Examples:
  ```
  admin@sonic:~$ show ip bgp neighbors 192.168.1.161

  admin@sonic:~$ show ip bgp neighbors 192.168.1.161 advertised-routes

  admin@sonic:~$ show ip bgp neighbors 192.168.1.161 received-routes

  admin@sonic:~$ show ip bgp neighbors 192.168.1.161 routes
  ```

**show ipv6 bgp summary**

This command displays the summary of all IPv4 bgp neighbors that are configured and the corresponding states.

- Usage:
  ```
  show ipv6 bgp summary
  ```

- Example:
  ```
  admin@sonic:~$ show ipv6 bgp summary
  BGP router identifier 10.1.0.32, local AS number 65100
  RIB entries 12809, using 1401 KiB of memory
  Peers 8, using 36 KiB of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ Up/Down  State/PfxRcd
  fc00::72        4 64600   12588   12591        0    0    0 06:51:17     6402
  fc00::76        4 64600   12587    6190        0    0    0 06:51:28     6402
  fc00::7a        4 64600   12587    9391        0    0    0 06:51:23     6402
  fc00::7e        4 64600   12589   12592        0    0    0 06:51:25     6402

  Total number of neighbors 4
  ```

**show ipv6 bgp neighbors**

This command displays all the details of one particular IPv6 Border Gateway Protocol (BGP) neighbor. Option is also available to display only the advertised routes, or the received routes, or all routes.

- Usage:
  ```
  show ipv6 bgp neighbors <ipv6-address> (advertised-routes | received-routes | routes)
  ```

- Examples:
  ```
  admin@sonic:~$ show ipv6 bgp neighbors fc00::72 advertised-routes

  admin@sonic:~$ show ipv6 bgp neighbors fc00::72 received-routes

  admin@sonic:~$ show ipv6 bgp neighbors fc00::72 routes
  ```

**show route-map**

This command displays the routing policy that takes precedence over the other route processes that are configured.

- Usage:
  ```
  show route-map
  ```

- Example:
  ```
  admin@sonic:~$ show route-map
  ZEBRA:
  route-map RM_SET_SRC, permit, sequence 10
    Match clauses:
    Set clauses:
      src 10.12.0.102
    Call clause:
    Action:
      Exit routemap
  ZEBRA:
  route-map RM_SET_SRC6, permit, sequence 10
    Match clauses:
    Set clauses:
      src fc00:1::102
    Call clause:
    Action:
      Exit routemap
  BGP:
  route-map FROM_BGP_SPEAKER_V4, permit, sequence 10
    Match clauses:
    Set clauses:
    Call clause:
    Action:
      Exit routemap
  BGP:
  route-map TO_BGP_SPEAKER_V4, deny, sequence 10
    Match clauses:
    Set clauses:
    Call clause:
    Action:
      Exit routemap
  BGP:
  route-map ISOLATE, permit, sequence 10
    Match clauses:
    Set clauses:
      as-path prepend 65000
    Call clause:
    Action:
      Exit routemap
  ```
Go Back To [Beginning of the document](#) or [Beginning of this section](#quagga-bgp-show-commands)

# ZTP Configuration And Show Commands

This section explains all the Zero Touch Provisioning commands that are supported in SONiC.

## ZTP show commands


This command displays the current ZTP configuration of the switch. It also displays detailed information about current state of a ZTP session. It displays information related to all configuration sections as defined in the switch provisioning information discovered in a particular ZTP session.

- Usage:
  show ztp status

  show ztp status --verbose

- Example:

```
root@B1-SP1-7712:/home/admin# show ztp status
ZTP Admin Mode : True
ZTP Service    : Inactive
ZTP Status     : SUCCESS
ZTP Source     : dhcp-opt67 (eth0)
Runtime        : 05m 31s
Timestamp      : 2019-09-11 19:12:24 UTC

ZTP Service is not running

01-configdb-json: SUCCESS
02-connectivity-check: SUCCESS
```
Use the verbose option to display more detailed information.

```
root@B1-SP1-7712:/home/admin# show ztp status --verbose
Command: ztp status --verbose
========================================
ZTP
========================================
ZTP Admin Mode : True
ZTP Service    : Inactive
ZTP Status     : SUCCESS
ZTP Source     : dhcp-opt67 (eth0)
Runtime        : 05m 31s
Timestamp      : 2019-09-11 19:12:16 UTC
ZTP JSON Version : 1.0

ZTP Service is not running

----------------------------------------
01-configdb-json
----------------------------------------
Status          : SUCCESS
Runtime         : 02m 48s
Timestamp       : 2019-09-11 19:11:55 UTC
Exit Code       : 0
Ignore Result   : False

----------------------------------------
02-connectivity-check
----------------------------------------
Status          : SUCCESS
Runtime         : 04s
Timestamp       : 2019-09-11 19:12:16 UTC
Exit Code       : 0
Ignore Result   : False
```

- Description

  - **ZTP Admin Mode** - Displays if the ZTP feature is administratively enabled or disabled. Possible values are True or False. This value is configurable using "config ztp enabled" and "config ztp disable" commands.
  - **ZTP Service** - Displays the ZTP service status. The following are possible values this field can display:
    - *Active Discovery*: ZTP service is operational and is performing DHCP discovery to learn switch provisioning information
    - *Processing*: ZTP service has discovered switch provisioning information and is processing it
  - **ZTP Status** - Displays the current state and result of ZTP session. The following are possible values this field can display:
    - *IN-PROGRESS*: ZTP session is currently in progress. ZTP service is processing switch provisioning information.
    - *SUCCESS*: ZTP service has successfully processed the switch provisioning information.
    - *FAILED*:  ZTP service has failed to process the switch provisioning information.
    - *Not Started*: ZTP service has not started processing the discovered switch provisioning information.
  - **ZTP Source** - Displays the DHCP option and then interface name from which switch provisioning information has been discovered.
  - **Runtime** - Displays the time taken for ZTP process to complete from start to finish. For individual configuration sections it indicates the time taken to process the associated configuration section.
  - **Timestamp** - Displays the date/time stamp when the status field has last changed.
  - **ZTP JSON Version** - Version of ZTP JSON file used for describing switch provisioning information.
  - **Status** - Displays the current state and result of a configuration section. The following are possible values this field can display:
    - *IN-PROGRESS*: Corresponding configuration section is currently being processed.
    - *SUCCESS*: Corresponding configuration section was processed successfully.
    - *FAILED*:  Corresponding configuration section failed to execute successfully.
    - *Not Started*: ZTP service has not started processing the corresponding configuration section.
    - *DISABLED*: Corresponding configuration section has been marked as disabled and will not be processed.
  - **Exit Code** - Displays the program exit code of the configuration section executed. Non-zero exit code indicates that the configuration section has failed to execute successfully.
  - **Ignore Result** - If this value is True, the result of the corresponding configuration section is ignored and not used to evaluate the overall ZTP result.
  - **Activity String** - In addition to above information an activity string is displayed indicating the current action being performed by the ZTP service and how much time it has been performing the mentioned activity. Below is an example.
    -    (04m 12s) Discovering provisioning data

## ZTP configuration commands

This sub-section explains the list of the configuration options available for ZTP.



**config ztp enable**

Use this command to enable ZTP administrative mode

- Example:

```
root@sonic:/home/admin# config ztp enable
Running command: ztp enable
```



**config ztp disable**

Use this command to disable ZTP administrative mode.  This command can also be used to abort a current ZTP session and load the factory default switch configuration.

- Usage:
  config ztp disable

  config ztp disable -y

- Example:

```
root@sonic:/home/admin# config ztp disable
Active ZTP session will be stopped and disabled, continue? [y/N]: y
Running command: ztp disable -y
```


**config ztp run**

Use this command to manually restart a new ZTP session.  This command deletes the existing */etc/sonic/config_db.json* file and stats ZTP service. It also erases the previous ZTP session data. ZTP configuration is loaded on to the switch and ZTP discovery is performed.

- Usage:
  config ztp run

  config ztp run -y

- Example:

```
root@sonic:/home/admin# config ztp run
ZTP will be restarted. You may lose switch data and connectivity, continue? [y/N]: y
Running command: ztp run -y
```

Go Back To [Beginning of the document](#SONiC-COMMAND-LINE-INTERFACE-GUIDE) or [Beginning of this section](#ztp-configuration-and-show-commands)