Command Reference-NOS v3 5

Command Reference Guide
NOS 3.5
23-Sep-2013
Notice
Copyright
Copyright 2013 Nutanix, Inc.
Nutanix, Inc.
1740 Technology Drive, Suite 400
San Jose, CA 95110
All rights reserved. This product is protected by U.S. and international copyright and intellectual property
laws. Nutanix is a trademark of Nutanix, Inc. in the United States and/or other jurisdictions. All other marks
and names mentioned herein may be trademarks of their respective companies.
Conventions
Convention Description
variable_value The action depends on a value that is unique to your environment.
ncli> command The commands are executed in the Nutanix nCLI.
user@host$ command The commands are executed as a non-privileged user (such as nutanix)
in the system shell.
root@host# command The commands are executed as the root user in the hypervisor host
(vSphere or KVM) shell.
output The information is displayed as output from a command or in a log file.
Default Cluster Credentials

Interface Target Username Password
Nutanix web console Nutanix Controller VM admin admin
vSphere client ESXi host root nutanix/4u
SSH client or console ESXi host root nutanix/4u

SSH client or console KVM host root nutanix/4u
SSH client Nutanix Controller VM nutanix nutanix/4u
IPMI web interface or ipmitool Nutanix node ADMIN ADMIN
IPMI web interface or ipmitool Nutanix node (NX-3000) admin admin
Version
Last modified: September 23, 2013 (2013-09-23-12:35 GMT-7)
Copyright | Command Reference Guide | NOS 3.5 | 2

Contents
1: Nutanix Command-Line Interface.......................................................... 4

To Install the nCLI on Your Local System..........................................................................................4
To Initiate an nCLI Session From Your Local System....................................................................... 5
Command Format................................................................................................................................5
Embedded Help...................................................................................................................................6
2: Controller VM Commands...................................................................... 7
cluster.................................................................................................................................................. 7
diagnostics.py.................................................................................................................................... 16
genesis...............................................................................................................................................18
3: nCLI Reference......................................................................................23
alerts: Alert.................................................................................................................................... 23
authconfig: Authentication Configuration...................................................................................... 24
cluster: Cluster.............................................................................................................................. 26
container: Storage Container........................................................................................................ 33
datastore: Datastore...................................................................................................................... 37
disk: Physical Disk..........................................................................................................................38
host: Physical Host......................................................................................................................... 40
http-proxy: HTTP Proxy................................................................................................................43
managementserver: Management Server....................................................................................... 45
protection-domain: Protection domain.........................................................................................46
rackable-unit: Rackable unit........................................................................................................53
remote-site: Remote Site............................................................................................................. 53
servicecenter: Service Center......................................................................................................55
snapshot: Snapshot........................................................................................................................ 56
snmp: SNMP..................................................................................................................................... 58
storagepool: Storage Pool............................................................................................................ 61
storagetier: Storage Tier............................................................................................................. 63
user: User........................................................................................................................................64
vdisk: Virtual Disk...........................................................................................................................67
virtualmachine: Virtual Machine...................................................................................................69
vzone: vZone................................................................................................................................... 70
vstore: VStore................................................................................................................................ 72
3
1
Nutanix Command-Line Interface
The Nutanix command-line interface (nCLI) allows you to run system administration commands against the
Nutanix cluster from any of the following machines:
• Your local machine (preferred)
• Any Controller VM in the cluster
To Install the nCLI on Your Local System

Tip: Refer to Default Cluster Credentials on page 2 for the default credentials of all cluster
components.
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
http://www.java.com/en/download/installed.jsp.
2. Download the nCLI.
a. Connect to the Nutanix web console.
b.
Click the user icon at the top of the console.
c. Select Download nCLI.
d. Download and unzip the file on your local system.
3. Configure your Windows %PATH% or Linux $PATH environment variables.

• ncli directory (for example, C:\ncli)
• JRE bin directory (for example, C:\Program Files\Java\jre1.6.0_21\bin)
Nutanix Command-Line Interface | Command Reference Guide | NOS 3.5 | 4

The procedure to complete this step depends on your operating system. For more information, go to
http://java.com/en/download/help/path.xml.
To Initiate an nCLI Session From Your Local System

Before you begin. Install the nCLI on your local system by following To Install the nCLI on Your Local
System on page 4.
1. Open a command prompt.
2. Start the nCLI.

$ cd ncli_dir
$ ./ncli -s management_ip_addr -p 'admin_password'
• Replace ncli_dir with the directory where the nCLI is installed.

• Replace management_ip_addr with the IP address of any Nutanix Controller VM in the cluster.
• Replace admin_password with the password of the Nutanix admin user.
Troubleshooting
Error Explanation/Resolution
Error: Bad credentials The admin user password has been changed from the default and
you did not specify the correct password.
Type exit and start the nCLI again with the correct password.
Error: Could not connect to The cluster is not started.

Nutanix Gateway
Log on to a Controller VM as the nutanix user and run the following
command:
nutanix@cvm$ cluster start
When the cluster is up, exit the nCLI and start it again.
Results. The Nutanix CLI is now in interactive mode. To exit this mode, type exit at the ncli> prompt.
Command Format
Nutanix Command-Line Interface commands must match the following format:
ncli> entity action parameter1=value parameter2=value ...
entity can be replaced by any Nutanix entity, such as cluster or disk.

action can be replaced by any valid action for the preceding entity. Each entity has a unique set of actions,
but a common action across all entities is list. For example, you can type the following command to
request a list of all storage pools in the cluster.
ncli> storagepool list

Some actions require parameters at the end of the command. For example, when creating an NFS
datastore, you need to provide both the name of the datastore as it will appear to the hypervisor and the
name of the source container.
ncli> datastore create name="NTNX-NFS" ctr-name="nfs-ctr"
Parameter-value pairs can be listed in any order, as long as they are preceded by a valid entity and action.
Tip: To avoid syntax errors, surround all string values with double-quotes, as demonstrated in the
preceding example. This is particularly important when specifying parameters that accept a list of
values.
Embedded Help
The nCLI provides assistance on all entities and actions. By typing help at the command line, you can
request additional information at one of three levels of detail.
help
Provides a list of entities and their corresponding actions
entity help
Provides a list of all actions and parameters associated with the entity, as well as which parameters
are required, and which are optional
entity action help
Provides a list of all parameters associated with the action, as well as a description of each
parameter
The nCLI provides additional details at each level. To control the scope of the nCLI help output, add the
detailed parameter, which can be set to either true or false.
For example, type the following command to request a detailed list of all actions and parameters for the
cluster entity.
ncli> cluster help detailed=true
You can also type the following command if you prefer to see a list of parameters for the cluster edit-
params action without descriptions.
ncli> cluster edit-params help detailed=false

2
Controller VM Commands
cluster
Usage
Usage: /home/nutanix/cluster/bin/cluster [flags] [command]
commands:
add_public_key
create
destroy
disable_auto_install
enable_auto_install
ipconfig
migrate_zeus
reconfig
remove_all_public_keys
remove_public_key
restart_genesis
start
status
stop
upgrade
/home/nutanix/cluster/bin/cluster
--add_dependencies
Include Dependencies.
Default: false
--clean_debug_data
If 'clean_debug_data' is True, then when we destroy a cluster we will also remove the logs, binary
logs, cached packages, and core dumps on each node.
Default: false
--cluster_name
Name of the cluster (use with create).
--config
Path to the cluster configuration file.
--force
Force action.
Default: false
--force_install_proto
When upgrading from 3.* to 3.5, force installation of python protobuf libraries is required for rolling
upgrade.
Default: true
Controller VM Commands | Command Reference Guide | NOS 3.5 | 7

--genesis_path
Path to genesis command on SVMs.
Default: /home/nutanix/cluster/bin/genesis
--help
show this help
Default: 0
--helpshort
show usage only for this module
Default: 0
--helpxml
like --help, but generates XML output
Default: false
--installer_dir_path
Location of the Nutanix installer directory.
--ip_specification_json
JSON file with IP configuration.
--key_file
Nutanix default SSH public key.
Default: /home/nutanix/ssh_keys/nutanix.pub
--key_name
Identifier of the public ssh key in the cluster.
Default: default
--lockdown_mode
Flag for lockdown mode
Default: false
--migrate_from
The old zeus node IP address for Zeus migration.
--migrate_to
The new zeus node IP address for Zeus migration.
--num_nodes_to_upload
Number of nodes to upload the installer directory to.
Default: 2
--nutanix_packages_json_basename
Base file name of the JSON file that contains the list of packages to expect in the packages directory.
Default: nutanix-packages.json
--python_lib
Path where python eggs are stored.
Default: /home/nutanix/cluster/lib/py
--python_proto_egg_path
Path of protobuf egg relative to the install dir.
Default: lib/py/protobuf-2.5.0-py2.6.egg
--ssh_key
SSH key used for logging into SVM.

Default: /home/nutanix/.ssh/id_rsa
--svm_ips
Comma separated list of IP addresses of one or more SVMs in the target cluster. Not required if
cluster.cfg is being used.
--svm_login
User name for logging into SVM.
Default: nutanix
--timeout
Number of seconds each command to SVMs should take.
Default: 180
--wait
Wait for action to complete.
Default: true
--yes
Confirmation to destroy.
Default: false
cluster.consts
--factory_config_json_path
Path to the factory_config.json file.
Default: /etc/nutanix/factory_config.json
--hyperv_external_network_interface
Default name of the network device for Hyper-V's external network.
Default: TenGigTeam
--hyperv_hypervisor_username
The username to use when logging into the local Hyper-V node.
Default: Administrator
--hyperv_internal_network_interface
Default name of the network device for Hyper-V's internal network.
Default: InternalSwitch
--hypervisor_internal_ip
Internal IP address of the hypervisor.
Default: 192.168.5.1
--hypervisor_password
The password to use when logging into the local hypervisor.
Default: nutanix/4u
--hypervisor_username
The username to use when logging into the local hypervisor.
Default: root
--ipmi_password
The password to use when logging into the local IPMI device.
Default: ADMIN

