Mastering the NSX Management Cluster: Essential Commands and Log Files

Manage the NSX Manager cluster from the CLI: cluster status and config, detach and join manager nodes, and the NSX Manager log files for troubleshooting.

Short answer: check NSX Manager cluster health with get cluster status and its setup with get cluster config. Remove a manager with detach node <ID>, and add one with join <primary-IP> cluster-id <ID> thumbprint <thumbprint> username admin password <password>. The log files to read when something breaks are listed at the end. Every other NSX Manager command, by NSX version, is in the NSX CLI interactive mindmap.

This blog post dives into the essential commands for managing the NSX Management Cluster and explores the key log files within the NSX Manager to ensure you’re equipped to maintain and troubleshoot your setup effectively.

Understanding the NSX Management Cluster

Essential Commands for NSX Management Cluster

To help you navigate the management of the NSX Management Cluster, here are some indispensable commands you should be familiar with:

Querying Cluster Status

  • Command: get cluster status
  • Description: This command allows you to check the current status of the NSX management cluster, providing insights into its health and operational state.

Querying Cluster Configuration

  • Command: get cluster config
  • Description: Use this command to obtain the configuration details of the NSX management cluster. It’s essential for verifying the current setup and planning any necessary adjustments.

Detaching a Manager Node

  • Command: detach node <ID>
  • Description: If you need to remove a Manager node from the cluster, this command lets you safely detach it, ensuring no disruption to the cluster’s operation.

Adding a New Manager Node

  • Command:
    join <Primary Manager Node IP> cluster-id <ID> thumbprint <Primary Manager Node Thumbprint> username admin password <admin password>
  • Description: This command is crucial for scaling or repairing the NSX management cluster. It allows you to add a new Manager node to the cluster, enhancing its resilience and capacity.

Key Log Files in NSX Manager

For effective troubleshooting and monitoring of the NSX Management Cluster, understanding how to access and interpret log files is crucial. Here are the essential log files within the NSX Manager:

NSX Manager Logs

  • Access Command: get log-file manager.log follow
  • Location & Description: This log provides detailed records of the operations and events within the NSX Manager, offering invaluable insights for troubleshooting.

Syslog Files

  • Access Command: get log-file syslog follow
  • Location & Description: The syslog files capture a wide range of system messages, including errors, warnings, and operational information, which are critical for diagnosing issues within the cluster.

Author: Daniel Micanek

Senior Service Architect, SAP/TDL Platform Services Team at Vivicta | vExpert ⭐⭐⭐⭐⭐⭐⭐ | Broadcom Knight: vSphere Kubernetes Service, VCF Networking (NSX), VCF Automation | Broadcom Software Knight: vSphere | Cisco Champion. Notes from running about 1,000 ESXi hosts on Cisco UCS, VCF 9 and SAP HANA on vSphere.