How to Install & Use nCLI

Installing the nCLI on Your Local System


  1. Verify that your system has Java Runtime Environment (JRE) version 5.0 or higher.

To check which version of Java is installed on your system or to download the latest version, go to

Step 1

  1. Download the nCLI.
    1. Connect to the Nutanix web console.
    2. Click the user icon at the top of the console.
  2. Select Download nCLI.
  3. Download and unzip the file on your local system.

Step 2

  1. Configure your Windows %PATH% or Linux $PATH environment variables.
    • nclidirectory (for example, C:\ncli)
    • JRE bindirectory (for example, C:\Program Files\Java\jre1.6.0_21\bin) If you are running Java 8, no need to add the path.

2. On your local system, open a command prompt (such as bash for Linux or CMD for Windows).

3. At the command prompt, start the nCLI by using one of the following commands.

  1. ncli -s management_ip_addr-u ‘username‘ -p ‘user_password

In this case, the console displays the password.

  1. ncli -s management_ip_addr-u ‘username‘ -p

In this case, you are prompted to specify the password.

  • Replace management_ip_addrwith the IP address of any Nutanix Controller VM in the cluster.
  • Replace usernamewith the name of the user (if not specified, the default is admin).

Command Format

Nutanix Command-Line Interface commands must match the following format:

ncli> entity action parameter1=value parameter2=value …

ncli> storagepool list