Search the VMware Knowledge Base (KB)
View by Article ID

Collecting diagnostic information for VMware NSX for vSphere 6.x (2074678)

  • 6 Ratings
Language Editions


This article provides information on obtaining diagnostic information for VMware NSX for vSphere.
VMware Technical Support routinely requests diagnostic information from you when a support request is handled. This diagnostic information contains product specific logs for analysis.


Collecting diagnostic information for VMware NSX for vSphere

To collect diagnostic information for VMware NSX for vSphere:

  1. Log in to the NSX Manager virtual appliance through a web browser.

    For example, http://NSX_Manager_IP

  2. In NSX Manager Virtual Appliance Management, click Download Tech Support Log.
  3. Click Download > Save.

    Note:  The vsm.log file is rotated after 200MB. A maximum of 10 files are retained. The log is compressed when stored and has a .gz file extension.

  4. In case of NSX Manager appears to have hung and you cannot access the UI, you can try to collect the logs via API.

    To generate the logs:

    Method: POST
    URL: https://nsxmgr_ip/api/1.0/appliance-management/techsupportlogs/NSX

    To download the generated tech support bundle

    Method: GET

    nsxmgr_ip is the IP address of the NSX Manager
    filename is the name of the techsupport bundle generated in post method.

Using the export host-tech-support Central CLI command

Starting with NSX 6.2.3, the export host-tech-support Central CLI command is introduced, allowing you to export an ESXi host Support bundle to a specified server. This command collects NSX related outputs and files on specified hosts, such as:

  • vmkernel and vsfwd log files
  • list of filters
  • list of dfw rules
  • list of containers
  • spoofguard details
  • host related information
  • ipdiscovery related info
  • rmq command outputs
  • security group and services profile and instance details
  • esxcli related outputs

To export an ESXi support bundle to a specified server:

  1. Log in to the NSX Manager using the admin credentials.
  2. Run this command:

    export host-tech-support host-id scp uid@ip:/path

    • This command generates the NSX tech-support bundle and copies it to a specified server.
    • This removes any temporary files on the NSX Manager.
    • Run the show cluster all command to get host-id information.

    ESXi Host Command Details


    • Usage: /bin/nsx-support {-h|start|getstatus|cleanup} [datastore_name]
    • Command outputs with different command arguments
    • nsx-support start datastore_name
    • If the command arguments are normal, it returns “In progress”
    • If nsx-support start datastore_name is not proper, such as nsx-support start abc.

      In the output, you see:

      Path does not exist: /vmfs/volumes/abc. Please specify output datastore name.
    nsx-support getstatus

    • If there is an available log bundle, it returns the absolute directory of the bundle in the datastore. For example, /vmfs/volumes/”{datastoreName}"/
    • Otherwise, it returns No NSX tech support bundle found.
    nsx-support delete

    • It returns Done.

Collecting NSX Controller logs
To collect NSX Controller logs:
  1. Log in to vCenter Sever using the vSphere Web Client through a web browser.
  2. Click Networking and Security.
  3. Click Installation on the left hand pane.
  4. Under the Manage tab, select the Controller you want to download logs from.
  5. Click Download Tech support logs.

To collect NSX Controller logs using the Command Line Interface (CLI):

  1. Log in to the NSX Controller for which you want to gather logs from either the console or through SSH.
  2. Run this command:

    save status-report filename

    Note: Running this command show file shows the filename. Log files are rotated after 100MB. A maximum of 5 files are retained. Files are compressed when stored.

  3. To transfer the created log file to a remote host, run this command copy file filename root@remote_host:/tmp.
  4. Upload the log file to VMware Support. For more information, see Uploading diagnostic information for VMware using FTP (2070100).

To collect Edge and Distributed Logical Router (DLR) logs:

  1. Log in to vCenter Sever using the vSphere Web Client through a web browser.
  2. Click Networking and Security icon.
  3. Click Edges on the left hand pane.
  4. On the right pane, select the Edge you want to download logs from.
  5. Click Actions and select Download Tech support logs.

Note: For the NSX Edge, all logs are stored in /var/log/messages, rotated after 2MB. A maximum of 5 files are retained. VMware recommends to use syslog for long term retention of the logs as all NSX components support it. As the disk on the appliances, such as NSX Manager, NSX Controller, NSX Edge are limited by the virtual machine sizing, the log rotation policy is primarily based on size (and not based on time.) For more information, see the Configure Remote Syslog Servers section in the NSX Administration Guide.

For more information, see Collecting diagnostic information for VMware NSX Edge (2079380).

For more information on known System Events, Error messages and recommended actions, see the NSX Logging and System Events Guide.

Additional Information

To collect Topology information, VMware request for customers to provide a clear diagram containing hostnames and IP addresses, which shows the network topology including NSX components such as Logical Switches, LDR and ESG.

    After collecting the diagnostic information, you can upload it to VMware Technical Support.

    To uniquely identify your information, use the Support Request (SR) number you received when you opened your Support Request.

    See Also

    Update History

    QA Completed-September 15, 2015-Shwetha Bandolkar

    Request a Product Feature

    To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.


    • 6 Ratings

    Did this article help you?
    This article resolved my issue.
    This article did not resolve my issue.
    This article helped but additional information was required to resolve my issue.

    What can we do to improve this information? (4000 or fewer characters)

    Please enter the Captcha code before clicking Submit.
    • 6 Ratings