The NSX Agent installation script provides configurable options. This table lists these options.

NSX Agent Install Script Options for Windows VMs

Table 1.
Option Description
-gateway <ip|dns>

NSX Public Cloud Gateway IP or DNS name.

Specify this option if you want to use an IP address for the PCG. The default DNS name of the PCG is used if this parameter is not specified.
  • PCG DNS name in AWS: nsx-gw.vmware.local
  • PCG DNS name in Microsoft Azure: nsx-gw
Note: In HA mode of PCGs, specify the "--gateway" option with both PCG names, for example, in a Microsoft Azure VM : --gateway "nsx-gw1;nsx-gw2"
-noStart true You can create a VHD of the VM after the NSX agent is installed on it. Run the install script with this option. Then from the Microsoft Azure portal, create a VHD of this VM.
-downloadPath <path>

This is the path to the directory in which the files should be downloaded. If the path includes escape characters, enclose them in single quotation marks.

Default = %temp%

-silentInstall <true/false>

If this is set to true, the script runs a silent installation.

Default is false

-noSigCheck <true/false> This allows you to specify whether to check the signatures on the binaries or not.

Default = false

-logLevel <value>

This allows you to specify the log level for NSX components

Default = 1

Verbose = 3

-operation <install/uninstall>

This allows you to specify the operation to perform: install or uninstall

Default = install

-bundlePath <path>

This allows you to specify the local path to the NSX VM agent bundle

Default option is to download the bundle from PCG.

Uninstalling NSX agent from a Windows VM

  1. Remote log in to the VM using RDP.
  2. Run the installation script with the uninstall option:
    \nsx_install.ps1  -operation uninstall

NSX Agent Install Script Options for Linux VMs

Table 2.
Option Description
--gateway <ip|dns>

NSX Public Cloud Gateway IP or DNS name.

Specify this option if you want to use an IP address for the PCG. The default DNS name of the PCG is used if this parameter is not specified.
  • PCG DNS name in AWS: nsx-gw.vmware.local
  • PCG DNS name in Microsoft Azure: nsx-gw
Note: In HA mode of PCGs, specify the "--gateway" option with both PCG names, for example, in a Microsoft Azure VM : --gateway "nsx-gw1;nsx-gw2"
--no-start You can create a VHD of the VM after the NSX agent is installed on it. Run the install script with this option. Then from the Microsoft Azure portal, create a VHD of this VM.
--uninstall Run the script with this option to uninstall the NSX agent.