arrow-left

All pages
gitbookPowered by GitBook
1 of 13

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Image Management

The switch image is the executable code running on the device. APB can be upgraded to the device

  • ONIE to APB

  • APB to APB

The typical upgrade process for the image consists of the following steps:

  1. Load a new firmware image and boot image onto an SFTP, HTTP, SCP, or TFTP server on your network.

  2. Transfer the new images to the switch

  3. Specify the new image as the one to be loaded the next time a switch reload occurs

  4. Reload the switch

Rebooting the Switch

You can reload/reboot the switch using the below command:

pbnoscli# save   
  save                  Copy Running configuration to Startup configuration
pbnoscli# save 
Saving Configuration

pbnoscli# reboot 
Check if running config is saved
Do you want to reboot the device [y/n]: y

Installing APB from ONIE

To install APB from ONIE, please follow the below steps:

  • Login using the console port and reboot the switch

  • Enter ONIE mode

ONIE
  • Select 'ONIE: Uninstall OS' to clean up installed images

circle-info

This step takes a few minutes and reboot the switch after cleanup is complete

  • The Switch will reboot and boot into 'ONIE: Install OS' mode, run the below command to stop auto-discovery

circle-info

The 'onie-discovery-stop' command is deprecated and will be removed in 2019.02.

If you are using the latest version of ONIE, Use 'onie-stop' instead.

  • Assign 'eth0' with a management-IP to copy image from remote server

  • If server is present on different network using below command to add a default route

  • Image can be installed using HTTP or SCP:

    • SCP -

  • HTTP -

    • start HTTP-server on image directory, on a linux server below command can be used to achieve this

  • On the switch console use the below command to install the image using HTTP, This will download and install the OPBNOS

Image Upgrade from APB

circle-exclamation

Note: The introduction of key enhancements, specifically LACP support and the SONiC operating system upgrade, dictates a direct upgrade path to APB version 2.10.0 from legacy versions is unavailable.

ONIE Install approach is recommended.

hashtag
Image Upgrade from APB

To upgrade image to a newer version from APB CLI, use the following command:

CLI Example:

To verify, Please run below command:

Command

copy scp <server_url> [timeout <interval> ] { opbnos-image }

Description

Copies new file OS image from remote SCP server and install to the switch

Parameters

Server_url username@ipaddress:filepathandname

timeout timeout

interval Specifies the maximum time (in seconds) to wait for the server to reply to the connection request. The timeout interval is from 1 to 100 seconds.

opbnos-image Copies OS image.

Mode

EXEC

pbnoscli# copy scp avizuser@10.2.2.10:/mnt/ws/images/opbnos/R2.8.0/nvidia/opb-nos-mellanox-20250207.2.8.0.bin opbnos-image
The authenticity of host '10.2.2.10 (10.2.2.10)' can't be established.
ECDSA key fingerprint is SHA256:+S2EmXkMAA6WYu6VKodKZtsha3HpVzLCnpG95yEqqlQ.
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added '10.2.2.10' (ECDSA) to the list of known hosts.
avizuser@10.2.2.10's password:
opb-nos-mellanox-20250215.2.8.0.bin                                                         100% 1467MB 109.8MB/s   00:13
New image will be installed, continue? [y/N]: y

//After installation is complete, perform a reboot
pbnoscli# reboot
pbnoscli# show boot
Current: OPBNOS-master.0-dirty-20250213.013329
Next: OPBNOS-master.0-dirty-20250207.160956  
Available:
OPBNOS-master.0-dirty-20250207.160956  
OPBNOS-master.0-dirty-20250213.013329


pbnoscli# show version

Aviz OPB NOS Version: 2.8.0
Distribution: Debian 11.11
Kernel: 5.10.0-18-2-amd64

Platform: x86_64-mlnx_msn4600c-r0
HwSKU: ACS-MSN4600C
ASIC: mellanox
ASIC Count: 1
Serial Number: MT2040X05753
Model Number: MSN4600-CS2FC
Hardware Revision: A1
Uptime: 18:07:38 up  3:20,  3 users,  load average: 0.11, 0.57, 0.71
Date: Mon 24 Feb 2025 18:07:38

