This section discusses the steps, prerequisites and restrictions while preparing for the patch.

Finding the Version

One or more patch packages may be applicable to a specific NSX Advanced Load Balancer version. Therefore, it is essential to know the version that the NSX Advanced Load Balancer is currently on. Check the NSX Advanced Load Balancer Controller or SE version(s) using the following commands:

  • show version controller

  • show version serviceengine

Prerequisites and Restrictions

  • Choose the required patch package based on the Controller and SE versions.

  • All Controllers must be on the same (base+patch) version to form a cluster. For instance, assume: A – is the major release and x.y – is the maintenance version. You cannot form a cluster with one Controller on A.x.y, one on A.x.y 2p1, and one on A.x.y 2p2.

  • For more information, see Clustering Patched Controllers.

  • All patches from a maintenance release are incorporated into successive maintenance releases.

  • Once a NSX Advanced Load Balancer Controller is upgraded to a new maintenance release, all underlying SE groups must be upgraded to the same release as well.

  • A patch family is the one in which the leading digit is the same. For instance, 1p1, 1p2, and 1p3 are patches in the 1px family.

  • Fixes accumulate within a patch family. For instance, the 1p2 patch contains new fixes unique to it, plus all the fixes from 1p1. The 1p3 patch includes fixes from both the 1p1 and 1p2 patches. Additionally, the 2p1 patch is the first in a new patch family and does not contain 1px fixes.

  • A given fix may appear in more than one patch family.

  • The following options are allowed when selecting a patch version:

    • Choose any patch applicable to a particular maintenance release as the first patch to be applied to that base version.

      For example, in a patch family comprised of 1p1, 1p2 and 1p3, any one of the three can be the first applied.

    • Apply any subsequent patch, as long as it is within the same patch family. For instance, you can apply 1p5 to 1p1.

  • The following options are not advisable while choosing a patch version:

    • Applying a patch from a patch family other than the one already chosen.

      For instance, you cannot apply patch 2p1 once any 1px patch has been applied.

    • Apply a patch that would imply an upgrade to a different NSX Advanced Load Balancer maintenance release.

      For example, it is impossible to patch upgrade from 17.2.3 to 17.2.4-1p3.

  • .pkg is the same for both container and non-container.

  • For Controllers on BareMetal/LSC or legacy GCP, the upgrade package is available in docker.tgz.

Upload the Patch Package

Use WinSCP or any similar tool to upload the patch package to the Controller.

The following are the ways to upload patch image to the NSX Advanced Load Balancer Controller.

  • Copy the downloaded patch image to the NSX Advanced Load Balancer Controller/tmp directory and then upload it on NSX Advanced Load Balancer Controller using image API.

  • Use the curl command to upload the respective patch packages.


The leader Controller ensures that the follower Controllers are on the same version. The Controller machine on the base version of NSX Advanced Load Balancer might be previously patched. Upload patch package by using image the API /api/image/.

Images should be uploaded before starting the upgrade process.

  1. Use the upload image filename <file path> command to start uploading the image.

    [admin:controller]: > upload image filename /tmp/se_patch.pkg
     Starting image upload...
       | Field         	| Value                                            	|
       | status        	| SYSERR_SUCCESS                                   	|
       | se_info       	|                                                  	|
       |   path        	| image://20.1.1-5000-2p2-20200217.063645/se_patch.pkg |
       |   hash        	| e337b2024fe8b1647128af9da3c66c83                 	|
       |   build       	|                                                  	|
       | 	min_version   | 15.2                                             	|
       | 	tag       	| 20.1.1-5000-20200217.063645                      	|
       | 	build_no  	| 5000                                             	|
       | 	patch_version | 2p2                                              	|
       | 	version   	| 20.1.1                                           	|
       | 	date      	| 2020-02-17 06:36:45 UTC                          	|
       |   patch       	|                                                  	|
       | 	patch_type	| se                                               	|
       | 	reboot    	| False                                            	|
       | uuid          	| image-b26182c2-92d9-4523-9c5e-676371664038       	|
       | type          	| IMAGE_TYPE_PATCH                                 	|
       | tenant_uuid   	| admin                                            	|
       | name          	| 20.1.1-5000-2p2-20200217.063645                  	|
       Time Taken: 2.15626502037

    Image upload is supported only on the Cluster Leader.

  2. Use the show image command to view the image.

    [admin:10-50-54-123]: > show  image
    | Name                        | UUID                                       | Type              | State               |
    | 20.1.7-9154-20210916.210140 | image-e4ffa292-be4e-45e0-b6f4-c4a5ee66fc66 | IMAGE_TYPE_SYSTEM | IMAGE_FSM_COMPLETED |
    | 21.1.3-9003-20211202.115243 | image-f2325e62-cae2-47af-bfb0-7fd9ab00d5b4 | IMAGE_TYPE_SYSTEM | IMAGE_FSM_COMPLETED |
    | 21.1.3-9007-20211204.000303 | image-d7764ab0-8ac3-4e58-8484-6ae5c77142f6 | IMAGE_TYPE_SYSTEM | IMAGE_FSM_COMPLETED |

  3. Log in to the NSX Advanced Load Balancer shell using admin credentials. Use the show upgrade status and show upgrade status detail commands to check the upgrade status.

    [admin:controller]: > show upgrade status
    | Name      	| Cloud     	| State             	| Operation | Image                   	| Patch |
    | cluster-0-1   | -         	| UPGRADE_FSM_COMPLETED | UPGRADE   | 18.2.8-9000-20200212.075158 | - 	|
    | Default-Group | Default-Cloud | UPGRADE_FSM_COMPLETED | UPGRADE   | 18.2.8-9000-20200212.075158 | - 	|
    | se1 | Default-Cloud | UPGRADE_FSM_COMPLETED | UPGRADE   | 18.2.8-9000-20200212.075158 | - 	|