--ipmi_username
The username to use when logging into the local IPMI device.
Default: ADMIN
--logpipe_path
Path to logpipe.
Default: /home/nutanix/cluster/bin/logpipe
--ntpd_driftfile_path
Path to the NTPD daemon's drift file.
Default: /var/lib/ntp/drift
--nutanix_bin_dir
Path to the nutanix bin folder.
Default: /home/nutanix/bin
--nutanix_binary_log_dir
Directory containing binary logs.
Default: /home/nutanix/data/binary_logs
--nutanix_core_dir
Directory containing core dumps of all Nutanix binaries.
Default: /home/nutanix/data/cores
--nutanix_data_dir
Path to the nutanix data folder.
Default: /home/nutanix/data
--nutanix_home
Nutanix home directory.
Default: /home/nutanix
--nutanix_lock_dir
Directory containing Nutanix service lock files.
Default: /home/nutanix/data/locks
--nutanix_log_dir
Directory containing logs.
Default: /home/nutanix/data/logs
--nutanix_private_key
Path to the private SSH key used to connect to SVMs the cluster.
Default: /home/nutanix/ssh_keys/nutanix
--nutanix_storage_dir
Nutanix storage directory
Default: /home/nutanix/data/stargate-storage/disks
--stargate_disk_config
JSON file on stargate disk holding disk config
Default: disk_config.json
--stargate_port
Port for Stargate
Default: 2009

--svm_non_ha_internal_ip
Internal IP address of SVM that is not redirected for HA.
Default: 192.168.5.254
--svm_os_version
The default version of SVM os
Default: centos
--svm_private_key
Path to the private SSH key used by SVM.
--toolchain_dir
Path to Nutanix toolchain.
Default: /home/nutanix/toolchain/x86_64-unknown-linux-gnu/1.6
--zeus_config_cache_path
Path to the zeus configuration cache kept in sync by Genesis.
Default: /home/nutanix/config/configuration_proto.dat
--zookeeper_host_port_list
Host port pair list for zookeeper.
Default: zk1:9876,zk2:9876,zk3:9876
cluster.genesis.client
--genesis_jsonrpc_url
URL of the JSON RPC handler on the Genesis HTTP server.
Default: /jsonrpc
--genesis_port
Port that Genesis listens on.
Default: 2100
--genesis_rpc_timeout_secs
Timeout for each Genesis RPC.
Default: 30
cluster.genesis.cluster_manager
--cluster_state_znode
Location in Zookeeper where we keep whether a node start or stop.
Default: /appliance/logical/genesis/cluster_state
--cluster_versions_znode
Location in Zookeeper where we keep the desired software versions map.
Default: /appliance/logical/genesis/cluster_versions
--force_disable_blackbox
File to disable blackbox mode completely.
Default: /home/nutanix/.force_disable_blackbox
--node_shutdown_token_state_znode
Location in Zookeeper where we keep state of which node has currently requested to go down for
maintenance.
Default: /appliance/logical/genesis/node_shutdown_token

--node_upgrade_status
Location in Zookeeper where we store upgrade status of nodes.
Default: /appliance/logical/genesis/node_upgrade_status
--nutanix_default_ssh_keys
Nutanix default SSH key used for logging into SVM.
--release_version_znode
Zookeeper node where we keep the current release version of the cluster.
Default: /appliance/logical/genesis/release_version
--services_to_be_started_znode
Encode the set of services to be started.
Default: /appliance/logical/genesis/services_started
cluster.genesis.migration_manager
--num_migration_commit_retries
Number of times to retry updating the zeus configuration with new zookeeper ensemble.
Default: 5
--num_migration_rpc_retries
Number of times to retry Rpcs to other nodes during zookeeper migration.
Default: 10
--tcpkill
Path to the tcpkill binary
Default: /usr/sbin/tcpkill
--zookeeper_migration_wal_path
Path to zookeeper write-ahead-log file where migration state is recorded.
Default: /home/nutanix/data/zookeeper_migration.wal
--zookeeper_session_check_time_secs
Number of seconds zookeeper takes to verify and disconnect zookeeper quorum ip addresses that
are no longer valid.
Default: 10
--zookeeper_tcpkill_timeout_secs
Number of seconds to let tpckill to disconnect the tcp connections of zookeeper ensemble member
that is to be removed.
Default: 10
cluster.genesis.node_manager
--auto_discovery_interval_secs
Number of seconds to sleep when local node can't join any discovered cluster.
Default: 5
--avahi_service_type
Avahi service type to publish under.
Default: _nutanix._tcp
--configure_iptables_with_stig
If True, then we will setup iptables to be STIG compliant.

Default: true
--default_ssh_keys
--dhcp_ntp_conf
dhcp ntp configuration file.
Default: /var/lib/ntp/ntp.conf.dhcp
--download_staging_area
Directory where we will download directories from other SVMs.
Default: /home/nutanix/tmp
--external_ntp_monitor_interval_secs
Number of seconds between each check of external NTP server.
Default: 600
--gold_image_version_path
Path to the file that contains the version of the gold image.
Default: /etc/nutanix/svm-version
--installer_dir
Path to the directory where the installer is contained.
Default: /home/nutanix/data/installer
--nagios_config_path
Path to the nagios configuration file.
Default: /home/nutanix/serviceability/config/nagios3/nutanix_nagios.cfg
--node_disable_auto_upgrade_marker
Path to marker file to indicate that automatic software upgrade should not be performed on this node.
Default: /home/nutanix/.node_disable_auto_upgrade
--node_reconfigure_marker
Path to marker file to indicate that this node should be reconfigured.
Default: /home/nutanix/.node_reconfigure
--node_ssh_key_dir
Path for node specific ssh keys on local disk
Default: /home/nutanix/ssh_keys/.blackbox
--node_unconfigure_marker
Path to marker file to indicate that node is ready to be unconfigured.
Default: /home/nutanix/.node_unconfigure
--ntp_config_path
The path to the configuration file for NTP.
Default: /etc/ntp.conf
--ntp_leader_znode
Zookeeper node containing the IP address of the current Zookeeper leader.
Default: /appliance/logical/genesis/ntp_leader
--ntpdate_timeout_secs
Time out to wait for ntp server to return a valid time.

Default: 10
--release_version_path
Path to the file that contains the local release version.
Default: /etc/nutanix/release_version
--rpm_genesis_log_file
Path to rpm log file during Genesis self install.
Default: /home/nutanix/data/logs/rpm.genesis.out
--service_vm_config_json_path
Path to the service_vm_config.json file.
Default: /home/nutanix/data/stargate-storage/service_vm_config.json
--svm_external_netif
External network interface of SVM to communicate with other SVMs.
Default: eth0
--svm_internal_ips
Internal IP addresses on eth1. The first one is the primary IP address, and the remaining are aliases.
Default: 192.168.5.2,192.168.5.254
--svm_internal_netif
Internal network interface of the SVM to communicate with local hypervisor.
Default: eth1
--svm_internal_netif_netmask
The netmask for the internal IP addresses on eth1.
Default: 255.255.255.128
--svm_non_ha_internal_netmask
The netmask for the non-data internal IP aliases on eth1.
Default: 255.255.255.0
--svm_reboot_required_marker
Marker file to indicate that SVM reboot is required and cluster services should not be started.
Default: /tmp/svm_reboot_required
--svm_reboot_suppressed_marker
Marker file to indicate that SVM reboot is currently suppressed.
Default: /tmp/svm_reboot_suppressed
--time_rollback_tolerance_secs
Maximum number of seconds by which NTP is allowed to roll back time on the system.
Default: 5
--zookeeper_start_timeout_secs
Timeout for waiting on Zookeeper connection on startup.
Default: 120
cluster.ipv4config
--esx_cmd_timeout_secs
Default timeout for running a remote command on an ESX host.
Default: 120

--esx_external_network_interface
Default name of the network device for ESX's external network.
Default: vmk0
--ipmi_apply_config_retries
Number of times to try applying an IPMI IPv4 configuration before failing.
Default: 6
--kvm_cmd_timeout_secs
Default timeout for running a remote command on an KVM host.
Default: 120
--kvm_external_network_interface
Default name of the network device for KVM's external network.
Default: br0
cluster.service.alert_manager_service
--alert_manager_data_dir
Path to the alert_manager data directory.
Default: /home/nutanix/data/alert_manager
--alert_manager_path
Path to the alert_manager binary.
Default: /home/nutanix/bin/alert_manager
--alert_manager_rss_mem_limit
Maximum amount of resident memory Alert Manager may use on an Svm with 8GB memory
configuration.
Default: 268435456
--alert_manager_virt_mem_limit
Maximum amount of virtual memory (in GB) Alert Manager may use on an Svm with 8GB memory
configuration.
Default: 1073741824
cluster.service.service_utils
--disk_inventory_path
The location to the file that contains the configurations for all of the supported disks.
Default: /home/nutanix/cluster/config/disk_inventory.cfg
--memory_limits_base_size_kb
Total memory size of the standard Svm based on which memory limits are derived.
Default: 8388608
--service_stop_wait
Wait time for how long we should wait before we start issuing SIGKILL instead of SIGTERM.
Default: 5
cluster.sshkeys_helper
--authorized_keys_file
Path to file containing list of permitted RSA keys
Default: /home/nutanix/.ssh/authorized_keys2

--id_rsa_path
--ssh_client_configuration
Location of ssh client configuration file.
Default: /home/nutanix/.ssh/config
--ssh_path
Location of ssh folder for nutanix.
Default: /home/nutanix/.ssh
diagnostics.py
Usage
Usage: /home/nutanix/diagnostics/diagnostics.py [command]
commands:
cleanup
list_runtime_test_args
run
/home/nutanix/diagnostics/diagnostics.py
--ctr_name
Name of the container to be created for the disks of the UVM
Default: NTNX-NFS-DEFAULT
--default_aggregator
Default script to aggregate results.
Default: fio_aggregator.py
--default_ncli_password
Default password for login into the ncli.
Default: admin
--default_ncli_user
Default username for login into the ncli.
Default: admin
--deprecated_ctr_name
Deprecated container name used by older versions of this script. This is used to cleanup any
container that may be left behind by the previous version.
Default: NTNX-diagnostics-ctr
--display_cassandra_latency_stats
Display cassandra latency stats for each test.
Default: true
--display_latency_stats
Display latency stats for each test (available in fio tests only).
Default: false

