Dell EMC Networking ONIE Quick Start Guide
Dell EMC Networking ONIE Quick Start Guide
Abstract
Dell EMC Networking ONIE quick start guide. This guide provides the
essentials needed to update and prepare a switch for a networking OS
installation.
August 2018
Acknowledgements
This paper was produced by the Dell EMC Networking Infrastructure Solutions team.
Dell_Networking_Solutions@dell.com
The information in this publication is provided “as is.” Dell Inc. makes no representations or warranties of any kind with respect to the information in this
publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose.
Use, copying, and distribution of any software described in this publication requires an applicable software license.
© 2018 Dell Inc. or its subsidiaries. All Rights Reserved. Dell, EMC, Dell EMC and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other
trademarks may be trademarks of their respective owners.
Dell believes the information in this document is accurate as of its publication date. The information is subject to change without notice.
The Open Network Install Environment, or ONIE, is an open-source project within the Open Computer Project
that provides an installation environment for bare metal networking switches. ONIE also provides the option
to install different network operating systems on a common set of networking hardware. ONIE is like any
operating system boot loader for Windows or Linux. ONIE uses the same Grand Unified Bootloader(GRUB)
structure that is commonly found in Linux distributions.
Note: For information about the Open Network Install Environment, see http://onie.org/. See
https://www.opencomputerproject.org/ for information about the Open Computer Project.
Within the Dell EMC Networking portfolio, any switch model that contains a “-ON” suffix, such as the Dell
EMC Networking Z9100-ON and the Dell EMC Networking S4148U-ON, have ONIE enabled.
This guide covers the menu options that are available within ONIE and the operations that can be performed
on each menu. The Dell EMC Networking S4148U-ON and the Dell EMC Networking S4048-ON are used to
demonstrate the specified operations within ONIE. However, all operations that are performed can also be
done on all data center switches that end in "-ON".
The steps in this document were validated using the specified Dell EMC Networking switches and operating
systems. Also, the steps can be leveraged for other Dell EMC Networking switch models utilizing the same
networking ONIE version.
Note: See section 4 ONIE: Install OS and section 7 ONIE: Update for more information.
ONIE: Update ONIE • Uses ONIE Discovery Process to update ONIE version
• ONIE Discovery Service enabled by default
• Manual update of ONIE
ONIE: Embed mode • Allows for install of ONIE on the switch without ONIE
To ensure that the latest firmware and software is configured on the switch, perform the following steps:
1. Check ONIE version and update if necessary, using the instructions within the ONIE: Update section.
2. Install the latest firmware versions, using the steps within the ONIE: Rescue section.
3. Install the latest diagnostics OS and required diagnostics tools, using the steps provided with the
Diagnostics section.
4. Optionally, select the ONIE: Uninstall OS menu to remove an existing networking OS.
5. Navigate to the ONIE: Install OS menu and follow the commands in the ONIE: Install OS section to
install the switch Operating System.
Note: See the Diagnostics section to resolve any issues or errors that occur.
Note: For specific connection information download and reference the switch's Installation Guide on
support.dell.com.
2. Once the connection has been made to the switch, power on the switch or reload.
As the switch boots, it will pause at the GRUB menu if the switch is loaded without an OS or has OS10
installed. If the switch has OS9 installed, press Esc during the autoboot process.
Note: Depending on pre-existing conditions, such as the type of operating system installed, other options may
be provided within this menu.
3. Use the down arrow key to select ONIE and press the Enter key.
Note: On the next step, you must use an up/down arrow key or make your selection within 5 seconds of
seeing the menu, or else the default selection will run automatically.
Note: Once the ONIE: Install OS option has been selected, an operating system installation may be
necessary regardless of any existing network operating systems that have been installed.
If a USB drive was previously inserted, auto-discovery searches the USB storage supporting the FAT32 or
EXT2 file system. It also searches for HTTP or TFTP servers if a USB installer file is not found. The auto
discovery method repeats until a successful software image installation occurs and reboots the switch.
4.1.1 HTTP/TFTP
For sites that require multiple operating system installs, the use of a less specific file name and file path
ensures that all the switches in the network install the same OS. Use of file path that includes the device MAC
address and the full onie-installer name, ensures that only a specific device receives the intended operating
system.
Note: For a listing of qualified file names used by ONIE auto-discovery, see Appendix C.
The process that ONIE uses for auto discovery will go through the following sequence until it finds a valid
installer file:
Note: For information on the auto discovery process, see the Open Computer Project. The content within this
document is specific to Dell EMC Networking as where the Open Computer Project documentation is more
generic.
1. Install a Linux web server, such as Apache, that a switch can access once it has obtained its IP
address from a DHCP server.
2. Copy the operating system installer file to the path shared by the web server, such as /var/www/html,
and rename it onie-installer or another qualified file name.
Note: For a listing of qualified file names used by ONIE auto-discovery, see Appendix C.
3. Create a DNS entry to resolve onie-server to the Linux web server address.
4. Test web access to the operating systems installer file by entering http://<server-ip-address>/<onie-
installer> into the web browser’s URL field on a system in the same IP subnet. The directory displays
the installer file.
5. Click on the file to download a local copy. The test passes when the file successfully downloads.
6. Perform the following steps on each switch to be installed with an operating system:
a. With ONIE installed on the switch with no operating system, connect the Out-of-Band (OOB)
port to the network containing the web server.
b. Power the switch on. The switch automatically starts the auto-discovery and zero-touch
installation.
c. Once the switch installs the operating system, it reboots to the OS login: prompt. The
installation is complete.
4.1.2 USB
There are two prerequisites for using a USB drive to install an operating system utilizing the automatic zero-
touch option.
Note: For a listing of qualified file names used by ONIE auto-discovery, see Appendix C.
4.2.1 HTTP/TFTP/FTP
To install an operating system manually, boot into the ONIE: Install OS menu.
From the ONIE prompt, use the following command to download and apply the update over the network. The
following example shows the use of TFTP; however, HTTP or FTP can also be used.
Note: Verify that the USB drive supports a FAT 32 or EXT2 file system.
1. Plug the USB drive with the desired operating system into the USB port on the device.
2. Enter the following command to create a USB mount location on the system:
3. Validate the specific file path for the USB drive on the switch with the blkid command. The USB
drive is highlighted in the command output below.
ONIE:/ # blkid
/dev/sda4: UUID="c4e653fd-b843-452f-9c9d-64429a3f945e"
/dev/sda3: LABEL="EDA-DIAG" UUID="bc182a2d-aa35-49b2-8510-08dd956dd057"
/dev/sda2: LABEL="ONIE-BOOT" UUID="17760947-e561-4eb7-87b4-4d0ad9254c3a"
/dev/sdb1: LABEL="THUMBDRIVE" UUID="14A6-FEE0"
/dev/sda1: LABEL="EFI System" UUID="90AE-9B38"
4. Mount the USB drive. The vfat option is used for FAT32 formatted drives.
5. Install the software from the USB drive, where /mnt/media specifies the path where the USB
partition is mounted.
Note: ONIE updates and operating system installations are covered in the ONIE: Update section and the
ONIE: Install OS section. The same process applies in ONIE: Rescue mode for those two operations.
Note: This process can also be run from ONIE: Install OS mode as well.
The onie-syseeprom command shows the current DIAG version. If a newer version is available, use this
section to update the switch to the current DIAG version.
Note: For current DIAG versions refer to switch specific release notes.
This process updates the diagnostics (DIAGs) operating system, refer to EDA-DIAG Tools Upgrade section to
verify and update the DIAG tools.
Note: Ensure that the file location is accessible over the network.
INSTALLER DONE...
Removing /tmp/tmp.bSyRpb
ONIE: NOS install successful: tftp://100.67.2.65/diag-installer-x86_64-
dellemc_s4100_c2338-r0-3.33.3.1-6-2018-02-05.bin
ONIE: Rebooting...
Note: The install package must be first downloaded from support.dell.com and accessible via http/tftp/ftp.
Verify that installation was successful. See the Diagnostics section to resolve any issues encountered with
the firmware update or with the individual components.
When the ONIE: Uninstall OS option is selected, ONIE automatically goes through and deletes any existing
operating system on the switch. ONIE and diagnostics are not deleted.
CAUTION: Before deleting the operating system, verify that this is the wanted action as there is no way to
stop the process once this menu option has been selected.
When in the CLI prompt of ONIE: Update, enter the following command to verify the ONIE version:
ONIE:/ # onie-sysinfo -v
3.33.1.1-6
If a different version of ONIE is required, perform the following steps to update ONIE:
1. Navigate to support.dell.com and select the specific Dell EMC networking device.
2. Select Drivers and downloads, Dell Networking <switch> ONIE v<version>, and then select the
option to view the full driver details.
3. Locate and click to download the onie-updater-x86_64-dell_-<version> file.
If a USB drive has been previously inserted, auto-discovery searches the USB drive supporting the FAT32 or
EXT2 file system. It also searches for HTTP or TFTP servers if a USB updater file is not found. The auto-
discovery method repeats until a successful software image update occurs and reboots the switch.
Note: For a listing of qualified file names used by ONIE auto-discovery, see Appendix C.
ONIE uses the following auto-discovery process sequence until it finds a valid onie-updater file:
This process repeats until it is either manually stopped or an <onie-updater> file is found.
1. Install a Linux web server, such as Apache, that a switch can access after it has obtained an IP
address from a DHCP server.
2. Copy the ONIE updater file to the path shared by the web server, such as /var/www/html, and rename
it to onie-updater or another qualified file name.
Note: For a listing of qualified file names used by ONIE auto-discovery, see Appendix C.
3. Create a DNS entry to resolve onie-server to the Linux web server address.
7.1.2 USB
The following are prerequisites for using a USB drive to install an operating system using the automatic zero-
touch option:
Note: For a listing of qualified file names used by ONIE auto-discovery, see Appendix C.
Note: The following example uses TFTP, however, HTTP or FTP can also be used.
Note: Before you continue, verify that the USB drive supports a FAT32 or EXT2 file system.
1. Plug the USB drive into the USB port on the device.
2. Enter the following command to create a USB mount location on the system:
3. Validate the specific file path for the USB drive on the switch with the blkid command. The USB
drive is highlighted in the command output below.
ONIE:/ # blkid
/dev/sda4: UUID="c4e653fd-b843-452f-9c9d-64429a3f945e"
/dev/sda3: LABEL="EDA-DIAG" UUID="bc182a2d-aa35-49b2-8510-08dd956dd057"
/dev/sda2: LABEL="ONIE-BOOT" UUID="17760947-e561-4eb7-87b4-4d0ad9254c3a"
/dev/sdb1: LABEL="THUMBDRIVE" UUID="14A6-FEE0"
/dev/sda1: LABEL="EFI System" UUID="90AE-9B38"
4. Mount the USB drive. The vfat option is used for FAT32 formatted drives.
5. Enter the following command to install the software from the USB drive.
Note: Replace /mnt/media with the file path where the USB partition is mounted.
The Dell EMC Networking S4048-ON and Dell EMC Networking S3048-ON use a different form of ONIE
Diagnostics called DCLI.
The information in this section outlines the upgrade procedures for EDA-DIAG.
Note: To ensure that the latest procedure is used, reference the most current release notes from
support.dell.com.
When EDA-DIAG boots to Linux, a username and password is required. Enter root for the user name and
calvin for the password.
Note: See Installing or Updating DIAG OS for information about diagnostic installation and updates.
When logging into the diag module, the Diag OS version displays:
The programs included with the Debian GNU/Linux system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.
Note: If edatool does not run, see the EDA-DIAG tools upgrade section for information on installing
diagnostic tools.
root@dellemc-diag-os:~# edatool
*****************************
* Diagnostics Application *
*****************************
Dell-EMC Diag edatool version 1.4, package 3.33.4.1-1 2017/05/12
Dell-EMC Diag cpldupgradetool - version 1.1 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag cputool - version 1.1 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag eepromtool - version 1.5 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag fantool - version 1.5 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag gpiotool - version 1.4 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag i2ctool - version 1.5 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag ledtool - version 1.0 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag lpctool - version 1.0 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag memtool - version 1.5 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag nputool - version 1.0 sdk-6.5.7 package 3.33.4.1-1
2017/05/12
Dell-EMC Diag nvramtool - version 1.5 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag opticstool - version 1.0 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag pcitool - version 1.5 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag phytool - version 1.1 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag pltool - version 1.5 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag psutool - version 1.4 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag rtctool - version 1.1 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag smbiostool - version 1.2 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag storagetool - version 1.1 package 3.33.4.1-1 2017/05/12
Dell-EMC Diag temptool - version 1.4 package 3.33.4.1-1 2017/05/12
Testing PCI devices:
+ Checking PCI 00:00.0, ID=1f0f8086 ....................... Passed
+ Checking PCI 00:01.0, ID=1f108086 ....................... Passed
+ Checking PCI 00:02.0, ID=1f118086 ....................... Passed
+ Checking PCI 00:03.0, ID=1f128086 ....................... Passed
:
root@dellemc-diag-os:~# ls
dn-diags-S4100-DiagOS-3.33.4.1-6-2018-01-21.deb
1. Check the current switch BIOS version with the following command:
2. Compare with available firmware version for the specific switch on support.dell.com.
3. Download and uncompress the file.
4. Run the following command to update BIOS:
Note: See the Hardware Diagnostic Guide specific to your switch, to update the SMF-MSS.
A switch that does not have an SMF-MSS image will not have the smarttool command available for use.
To verify the SMF-MSS version, enter the following command:
root@dellemc-diag-os:~# reboot
onie-discovery-stop
2. If a DHCP server is not used, configure the IP address and subnet mask on the management port,
where x.x.x.x represents your internal IP address.
3. Use the following command to verify that the IP address has been assigned to eth0:
ONIE:/ # ifconfig
eth0 Link encap:Ethernet HWaddr 14:18:77:E0:69:31
inet addr:100.67.170.221 Bcast:100.67.170.255
Mask:255.255.255.0
inet6 addr: fe80::1618:77ff:fee0:6931/64 Scope:Link
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
RX packets:28 errors:0 dropped:0 overruns:0 frame:0
TX packets:13 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:1000
RX bytes:11176 (10.9 KiB) TX bytes:2712 (2.6 KiB)
Memory:dfe60000-dfe7ffff
4. If the server is in a separate subnet, add a default route using the following command:
ONIE:/ # route -n
Kernel IP routing table
Destination Gateway Genmask Flags Metric Ref Use Iface
0.0.0.0 100.67.170.254 0.0.0.0 UG 0 0 0 eth0
100.67.170.0 0.0.0.0 255.255.255.0 U 0 0 0 eth0
Note: This process is not persistent and will need to be reconfigured after a reboot.
DCLI-> showSystemInfo
************************** S4048ON SYSTEM INFO ****************************
Software Info:
SW Name : Dell Networking OS
SW Version : 1.0(0.14)
Board Info:
Board Revision : 0x2
Board Service Tag : 59D7VS1
CPLD Info:
System CPLD Version : 15.2
Master CPLD Version : 12
PPId Info:
PPId : TW0J09D32829849Q0048
PPId Revision : X01
SysEeprom Info:
Base MAC Address : 34:17:eb:f2:52:c4
Country Code : TW
Part Number : 0J09D3
Manufacturer : 28298
Manufacture Date : 10/03/2014 13:39:37
Product Name :
Note: This example was done using the Dell EMC Networking S4048-ON. For current DCLI diagnostic
versions, see the Release Notes specific to your switch.
If a newer version of DIAGs is needed, update the DIAGs using the following steps:
Note: Download the INSTALLER-DND-SG-<version>.bin file from support.dell.com. Navigate to the specific
Dell EMC networking device page. Go to Drivers and downloads > Dell Networking Diagnostics for <switch>
Open Networking Switch and then select view full driver details.
DCLI-> testall
Dell Networking OS S4048-ON BOARD DIAGNOSTIC [0]
:
DCLI-> upgradeCPLDImage
Upgrade CPLD Image [YES/NO]: YES
2. When the upgrade is done, manually power-cycle the switch using the powercycle command.
DCLI-> powercycle
Power cycling the device ...
Note: Do not enter ‘exit’ from the DCLI prompt or the switch, otherwise you will need to power cycle the
switch.
Note: To reach a larger grouping of switches, Dell EMC recommends the use of a more generic file name.
• onie-installer-x86_64-dell_s4000_c2338-r0
• onie-installer-x86_64-dell_s4000_c2338
• onie-installer-dell_s4000_c2338
• onie-installer-x86_64-bcm
• onie-installer-x86_64
• onie-installer
ONIE update:
• onie-updater-x86_64-dell_s4000_c2338-r0
• onie-updater-x86_64-dell_s4000_c2338
• onie-updater-dell_s4000_c2338
• onie-updater-x86_64-bcm
• onie-updater-x86_64
• onie-updater
Onie _recovery_notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId INSTALLER-DND-SG-
=X1GJP x.x.x.x.bin
Onie_FW_updater
Release Notes
Onie_recovery_notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId INSTALLER-DND SK-
=GK22T x.x.x.x.bin
Release Notes
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId BIOS.zip
=V4DJ1
CPLD.zip
Onie_FW_updater
Release Notes
Onie _recovery_notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag-installer
=D7F0N
S4048T Release Notes
Diagnostic tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4048T-
=YGX5J DiagOS.xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=98CDR
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag-installer
=Y1T02
Diagnostic tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4100-
=M0PFV DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=N45G5
BIOS
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=TJ9N5
Diagnostic tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4100-
=GXXTV DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=FT8DP
BIOS
CPLD
Release Notes
Diagnostic OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=TJ9N5
Diagnostic tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4100-
=GXXTV DiagOS-xxxxx.deb
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=TJ9N5
Diagnostic Tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4100-
=GXXTV DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=FT8DP
BIOS
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=1DWN8
Diag Tools for https://www.dell.com/sup .zip
S4248FB/FBL-ON port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4200-
=MN65P DiagOS-xxxxx.deb
Diag Tools for https://www.dell.com/sup .zip
S4248FBL-ON port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4248FBL-
=4CD1C DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=FF98P
BIOS
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=D4J38
Diagnostic Tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4100-
=21JT1 DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=34V0J
BIOS
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=V9C6J
CPLD
Diag OS
BIOS Updater
Release Notes
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=4178G
Diagnostic Tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4100-
=09J4V DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=7XFV8
BIOS
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=0G65N
Diagnostic Tools https://www.dell.com/sup .zip
port/home/us/n/19/driver
s/driversdetails?driverId Dn-diags-S4100-
=9MGPP DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=W8RCG
BIOS
CPLD
Release Notes
Diagnostics OS https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Diag OS Installer
=K9D2F
Diagnostic Tools https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Dn-diags-S4100-
=JMFJV DiagOS-xxxxx.deb
Firmware updater https://www.dell.com/sup .zip
port/home/us/en/19/drive
rs/driversdetails?driverId Onie-firmware
=C3N00
BIOS
CPLD
We encourage readers to provide feedback on the quality and usefulness of this publication by sending an
email to Dell_Networking_Solutions@dell.com