Docker images:
REPOSITORY                TAG                              IMAGE ID       SIZE
docker-syncd-mlnx         latest                           c530e940d41c   898MB
docker-syncd-mlnx         master.0-dirty-20250207.160956   c530e940d41c   898MB
docker-snmp               latest                           27018d6fc1c5   408MB
docker-snmp               master.0-dirty-20250207.160956   27018d6fc1c5   408MB
docker-platform-monitor   latest                           b48d9e8798f6   881MB
docker-platform-monitor   master.0-dirty-20250207.160956   b48d9e8798f6   881MB
docker-orchagent          latest                           83e221477668   396MB
docker-orchagent          master.0-dirty-20250207.160956   83e221477668   396MB
docker-lldp               latest                           b8dda16e3032   403MB
docker-lldp               master.0-dirty-20250207.160956   b8dda16e3032   403MB
docker-eventd             latest                           cfc31e8b5c59   361MB
docker-eventd             master.0-dirty-20250207.160956   cfc31e8b5c59   361MB
docker-database           latest                           7099928b9e6f   361MB
docker-database           master.0-dirty-20250207.160956   7099928b9e6f   361MB
docker-sflow              latest                           8f7d4b72342d   361MB
docker-sflow              master.0-dirty-20250207.160956   8f7d4b72342d   361MB
docker-nagr               latest                           2d4c3653029e   804MB
docker-nagr               master.0-dirty-20250207.160956   2d4c3653029e   804MB
fv                        latest                           a55f748c07a0   173MB
                    latest                           a55f748c07a0   173MB
ONIE-Uninstaller
ONIE:/ # onie-discovery-stop 
ONIE:/ # ifconfig eth0 <mgmt-ip> netmask <netmask> up
//Example - ifconfig eth0 10.4.4.72 netmask 255.255.254.0 up
ONIE:/ # route add default gw <gw-ip>
//Example - route add default gw 10.4.4.1 
//Copy image - 
ONIE:/ # scp <user>@<server-ip>:/<dir>/opb-nos.bin opbnos.bin
//Example - scp aviz@10.2.2.10:/images/opb/opb-nos.bin opbnos.bin 

//Install copied image -
ONIE:/ # onie-nos-install <image-name.bin>
//Example - onie-nos-install opbnos.bin
aviz@10.2.2.10:/images/opb$ python3 -m http.server 8030
ONIE:/ # onie-nos-install http://<IP>:<port>/<opb-nos.bin>
//Example - onie-nos-install http://10.2.2.10:8030/opb-nos-20220714.2.1.1.bin

Supported Platforms

List of switches along with their speeds and supported licenses:

Port Speed
HWSKU
Vendor
License

1/10GbE

[48x1GbE + 8x10GbE]

Celestica

Basic, Advanced**

1/100GbE

[48x1GbE + 4x100GbE]

NVIDIA

circle-info

Please refer to the "Licensing" page for detailed information.

circle-info

* Devices are End-Of-Life

Basic

10GbE/40GbE

DCS208arrow-up-right(EC5812) [48x10GbE + 6x40GbE]*

Edgecore

Basic

10GbE/100GbE

DCS201arrow-up-right(EC5835) [48x10GbE + 6x100GbE]

Edgecore

Basic, Advanced**

10GbE/25GbE/100GbE

DCS203arrow-up-right(EC7326) [48x25GbE + 8x100GbE]

Edgecore

Basic, Advanced**

10GbE/25GbE/100GbE

DS2000arrow-up-right [48x25GbE + 8x100GbE]

Celestica

Basic,Advanced**

10GbE/25GbE/100GbE

S5248F-ONarrow-up-right [48x25GbE + 8x100GbE]

DELL

Basic,Advanced**

10GbE/25GbE/100GbE

SN2010arrow-up-right [18x25GbE + 4x100GbE]

NVIDIA

Basic

10GbE/25GbE/100GbE

SN3420arrow-up-right [48x25GbE + 12x100GbE]

NVIDIA