--dry_run
If True, only prints the tests it would have executed.
Default: false
--esx_diagnostics_image_path
Path to the diagnostics VM image for ESX.
Default: /home/nutanix/data/images/diagnostics/nutanix-diagnostics-1.0.ovf
--external_uvm_ips
IP addresses of external UVMs. If specified, the setup step is skipped and the tests are run on these
UVMs
--fingerprint_on_write
Whether to enable fingerprint on write on container.
Default: false
--flush_svm_caches
Whether to flush svm cache before each test.
Default: true
--hyperv_diagnostics_image_path
Path to the diagnostics VM image for Hyper-V.
Default: /home/nutanix/data/images/diagnostics/diagnostics_uvm.vhd.gz
--inline_compression
Whether to enable inline compression on container.
Default: false
--max_oplog_flush_wait_secs
Maximum time waiting for the oplogs to flush before running a test.
Default: 600
--nodes
Comma-separated list of nodes (IP addresses of the hosts) where the tests are run. If not specified,
tests are run on all nodes.
--results_dir_name
Name of the results directory. Leave empty for an automatically generated name.
--runtime_test_args
Comma-separated list of test arguments of the form key=value, to be passed to the test scripts. Use
'diagnostics.py list_test_args' for a list of supported test args.
--scripts_dir
Path to the directory where the uvm tool scripts reside
Default: /home/nutanix/diagnostics
--setup_only
Only setup the test UVMs without running any actual tests. This option is mutually exclusive with --
skip_setup.
Default: false
--skip_setup
Skip setting up the UVMs. Useful when the setup has already been performed by a previous run. This
option is mutually exclusive with --setup_only.
Default: false

--skip_ssd_pcie_check
Skip the check which ensures that disks exist in the SSD-PCIe tier.
Default: false
--sp_name
Name of the storage pool to be created for the disks of the UVM
Default: NTNX-SP-DEFAULT
--terse
Terse output - just prints the test name and the BW/IOPs as applicable. Note that any pre-req cluster/
uvm setup logs are still emitted.
Default: false
--test_groups
Comma-separated list of test groups to run. If not specified, the 'default' test group is run (unless --
tests is specified).
Default: default
--tests
Comma-separated list of tests to run. If not specified, all tests in the specified test groups are run.
--tunnels_start_port
Starting port for setting up tunnels to the UVMs
Default: 17000
--uvm_identity_file
SSH identity file of the diagnostics VM
Default: diagnostics_id_rsa
--uvm_ip
IP address of the UVM
Default: 192.168.5.253
--uvm_name_prefix
Common prefix of the names of the UVMs
Default: NTNX_diagnostics
--verbose
If True, print verbose information to stdout.
Default: false
genesis
Usage
Usage: /home/nutanix/cluster/bin/genesis start [all|<service_name>]|stop [all|
<service_name>]|restart|status
/home/nutanix/cluster/bin/genesis
--foreground
Run Genesis in foreground.
Default: false

--genesis_self_monitoring
Genesis to do self monitoring.
Default: true
--help
show this help
Default: 0
--helpshort
show usage only for this module
Default: 0
--helpxml
like --help, but generates XML output
Default: false
cluster.genesis.client
--genesis_jsonrpc_url
URL of the JSON RPC handler on the Genesis HTTP server.
Default: /jsonrpc
--genesis_port
Port that Genesis listens on.
Default: 2100
--genesis_rpc_timeout_secs
Timeout for each Genesis RPC.
Default: 30
cluster.genesis.cluster_manager
--cluster_state_znode
Location in Zookeeper where we keep whether a node start or stop.
Default: /appliance/logical/genesis/cluster_state
--cluster_versions_znode
Location in Zookeeper where we keep the desired software versions map.
Default: /appliance/logical/genesis/cluster_versions
--force_disable_blackbox
File to disable blackbox mode completely.
Default: /home/nutanix/.force_disable_blackbox
--node_shutdown_token_state_znode
Location in Zookeeper where we keep state of which node has currently requested to go down for
maintenance.
Default: /appliance/logical/genesis/node_shutdown_token
--node_upgrade_status
Location in Zookeeper where we store upgrade status of nodes.
Default: /appliance/logical/genesis/node_upgrade_status
--nutanix_default_ssh_keys

--release_version_znode
Zookeeper node where we keep the current release version of the cluster.
Default: /appliance/logical/genesis/release_version
--services_to_be_started_znode
Encode the set of services to be started.
Default: /appliance/logical/genesis/services_started
cluster.genesis.migration_manager
--num_migration_commit_retries
Number of times to retry updating the zeus configuration with new zookeeper ensemble.
Default: 5
--num_migration_rpc_retries
Number of times to retry Rpcs to other nodes during zookeeper migration.
Default: 10
--tcpkill
Path to the tcpkill binary
Default: /usr/sbin/tcpkill
--zookeeper_migration_wal_path
Path to zookeeper write-ahead-log file where migration state is recorded.
Default: /home/nutanix/data/zookeeper_migration.wal
--zookeeper_session_check_time_secs
Number of seconds zookeeper takes to verify and disconnect zookeeper quorum ip addresses that
are no longer valid.
Default: 10
--zookeeper_tcpkill_timeout_secs
Number of seconds to let tpckill to disconnect the tcp connections of zookeeper ensemble member
that is to be removed.
Default: 10
cluster.genesis.node_manager
--auto_discovery_interval_secs
Number of seconds to sleep when local node can't join any discovered cluster.
Default: 5
--avahi_service_type
Avahi service type to publish under.
Default: _nutanix._tcp
--configure_iptables_with_stig
If True, then we will setup iptables to be STIG compliant.
Default: true
--default_ssh_keys
--dhcp_ntp_conf
dhcp ntp configuration file.

Default: /var/lib/ntp/ntp.conf.dhcp
--download_staging_area
Directory where we will download directories from other SVMs.
Default: /home/nutanix/tmp
--external_ntp_monitor_interval_secs
Number of seconds between each check of external NTP server.
Default: 600
--gold_image_version_path
Path to the file that contains the version of the gold image.
Default: /etc/nutanix/svm-version
--installer_dir
Path to the directory where the installer is contained.
Default: /home/nutanix/data/installer
--nagios_config_path
Path to the nagios configuration file.
Default: /home/nutanix/serviceability/config/nagios3/nutanix_nagios.cfg
--node_disable_auto_upgrade_marker
Path to marker file to indicate that automatic software upgrade should not be performed on this node.
Default: /home/nutanix/.node_disable_auto_upgrade
--node_reconfigure_marker
Path to marker file to indicate that this node should be reconfigured.
Default: /home/nutanix/.node_reconfigure
--node_ssh_key_dir
Path for node specific ssh keys on local disk
Default: /home/nutanix/ssh_keys/.blackbox
--node_unconfigure_marker
Path to marker file to indicate that node is ready to be unconfigured.
Default: /home/nutanix/.node_unconfigure
--ntp_config_path
The path to the configuration file for NTP.
Default: /etc/ntp.conf
--ntp_leader_znode
Zookeeper node containing the IP address of the current Zookeeper leader.
Default: /appliance/logical/genesis/ntp_leader
--ntpdate_timeout_secs
Time out to wait for ntp server to return a valid time.
Default: 10
--release_version_path
Path to the file that contains the local release version.
Default: /etc/nutanix/release_version
--rpm_genesis_log_file
Path to rpm log file during Genesis self install.

Default: /home/nutanix/data/logs/rpm.genesis.out
--service_vm_config_json_path
Path to the service_vm_config.json file.
Default: /home/nutanix/data/stargate-storage/service_vm_config.json
--svm_external_netif
External network interface of SVM to communicate with other SVMs.
Default: eth0
--svm_internal_ips
Internal IP addresses on eth1. The first one is the primary IP address, and the remaining are aliases.
Default: 192.168.5.2,192.168.5.254
--svm_internal_netif
Internal network interface of the SVM to communicate with local hypervisor.
Default: eth1
--svm_internal_netif_netmask
The netmask for the internal IP addresses on eth1.
Default: 255.255.255.128
--svm_non_ha_internal_netmask
The netmask for the non-data internal IP aliases on eth1.
Default: 255.255.255.0
--svm_reboot_required_marker
Marker file to indicate that SVM reboot is required and cluster services should not be started.
Default: /tmp/svm_reboot_required
--svm_reboot_suppressed_marker
Marker file to indicate that SVM reboot is currently suppressed.
Default: /tmp/svm_reboot_suppressed
--time_rollback_tolerance_secs
Maximum number of seconds by which NTP is allowed to roll back time on the system.
Default: 5
--zookeeper_start_timeout_secs
Timeout for waiting on Zookeeper connection on startup.
Default: 120
cluster.genesis.server
--genesis_document_root
Document root where static files are served from.
Default: /home/nutanix/cluster/www

3
nCLI Reference
alerts: Alert
Description An Alert
Alias alert
Operations • acknowledge | ack

• history
• list | ls
• resolve
Acknowledge Alerts
ncli> alerts { acknowledge | ack } ids
Required arguments
ids
A comma-separated list of ids of the Alerts
List history of Alerts

ncli> alerts history duration { acknowledged } { resolved } { max-alerts }
Required arguments
duration
Duration (in days) for getting the history of Alerts
Optional arguments
acknowledged
Include acknowledged Alerts?
Default: true
resolved
Include resolved Alerts?
Default: true
max-alerts
Maximum number of Alerts to fetch
Default: 100
List Alerts
ncli> alerts { list | ls } { acknowledged } { max-alerts }
Required arguments
None
nCLI Reference | Command Reference Guide | NOS 3.5 | 23

Optional arguments
acknowledged
Include acknowledged Alerts?
Default: true
max-alerts
Maximum number of Alerts to fetch
Default: 100
Resolve Alerts
ncli> alerts resolve ids
Required arguments
ids
A comma-separated list of ids of the Alerts
authconfig: Authentication Configuration

Description Configuration information used to authenticate user
Alias None
Operations • create-directory | add-directory

• edit | update
• edit-directory | update-directory
• list | ls
• list-directory | ls-directory
• remove | rm
• remove-directory | rm-directory
Create Directory Service Configuration

ncli> authconfig { create-directory | add-directory } name url domain { type } {
connection-type }
Required arguments
name
Name of the Directory Service
url
Url to connect to the Directory Service
domain
Domain of the Directory Service
Optional arguments
type
Type of the Directory Service
connection-type
Connection type for the Directory Service
Update Authentication Configuration

ncli> authconfig { edit | update } { type } { enable-client-auth }

Required arguments
None
Optional arguments
type
Comma-separated list of authentication types
enable-client-auth
Indication for the server to ask for client certificate
Update Directory Service Configuration

