Renaming an NSX-T Segment with Active Workloads

Products

• VMware NSX

Issue/Introduction

This article provides a step-by-step guide for safely renaming an existing NSX-T segment, even when it is in a production environment with active virtual machine workloads connected. 

Environment

VMware NSX

Cause

Renaming Segments is often required for adherence to new naming conventions or the organization's Standardization.

Resolution

1. Login to NSX-T Manager:

   • Access the NSX-T Manager UI using administrative credentials with sufficient permissions.

2. Navigate to Segments:

   • In the NSX-T Manager UI, go to Networking > Segments.

3. Locate the Target Segment:

   • From the list of segments, identify and find the specific segment you intend to rename.

4. Edit the Segment:

   • Click the vertical ellipsis (three dots ...) located next to the segment's row, and then select Edit.
   • Alternatively, you can click on the segment name itself to open its detailed view, and then click the Edit button.

5. Rename the Segment:

   • Within the "Edit Segment" wizard, locate the Segment Name field.
   • Modify the current name to the desired new name.
   • IMPORTANT: Do NOT change any other settings (e.g., connected gateway, subnets, VLAN ID, transport zone, etc.) unless they are explicitly part of this planned change. Modifying other settings could lead to network disruption.

6. Save Changes:

   • Click Save to apply the new segment name.

7. Review Configuration:

   • Review the changes in the summary window to confirm that the new name has been successfully applied.

8. Verify in vCenter (Optional but Recommended):

   • This step helps to confirm the change has propagated and provides assurance.
   • Login to the vCenter Server UI.
   • Navigate to Networking.
   • Expand the Distributed Switch that is associated with the NSX-T overlay where the segment resides.
   • Verify that the corresponding Distributed Port Group name has been updated to the new segment name.
   • Check the network adapters of a few virtual machines connected to this segment; their network adapters should now display the new port group name.

 

Additional Information

Impact :  NSX-T segment rename is purely a metadata operation. It does not cause any data plane impact or disruption to active workloads connected to the segment.