NSX Edge Description field cannot be edited after deployment

Products

• VMware NSX Networking

Issue/Introduction

Symptoms:
Once Edge/DLR is deployed it is not possible to change the description field via API, UI.

• In UI there is no option to edit the description in Edge/DLR once it is deployed. 
• API to change the description is available however fails to change the description when used.
• API detail: https://docs.vmware.com/en/VMware-NSX-Data-Center-for-vSphere/6.4/nsx_64_api.pdf
  Page 344
  PUT /api/4.0/edges/{edgeId}

Cause

Editing of the "Description" field is not allowed by design and hence API is also not allowing edit operation.

Resolution

Option to change the Description via API/ UI will be available in future release.

Workaround:

Changing the Description from NSX Manager DB can be used as a workaround as below

Login to NSX manager in engineering mode and login to sql prompt and apply below:

#update domain_object set description = 'DESCRIPTION_CONTENT' where objectid = 'edge-id';

DESCRIPTION_CONTENT : Field description has a limit of 1024 chars.