ncli> authconfig { edit-directory | update-directory } name { type } { connection-type
} { url } { domain }
Required arguments
name
Optional arguments
type
Type of the Directory Service
connection-type
Connection type for the Directory Service
url
Url to connect to the Directory Service
domain
Domain of the Directory Service
List Authentication Configuration

ncli> authconfig { list | ls }
Required arguments
None
List Authentication Configuration

ncli> authconfig { list-directory | ls-directory } { name }
Required arguments
None
Optional arguments
name
Remove Authentication Configuration

ncli> authconfig { remove | rm }
Required arguments
None
Remove Directory Service Configuration

ncli> authconfig { remove-directory | rm-directory } name

Required arguments
name
cluster: Cluster
Description A Nutanix Complete Cluster
Alias None
Operations • add-node
• add-public-key
• add-to-email-contacts
• add-to-name-servers
• add-to-nfs-whitelist
• add-to-ntp-servers
• clear-smtp-server
• configure-node
• discover-nodes
• edit-params | edit-info
• execute-command | exec-cmd
• get-email-alerts-status
• get-email-contacts
• get-name-servers
• get-nfs-whitelist
• get-ntp-servers
• get-params | info
• get-remote-support-status
• get-remove-status | get-rm-status
• get-send-stats-params
• get-smtp-server
• list-public-keys | ls-public-keys
• remove-all-public-keys | rm-all-public-keys
• remove-finish | rm-finish
• remove-from-email-contacts
• remove-from-name-servers
• remove-from-nfs-whitelist
• remove-from-ntp-servers
• remove-public-key | rm-public-key
• remove-start | rm-start delete
• send-test-email
• set-send-stats-params
• set-smtp-server
• start
• start-email-alerts
• start-remote-support
• status
• stop
• stop-email-alerts

• stop-remote-support
• version
Add the configured node to the cluster

ncli> cluster add-node node-uuid
Required arguments
node-uuid
UUID of the new node
Add public key to the cluster

ncli> cluster add-public-key name file-path
Required arguments
name
Name of the cluster public key
file-path
Full path of the public key file
Add email addresses to the list of email alert contacts

ncli> cluster add-to-email-contacts email-addresses
Required arguments
email-addresses
Comma-separated list of email addresses to be included in the email alert contact list
Add addresses to the list of name servers

ncli> cluster add-to-name-servers servers
Required arguments
servers
Comma-separated list of IP addresses/Host names to be included in the name servers list
Add addresses to the list of NFS subnet whitelist

ncli> cluster add-to-nfs-whitelist ip-subnet-masks
Required arguments
ip-subnet-masks
Comma-separated list with entries of the form 'IP/subnet mask'(a.b.c.d/l.m.n.o) to be included in
the NFS subnet whitelist
Add addresses to the list of NTP servers

ncli> cluster add-to-ntp-servers servers
Required arguments
servers
Comma-separated list of IP addresses/Host names to be included in the NTP servers list
Clear configuration of SMTP Server used for transmitting alerts and report emails to Nutanix support
ncli> cluster clear-smtp-server
Required arguments
None

Configure discovered node with IP addresses (Hypervisor, CVM and IPMI addresses)
ncli> cluster configure-node node-uuid { cvm-ip } { hypervisor-ip } { ipmi-ip } { ipmi-
netmask } { ipmi-gateway }
Required arguments
node-uuid
Optional arguments
cvm-ip
IP address of the controller VM
hypervisor-ip
IP address of the Hypervisor Host
ipmi-ip
IPMI address of the node
ipmi-netmask
IPMI netmask of the node
ipmi-gateway
IPMI gateway of the node
Discover new nodes available to add to the cluster

ncli> cluster discover-nodes
Required arguments
None
Edit params of a Cluster

ncli> cluster { edit-params | edit-info } { new-name } { support-verbosity-level }
Required arguments
None
Optional arguments
new-name
Name of the cluster
support-verbosity-level
Verbosity level settings for populating support information
Execute the specified command in the cluster

ncli> cluster { execute-command | exec-cmd } name { args } { timeout }
Required arguments
name
Name of the command to execute in the cluster
Optional arguments
args
Arguments to be passed to the command
timeout
Command execution timeout (secs)
Default: 0

Get email alerts status on a Cluster
ncli> cluster get-email-alerts-status
Required arguments
None
Get the list of email alert contacts

ncli> cluster get-email-contacts
Required arguments
None
Get the list of name servers

ncli> cluster get-name-servers
Required arguments
None
Get the list of NFS subnet whitelist

ncli> cluster get-nfs-whitelist
Required arguments
None
Get the list of NTP servers

ncli> cluster get-ntp-servers
Required arguments
None
Get params of a Cluster

ncli> cluster { get-params | info }
Required arguments
None
Get remote support status on a Cluster

ncli> cluster get-remote-support-status
Required arguments
None
Check the removal status for Physical Hosts

ncli> cluster { get-remove-status | get-rm-status } { id }
Required arguments
None
Optional arguments
id
ID of the Physical Host
Get Configuration parameters for sending stats to Nutanix home for offsite analytics
ncli> cluster get-send-stats-params

Required arguments
None
Get configuration of SMTP Server used for transmitting alerts and report emails to Nutanix support
ncli> cluster get-smtp-server
Required arguments
None
Get the list of public keys configured in the cluster

ncli> cluster { list-public-keys | ls-public-keys } { name }
Required arguments
None
Optional arguments
name
Remove all the public keys previously configured in the cluster

ncli> cluster { remove-all-public-keys | rm-all-public-keys }
Required arguments
None
Finish the process of removing a Physical Host

ncli> cluster { remove-finish | rm-finish } id
Required arguments
id
Remove email addresses from the list of email alert contacts

ncli> cluster remove-from-email-contacts email-addresses
Required arguments
email-addresses
Comma-separated list of email addresses to be removed from the email alert contact list
Remove addresses from the list of name servers

ncli> cluster remove-from-name-servers servers
Required arguments
servers
Comma-separated list of IP addresses/Host names to be removed from the name servers list
Remove addresses from the list of NFS subnet whitelist

ncli> cluster remove-from-nfs-whitelist ip-subnet-masks
Required arguments
ip-subnet-masks
Comma-separated list with entries of the form 'IP/subnet mask' (a.b.c.d/l.m.n.o) to be removed
from the NFS subnet whitelist

Remove addresses from the list of NTP servers
ncli> cluster remove-from-ntp-servers servers
Required arguments
servers
Comma-separated list of IP addresses/Host names to be removed from the NTP servers list
Delete public key with the specified name from the cluster
ncli> cluster { remove-public-key | rm-public-key } name
Required arguments
name
Begin the process of removing a Physical Host

ncli> cluster { remove-start | rm-start delete } id { skip-space-check }
Required arguments
id
Optional arguments
skip-space-check
Skip checking storage space-related constraints when initiating removal of a host from the
cluster
Default: false
Send an email to test the SMTP Server configuration

ncli> cluster send-test-email recipient subject
Required arguments
recipient
Recipient of the test email
subject
Subject of the test email
Configure parameters for sending stats to Nutanix home for offsite analytics
ncli> cluster set-send-stats-params { enable } { interval }
Required arguments
None
Optional arguments
enable
Whether to enable sending of stats to Nutanix Home for offsite analytics
interval
Interval in minutes at which stats are sent to Nutanix home for offsite analytics
Set configuration of SMTP Server used for transmitting alert and report emails to Nutanix support
ncli> cluster set-smtp-server address { port } { username } { password } { security-mode
}

Required arguments
address
Fully Qualified Domain Name(FQDN) or IPv4 address of the SMTP Server
Optional arguments
port
Port number of the SMTP Server. By default, port 25 is used
username
Username to access the SMTP Server
password
Password to access the SMTP Server
security-mode
Security mode used by SMTP Server for data encryption and authentication. SMTP Server in
Nutanix cluster can be configured with one of the following mode: 'none', 'ssl' or 'starttls'
Default: none
Start all services in the cluster

ncli> cluster start
Required arguments
None
Start email alerts on a Cluster

ncli> cluster start-email-alerts { duration }
Required arguments
None
Optional arguments
duration
Time (in minutes) to keep email alerts enabled
Default: 0
Start remote support on a Cluster

ncli> cluster start-remote-support { duration }
Required arguments
None
Optional arguments
duration
Time (in minutes) to keep remote support enabled
Default: 0
Get the status of all services in the cluster

ncli> cluster status
Required arguments
None
Stop all services in the cluster

ncli> cluster stop
Required arguments
None
Stop email alerts on a Cluster

ncli> cluster stop-email-alerts { duration }
Required arguments
None
Optional arguments
duration
Time (in minutes) to keep email alerts disabled
Default: 0
Stop remote support on a Cluster

ncli> cluster stop-remote-support { duration }
Required arguments
None
Optional arguments
duration
Time (in minutes) to keep remote support disabled
Default: 0
Get version of software running on a Cluster

ncli> cluster version
Required arguments
None
container: Storage Container

Description A Storage Container is a container for virtual disks
Alias ctr
Operations • add-to-nfs-whitelist
• create | add
• edit | update
• get-down-migrate-times | get-dm-times
• list | ls
• list-stats | ls-stats
• remove | rm
• remove-from-nfs-whitelist
• set-down-migrate-times | set-dm-times
Add addresses to Storage Container's NFS subnet whitelist

ncli> container add-to-nfs-whitelist ip-subnet-masks { id } { name }

Required arguments
ip-subnet-masks
the Storage Container's NFS subnet whitelist
Optional arguments
id
ID of the Storage Container
name
Name of the Storage Container
Create a new Storage Container

ncli> container { create | add } name { res-capacity } { sp-id } { sp-name } { random-
io-priority-order } { sequential-io-priority-order } { enable-oplog-ha } { enable-
compression } { fingerprint-on-write } { compression-delay } { ip-subnet-masks }
Required arguments
name
Optional arguments
res-capacity
Explicit reserved Capacity (GB) of the Storage Container
sp-id
ID of the Storage Pool for the Storage Container
sp-name
Name of the Storage Pool for the Storage Container
random-io-priority-order
Comma seperated random I/O priority order (high to low) of Storage Tiers in a Storage
Container
sequential-io-priority-order
Comma seperated sequential I/O priority order (high to low) of Storage Tiers in a Storage
Container
enable-oplog-ha
Enable high-availability of the oplog (through replication) for a Storage Container?
Default: true
enable-compression
Enable or disable compression on a Storage Container {true, false}
Default: false
fingerprint-on-write
Fingerprint on writes to the Storage Container {on, off, none}
compression-delay
Time delay in minutes for compressing/uncompressing the data on Storage Container
ip-subnet-masks
Edit a Storage Container

