Process to change VXLAN port from 8472 to 4789 may fail or never complete

Products

• VMware NSX

Issue/Introduction

Symptoms:
The process may fail or never complete while changing the VXLAN port from 8472 to 4789 (standard port assigned by IANA).

Note: Starting with NSX 6.2.4, the default VXLAN port is 4789, the standard port assigned by IANA. In versions earlier to NSX 6.2.4, the default VXLAN UDP port number was 8472.

Environment

VMware NSX for vSphere 6.2.x
VMware NSX for vSphere 6.3.x
VMware NSX for vSphere 6.4.x

Resolution

To resolve the issue, run the REST API calls to check the status of the job and resume the change.

Prerequisites:

• Verify that the port for VXLAN is not blocked by a firewall.
• Verify that host preparation is not running at the same time as the VXLAN port change.

Procedure:

1. Check the status of the job by running GET REST API call.
   
   Method: GET
   URL: https://NSXM-IP/api/2.0/vdn/config/vxlan/udp/port/taskStatus
   Sample Output:
   <?xml version="1.0" encoding="UTF-8"?>
   <vxlanPortUpdatingStatus>
   <prevPort>8472</prevPort>
   <targetPort>4789</targetPort>
   <taskPhase>PHASE_TWO</taskPhase>
   <taskStatus>PAUSED</taskStatus>
   </vxlanPortUpdatingStatus>
    
2. Resume the job by running the POST REST API call.
   
   Method: POST
   URL: https://NSXM-IP/api/2.0/vdn/config/vxlan/udp/port/resume
   Body:
   <?xml version="1.0" encoding="UTF-8"?>
   <vxlanPortUpdatingStatus>
   <prevPort>8472</prevPort>
   <targetPort>4789</targetPort>
   <taskPhase>FINISHED</taskPhase>
   <taskStatus>SUCCEED</taskStatus>
   </vxlanPortUpdatingStatus>

For more information, see Change VXLAN Port.

Additional Information