Basic, Advanced, Performance

100GbE

DCS204arrow-up-right(EC7726) [32x100GbE]

Edgecore

Basic,Advanced**

100GbE

DCS501arrow-up-right(EC7712) [32x100GbE]*

Edgecore

Basic

100GbE

S5232F-ONarrow-up-right [32x100GbE]

DELL

Basic,Advanced**

100GbE

DS3000arrow-up-right [32x100GbE]

Celestica

Basic,Advanced**

100GbE

SN2100arrow-up-right [16x100GbE]*

NVIDIA

Basic

100GbE

SN2700arrow-up-right [32x100GbE]*

NVIDIA

Basic

100GbE

SN3700Carrow-up-right [32x100GbE]

NVIDIA

Basic, Advanced, Performance

100GbE

DCS500arrow-up-right(EC7816) [64x100GbE]

Edgecore

Basic

100GbE

SN3800arrow-up-right [64x100GbE]*

NVIDIA

Basic, Advanced, Performance

100GbE

SN4600Carrow-up-right [64x100GbE]

NVIDIA

Basic, Advanced, Performance

200GbE

SN3700arrow-up-right [32x200GbE]

NVIDIA

Basic, Advanced, Performance

200GbE

SN4600arrow-up-right [64x200GbE]

NVIDIA

Basic, Advanced, Performance

400GbE

SN4700arrow-up-right [32x400GbE]

NVIDIA

Basic, Advanced, Performance

Licensingchevron-right
DS1000arrow-up-right
SN2201arrow-up-right

Removing available images

You can remove unused or old images from the device to optimize disk utilization using the "cleanup-images" and "remove-image" commands.

hashtag
Reference

Command

remove-image < image_name>

Description

hashtag
CLI Example

Reference

Scalability

Vendor
ASIC
Platform Matrix
HWSKU
Supported Speeds
Specification

Selecting APB on next boot

To specify APB image on next reboot, use the following command:

Reference

Comment

Remove specific image from the switch

Parameters

ImageName - Can be obtained from "show

boot"

Mode

EXEC

Command

cleanup-images

Description

Remove all available images from the switch

Parameters

ImageName - Can be obtained from "show

boot"

Mode

EXEC

List the available images using the following command:

hashtag
CLI Example

Select image to boot on next reboot using below command:

arrow-up-right

Command

nextboot-image < image_name>

Description

Set next image to be loaded after the reboot

Parameters

image_name- Can be obtained from "show boot"

Mode

EXEC

pbnoscli# show boot
pbnoscli# remove-image <image-name>
//Example - remove-image SONiC-OS-2.1.1_RELEASE.0-dirty-20220718.065117
pbnoscli#cleanup-images
pbnoscli# show boot
Current: OPBNOS-master.0-dirty-20250213.013329
Next: OPBNOS-master.0-dirty-20250213.013329
Available:
OPBNOS-master.0-dirty-20250213.013329
OPBNOS-master.0-dirty-20250209.063638
pbnoscli# nextboot-image OPBNOS-master.0-dirty-20250209.063638

TD3

DS2000

10GbE/25GbE/100GbE

48x25GbE + 8x100GbE

Celestica

Broadcom

TD3

DS3000

100GbE

32x100GbE

Dell

Broadcom

TD3

DELL 5248f-ON

10GbE/25GbE/100GbE

48x25GbE + 8x100GbE

Dell

Broadcom

TD3

DELL 5232f-ON

100GbE

32x100GbE

Edgecore

Broadcom

TD2

DCS208(EC5812)

10GbE/40GbE

48x10GbE + 6x40GbE

Edgecore

Broadcom

TD3

DCS201(EC5835)

10GbE/100GbE

48x10GbE + 6x100GbE

Edgecore

Broadcom

TD3

DCS203(EC7326)

10GbE/25GbE/100GbE

48x25GbE + 8x100GbE

Edgecore

Broadcom

TD3

DCS204(EC7726)

100GbE

32x100GbE

Edgecore

Broadcom

TH

DCS501(EC7712)

100GbE

32x100GbE

Edgecore