ncli> container { edit | update } { id } { name } { new-name } { res-capacity } {
random-io-priority-order } { sequential-io-priority-order } { enable-oplog-ha } {
enable-compression } { compression-delay } { fingerprint-on-write } { ip-subnet-masks }
Required arguments
None
Optional arguments
id
name
new-name
res-capacity
Explicit reserved Capacity (GB) of the Storage Container
Comma seperated random I/O priority order (high to low) of Storage Tiers in a Storage
Container
Comma seperated sequential I/O priority order (high to low) of Storage Tiers in a Storage
Container
enable-oplog-ha
Enable high-availability of the oplog (through replication) for a Storage Container?
enable-compression
Enable or disable compression on a Storage Container {true, false}
compression-delay
Time delay in minutes for compressing/uncompressing the data on Storage Container
Fingerprint on writes to the Storage Container {on, off, none}
ip-subnet-masks
Get the down-migrate times (in minutes) for Storage Tiers in a Storage Container
ncli> container { get-down-migrate-times | get-dm-times } { id } { name }
Required arguments
None
Optional arguments
id
name
List Storage Containers

ncli> container { list | ls } { id } { name }

Required arguments
None
Optional arguments
id
name
Get stats data for Storage Containers

ncli> container { list-stats | ls-stats } { id } { name }
Required arguments
None
Optional arguments
id
name
Delete a Storage Container

ncli> container { remove | rm } { id } { name } { ignore-small-files }
Required arguments
None
Optional arguments
id
name
ignore-small-files
Ignores all the small files on the Storage Container {true, false} while marking for removal
Default: false
Remove addresses from Storage Container's NFS subnet whitelist

ncli> container remove-from-nfs-whitelist ip-subnet-masks { id } { name }
Required arguments
ip-subnet-masks
Optional arguments
id
name
Set the down-migrate times (in minutes) for a Storage Tier in a Storage Container

ncli> container { set-down-migrate-times | set-dm-times } tier-names { id } { name } {
time-in-min }
Required arguments
tier-names
A comma-separated list of Storage Tiers
Optional arguments
id
name
time-in-min
Time in minutes after which to down-migrate data in a given Storage Tier in a Storage Container
Default: 30
datastore: Datastore
Description An NFS Datastore
Alias None
Operations • create | add

• delete | remove rm
• list | ls
Create a new NFS datastore on the Physical Hosts using the Storage Container (ESX only)
ncli> datastore { create | add } name ctr-name { host-ids } { read-only }
Required arguments
name
Name of the Datastore
ctr-name
Optional arguments
host-ids
A comma-separated list of the ids of the Physical Hosts (default = Includes all hosts)
read-only
Whether a Physical Host must have only read-only access to the Datastore
Default: false
Delete the NFS datastore on the Physical Hosts

ncli> datastore { delete | remove rm } name { host-ids }
Required arguments
name
Name of the Datastore

Optional arguments
host-ids
A comma-separated list of the ids of the Physical Hosts (default = Includes all hosts)
List NFS Datastores

ncli> datastore { list | ls }
Required arguments
None
disk: Physical Disk

Description A Physical Disk
Alias None
Operations • edit | update

• list | ls
• list-free | ls-free
• mark-online
• remove-cancel | rm-cancel
Edit a Physical Disk

ncli> disk { edit | update } id { tier-name }
Required arguments
id
ID of the Physical Disk
Optional arguments
tier-name
Corresponding Storage Tier
Check the removal status for Physical Disks

ncli> disk { get-remove-status | get-rm-status } { id }
Required arguments
None
Optional arguments
id
List Physical Disks

ncli> disk { list | ls } { id } { sp-id } { sp-name } { tier-name }
Required arguments
None

Optional arguments
id
sp-id
ID of the Storage Pool for the Physical Disk
sp-name
Name of the Storage Pool for the Physical Disk
tier-name
List Physical Disks that are not assigned to any Storage Pool
ncli> disk { list-free | ls-free }
Required arguments
None
Get stats data for Physical Disks

ncli> disk { list-stats | ls-stats } { id } { sp-id } { tier-name }
Required arguments
None
Optional arguments
id
sp-id
ID of the Storage Pool for the Physical Disk
tier-name
Mark a Physical Disk online

ncli> disk mark-online id
Required arguments
id
Cancel the process of removing a Physical Disk

ncli> disk { remove-cancel | rm-cancel } id
Required arguments
id
Complete the process of removing a Physical Disk

ncli> disk { remove-finish | rm-finish } id
Required arguments
id
Begin the process of removing a Physical Disk

ncli> disk { remove-start | rm-start delete } id { force }
Required arguments
id
Optional arguments
force
Forcefully perform the requested operation skipping any constraint validation
Default: false
host: Physical Host

Description A Physical Host hosts Virtual Machines
Alias None
Operations • add-hacluster
• add-host-to-ha-cluster
• add-node
• configure-node
• discover-nodes
• edit | update
• enable-metadata-store
• list | ls
• list-hadatacenters | ls-hadatacenters
• set-monitoring
Create a new HACluster

ncli> host add-hacluster ms-name datacenter-name cluster-name
Required arguments
ms-name
Name of the Management Server
datacenter-name
Name of an HADatacenter
cluster-name
Name of an HACluster
Add host to anHACluster

ncli> host add-host-to-ha-cluster ms-name datacenter-name cluster-name host-address
host-username host-password
Required arguments
ms-name

datacenter-name
cluster-name
Name of an HACluster
host-address
IP address of a Physical Host
host-username
Username of the Hypervisor
host-password
Password of the Hypervisor
Add the configured node to the cluster

ncli> host add-node node-uuid
Required arguments
node-uuid
Configure discovered node with IP addresses (Hypervisor, CVM and IPMI addresses)
ncli> host configure-node node-uuid { cvm-ip } { hypervisor-ip } { ipmi-ip } { ipmi-
netmask } { ipmi-gateway }
Required arguments
node-uuid
Optional arguments
cvm-ip
IP address of the controller VM
hypervisor-ip
IP address of the Hypervisor Host
ipmi-ip
IPMI address of the node
ipmi-netmask
IPMI netmask of the node
ipmi-gateway
IPMI gateway of the node
Discover new nodes available to add to the cluster

ncli> host discover-nodes
Required arguments
None
Edit Physical Host

ncli> host { edit | update } id { hypervisor-username } { hypervisor-password } { new-
ms-name } { oplog-disk-pct } { ipmi-username } { ipmi-password }
Required arguments
id

Optional arguments
hypervisor-username
Username to access the Hypervisor Host
hypervisor-password
Password to access the Hypervisor Host
new-ms-name
oplog-disk-pct
The percentage of the oplog-disk to use for oplog data
ipmi-username
Username for IPMI access to a Physical Host
ipmi-password
Password for IPMI access to a Physical Host
Enable metadata store on a Physical Host

ncli> host enable-metadata-store id
Required arguments
id
Check the removal status for Physical Hosts

ncli> host { get-remove-status | get-rm-status } { id }
Required arguments
None
Optional arguments
id
List Physical Hosts

ncli> host { list | ls } { id }
Required arguments
None
Optional arguments
id
List HADatacenter(s)
ncli> host { list-hadatacenters | ls-hadatacenters } ms-name { datacenter-name }
Required arguments
ms-name
Optional arguments
datacenter-name

Get stats data for Physical Host
ncli> host { list-stats | ls-stats } { id }
Required arguments
None
Optional arguments
id
Finish the process of removing a Physical Host

ncli> host { remove-finish | rm-finish } id
Required arguments
id
Begin the process of removing a Physical Host

ncli> host { remove-start | rm-start delete } id { skip-space-check }
Required arguments
id
Optional arguments
skip-space-check
Skip checking storage space-related constraints when initiating removal of a host from the
cluster
Default: false
Set the monitoring status of Physical Hosts

ncli> host set-monitoring enabled ids
Required arguments
enabled
Enable monitoring of Physical Hosts?
ids
A comma-separated list of the ids of the Physical Hosts
http-proxy: HTTP Proxy

Description An HTTP Proxy
Alias proxy
Operations • add
• edit | update
• list | ls
• remove | rm
Create a new HTTP Proxy

ncli> http-proxy add name ip-address port { username } { password }

Required arguments
name
Name of the HTTP Proxy
ip-address
IP Address of the HTTP Proxy
port
Port number of the HTTP Proxy
Optional arguments
username
Username to access the HTTP Proxy
password
Password to access the HTTP Proxy
Edit an HTTP Proxy

ncli> http-proxy { edit | update } name { ip-address } { username } { password } { port
}
Required arguments
name
Optional arguments
ip-address
IP Address of the HTTP Proxy
username
Username to access the HTTP Proxy
password
Password to access the HTTP Proxy
port
Port number of the HTTP Proxy
List HTTP Proxies

ncli> http-proxy { list | ls } { name }
Required arguments
None
Optional arguments
name
Remove an HTTP Proxy

ncli> http-proxy { remove | rm } { name }
Required arguments
None
Optional arguments
name

managementserver: Management Server
Description An infrastructure management server such as
VCenter
Alias ms
Operations • add
• edit | update
• list | ls
• list-types | ls-types
• remove | rm
• rename
Add a new Management Server

ncli> managementserver add name url username password
Required arguments
name
url
Access URL of the Management Server
username
Username for access to the Management Server
password
Password for access to the Management Server
Add a new Management Server

ncli> managementserver { edit | update } name { url } { username } { password }
Required arguments
name
Optional arguments
url
Access URL of the Management Server
username
Username for access to the Management Server
password
Password for access to the Management Server
List Management Servers

ncli> managementserver { list | ls } { name }
Required arguments
None

Optional arguments
name
List Management Servers

ncli> managementserver { list-types | ls-types }
Required arguments
None
Delete a Management Server

ncli> managementserver { remove | rm } name
Required arguments
name
Rename a Management Server

ncli> managementserver rename name new-name
Required arguments
name
new-name
New name of the Management Server
protection-domain: Protection domain

