A switch can contact an upgrade server, either directly or through a proxy, to download and upgrade to a newer version of Netvisor OS. You can modify the upgrade process for the switch and add a proxy host.
Informational Note:This upgrade procedure applies to only one switch. To upgrade switches on the fabric or to create a “rolling upgrade” on the fabric, see
What are Software Tracks?
Software tracks are a method for Pluribus Networks to manage different software releases available to customers. The software track, release, is the default standard track, but other tracks, such as Beta, may be available for download.
CLI (network-admin@Leaf1)>software-modify phone-home
Pluribus Networks switches can send “phone home” messages to the Pluribus Networks update servers to determine if a new release of software is available for download.
1. To view the current version of Netvisor OS on the switch, use the following command:
version-available: 2.2.0-202006524 -> 2.2.1-202016554
2. If the upgrade status indicates that a newer version of Netvisor OS is available, request an update from the server:
upgrade successful. rebooting...
To check the status while the switch is upgrading, use the software-upgrade-status-show command.
3. To check the status of the switch after upgrading, reconnect to the switch, and enter the following command:
Informational Note: Allow plenty of time for the switch to download and install the new version of software. Do not interrupt the operation while the upgrade is in progress. When the upgrade is complete, the switch reboots and loads the latest version of the software.
If you encounter any problems with the new version of the software, a previous version can be selected as the boot software.
Informational Note: Upgrading without an Internet connection - If the switch does not have direct access to the Internet but can use a proxy server, enter the software-modify use-proxy command to configure the proxy and then check for software upgrade availability. If there is no access to the Internet from the switch, contact Pluribus Technical Support for instructions on upgrading a switch offline.
To upgrade the current Netvisor OS to a later release, use the software-upgrade command.
CLI (network-admin@Leaf1)>software-upgrade package nvos-2.3.1-203018600.tgz
The parameter package allows you to specify the name of the upgrade file.
To display information about the software upgrade path, you can use the software-track-show command.
You can now implement a fabric-wide upgrade and reboot the switches at the same time or in a sequential order. A fabric upgrade requires downloading the new Netvisor software package to each switch, and rolling upgrade downloads the software packages from the update server and then copies the software to each switch as the upgrade proceeds.
The upgrade controller is the switch where the fabric-upgrade-start command is issued. All upgrade commands should be executed from the upgrade controller.
The fabric upgrade feature has two phases:
Upgrade — start the upgrade which creates and updates Netvisor to new boot environments but does not reboot the fabric.
Reboot — reboots the entire fabric after all server-switches are upgraded to new boot environments. It is also possible during this phase to abort the process and discard the new boot environments.
The fabric is locked during the entire process and you cannot change any configurations during the process.
Before You Begin the Fabric Upgrade
Before you begin, you may want to consider the following options for the fabric-upgrade-start command:
auto-finish — you can specify to automatically reboot the entire fabric after the upgrade is complete.
rolling — specify if you want to perform a rolling fabric upgrade. A rolling fabric upgrade performs the upgrade procedure on a switch-by-switch basis and copies the software package from the controller to other switches in the fabric. If you specify no-rolling, all switches are booted after the upgrade.
abort-on-failure — specify if you want the upgrade to stop if there is a failure during the process.
manual-reboot — specify if you want to manually reboot individual switches after the upgrade process. If you specify no-manual-reboot, all switches reboot automatically after the upgrade is complete.
prepare — specify if you want to perform setup steps prior to performing the upgrade. This step copies the offline software package and then extracts and prepares it for the final upgrade process. Once you begin the prepare process, you cannot add new switches to the fabric.
reboot-parallel — specify to reboot switches in parallel if the switches are in a cluster configuration. Or, you can reboot them one at time using the reboot-single option.
reboot-group — specify the number of switches to reboot as a group in parallel mode. The default is the maximum number of switches in the fabric up to 100 switches.
Starting the Fabric Upgrade
1. Download the latest Netvisor software from the update server onto a switch in the fabric.
2. Copy the Netvisor software package to each switch in the fabric.
3. Select a switch in the fabric to act as the upgrade controller switch, and use the fabric-upgrade-start command to begin the upgrade.
4. Depending on the options selected, the upgrade completes by reboot the fabric or rebooting all of the switches.
Starting the Rolling Fabric Upgrade
If you opted for a rolling fabric upgrade, then the upgrade controller switch begins copying to software packages to other switches in the fabric. Other than this step, the rolling fabric upgrade has the same behavior as a fabric upgrade depending on the selected options.
You can check the status of the upgrade using the fabric-upgrade-status-show command:
CLI (network-admin@sw1) > fabric-upgrade-status-show
log switch state
----------------------------------------------- -------- ------------------
(0:00:36)Upgrading software upgrade framework sw3 Running
(0:00:08)Computing package update requirements. sw2 Running
(0:00:12)Agent needs restart sw1* Agent restart wait
The first entry in the log is the duration of the upgrade process. It does not include waiting time. The switch with the asterisk (*) is the controller server-switch where the fabric-upgrade-start command was issued.
Additional commands for the fabric upgrade feature:
fabric-upgrade-finish — you can issue this command at any time during the fabric upgrade to reboot all nodes in the fabric and complete the upgrade. Once the upgrade phase is complete, all server-switches display the “Upgrade complete” message in the log field. You can then safely reboot the fabric.
fabric-upgrade-abort — aborts the software upgrade process. All changes to the server-switches are cleaned up and the server-switches do not reboot. The configuration lock on the fabric is also released.
If you issue the fabric-upgrade-abort command during the upgrade process, it may take some time before the process stops because the upgrade has to reach a logical completion point before the changes are rolled back on the fabric. This allows the proper cleanup of the changes.
fabric-upgrade-prepare-cancel — cancels a fabric upgrade that was prepared earlier.
fabric-upgrade-prepare-resume — resume a fabric upgrade that was prepared earlier.
fabric-upgrade-prepare-show — displays the status of prepared upgrades on the fabric nodes.
A switch contains local configuration information such as port settings as well as fabric configuration information. Fabric configurations are stored on every switch in the fabric and does not require that you save and restore before replacing a switch. When a switch is replaced, removed, or otherwise disrupted, you can save and restore the local configuration information.
The information that is saved and restored on the local switch includes the following:
VNETs with VNET manager running on the switch
Port VLAN associations
Network services running on the switch
To display a full list of the current configuration details for a switch, use the running-config-show command.
SFTP and NFS can be used to transfer the configuration file, but you must enable the two features before using them.
Caution! There is a potential for data loss when restoring a configuration. The configuration on the switch is replaced by the configuration stored in the import file. Although ISO images and disk-library images are not likely to disappear, you should only perform switch-config-import on a switch that doesn’t have important data stored on it.
As a precaution, consider using the command switch-config-export to save the data on the switch that you are importing the configuration file.
Also, copy the ISO images and disk images from the switch using the iso-image-library and disk-library-image-export commands and copying the files from the switch.
1. To save the switch configuration to a file, use the following command:
CLI (network-admin@Leaf1)>switch-config-export export-file pleiades24
Exported configuration to /nvOS/export/pleiades24.2013-11-04T22.33.31.tar.gz
To display the files available for import and export, use the following command:
You can now copy the configuration file to a different host using SFTP or NFS. For example, you can SFTP to the switch-ip-address, and login using the SFTP password. Then use cd/nvOS/import, and use get to download the configuration file.
The switch-config-export command is used to export the configuration of the local switch. The file that is created is a tar file that includes a number of configuration files for the switch. The file is created under /nvOS/export. This is the command used to export the current configuration on the local switch. vAlso, each time you reset the switch using the command, switch-config-reset, a backup of the configuration is made and places a file in the same location.
Once the switch configuration is exported, it becomes available to import on the same switch, by using the switch-config-copy-to-import command. Netvisor copies the configuration tar file from the /nvOS/export to the /nvOS/import directory. Once in the /nvOS/import directory, it is possible to use the switch-config-import command to import the switch configuration.
The switch-config-import command is used to import a configuration on the local switch. When using that command, the intention is to import a switch configuration t previously exported by the same switch.
The switch-config-import command has a few parameters to it. The ignore-system-config and the apply-system-config parameters are 2 parameters that allow the imported configuration of the switch to override or not override the currently configured information found under the switch-setup-show command. When you select the ignore-system-config parameter, the local configuration is saved to an archive. If you select apply-system-config, the settings in the tar file are applied to the local switch.
When you import a configuration using the switch-config-import command, the current configuration on the switch is overwritten by the imported configuration file.
The skip-fabric-join option imports the fabric configuration from the tar file. However, this information may be out of date with respect to the fabric if transactions have occurred on the fabric since the file was exported which causes the imported configuration to be out-of-sync with the current fabric. The alternative is to specify do-fabric-join, which extracts the fabric name from the tar file, and attempts to join the fabric and download the current fabric configuration, so that it is in sync with the rest of the fabric. The fabric configuration in the tar file is ignored, but cluster and local configurations are imported from the tar file.
When a switch that was part of a cluster is replaced, the fabric-join repeer-to-cluster-node command is used for the new switch to receive all required switch configuration, including the local configuration.
To upload a configuration file to a switch and set the configuration for the switch using the configuration file, you must transfer the configuration file to the target switch using the following sequence of commands:
Connecting to switch-ip-address
sftp> cd nvOS/import
sftp> put pleiades24.2013-11-04T22.33.31.tar.gz
Informational Note: The configuration file must use the *.tar.gz extension to be recognized by nvOS.
CAUTION! Loading the configuration file causes nvOS to restart which results in a brief interruption to switch traffic flow.
Now load the configuration file which replaces the current configuration on the switch with the information in the file.
CLI (network-admin@Leaf1)>switch-config-import import-file pleiades24.2013-11-04T22.33.31.tar.gz
New configuration imported. Restarting nvOS...
Connected to Switch pleiades24; nvOS Identifier:0xb000011; Ver: 0.19.3747
There are many options available that allow you to control how the switch-config-import modifies the switch, including the following:
ignore-system-config - ignore the current system configuration.The settings in the *.tar file are not applied to the local switch.
apply-system-config — apply the system configuration in the imported file. The settings in the *.tar file are applied to the local switch. You typically do not want to use this option as it changes the in-band IP address and other settings.
skip-fabric-join — opt out of joining the fabric. This setting imports the fabric configuration from the *.tar file, but this information may be out of date with respect to the fabric if additional transactions occur on the fabric since the file was exported.
do-fabric-join — join the current fabric. This setting extracts the fabric name from the *.tar file and attempts to join the fabric. Then the switch contacts the current fabric to download the configuration so that the switch is in sync with the rest of the fabric. Cluster and local configurations are imported from the *.tar file.
no-replace-switch — do not replace the current switch.
replace-switch — replace the current switch. This setting is used to replace a faulty switch and after importing the file, has the same configuration as the replaced switch. This replaces all of the local, cluster, and fabric configuration by downloading the configurations from peer switches. No configuration is necessary or advised before running this command. However, you need to run the initial quickstart to obtain an in-band IP address.
By default, the initial switch system configuration, management IP addresses and other parameters, are not applied if there is another switch in the fabric with the same settings. To apply the initial settings, use the apply-system-config option. Also, by default, the imported configuration attempts to join the same fabric that the original switch was a member. If that join fails, then the import fails. You can avoid this issue by using the skip-fabric-join option. Finally, if the original switch is still on the network and you want to copy the configuration to a new switch, but you want to prevent the new switch from taking ownership of any objects specific to the original switch, such as VNET services, or VLAN port settings, you must use the no-replace-switch option.
You can create a configuration file to import to another switch by using the switch-config-copy-to-import command. To create a configuration file with the name config-092613 to import on another switch, use the following syntax:
CLI (network-admin@Leaf1)>switch-config-copy-to-import export-file config-092613
After you create the configuration file, you can export it to /nvOS/export/ directory, and SFTP to it from the target switch.
To review the available files for import and export, use the following syntax:
Depending on the available remote access services, you can now copy the configuration file to a different switch. For example, you can SFTP to another switch using the IP address of the switch, login as SFTP with the password that you previously set, cd /nvOS/import and get the configuration file.
To upload the configuration file to the target switch and set the configuration from the configuration file, transfer the configuration file to the target switch with the IP address, 192.168.3.35.
To export a configuration to a server, use the switch-config-export command:
The SCP is a network protocol based on the BSD RCP protocol supporting file transfers between hosts on a network. SCP uses Secure Shell (SSH) for data transfer and uses the same mechanisms for authentication, and ensures the authenticity and confidentiality of the data in transit. A client can upload files to a server, optionally including basic attributes such as permissions or timestamps. Clients can also download files or directories from a server. SCP runs over TCP port 22 by default. Like RCP, there is no RFC that defines the specifics of the protocol.
In Netvisor, you are prompted for a password when the upload-server option is provided in CLI.
During the software upgrade process, Netvisor exports the switch configuration and moves it to a shared directory. The exported configuration archive is accessible from all boot environments. Netvisor exports the configuration before the start of the software upgrade.
Netvisor stores a maximum of three configuration archives on the switch. Older configurations are deleted.
New parameters in Netvisor support this feature:
export-file switch-config export-file
Specify the name of the file to export.
Specify the upgrade location mappings.
Specify any of the following options:
Specify the name of the upload server.
Specify the password for the upload server.
If you specify an upload server and password, Netvisor OS prompts you for that information when you execute the software-upgrade command.