Activate/Deactivate local Users on NSX appliances

Products

• VMware NSX

Issue/Introduction

This article explains how to deactivate/activate local users on NSX Managers and NSX Edges.

Environment

VMware NSX

Resolution

NSX Managers

• Activate/Deactivate local users can be done via the UI following the steps in the NSX Documentation.

NSX Edges

• There are no option on the NSX UI, but the following steps provide the procedure via API:
  
  
  • Deactivate users:
    1. Run the below API and note the user ID:

        GET /api/v1/transport-nodes/{transport-node-id}/node/users?internal=true

    2. Run the below API to confirm the user status is "Active":
       

       Get /api/v1/transport-nodes/{transport-node-id}/node/users/{user-id-from-step-1}

    3. After confirming the user status is "Acitve", run the below API to deactivate it:
       

       POST api/v1/transport-nodes/{transport-node-id}/node/users/{user-id-from-step-1}?action=deactivate

    4. Repeat Step #2 to confirm the status is now "Not_Activated".
       
       
  • Activate users:
    1. Run the below API and note the user ID:

        GET /api/v1/transport-nodes/{transport-node-id}/node/users?internal=true

    2. Run the below API to confirm the user status is "NOT_ACTIVATED":
       

       Get /api/v1/transport-nodes/{transport-node-id}/node/users/{user-id-from-step-1}

    3. Run the below API to Activate the user:
       

       PUT /api/v1/transport-nodes/{transport-node-id}/node/users/{user-id-from-step-1}

       Body:

       {
           "password": "<new_password>"
       }