Description A protection domain to be used for disaster
recovery and backups
Alias pd
Operations • abort-replication | abort-repl

• activate
• add-one-time-snapshot | create-one-time-
snapshot
• create | add
• deactivate
• list | ls
• list-replication-status | ls-repl-status
• list-snapshots | ls-snaps
• ls-pending-actions
• ls-pending-one-time-snapshots
• ls-schedule | ls-sched
• migrate
• pause-replication | pause-repl
• protect
• remove | rm
• resume-replication | resume-repl
• retain-snapshot | retain-snap

• rm-one-time-schedules
• rm-schedule
• rm-snapshot | rm-snap
• rollback-nfs-files
• rollback-pd
• rollback-vms
• set-schedule
• unprotect
Abort replications of a Protection domain

ncli> protection-domain { abort-replication | abort-repl } name replication-ids
Required arguments
name
Name of the Protection domain
replication-ids
List of comma-separated identifier of replications
Mark Protection domain as active

ncli> protection-domain activate name { snap-id }
Required arguments
name
Optional arguments
snap-id
Id of the Snapshot to be restored while making Protection domain as active. By default, latest
snapshot is restored.
Create a new out of band snapshot schedule in a Protection domain to take a snapshot at a specified time
ncli> protection-domain { add-one-time-snapshot | create-one-time-snapshot } name {
snap-time } { remote-sites } { retention-time }
Required arguments
name
Optional arguments
snap-time
Specify time in format MM/dd/yyyy [HH:mm:ss [z]] at which snapshot is to be taken. If not
specified, snapshot will be taken immediately
remote-sites
Comma-separated list of Remote Site to which snapshots are replicated. If not specified, remote
replication is not performed
retention-time
Number of seconds to retain the snapshot. Aged snapshots will be garbage collected. By
default, snapshot is retained forever
Create a new active Protection domain

ncli> protection-domain { create | add } name

Required arguments
name
Mark Protection domain as inactive

ncli> protection-domain deactivate name
Required arguments
name
List all Protection domains

ncli> protection-domain { list | ls } { name }
Required arguments
None
Optional arguments
name
Get the status of replication in a Protection domain

ncli> protection-domain { list-replication-status | ls-repl-status } { name }
Required arguments
None
Optional arguments
name
List Snapshots of a Protection domain

ncli> protection-domain { list-snapshots | ls-snaps } { name } { snap-id }
Required arguments
None
Optional arguments
name
snap-id
Id of the Snapshot
List all pending actions for Protection domains

ncli> protection-domain ls-pending-actions { name }
Required arguments
None
Optional arguments
name
List out of band snapshot schedules of Protection domains

ncli> protection-domain ls-pending-one-time-snapshots { name }
Required arguments
None
Optional arguments
name
Get periodic snapshot schedule of Protection domains

ncli> protection-domain { ls-schedule | ls-sched } { name }
Required arguments
None
Optional arguments
name
Mark Protection domain as inactive and failover to the specified Remote Site
ncli> protection-domain migrate name remote-site
Required arguments
name
remote-site
Remote Site to be used for planned failover
Pause replications of a Protection domain

ncli> protection-domain { pause-replication | pause-repl } name replication-ids
Required arguments
name
replication-ids
Add Virtual Machines and NFS files to a Protection domain

ncli> protection-domain protect name { vm-names } { ctr-id } { host-id } { files } { cg-
name } { ignore-duplicates }
Required arguments
name
Optional arguments
vm-names
Comma-separated list of Virtual Machine names to be added in Protection domain
ctr-id
Add all Virtual Machines in a Storage Container to a Protection domain
host-id
Add all Virtual Machines in a Physical Host to a Protection domain

files
Comma-separated list of NFS files to be added in Protection domain
cg-name
Name of the Consistency group to which Virtual Machines are added. If not specified, each
Virtual Machines is added to a Consistency group which has same name as the Virtual Machine
name
ignore-duplicates
Whether to ignore if any of the specified Virtual Machines already exist in the specified
Protection domain
Default: true
Mark a Protection domain for removal. Protection domain will be removed from the appliance when all
outstanding operations on it are cancelled
ncli> protection-domain { remove | rm } name
Required arguments
name
Resume previously paused replications of a Protection domain

ncli> protection-domain { resume-replication | resume-repl } name replication-ids
Required arguments
name
replication-ids
Retain snaphots forever of a Protection domain

ncli> protection-domain { retain-snapshot | retain-snap } name snap-ids
Required arguments
name
snap-ids
List of comma-separated identifier of Snapshots
Remove out of band snapshot schedules from a Protection domain

ncli> protection-domain rm-one-time-schedules name schedule-ids
Required arguments
name
schedule-ids
List of comma-separated identifier of Out of band schedules
Set the periodic snapshot schedule of a Protection domain

ncli> protection-domain rm-schedule name
Required arguments
name

Remove snaphots of a Protection domain
ncli> protection-domain { rm-snapshot | rm-snap } name snap-ids
Required arguments
name
snap-ids
List of comma-separated identifier of Snapshots
Rollback NFS files to a Snapshot

ncli> protection-domain rollback-nfs-files name files snap-id { replace-nfs-files } {
path-prefix }
Required arguments
name
files
Comma-separated list of NFS files to be restored
snap-id
Id of the Snapshot to be used for rollback
Optional arguments
replace-nfs-files
Whether the restored NFS files replace their corresponding live NFS files. If set to false, then
the parameter path-prefix must be specified
Default: false
path-prefix
The path prefix that apply to the restored file paths. For example, if restoring file '/ctr/dir/file' with
a prefix of '/prefix', then the restored files will be put in path '/ctr/prefix/dir/file'. If empty, then no
path prefix will be applied.
Rollback an active Protection domain to a snapshot

ncli> protection-domain rollback-pd name snap-id
Required arguments
name
snap-id
Snapshot to which Protection domain is to be rollbacked
Rollback Virtual Machines to a Snapshot

ncli> protection-domain rollback-vms name vm-names snap-id { replace-vms } { path-
prefix }
Required arguments
name
vm-names
Comma-separated list of Virtual Machine ids to be restored
snap-id
Id of the Snapshot to be used for rollback

Optional arguments
replace-vms
Whether the restored Virtual Machines replace their corresponding live Virtual Machines. If set
to false, then the parameter path-prefix must be specified
Default: false
path-prefix
The path prefix that apply to the restored file paths. For example, if restoring file '/ctr/dir/file' with
a prefix of '/prefix', then the restored files will be put in path '/ctr/prefix/dir/file'. If empty, then no
path prefix will be applied.
Set the periodic snapshot schedule of a Protection domain

ncli> protection-domain set-schedule name retention-policy { start-time } { interval }
{ min-snap-retention-count } { remote-sites } { remote-factors }
Required arguments
name
retention-policy
Comma-separated series of entries of the form <factor>:<quantity> to specify the retention
policy for the schedule. If factor=X and quantity=N, then the last N of every Xth snapshot taken
is retained. Thus, if snapshot_interval_secs=60, and factor=30 and quantity=5, then last 5
snapshots taken at half hour intervals are retained. The first entry for factor in retention-policy
must be 1
Optional arguments
start-time
Specify time in format MM/dd/yyyy [HH:mm:ss [z]] at which the schedule become active. If not
specified, schedule will become active immediately
interval
Interval in seconds at which periodic snapshots are taken. If not specified, default value will be
set by Nutanix
min-snap-retention-count
Minimum number of snapshots to retain. It is also applicable to out of band snapshots
Default: 5
remote-sites
Comma-separated list of Remote Site to which snapshots are replicated
remote-factors
Remote factor list determines which of the periodic snapshots taken get transferred to the
corresponding remote site specified using the parameter remote-sites. Thus, if the factor is 2,
every other snapshot is replicated to the corresponding remote. Size of this list must match
the size of list specified for remote-sites. If not specified, every snapshot is transferred to all
specified remote sites
Mark Virtual Machines and NFS files for removal from a given Protection domain. They will be removed when all
outstanding operations on them are completed/cancelled
ncli> protection-domain unprotect name { files } { vm-names }
Required arguments
name

Optional arguments
files
Comma-separated list of NFS files to be removed from Protection domain
vm-names
Comma-separated list of Virtual Machine name to be removed from Protection domain
rackable-unit: Rackable unit

Description A rackable unit
Alias ru
Operations • edit | update

• list | ls
• remove | rm
Edit a Rackable unit

ncli> rackable-unit { edit | update } id location
Required arguments
id
Id of the Rackable unit
location
Location of the Rackable unit
List Rackable unit

ncli> rackable-unit { list | ls }
Required arguments
None
Remove a Rackable unit

ncli> rackable-unit { remove | rm } id
Required arguments
id
Id of the Rackable unit
remote-site: Remote Site

Description A remote cluster to be used for replicating data
Alias rs

• edit | update
• list | ls
• remove | rm
Create a new Remote Site

ncli> remote-site { create | add } name address-list { max-bandwidth } { enable-proxy }
{ enable-compression } { vstore-map }
Required arguments
name
Name of the Remote Site
address-list
List of comma-separated addresses of the remote site. All addresses should be of format <ip>
or of format <ip:port>. Default port is used if the port number is not specified
Optional arguments
max-bandwidth
Maximum bandwidth (in kilobytes per sec) to be used while replicating to the remote site. If not
specified, restriction is not placed on maximum bandwidth used by replication
enable-proxy
Boolean parameter to indicate whether the addresses specified in address-list can be used as a
proxy to communicate with other Nutanix components on the remote site
enable-compression
Enable or disable compression of data during replication
vstore-map
By default, data from a local vStore is replicated to a identically named vStore in the remote site.
To setup data replication from local vStore to remote vStore having different names, provide
comma-separated list of <local vStore>:<target vStore> mapping. Mapping is not required if the
names of local and target vStore are same
Edit a Remote Site