Broadcom

TH2

DCS500(EC7816)

100GbE

64x100GbE

NVIDIA

NVIDIA

Spectrum-1

SN2201

1GbE/100 GbE

48x1GbE + 4x100GbE

NVIDIA

NVIDIA

Spectrum-1

SN2010

10GbE/25GbE/100GbE

18x25GbE + 4x100GbE

NVIDIA

NVIDIA

Spectrum-1

SN2100

100GbE

16x100GbE

NVIDIA

NVIDIA

Spectrum-1

SN2700

100GbE

32x100GbE

NVIDIA

NVIDIA

Spectrum-2

SN3420

10GbE/25GbE/100GbE

48x25GbE + 12x100GbE

NVIDIA

NVIDIA

Spectrum-2

SN3700C

100GbE

32x100GbE

NVIDIA

NVIDIA

Spectrum-2

SN3800

100GbE

64x100GbE

NVIDIA

NVIDIA

Spectrum-2

SN3700

200GbE

32x200GbE

NVIDIA

NVIDIA

Spectrum-3

SN4600C

100GbE

64x100GbE

NVIDIA

NVIDIA

Spectrum-3

SN4600

200GbE

64x200GbE

NVIDIA

NVIDIA

Spectrum-3

SN4700

400GbE

32x400GbE

Description
BCM TD3
BCM TH2
BCM TD2/TH
Nvidia SP2 & SP3
Nvidia SP1

Max rules per switch

1500

1500

768

8000

400

Max rules per flow

1500

1500

Celestica

Broadcom

TD3

DS1000

1GbE/10 GbE

48x1GbE + 8x10GbE

Celestica

Broadcom

768

4000

400

Max number of flows

63

63

63

10

2

Max number of Port channels

32

32

16

32

32

Max number of Port Channel members

All ports

All ports

All ports

All ports

All ports

Max number of VXLAN tunnel

50

NA

NA

1

NA

Max number of ERSPAN tunnel

NA

NA

NA

1

NA

Limitations

hashtag
ASIC Limitations:

  • Multiple flows can not have the same network port

  • In VLAN-aware mode, VLAN is a mandatory match qualifier in the flow rule for matching tagged packets

  • Pop-VLAN is supported on flow rules which have VLAN id as a qualifier

  • Flow rule VLAN qualifier is not supported in VLAN-Unaware mode

  • For VxLAN, NVIDIA supports only one source VTEP per system but supports multiple destination VTEP

  • For VxLAN, multiple VNI cannot be mapped to the same Destination VTEP

  • GTP, UDF and Generic Header Filtering configurations and rules are not supported for the NVIDIA SN2100 switch

  • Ingress-VLAN is not supported on EC-AS7326 and EC-AS7726 platforms

  • Dell 5232 does not support Dynamic Port Breakout configurations on Ethernet32

hashtag
Software Limitations:

  • A Maximum of 4 active SSH sessions are supported

  • Tunnel attributes cannot be updated and will require deleting the existing tunnel and reconfiguring

  • Override qualifiers are not supported for the VxLAN feature

circle-info

SSH connection should be disconnected gracefully using the “quit” command once the usage is completed

