Enabling SSH on NSX Manager via API without console access.

Products

• VMware NSX

Issue/Introduction

• SSH access to the VMware NSX Manager is disabled by default.
• Console access is unavailable to enable the service manually.
• API intervention is required to start the service for troubleshooting or deployment tasks.

Environment

VMware NSX

Resolution

• Execute the API command against the specific node to enable the service.

POST https://<nsxmanagerip>/api/v1/node/services/ssh?action=start 

• Execute the API command if it is required to disable the service.

POST https://<nsxmanagerip>/api/v1/node/services/ssh?action=stop

• Validate the expected response is 200 OK to confirm the action was processed successfully.
• Check the current state by executing the API command to verify the operational status.

GET https://<nsxmanagerip>/api/v1/node/services/ssh/status 

• Restart the SSH service by executing if the service becomes unresponsive or requires a refresh.

POST https://<nsxmanagerip>/api/v1/node/services/ssh?action=restart

Additional Information

Enable SSH on NSX managers