ncli> remote-site { edit | update } name { max-bandwidth } { enable-proxy } { enable-
compression } { address-add } { address-del } { vstore-map-add } { vstore-map-del }
Required arguments
name
Optional arguments
max-bandwidth
Maximum bandwidth (in kilobytes per sec) to be used while replicating to the remote site. If not
specified, restriction is not placed on maximum bandwidth used by replication
enable-proxy
Boolean parameter to indicate whether the addresses specified in address-list can be used as a
proxy to communicate with other Nutanix components on the remote site
enable-compression
Enable or disable compression of data during replication
address-add
Address to be included in the remote site address list. Address should be of the format <ip> or
of the format <ip:port> and should conform to the format of the current remote site address list
address-del
Address to be removed from the remote site address list. Port number, if provided, is ignored
vstore-map-add
Entry of the form <local vStore>:<target vStore> to be included in the vStore replication map. If
mapping for a local vStore already exists, mapping is updated with the the new target vStore

vstore-map-del
Entry of the form <local vStore>:<target vStore> to be removed from the vStore replication map
List Remote Sites

ncli> remote-site { list | ls } { name }
Required arguments
None
Optional arguments
name
Mark a Remote Site for removal. Site will be removed from the appliance when all outstanding operations that are
using the remote site are cancelled
ncli> remote-site { remove | rm } name
Required arguments
name
servicecenter: Service Center

Description A Service Center
Alias sc
Operations • add
• edit | update
• list | ls
• remove | rm
Create a new Service Center

ncli> servicecenter add name username ip-address port
Required arguments
name
Name of the Service Center
username
Username to access the Service Center
ip-address
IP Address of the Service Center
port
Port number of the Service Center
Edit a Service Center

ncli> servicecenter { edit | update } name { ip-address } { username } { port }
Required arguments
name

Optional arguments
ip-address
IP Address of the Service Center
username
Username to access the Service Center
port
Port number of the Service Center
List Service Centers

ncli> servicecenter { list | ls } { name }
Required arguments
None
Optional arguments
name
Remove a Service Center

ncli> servicecenter { remove | rm } name
Required arguments
name
snapshot: Snapshot
Description Snapshot of a Virtual Disk
Alias snap
Operations • clone
• create | add
• list | ls
• remove | rm
Create a (fast) clone based on a Snapshot

ncli> snapshot clone { name } { clone-names } { src-file } { dest-files } { allow-
overwrite }
Required arguments
None
Optional arguments
name
Name of the Snapshot
clone-names
A comma-separated list of names for the newly created Snapshots
src-file
Absolute path of the NFS snapshot file

dest-files
Absolute path(s) of the clone(s) to be created
allow-overwrite
Enable overwriting if a NFS file already exists in the destination path
Default: false
Create a new Snapshot of a Virtual Disk or a NFS file

ncli> snapshot { create | add } { name } { vdisk-name } { src-file } { dest-file } {
allow-overwrite }
Required arguments
None
Optional arguments
name
Name of the Snapshot. If name is not specified, format snap_<vDisk-
name>_YYYY_MM_DD_HH_MM_SS is used to generate the name
vdisk-name
Name of the Virtual Disk
src-file
Absolute path of the NFS snapshot file
dest-file
Absolute path of the snapshot file to be created
allow-overwrite
Enable overwriting if a NFS file already exists in the destination path
Default: false
List Snapshots
ncli> snapshot { list | ls } { name } { vdisk-name }
Required arguments
None
Optional arguments
name
vdisk-name
Name of the corresponding Virtual Disk
Get stats data for Snapshots

ncli> snapshot { list-stats | ls-stats } { name } { vdisk-name }
Required arguments
None
Optional arguments
name
vdisk-name
Name of the corresponding Virtual Disk

Delete a Snapshot
ncli> snapshot { remove | rm } name
Required arguments
name
snmp: SNMP
Description An SNMP agent
Alias None
Operations • add-transport
• add-trap
• add-user
• edit-trap | update-trap
• edit-user | update-user
• get-status
• list-transports | ls-transports
• list-traps | ls-traps
• list-users | ls-users
• remove-transport | delete-transport
• remove-trap | delete-trap
• remove-user | delete-user
• set-status
Add a transport to the list of snmp transports. Each transport is a protocol:port pair
ncli> snmp add-transport protocol port
Required arguments
protocol
Protocol for the snmp agent or trap sink. Currently supported protocols are UDP, TCP and
UDP_6
port
Port number on which an snmp agent listens for requests or on which a trap sink is waiting traps
Add a trap sink to the list of trap sinks. Each trap sink is a combination of trap sink address, username and
authentication information
ncli> snmp add-trap username address { port } { protocol } { engine-id } { inform }
Required arguments
username
Identity of an snmp user
address
Address of an snmp trap sink. This should be an IP address or FQDN
Optional arguments
port

protocol
UDP_6
engine-id
Engine id of the snmp trap sink. This must be a hex string starting with 0x
inform
Flag that specifies whether a trap sink is actually an inform sink
Default: false
Add an snmp user along with its authentication and privacy keys
ncli> snmp add-user username auth-key auth-type { priv-key } { priv-type }
Required arguments
username
auth-key
Authentication key for an snmp user
auth-type
Authentication type for snmp user. Can be MD_5 or SHA
Optional arguments
priv-key
Encryption key for an snmp user
priv-type
Encryption type for an snmp user. Can be DES or AES
Edit one of the trap sinks from the list of trap sinks. Editable properties are username, authentication and privacy
settings and protocol
ncli> snmp { edit-trap | update-trap } address { port } { protocol } { engine-id } {
inform }
Required arguments
address
Optional arguments
port
protocol
UDP_6
engine-id
Engine id of the snmp trap sink. This must be a hex string starting with 0x
inform
Flag that specifies whether a trap sink is actually an inform sink
Modify the authentication and encrytption information of an existing snmp user

ncli> snmp { edit-user | update-user } username { auth-key } { auth-type } { priv-key }
{ priv-type }

Required arguments
username
Optional arguments
auth-key
Authentication key for an snmp user
auth-type
Authentication type for snmp user. Can be MD_5 or SHA
priv-key
Encryption key for an snmp user
priv-type
Encryption type for an snmp user. Can be DES or AES
Returns the status of the snmp service

ncli> snmp get-status
Required arguments
None
List all the transports specified for the snmp agent. Each transport is a protocol:port pair
ncli> snmp { list-transports | ls-transports }
Required arguments
None
List all the configured trap sinks along with their user information.
ncli> snmp { list-traps | ls-traps } { address }
Required arguments
None
Optional arguments
address
Lists all the snmp users along with their properties like authentication and privacy information
ncli> snmp { list-users | ls-users } { username }
Required arguments
None
Optional arguments
username
Remove a transport from the list of snmp transports

ncli> snmp { remove-transport | delete-transport } protocol port
Required arguments
protocol
UDP_6

port
Remove a trap from the list of snmp traps

ncli> snmp { remove-trap | delete-trap } address
Required arguments
address
Remove a user from the list of snmp users

ncli> snmp { remove-user | delete-user } username
Required arguments
username
Sets the status of the snmp service

ncli> snmp set-status enable
Required arguments
enable
Enable or disable snmp agent on a cluster {true, false}
storagepool: Storage Pool

Description A Pool of Physical Disks
Alias sp

• edit | update
• list | ls
• remove | rm
Create a new Storage Pool

ncli> storagepool { create | add } name { disk-ids } { add-all-free-disks } { ilm-
thresh } { force }
Required arguments
name
Name of the Storage Pool
Optional arguments
disk-ids
IDs of Physical Disk in the Storage Pool
add-all-free-disks
Add all free disks that are not part of any storage pool?
ilm-thresh
ILM down-migrate (%) threshold for a Storage Pool

force
Default: false
Edit a Storage Pool

ncli> storagepool { edit | update } { id } { name } { new-name } { add-all-free-disks }
{ add-disk-ids } { rm-disk-ids } { ilm-thresh } { force }
Required arguments
None
Optional arguments
id
ID of the Storage Pool
name
new-name
add-all-free-disks
Add all free disks that are not part of any storage pool?
add-disk-ids
A comma-separated list of Physical Disk IDs to be added to the Storage Pool
rm-disk-ids
A comma-separated list of Physical Disk IDs to be removed from the Storage Pool
ilm-thresh
ILM down-migrate (%) threshold for a Storage Pool
force
Default: false
List Storage Pools

ncli> storagepool { list | ls } { id } { name }
Required arguments
None
Optional arguments
id
name
Get stats data for Storage Pools

ncli> storagepool { list-stats | ls-stats } { id } { name }
Required arguments
None

Optional arguments
id
name
Delete a Storage Pool

ncli> storagepool { remove | rm } { id } { name }
Required arguments
None
Optional arguments
id
name
storagetier: Storage Tier

Description A Tier of physical storage
Alias tier

• get-default-io-priority-order | get-def-io-
pri
• list | ls
• list-types | ls-types
• remove | rm
• set-default-io-priority-order | set-def-io-
pri
Add a new Storage Tier

ncli> storagetier { create | add } name type
Required arguments
name
Name of the Storage Tier
type
Type of Storage Tier (as provided by the 'list-types' operation)
List the (global) default I/O priority order of Storage Tiers

ncli> storagetier { get-default-io-priority-order | get-def-io-pri }
Required arguments
None
List Storage Tiers

ncli> storagetier { list | ls } { name } { type }

Required arguments
None
Optional arguments
name
type
Type of Storage Tier (as provided by the 'list-types' operation)
List types of Storage Tiers

ncli> storagetier { list-types | ls-types }
Required arguments
None
Remove a Storage Tier

ncli> storagetier { remove | rm } name
Required arguments
name
Set the (global) default I/O priority order of Storage Tiers

ncli> storagetier { set-default-io-priority-order | set-def-io-pri } random-io-
priority-order sequential-io-priority-order
Required arguments
Random I/O priority order (high to low) of Storage Tiers
Sequential I/O priority order (high to low) of Storage Tiers
user: User
Description A User
Alias None
Operations • change-password
• create | add
• delete | remove rm
• disable
• edit | update
• enable
• grant-cluster-admin-role
• grant-user-admin-role
• list | ls
• reset-password
• revoke-cluster-admin-role
• revoke-user-admin-role
• show-profile

Change the password of a User
ncli> user change-password current-password new-password
Required arguments
current-password
Current password of the user
new-password
New password of the user
Add a new User

ncli> user { create | add } user-name user-password first-name last-name email-id {
middle-initial }
Required arguments
user-name
User name of the user
user-password
Password of the user
first-name
First name of the user
last-name
Last name of the user
email-id
Email address of the user
Optional arguments
middle-initial
Middle Initial of the user
Delete a User
ncli> user { delete | remove rm } user-name
Required arguments
user-name
Disable a User
ncli> user disable user-name
Required arguments
user-name
Edit a User
ncli> user { edit | update } user-name { first-name } { last-name } { middle-initial }
{ email-id }
Required arguments
user-name