GTP rule configuration is to be done using a string (i.e. double quotes)
  • GTP global configuration must be enabled before configuring the GTP rule

  • A proper license is required before configuring a feature

  • System reboot is required after port breakout configuration.

  • Before doing port breakout, make sure interface doesn't have any dependent configuration, best practice is to do port breakout with clean configuration.

  • Vlan actions "push/pop" will not be functioning when packet slicing feature is enabled.

  • Licensing

    Aviz Packet Broker supports 3 license types as listed below

    License
    Features
    Platforms

    Basic

    • Layer 3/4 (IPv4 and IPv6) Filtering.

    • Layer 2 (VLAN and Ethertype) Filtering.

    • VLAN Actions (Ingress and Egress).

    Broadcom (TD2X)

    EC5812

    Broadcom (TD3)

    DELL S5232, DELL S5248, DS1000, DS2000, DS3000, EC5835, EC7326, EC7726

    Broadcom (TH)

    Advanced

    (Includes Basic)

    • Generic Header Filtering (MPLS, L2GRE, VXLAN, IP-n-IP)

    • User Defined Offset Filtering

    • Truncation (Slicing)

    Nvidia (Spectrum 2,3)

    SN3420, SN3700C, SN3800, SN3700, SN4600C, SN4600, SN4700

    circle-info

    **Supported only on Broadcom TD3 platforms - EC7726, EC7326, EC5835, DS1000, DS2000, DS3000, Dell S5248, Dell S5232.

    Installing APB from USB Drive

    To install APB from USB Drive, Please follow the below steps:

    • Login using the console port and reboot the switch

    • Enter ONIE mode

    Redirection (Ports, Static LAG) .
  • TAP Connector - Rx-Only, Tx-Only.

  • Port and Flow Statistics.

  • Management: NTP, SSH, Timezone, SYSLOG, LLDP, TACACS+, ZTP, RBAC, Radius, SNMPv1/v2/v3, Traps (FAN, PSU, CPU, Disk, Link flap).

  • ISCLI, REST API & sFlow.

  • GUI Based Fabric Manager & Analytics Application (FlowVision).

  • NTP based packet Time stamping - Broadcom Only

  • EC7712

    Broadcom (TH2)

    EC7816

    Nvidia (Spectrum 1,2,3)

    SN2010, SN2100, SN2201, SN2700,

    SN3420, SN3700C, SN3800, SN3700, SN4600C, SN4600, SN4700

    VXLAN Encapsulation (Initiation)
  • VXLAN Decapsulation (Termination)

  • VXLAN Header Stripping

  • ERSPAN Header Stripping

  • Advanced**

    (Includes Basic)

    • VXLAN Encapsulation (Initiation)

    • Truncation (Slicing)

    Broadcom (TD3)

    DELL S5232, DELL S5248, DS1000, DS2000, DS3000, EC5835, EC7326, EC7726

    Performance (Includes Advanced)

    • GTP Filtering - Inner IP header & Tunnel IDs.

    • Symmetric Load balancing based on Inner IP (v4/v6) header

    Nvidia (Spectrum 2,3)

    SN3420, SN3700C, SN3800, SN3700, SN4600C, SN4600, SN4700

    Getting Started

    This section provides information about how to install/upgrade the OPBNOS and information on the SONiC shell.

    Licensingchevron-rightLimitationschevron-rightImage Managementchevron-rightSupported Platformschevron-rightScalabilitychevron-right

    Select 'ONIE: Uninstall OS' to clean up installed images

    • The Switch will reboot and boot into 'ONIE: Install OS' mode, run the below command to stop auto-discovery

    • Enter the following command to create a USB mount location on the system

    • Enter the following command to mount the USB. The vfat option is used for FAT32 formatted drives

    • Install the software from the USB drive, where /mnt/media specifies the path where the USB partition is mounted

    ONIE:/ # onie-discovery-stop 
    ONIE:/ # mkdir /mnt/media

    Downloads

    Please refer to the following links for downloading APB and FlowVision:

    • APB for Edgecore(AS5812/AS7712) - https://support.aviznetworks.com/hc/en-us/articles/14686290310797-EdgeCore-Broadcomarrow-up-right

    • APB for Nvidia - https://support.aviznetworks.com/hc/en-us/articles/14587053512973-NVIDIAarrow-up-right

    • APB for all Broadcom devices except (AS5812/AS7712) -

    • FlowVision -

    NOTE: You are required to sign-up on for getting access to the download page.

    ONIE:/ # mount -t vfat /mnt/media
    Example - ONIE:/ # mount -t vfat /dev/sdb1 /mnt/media
    ONIE:/ # onie-nos-install /mnt/media/opbnos.bin
    https://support.aviznetworks.com/hc/en-us/articles/13612951043341-OPB-for-Broadcomarrow-up-right
    https://support.aviznetworks.com/hc/en-us/articles/17752422217869-FlowVisionarrow-up-right
    https://support.aviznetworks.com/hc/en-usarrow-up-right