Optional arguments
first-name
First name of the user
last-name
Last name of the user
middle-initial
Middle Initial of the user
email-id
Email address of the user
Enable a User
ncli> user enable user-name
Required arguments
user-name
Grant cluster administration role to a User

ncli> user grant-cluster-admin-role user-name
Required arguments
user-name
Grant user administration role to a User

ncli> user grant-user-admin-role user-name
Required arguments
user-name
List Users
ncli> user { list | ls } { user-name }
Required arguments
None
Optional arguments
user-name
Reset the password of a User

ncli> user reset-password user-name
Required arguments
user-name
Revoke cluster administration role from a User

ncli> user revoke-cluster-admin-role user-name

Required arguments
user-name
Revoke user administration role from a User

ncli> user revoke-user-admin-role user-name
Required arguments
user-name
Show profile of current User

ncli> user show-profile
Required arguments
None
vdisk: Virtual Disk

Description A Virtual Disk
Alias None
Operations • clone
• create | add
• edit | update
• list | ls
• list-snapshots | ls-snaps
• remove | rm
• snapshot | snap
Create a (fast) clone of a Virtual Disk

ncli> vdisk clone name clone-names { snap-name }
Required arguments
name
clone-names
A comma-separated list of names for the newly created Snapshots
Optional arguments
snap-name
Name of the Snapshot on which the clone is based
Create a new Virtual Disk

ncli> vdisk { create | add } name max-capacity { ctr-id } { ctr-name } { res-capacity }
{ fingerprint-on-write } { shared }
Required arguments
name

max-capacity
Max Capacity (GB) of the Virtual Disk
Optional arguments
ctr-id
ID of the Storage Container for the Virtual Disk
ctr-name
Name of the Storage Container for the Virtual Disk
res-capacity
Reserved Capacity (GB) of the Virtual Disk
Fingerprint on writes to the Virtual Disk {on, off, none}. This VDisk level setting overrides the
container level setting
shared
Is this a shared Virtual Disk?
Default: false
Edit a Virtual Disk

ncli> vdisk { edit | update } name { max-capacity } { res-capacity } { fingerprint-on-
write }
Required arguments
name
Optional arguments
max-capacity
Max Capacity (GB) of the Virtual Disk
res-capacity
Reserved Capacity (GB) of the Virtual Disk
Fingerprint on writes to the Virtual Disk {on, off, none}. This VDisk level setting overrides the
container level setting
List Virtual Disks

ncli> vdisk { list | ls } { names } { vm-id } { ctr-id }
Required arguments
None
Optional arguments
names
A comma-separated list of the names of the Virtual Disks
vm-id
ID of a Virtual Machine that the Virtual Disk is mapped to
ctr-id
Get Virtual Disks in the specified Storage Container
List Snapshots
ncli> vdisk { list-snapshots | ls-snaps } name

Required arguments
name
Get stats data for Virtual Disks

ncli> vdisk { list-stats | ls-stats } { names } { vm-id } { ctr-id }
Required arguments
None
Optional arguments
names
vm-id
ID of a Virtual Machine that the Virtual Disk is mapped to
ctr-id
Get Virtual Disks in the specified Storage Container
Delete a Virtual Disk

ncli> vdisk { remove | rm } name
Required arguments
name
Create a new Snapshot of a Virtual Disk

ncli> vdisk { snapshot | snap } name { snap-name }
Required arguments
name
Optional arguments
snap-name
virtualmachine: Virtual Machine

Description A Virtual Machine
Alias vm
Operations • list | ls
List Virtual Machine

ncli> virtualmachine { list | ls } { name } { host-id } { get-unprotected-cbr-vms-only
}
Required arguments
None

Optional arguments
name
Name of the Virtual Machine
host-id
ID of the Physical Host running Virtual Machines
get-unprotected-cbr-vms-only
Get only unprotected Virtual Machines that can participate in Nutanix Converged Backup and
Recovery?
Default: false
Get stats data for Virtual Machine

ncli> virtualmachine { list-stats | ls-stats } { name } { host-id }
Required arguments
None
Optional arguments
name
Name of the Virtual Machine
host-id
ID of the Physical Host running Virtual Machines
vzone: vZone
Description A vZone
Alias None
Operations • add-hosts
• add-vdisks
• create | add
• list | ls
• remove | rm
• remove-all-vdisks
• remove-hosts
• remove-vdisks
• sync-haclusters
Add Physical Hosts to a vZone

ncli> vzone add-hosts name host-ids
Required arguments
name
Name of the vZone
host-ids
Add Virtual Disks to a vZone

ncli> vzone add-vdisks name vdisk-names

Required arguments
name
Name of the vZone
vdisk-names
Create a new vZone

ncli> vzone { create | add } name
Required arguments
name
Name of the vZone
List vZones
ncli> vzone { list | ls } { name }
Required arguments
None
Optional arguments
name
Name of the vZone
Delete avZone
ncli> vzone { remove | rm } name
Required arguments
name
Name of the vZone
Remove allVirtual Disks from a vZone

ncli> vzone remove-all-vdisks name
Required arguments
name
Name of the vZone
Remove Physical Hosts from a vZone

ncli> vzone remove-hosts name host-ids
Required arguments
name
Name of the vZone
host-ids
Remove Virtual Disks from a vZone

ncli> vzone remove-vdisks name vdisk-names
Required arguments
name
Name of the vZone

vdisk-names
Sync HACluster(s) with vZones

ncli> vzone sync-haclusters ms-name datacenter-name
Required arguments
ms-name
datacenter-name
vstore: VStore
Description A file namespace in a container
Alias None

• list | ls
• protect
• remove | rm
• unprotect
Create a new VStore

ncli> vstore { create | add } { ctr-id } { ctr-name }
Required arguments
None
Optional arguments
ctr-id
ID of a Storage Container for the VStore
ctr-name
Name of a Storage Container for the VStore
List VStores
ncli> vstore { list | ls } { id } { name }
Required arguments
None
Optional arguments
id
ID of a VStore
name
Name of a VStore
Protect a VStore. Files in a protected VStore are replicated to a Remote Site at a defined frequency and these
protected files can be recovered in the event of a disaster
ncli> vstore protect { id } { name }

Required arguments
None
Optional arguments
id
ID of a VStore
name
Name of a VStore
Delete a VStore
ncli> vstore { remove | rm } { id } { name } { force }
Required arguments
None
Optional arguments
id
ID of a VStore
name
Name of a VStore
force
Delete a VStore
Default: false
Unprotect a VStore
ncli> vstore unprotect { id } { name }
Required arguments
None
Optional arguments
id
ID of a VStore
name
Name of a VStore

Command Reference-NOS v3 5

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Command Reference-NOS v3 5

Uploaded by

Copyright:

Available Formats

Command Reference Guide

variable_value The action depends on a value that is unique to your environment.

ncli> command The commands are executed in the Nutanix nCLI.

output The information is displayed as output from a command or in a log file.

Default Cluster Credentials

Nutanix web console Nutanix Controller VM admin admin

vSphere client ESXi host root nutanix/4u

SSH client or console ESXi host root nutanix/4u

SSH client Nutanix Controller VM nutanix nutanix/4u

IPMI web interface or ipmitool Nutanix node ADMIN ADMIN

IPMI web interface or ipmitool Nutanix node (NX-3000) admin admin

Copyright | Command Reference Guide | NOS 3.5 | 2

1: Nutanix Command-Line Interface.......................................................... 4

To Install the nCLI on Your Local System

2. Download the nCLI.

a. Connect to the Nutanix web console.

c. Select Download nCLI.

d. Download and unzip the file on your local system.

3. Configure your Windows %PATH% or Linux $PATH environment variables.

Nutanix Command-Line Interface | Command Reference Guide | NOS 3.5 | 4

To Initiate an nCLI Session From Your Local System

1. Open a command prompt.

2. Start the nCLI.

• Replace ncli_dir with the directory where the nCLI is installed.

Error: Could not connect to The cluster is not started.

entity can be replaced by any Nutanix entity, such as cluster or disk.

Nutanix Command-Line Interface | Command Reference Guide | NOS 3.5 | 5

Nutanix Command-Line Interface | Command Reference Guide | NOS 3.5 | 6

Controller VM Commands | Command Reference Guide | NOS 3.5 | 7

Controller VM Commands | Command Reference Guide | NOS 3.5 | 8

Controller VM Commands | Command Reference Guide | NOS 3.5 | 9

Controller VM Commands | Command Reference Guide | NOS 3.5 | 10

Controller VM Commands | Command Reference Guide | NOS 3.5 | 11

Controller VM Commands | Command Reference Guide | NOS 3.5 | 12

Controller VM Commands | Command Reference Guide | NOS 3.5 | 13

Controller VM Commands | Command Reference Guide | NOS 3.5 | 14

Controller VM Commands | Command Reference Guide | NOS 3.5 | 15

Controller VM Commands | Command Reference Guide | NOS 3.5 | 16

Controller VM Commands | Command Reference Guide | NOS 3.5 | 17

Controller VM Commands | Command Reference Guide | NOS 3.5 | 18

Controller VM Commands | Command Reference Guide | NOS 3.5 | 19

Controller VM Commands | Command Reference Guide | NOS 3.5 | 20

Controller VM Commands | Command Reference Guide | NOS 3.5 | 21

Controller VM Commands | Command Reference Guide | NOS 3.5 | 22

Operations • acknowledge | ack

List history of Alerts

nCLI Reference | Command Reference Guide | NOS 3.5 | 23

authconfig: Authentication Configuration

Operations • create-directory | add-directory

Create Directory Service Configuration

Update Authentication Configuration

nCLI Reference | Command Reference Guide | NOS 3.5 | 24

Update Directory Service Configuration

List Authentication Configuration

List Authentication Configuration

Remove Authentication Configuration

Remove Directory Service Configuration

nCLI Reference | Command Reference Guide | NOS 3.5 | 25

nCLI Reference | Command Reference Guide | NOS 3.5 | 26

Add the configured node to the cluster

Add public key to the cluster

Add email addresses to the list of email alert contacts

Add addresses to the list of name servers

Add addresses to the list of NFS subnet whitelist