Command reference nos-v3_5

Command Reference Guide

NOS 3.523-Sep-2013

Copyright | Command Reference Guide | NOS 3.5 | 2

Notice

Copyright

Copyright 2013 Nutanix, Inc.

Nutanix, Inc.1740 Technology Drive, Suite 400San Jose, CA 95110

All rights reserved. This product is protected by U.S. and international copyright and intellectual propertylaws. Nutanix is a trademark of Nutanix, Inc. in the United States and/or other jurisdictions. All other marksand 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)

3

Contents

1: Nutanix Command-Line Interface..........................................................4To Install the nCLI on Your Local System..........................................................................................4To Initiate an nCLI Session From Your Local System....................................................................... 5Command Format................................................................................................................................5Embedded Help...................................................................................................................................6

2: Controller VM Commands......................................................................7cluster.................................................................................................................................................. 7diagnostics.py.................................................................................................................................... 16genesis...............................................................................................................................................18

3: nCLI Reference......................................................................................23alerts: Alert....................................................................................................................................23authconfig: Authentication Configuration...................................................................................... 24cluster: Cluster.............................................................................................................................. 26container: Storage Container........................................................................................................ 33datastore: Datastore......................................................................................................................37disk: Physical Disk..........................................................................................................................38host: Physical Host......................................................................................................................... 40http-proxy: HTTP Proxy................................................................................................................43managementserver: Management Server....................................................................................... 45protection-domain: Protection domain.........................................................................................46rackable-unit: Rackable unit........................................................................................................53remote-site: Remote Site............................................................................................................. 53servicecenter: Service Center......................................................................................................55snapshot: Snapshot........................................................................................................................ 56snmp: SNMP.....................................................................................................................................58storagepool: Storage Pool............................................................................................................ 61storagetier: Storage Tier............................................................................................................. 63user: User........................................................................................................................................64vdisk: Virtual Disk...........................................................................................................................67virtualmachine: Virtual Machine...................................................................................................69vzone: vZone................................................................................................................................... 70vstore: VStore................................................................................................................................ 72

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

1Nutanix Command-Line Interface

The Nutanix command-line interface (nCLI) allows you to run system administration commands against theNutanix 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 clustercomponents.

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 tohttp://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)

http://www.java.com/en/download/installed.jsp


The procedure to complete this step depends on your operating system. For more information, go tohttp://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 LocalSystem 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 andyou did not specify the correct password.

Type exit and start the nCLI again with the correct password.

Error: Could not connect toNutanix Gateway

The cluster is not started.

Log on to a Controller VM as the nutanix user and run the followingcommand:

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 torequest a list of all storage pools in the cluster.

ncli> storagepool list

http://java.com/en/download/help/path.xml


Some actions require parameters at the end of the command. For example, when creating an NFSdatastore, you need to provide both the name of the datastore as it will appear to the hypervisor and thename 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 thepreceding example. This is particularly important when specifying parameters that accept a list ofvalues.

Embedded Help

The nCLI provides assistance on all entities and actions. By typing help at the command line, you canrequest additional information at one of three levels of detail.

helpProvides a list of entities and their corresponding actions

entity helpProvides a list of all actions and parameters associated with the entity, as well as which parametersare required, and which are optional

entity action helpProvides a list of all parameters associated with the action, as well as a description of eachparameter

The nCLI provides additional details at each level. To control the scope of the nCLI help output, add thedetailed 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 thecluster 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

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

2Controller 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_dependenciesInclude Dependencies.

Default: false

--clean_debug_dataIf 'clean_debug_data' is True, then when we destroy a cluster we will also remove the logs, binarylogs, cached packages, and core dumps on each node.

Default: false

--cluster_nameName of the cluster (use with create).

--configPath to the cluster configuration file.

--forceForce action.

Default: false

--force_install_protoWhen upgrading from 3.* to 3.5, force installation of python protobuf libraries is required for rollingupgrade.

Default: true


--genesis_pathPath to genesis command on SVMs.

Default: /home/nutanix/cluster/bin/genesis

--helpshow this help

Default: 0

--helpshortshow usage only for this module

Default: 0

--helpxmllike --help, but generates XML output

Default: false

--installer_dir_pathLocation of the Nutanix installer directory.

--ip_specification_jsonJSON file with IP configuration.

--key_fileNutanix default SSH public key.

Default: /home/nutanix/ssh_keys/nutanix.pub

--key_nameIdentifier of the public ssh key in the cluster.

Default: default

--lockdown_modeFlag for lockdown mode

Default: false

--migrate_fromThe old zeus node IP address for Zeus migration.

--migrate_toThe new zeus node IP address for Zeus migration.

--num_nodes_to_uploadNumber of nodes to upload the installer directory to.

Default: 2

--nutanix_packages_json_basenameBase file name of the JSON file that contains the list of packages to expect in the packages directory.

Default: nutanix-packages.json

--python_libPath where python eggs are stored.

Default: /home/nutanix/cluster/lib/py

--python_proto_egg_pathPath of protobuf egg relative to the install dir.

Default: lib/py/protobuf-2.5.0-py2.6.egg

--ssh_keySSH key used for logging into SVM.


Default: /home/nutanix/.ssh/id_rsa

--svm_ipsComma separated list of IP addresses of one or more SVMs in the target cluster. Not required ifcluster.cfg is being used.

--svm_loginUser name for logging into SVM.

Default: nutanix

--timeoutNumber of seconds each command to SVMs should take.

Default: 180

--waitWait for action to complete.

Default: true

--yesConfirmation to destroy.

Default: false

cluster.consts

--factory_config_json_pathPath to the factory_config.json file.

Default: /etc/nutanix/factory_config.json

--hyperv_external_network_interfaceDefault name of the network device for Hyper-V's external network.

Default: TenGigTeam

--hyperv_hypervisor_usernameThe username to use when logging into the local Hyper-V node.

Default: Administrator

--hyperv_internal_network_interfaceDefault name of the network device for Hyper-V's internal network.

Default: InternalSwitch

--hypervisor_internal_ipInternal IP address of the hypervisor.

Default: 192.168.5.1

--hypervisor_passwordThe password to use when logging into the local hypervisor.

Default: nutanix/4u

--hypervisor_usernameThe username to use when logging into the local hypervisor.

Default: root

--ipmi_passwordThe password to use when logging into the local IPMI device.

Default: ADMIN


--ipmi_usernameThe username to use when logging into the local IPMI device.

Default: ADMIN

--logpipe_pathPath to logpipe.

Default: /home/nutanix/cluster/bin/logpipe

--ntpd_driftfile_pathPath to the NTPD daemon's drift file.

Default: /var/lib/ntp/drift

--nutanix_bin_dirPath to the nutanix bin folder.

Default: /home/nutanix/bin

--nutanix_binary_log_dirDirectory containing binary logs.

Default: /home/nutanix/data/binary_logs

--nutanix_core_dirDirectory containing core dumps of all Nutanix binaries.

Default: /home/nutanix/data/cores

--nutanix_data_dirPath to the nutanix data folder.

Default: /home/nutanix/data

--nutanix_homeNutanix home directory.

Default: /home/nutanix

--nutanix_lock_dirDirectory containing Nutanix service lock files.

Default: /home/nutanix/data/locks

--nutanix_log_dirDirectory containing logs.

Default: /home/nutanix/data/logs

--nutanix_private_keyPath to the private SSH key used to connect to SVMs the cluster.

Default: /home/nutanix/ssh_keys/nutanix

--nutanix_storage_dirNutanix storage directory

Default: /home/nutanix/data/stargate-storage/disks

--stargate_disk_configJSON file on stargate disk holding disk config

Default: disk_config.json

--stargate_portPort for Stargate

Default: 2009


--svm_non_ha_internal_ipInternal IP address of SVM that is not redirected for HA.

Default: 192.168.5.254

--svm_os_versionThe default version of SVM os

Default: centos

--svm_private_keyPath to the private SSH key used by SVM.


--toolchain_dirPath to Nutanix toolchain.

Default: /home/nutanix/toolchain/x86_64-unknown-linux-gnu/1.6

--zeus_config_cache_pathPath to the zeus configuration cache kept in sync by Genesis.

Default: /home/nutanix/config/configuration_proto.dat

--zookeeper_host_port_listHost port pair list for zookeeper.

Default: zk1:9876,zk2:9876,zk3:9876

cluster.genesis.client

--genesis_jsonrpc_urlURL of the JSON RPC handler on the Genesis HTTP server.

Default: /jsonrpc

--genesis_portPort that Genesis listens on.

Default: 2100

--genesis_rpc_timeout_secsTimeout for each Genesis RPC.

Default: 30

cluster.genesis.cluster_manager

--cluster_state_znodeLocation in Zookeeper where we keep whether a node start or stop.

Default: /appliance/logical/genesis/cluster_state

--cluster_versions_znodeLocation in Zookeeper where we keep the desired software versions map.

Default: /appliance/logical/genesis/cluster_versions

--force_disable_blackboxFile to disable blackbox mode completely.

Default: /home/nutanix/.force_disable_blackbox

--node_shutdown_token_state_znodeLocation in Zookeeper where we keep state of which node has currently requested to go down formaintenance.

Default: /appliance/logical/genesis/node_shutdown_token


--node_upgrade_statusLocation in Zookeeper where we store upgrade status of nodes.

Default: /appliance/logical/genesis/node_upgrade_status

--nutanix_default_ssh_keysNutanix default SSH key used for logging into SVM.


--release_version_znodeZookeeper node where we keep the current release version of the cluster.

Default: /appliance/logical/genesis/release_version

--services_to_be_started_znodeEncode the set of services to be started.

Default: /appliance/logical/genesis/services_started

cluster.genesis.migration_manager

--num_migration_commit_retriesNumber of times to retry updating the zeus configuration with new zookeeper ensemble.

Default: 5

--num_migration_rpc_retriesNumber of times to retry Rpcs to other nodes during zookeeper migration.

Default: 10

--tcpkillPath to the tcpkill binary

Default: /usr/sbin/tcpkill

--zookeeper_migration_wal_pathPath to zookeeper write-ahead-log file where migration state is recorded.

Default: /home/nutanix/data/zookeeper_migration.wal

--zookeeper_session_check_time_secsNumber of seconds zookeeper takes to verify and disconnect zookeeper quorum ip addresses thatare no longer valid.

Default: 10

--zookeeper_tcpkill_timeout_secsNumber of seconds to let tpckill to disconnect the tcp connections of zookeeper ensemble memberthat is to be removed.

Default: 10

cluster.genesis.node_manager

--auto_discovery_interval_secsNumber of seconds to sleep when local node can't join any discovered cluster.

Default: 5

--avahi_service_typeAvahi service type to publish under.

Default: _nutanix._tcp

--configure_iptables_with_stigIf True, then we will setup iptables to be STIG compliant.


Default: true

--default_ssh_keysSSH key used for logging into SVM.


--dhcp_ntp_confdhcp ntp configuration file.

Default: /var/lib/ntp/ntp.conf.dhcp

--download_staging_areaDirectory where we will download directories from other SVMs.

Default: /home/nutanix/tmp

--external_ntp_monitor_interval_secsNumber of seconds between each check of external NTP server.

Default: 600

--gold_image_version_pathPath to the file that contains the version of the gold image.

Default: /etc/nutanix/svm-version

--installer_dirPath to the directory where the installer is contained.

Default: /home/nutanix/data/installer

--nagios_config_pathPath to the nagios configuration file.

Default: /home/nutanix/serviceability/config/nagios3/nutanix_nagios.cfg

--node_disable_auto_upgrade_markerPath 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_markerPath to marker file to indicate that this node should be reconfigured.

Default: /home/nutanix/.node_reconfigure

--node_ssh_key_dirPath for node specific ssh keys on local disk

Default: /home/nutanix/ssh_keys/.blackbox

--node_unconfigure_markerPath to marker file to indicate that node is ready to be unconfigured.

Default: /home/nutanix/.node_unconfigure

--ntp_config_pathThe path to the configuration file for NTP.

Default: /etc/ntp.conf

--ntp_leader_znodeZookeeper node containing the IP address of the current Zookeeper leader.

Default: /appliance/logical/genesis/ntp_leader

--ntpdate_timeout_secsTime out to wait for ntp server to return a valid time.


Default: 10

--release_version_pathPath to the file that contains the local release version.

Default: /etc/nutanix/release_version

--rpm_genesis_log_filePath to rpm log file during Genesis self install.

Default: /home/nutanix/data/logs/rpm.genesis.out

--service_vm_config_json_pathPath to the service_vm_config.json file.

Default: /home/nutanix/data/stargate-storage/service_vm_config.json

--svm_external_netifExternal network interface of SVM to communicate with other SVMs.

Default: eth0

--svm_internal_ipsInternal 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_netifInternal network interface of the SVM to communicate with local hypervisor.

Default: eth1

--svm_internal_netif_netmaskThe netmask for the internal IP addresses on eth1.

Default: 255.255.255.128

--svm_non_ha_internal_netmaskThe netmask for the non-data internal IP aliases on eth1.

Default: 255.255.255.0

--svm_reboot_required_markerMarker file to indicate that SVM reboot is required and cluster services should not be started.

Default: /tmp/svm_reboot_required

--svm_reboot_suppressed_markerMarker file to indicate that SVM reboot is currently suppressed.

Default: /tmp/svm_reboot_suppressed

--time_rollback_tolerance_secsMaximum number of seconds by which NTP is allowed to roll back time on the system.

Default: 5

--zookeeper_start_timeout_secsTimeout for waiting on Zookeeper connection on startup.

Default: 120

cluster.ipv4config

--esx_cmd_timeout_secsDefault timeout for running a remote command on an ESX host.

Default: 120


--esx_external_network_interfaceDefault name of the network device for ESX's external network.

Default: vmk0

--ipmi_apply_config_retriesNumber of times to try applying an IPMI IPv4 configuration before failing.

Default: 6

--kvm_cmd_timeout_secsDefault timeout for running a remote command on an KVM host.

Default: 120

--kvm_external_network_interfaceDefault name of the network device for KVM's external network.

Default: br0

cluster.service.alert_manager_service

--alert_manager_data_dirPath to the alert_manager data directory.

Default: /home/nutanix/data/alert_manager

--alert_manager_pathPath to the alert_manager binary.

Default: /home/nutanix/bin/alert_manager

--alert_manager_rss_mem_limitMaximum amount of resident memory Alert Manager may use on an Svm with 8GB memoryconfiguration.

Default: 268435456

--alert_manager_virt_mem_limitMaximum amount of virtual memory (in GB) Alert Manager may use on an Svm with 8GB memoryconfiguration.

Default: 1073741824

cluster.service.service_utils

--disk_inventory_pathThe 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_kbTotal memory size of the standard Svm based on which memory limits are derived.

Default: 8388608

--service_stop_waitWait time for how long we should wait before we start issuing SIGKILL instead of SIGTERM.

Default: 5

cluster.sshkeys_helper

--authorized_keys_filePath to file containing list of permitted RSA keys

Default: /home/nutanix/.ssh/authorized_keys2


--id_rsa_pathNutanix default SSH key used for logging into SVM.


--ssh_client_configurationLocation of ssh client configuration file.

Default: /home/nutanix/.ssh/config

--ssh_pathLocation 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_nameName of the container to be created for the disks of the UVM

Default: NTNX-NFS-DEFAULT

--default_aggregatorDefault script to aggregate results.

Default: fio_aggregator.py

--default_ncli_passwordDefault password for login into the ncli.

Default: admin

--default_ncli_userDefault username for login into the ncli.

Default: admin

--deprecated_ctr_nameDeprecated container name used by older versions of this script. This is used to cleanup anycontainer that may be left behind by the previous version.

Default: NTNX-diagnostics-ctr

--display_cassandra_latency_statsDisplay cassandra latency stats for each test.

Default: true

--display_latency_statsDisplay latency stats for each test (available in fio tests only).

Default: false


--dry_runIf True, only prints the tests it would have executed.

Default: false

--esx_diagnostics_image_pathPath to the diagnostics VM image for ESX.

Default: /home/nutanix/data/images/diagnostics/nutanix-diagnostics-1.0.ovf

--external_uvm_ipsIP addresses of external UVMs. If specified, the setup step is skipped and the tests are run on theseUVMs

--fingerprint_on_writeWhether to enable fingerprint on write on container.

Default: false

--flush_svm_cachesWhether to flush svm cache before each test.

Default: true

--hyperv_diagnostics_image_pathPath to the diagnostics VM image for Hyper-V.

Default: /home/nutanix/data/images/diagnostics/diagnostics_uvm.vhd.gz

--inline_compressionWhether to enable inline compression on container.

Default: false

--max_oplog_flush_wait_secsMaximum time waiting for the oplogs to flush before running a test.

Default: 600

--nodesComma-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_nameName of the results directory. Leave empty for an automatically generated name.

--runtime_test_argsComma-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_dirPath to the directory where the uvm tool scripts reside

Default: /home/nutanix/diagnostics

--setup_onlyOnly setup the test UVMs without running any actual tests. This option is mutually exclusive with --skip_setup.

Default: false

--skip_setupSkip setting up the UVMs. Useful when the setup has already been performed by a previous run. Thisoption is mutually exclusive with --setup_only.

Default: false


--skip_ssd_pcie_checkSkip the check which ensures that disks exist in the SSD-PCIe tier.

Default: false

--sp_nameName of the storage pool to be created for the disks of the UVM

Default: NTNX-SP-DEFAULT

--terseTerse 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_groupsComma-separated list of test groups to run. If not specified, the 'default' test group is run (unless --tests is specified).

Default: default

--testsComma-separated list of tests to run. If not specified, all tests in the specified test groups are run.

--tunnels_start_portStarting port for setting up tunnels to the UVMs

Default: 17000

--uvm_identity_fileSSH identity file of the diagnostics VM

Default: diagnostics_id_rsa

--uvm_ipIP address of the UVM

Default: 192.168.5.253

--uvm_name_prefixCommon prefix of the names of the UVMs

Default: NTNX_diagnostics

--verboseIf 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

--foregroundRun Genesis in foreground.

Default: false


--genesis_self_monitoringGenesis to do self monitoring.

Default: true

--helpshow this help

Default: 0

--helpshortshow usage only for this module

Default: 0

--helpxmllike --help, but generates XML output

Default: false

cluster.genesis.client

--genesis_jsonrpc_urlURL of the JSON RPC handler on the Genesis HTTP server.

Default: /jsonrpc

--genesis_portPort that Genesis listens on.

Default: 2100

--genesis_rpc_timeout_secsTimeout for each Genesis RPC.

Default: 30

cluster.genesis.cluster_manager

--cluster_state_znodeLocation in Zookeeper where we keep whether a node start or stop.

Default: /appliance/logical/genesis/cluster_state

--cluster_versions_znodeLocation in Zookeeper where we keep the desired software versions map.

Default: /appliance/logical/genesis/cluster_versions

--force_disable_blackboxFile to disable blackbox mode completely.

Default: /home/nutanix/.force_disable_blackbox

--node_shutdown_token_state_znodeLocation in Zookeeper where we keep state of which node has currently requested to go down formaintenance.

Default: /appliance/logical/genesis/node_shutdown_token

--node_upgrade_statusLocation in Zookeeper where we store upgrade status of nodes.

Default: /appliance/logical/genesis/node_upgrade_status

--nutanix_default_ssh_keysNutanix default SSH key used for logging into SVM.



--release_version_znodeZookeeper node where we keep the current release version of the cluster.

Default: /appliance/logical/genesis/release_version

--services_to_be_started_znodeEncode the set of services to be started.

Default: /appliance/logical/genesis/services_started

cluster.genesis.migration_manager

--num_migration_commit_retriesNumber of times to retry updating the zeus configuration with new zookeeper ensemble.

Default: 5

--num_migration_rpc_retriesNumber of times to retry Rpcs to other nodes during zookeeper migration.

Default: 10

--tcpkillPath to the tcpkill binary

Default: /usr/sbin/tcpkill

--zookeeper_migration_wal_pathPath to zookeeper write-ahead-log file where migration state is recorded.

Default: /home/nutanix/data/zookeeper_migration.wal

--zookeeper_session_check_time_secsNumber of seconds zookeeper takes to verify and disconnect zookeeper quorum ip addresses thatare no longer valid.

Default: 10

--zookeeper_tcpkill_timeout_secsNumber of seconds to let tpckill to disconnect the tcp connections of zookeeper ensemble memberthat is to be removed.

Default: 10

cluster.genesis.node_manager

--auto_discovery_interval_secsNumber of seconds to sleep when local node can't join any discovered cluster.

Default: 5

--avahi_service_typeAvahi service type to publish under.

Default: _nutanix._tcp

--configure_iptables_with_stigIf True, then we will setup iptables to be STIG compliant.

Default: true

--default_ssh_keysSSH key used for logging into SVM.


--dhcp_ntp_confdhcp ntp configuration file.


Default: /var/lib/ntp/ntp.conf.dhcp

--download_staging_areaDirectory where we will download directories from other SVMs.

Default: /home/nutanix/tmp

--external_ntp_monitor_interval_secsNumber of seconds between each check of external NTP server.

Default: 600

--gold_image_version_pathPath to the file that contains the version of the gold image.

Default: /etc/nutanix/svm-version

--installer_dirPath to the directory where the installer is contained.

Default: /home/nutanix/data/installer

--nagios_config_pathPath to the nagios configuration file.

Default: /home/nutanix/serviceability/config/nagios3/nutanix_nagios.cfg

--node_disable_auto_upgrade_markerPath 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_markerPath to marker file to indicate that this node should be reconfigured.

Default: /home/nutanix/.node_reconfigure

--node_ssh_key_dirPath for node specific ssh keys on local disk

Default: /home/nutanix/ssh_keys/.blackbox

--node_unconfigure_markerPath to marker file to indicate that node is ready to be unconfigured.

Default: /home/nutanix/.node_unconfigure

--ntp_config_pathThe path to the configuration file for NTP.

Default: /etc/ntp.conf

--ntp_leader_znodeZookeeper node containing the IP address of the current Zookeeper leader.

Default: /appliance/logical/genesis/ntp_leader

--ntpdate_timeout_secsTime out to wait for ntp server to return a valid time.

Default: 10

--release_version_pathPath to the file that contains the local release version.

Default: /etc/nutanix/release_version

--rpm_genesis_log_filePath to rpm log file during Genesis self install.


Default: /home/nutanix/data/logs/rpm.genesis.out

--service_vm_config_json_pathPath to the service_vm_config.json file.

Default: /home/nutanix/data/stargate-storage/service_vm_config.json

--svm_external_netifExternal network interface of SVM to communicate with other SVMs.

Default: eth0

--svm_internal_ipsInternal 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_netifInternal network interface of the SVM to communicate with local hypervisor.

Default: eth1

--svm_internal_netif_netmaskThe netmask for the internal IP addresses on eth1.

Default: 255.255.255.128

--svm_non_ha_internal_netmaskThe netmask for the non-data internal IP aliases on eth1.

Default: 255.255.255.0

--svm_reboot_required_markerMarker file to indicate that SVM reboot is required and cluster services should not be started.

Default: /tmp/svm_reboot_required

--svm_reboot_suppressed_markerMarker file to indicate that SVM reboot is currently suppressed.

Default: /tmp/svm_reboot_suppressed

--time_rollback_tolerance_secsMaximum number of seconds by which NTP is allowed to roll back time on the system.

Default: 5

--zookeeper_start_timeout_secsTimeout for waiting on Zookeeper connection on startup.

Default: 120

cluster.genesis.server

--genesis_document_rootDocument root where static files are served from.

Default: /home/nutanix/cluster/www

nCLI Reference | Command Reference Guide | NOS 3.5 | 23

3nCLI Reference

alerts: Alert

Description An Alert

Alias alert

Operations • acknowledge | ack• history• list | ls• resolve

Acknowledge Alertsncli> alerts { acknowledge | ack } ids

Required arguments

idsA comma-separated list of ids of the Alerts

List history of Alertsncli> alerts history duration { acknowledged } { resolved } { max-alerts }

Required arguments

durationDuration (in days) for getting the history of Alerts

Optional arguments

acknowledgedInclude acknowledged Alerts?

Default: true

resolvedInclude resolved Alerts?

Default: true

max-alertsMaximum number of Alerts to fetch

Default: 100

List Alertsncli> alerts { list | ls } { acknowledged } { max-alerts }

Required arguments

None


Optional arguments

acknowledgedInclude acknowledged Alerts?

Default: true

max-alertsMaximum number of Alerts to fetch

Default: 100

Resolve Alertsncli> alerts resolve ids

Required arguments

idsA 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 Configurationncli> authconfig { create-directory | add-directory } name url domain { type } {connection-type }

Required arguments

nameName of the Directory Service

urlUrl to connect to the Directory Service

domainDomain of the Directory Service

Optional arguments

typeType of the Directory Service

connection-typeConnection type for the Directory Service

Update Authentication Configurationncli> authconfig { edit | update } { type } { enable-client-auth }


Required arguments

None

Optional arguments

typeComma-separated list of authentication types

enable-client-authIndication for the server to ask for client certificate

Update Directory Service Configurationncli> authconfig { edit-directory | update-directory } name { type } { connection-type} { url } { domain }

Required arguments


Optional arguments

typeType of the Directory Service

connection-typeConnection type for the Directory Service

urlUrl to connect to the Directory Service

domainDomain of the Directory Service

List Authentication Configurationncli> authconfig { list | ls }

Required arguments

None

List Authentication Configurationncli> authconfig { list-directory | ls-directory } { name }

Required arguments

None

Optional arguments


Remove Authentication Configurationncli> authconfig { remove | rm }

Required arguments

None

Remove Directory Service Configurationncli> authconfig { remove-directory | rm-directory } name


Required arguments


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 clusterncli> cluster add-node node-uuid

Required arguments

node-uuidUUID of the new node

Add public key to the clusterncli> cluster add-public-key name file-path

Required arguments

nameName of the cluster public key

file-pathFull path of the public key file

Add email addresses to the list of email alert contactsncli> cluster add-to-email-contacts email-addresses

Required arguments

email-addressesComma-separated list of email addresses to be included in the email alert contact list

Add addresses to the list of name serversncli> cluster add-to-name-servers servers

Required arguments

serversComma-separated list of IP addresses/Host names to be included in the name servers list

Add addresses to the list of NFS subnet whitelistncli> cluster add-to-nfs-whitelist ip-subnet-masks

Required arguments

ip-subnet-masksComma-separated list with entries of the form 'IP/subnet mask'(a.b.c.d/l.m.n.o) to be included inthe NFS subnet whitelist

Add addresses to the list of NTP serversncli> cluster add-to-ntp-servers servers

Required arguments

serversComma-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 supportncli> 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


Optional arguments

cvm-ipIP address of the controller VM

hypervisor-ipIP address of the Hypervisor Host

ipmi-ipIPMI address of the node

ipmi-netmaskIPMI netmask of the node

ipmi-gatewayIPMI gateway of the node

Discover new nodes available to add to the clusterncli> cluster discover-nodes

Required arguments

None

Edit params of a Clusterncli> cluster { edit-params | edit-info } { new-name } { support-verbosity-level }

Required arguments

None

Optional arguments

new-nameName of the cluster

support-verbosity-levelVerbosity level settings for populating support information

Execute the specified command in the clusterncli> cluster { execute-command | exec-cmd } name { args } { timeout }

Required arguments

nameName of the command to execute in the cluster

Optional arguments

argsArguments to be passed to the command

timeoutCommand execution timeout (secs)

Default: 0


Get email alerts status on a Clusterncli> cluster get-email-alerts-status

Required arguments

None

Get the list of email alert contactsncli> cluster get-email-contacts

Required arguments

None

Get the list of name serversncli> cluster get-name-servers

Required arguments

None

Get the list of NFS subnet whitelistncli> cluster get-nfs-whitelist

Required arguments

None

Get the list of NTP serversncli> cluster get-ntp-servers

Required arguments

None

Get params of a Clusterncli> cluster { get-params | info }

Required arguments

None

Get remote support status on a Clusterncli> cluster get-remote-support-status

Required arguments

None

Check the removal status for Physical Hostsncli> cluster { get-remove-status | get-rm-status } { id }

Required arguments

None

Optional arguments

idID of the Physical Host

Get Configuration parameters for sending stats to Nutanix home for offsite analyticsncli> cluster get-send-stats-params


Required arguments

None

Get configuration of SMTP Server used for transmitting alerts and report emails to Nutanix supportncli> cluster get-smtp-server

Required arguments

None

Get the list of public keys configured in the clusterncli> cluster { list-public-keys | ls-public-keys } { name }

Required arguments

None

Optional arguments


Remove all the public keys previously configured in the clusterncli> cluster { remove-all-public-keys | rm-all-public-keys }

Required arguments

None

Finish the process of removing a Physical Hostncli> cluster { remove-finish | rm-finish } id

Required arguments


Remove email addresses from the list of email alert contactsncli> cluster remove-from-email-contacts email-addresses

Required arguments

email-addressesComma-separated list of email addresses to be removed from the email alert contact list

Remove addresses from the list of name serversncli> cluster remove-from-name-servers servers

Required arguments

serversComma-separated list of IP addresses/Host names to be removed from the name servers list

Remove addresses from the list of NFS subnet whitelistncli> cluster remove-from-nfs-whitelist ip-subnet-masks

Required arguments

ip-subnet-masksComma-separated list with entries of the form 'IP/subnet mask' (a.b.c.d/l.m.n.o) to be removedfrom the NFS subnet whitelist


Remove addresses from the list of NTP serversncli> cluster remove-from-ntp-servers servers

Required arguments

serversComma-separated list of IP addresses/Host names to be removed from the NTP servers list

Delete public key with the specified name from the clusterncli> cluster { remove-public-key | rm-public-key } name

Required arguments


Begin the process of removing a Physical Hostncli> cluster { remove-start | rm-start delete } id { skip-space-check }

Required arguments


Optional arguments

skip-space-checkSkip checking storage space-related constraints when initiating removal of a host from thecluster

Default: false

Send an email to test the SMTP Server configurationncli> cluster send-test-email recipient subject

Required arguments

recipientRecipient of the test email

subjectSubject of the test email

Configure parameters for sending stats to Nutanix home for offsite analyticsncli> cluster set-send-stats-params { enable } { interval }

Required arguments

None

Optional arguments

enableWhether to enable sending of stats to Nutanix Home for offsite analytics

intervalInterval 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 supportncli> cluster set-smtp-server address { port } { username } { password } { security-mode}


Required arguments

addressFully Qualified Domain Name(FQDN) or IPv4 address of the SMTP Server

Optional arguments

portPort number of the SMTP Server. By default, port 25 is used

usernameUsername to access the SMTP Server

passwordPassword to access the SMTP Server

security-modeSecurity mode used by SMTP Server for data encryption and authentication. SMTP Server inNutanix cluster can be configured with one of the following mode: 'none', 'ssl' or 'starttls'

Default: none

Start all services in the clusterncli> cluster start

Required arguments

None

Start email alerts on a Clusterncli> cluster start-email-alerts { duration }

Required arguments

None

Optional arguments

durationTime (in minutes) to keep email alerts enabled

Default: 0

Start remote support on a Clusterncli> cluster start-remote-support { duration }

Required arguments

None

Optional arguments

durationTime (in minutes) to keep remote support enabled

Default: 0

Get the status of all services in the clusterncli> cluster status

Required arguments

None

Stop all services in the cluster


ncli> cluster stop

Required arguments

None

Stop email alerts on a Clusterncli> cluster stop-email-alerts { duration }

Required arguments

None

Optional arguments

durationTime (in minutes) to keep email alerts disabled

Default: 0

Stop remote support on a Clusterncli> cluster stop-remote-support { duration }

Required arguments

None

Optional arguments

durationTime (in minutes) to keep remote support disabled

Default: 0

Get version of software running on a Clusterncli> 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 whitelistncli> container add-to-nfs-whitelist ip-subnet-masks { id } { name }


Required arguments

ip-subnet-masksComma-separated list with entries of the form 'IP/subnet mask'(a.b.c.d/l.m.n.o) to be included inthe Storage Container's NFS subnet whitelist

Optional arguments

idID of the Storage Container

nameName of the Storage Container

Create a new Storage Containerncli> 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


Optional arguments

res-capacityExplicit reserved Capacity (GB) of the Storage Container

sp-idID of the Storage Pool for the Storage Container

sp-nameName of the Storage Pool for the Storage Container

random-io-priority-orderComma seperated random I/O priority order (high to low) of Storage Tiers in a StorageContainer

sequential-io-priority-orderComma seperated sequential I/O priority order (high to low) of Storage Tiers in a StorageContainer

enable-oplog-haEnable high-availability of the oplog (through replication) for a Storage Container?

Default: true

enable-compressionEnable or disable compression on a Storage Container {true, false}

Default: false

fingerprint-on-writeFingerprint on writes to the Storage Container {on, off, none}

compression-delayTime delay in minutes for compressing/uncompressing the data on Storage Container


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



new-nameName of the Storage Container

res-capacityExplicit reserved Capacity (GB) of the Storage Container

random-io-priority-orderComma seperated random I/O priority order (high to low) of Storage Tiers in a StorageContainer

sequential-io-priority-orderComma seperated sequential I/O priority order (high to low) of Storage Tiers in a StorageContainer

enable-oplog-haEnable high-availability of the oplog (through replication) for a Storage Container?

enable-compressionEnable or disable compression on a Storage Container {true, false}

compression-delayTime delay in minutes for compressing/uncompressing the data on Storage Container

fingerprint-on-writeFingerprint on writes to the Storage Container {on, off, none}


Get the down-migrate times (in minutes) for Storage Tiers in a Storage Containerncli> container { get-down-migrate-times | get-dm-times } { id } { name }

Required arguments

None

Optional arguments



List Storage Containersncli> container { list | ls } { id } { name }


Required arguments

None

Optional arguments



Get stats data for Storage Containersncli> container { list-stats | ls-stats } { id } { name }

Required arguments

None

Optional arguments



Delete a Storage Containerncli> container { remove | rm } { id } { name } { ignore-small-files }

Required arguments

None

Optional arguments



ignore-small-filesIgnores all the small files on the Storage Container {true, false} while marking for removal

Default: false

Remove addresses from Storage Container's NFS subnet whitelistncli> container remove-from-nfs-whitelist ip-subnet-masks { id } { name }

Required arguments


Optional arguments



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-namesA comma-separated list of Storage Tiers

Optional arguments



time-in-minTime 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

nameName of the Datastore

ctr-nameName of the Storage Container

Optional arguments

host-idsA comma-separated list of the ids of the Physical Hosts (default = Includes all hosts)

read-onlyWhether a Physical Host must have only read-only access to the Datastore

Default: false

Delete the NFS datastore on the Physical Hostsncli> datastore { delete | remove rm } name { host-ids }

Required arguments

nameName of the Datastore


Optional arguments

host-idsA comma-separated list of the ids of the Physical Hosts (default = Includes all hosts)

List NFS Datastoresncli> datastore { list | ls }

Required arguments

None

disk: Physical Disk

Description A Physical Disk

Alias None

Operations • edit | update• get-remove-status | get-rm-status• list | ls• list-free | ls-free• list-stats | ls-stats• mark-online• remove-cancel | rm-cancel• remove-finish | rm-finish• remove-start | rm-start delete

Edit a Physical Diskncli> disk { edit | update } id { tier-name }

Required arguments

idID of the Physical Disk

Optional arguments

tier-nameCorresponding Storage Tier

Check the removal status for Physical Disksncli> disk { get-remove-status | get-rm-status } { id }

Required arguments

None

Optional arguments


List Physical Disksncli> disk { list | ls } { id } { sp-id } { sp-name } { tier-name }

Required arguments

None


Optional arguments


sp-idID of the Storage Pool for the Physical Disk

sp-nameName of the Storage Pool for the Physical Disk


List Physical Disks that are not assigned to any Storage Poolncli> disk { list-free | ls-free }

Required arguments

None

Get stats data for Physical Disksncli> disk { list-stats | ls-stats } { id } { sp-id } { tier-name }

Required arguments

None

Optional arguments


sp-idID of the Storage Pool for the Physical Disk


Mark a Physical Disk onlinencli> disk mark-online id

Required arguments


Cancel the process of removing a Physical Diskncli> disk { remove-cancel | rm-cancel } id

Required arguments


Complete the process of removing a Physical Diskncli> disk { remove-finish | rm-finish } id

Required arguments


Begin the process of removing a Physical Disk


ncli> disk { remove-start | rm-start delete } id { force }

Required arguments


Optional arguments

forceForcefully 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• get-remove-status | get-rm-status• list | ls• list-hadatacenters | ls-hadatacenters• list-stats | ls-stats• remove-finish | rm-finish• remove-start | rm-start delete• set-monitoring

Create a new HAClusterncli> host add-hacluster ms-name datacenter-name cluster-name

Required arguments

ms-nameName of the Management Server

datacenter-nameName of an HADatacenter

cluster-nameName of an HACluster

Add host to anHAClusterncli> host add-host-to-ha-cluster ms-name datacenter-name cluster-name host-addresshost-username host-password

Required arguments




cluster-nameName of an HACluster

host-addressIP address of a Physical Host

host-usernameUsername of the Hypervisor

host-passwordPassword of the Hypervisor

Add the configured node to the clusterncli> host add-node node-uuid

Required arguments


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


Optional arguments

cvm-ipIP address of the controller VM

hypervisor-ipIP address of the Hypervisor Host

ipmi-ipIPMI address of the node

ipmi-netmaskIPMI netmask of the node

ipmi-gatewayIPMI gateway of the node

Discover new nodes available to add to the clusterncli> host discover-nodes

Required arguments

None

Edit Physical Hostncli> host { edit | update } id { hypervisor-username } { hypervisor-password } { new-ms-name } { oplog-disk-pct } { ipmi-username } { ipmi-password }

Required arguments



Optional arguments

hypervisor-usernameUsername to access the Hypervisor Host

hypervisor-passwordPassword to access the Hypervisor Host

new-ms-nameName of the Management Server

oplog-disk-pctThe percentage of the oplog-disk to use for oplog data

ipmi-usernameUsername for IPMI access to a Physical Host

ipmi-passwordPassword for IPMI access to a Physical Host

Enable metadata store on a Physical Hostncli> host enable-metadata-store id

Required arguments


Check the removal status for Physical Hostsncli> host { get-remove-status | get-rm-status } { id }

Required arguments

None

Optional arguments


List Physical Hostsncli> host { list | ls } { id }

Required arguments

None

Optional arguments


List HADatacenter(s)ncli> host { list-hadatacenters | ls-hadatacenters } ms-name { datacenter-name }

Required arguments


Optional arguments



Get stats data for Physical Hostncli> host { list-stats | ls-stats } { id }

Required arguments

None

Optional arguments


Finish the process of removing a Physical Hostncli> host { remove-finish | rm-finish } id

Required arguments


Begin the process of removing a Physical Hostncli> host { remove-start | rm-start delete } id { skip-space-check }

Required arguments


Optional arguments

skip-space-checkSkip checking storage space-related constraints when initiating removal of a host from thecluster

Default: false

Set the monitoring status of Physical Hostsncli> host set-monitoring enabled ids

Required arguments

enabledEnable monitoring of Physical Hosts?

idsA 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 Proxyncli> http-proxy add name ip-address port { username } { password }


Required arguments

nameName of the HTTP Proxy

ip-addressIP Address of the HTTP Proxy

portPort number of the HTTP Proxy

Optional arguments

usernameUsername to access the HTTP Proxy

passwordPassword to access the HTTP Proxy

Edit an HTTP Proxyncli> http-proxy { edit | update } name { ip-address } { username } { password } { port}

Required arguments


Optional arguments

ip-addressIP Address of the HTTP Proxy

usernameUsername to access the HTTP Proxy

passwordPassword to access the HTTP Proxy

portPort number of the HTTP Proxy

List HTTP Proxiesncli> http-proxy { list | ls } { name }

Required arguments

None

Optional arguments


Remove an HTTP Proxyncli> http-proxy { remove | rm } { name }

Required arguments

None

Optional arguments



managementserver: Management Server

Description An infrastructure management server such asVCenter

Alias ms

Operations • add• edit | update• list | ls• list-types | ls-types• remove | rm• rename

Add a new Management Serverncli> managementserver add name url username password

Required arguments

nameName of the Management Server

urlAccess URL of the Management Server

usernameUsername for access to the Management Server

passwordPassword for access to the Management Server

Add a new Management Serverncli> managementserver { edit | update } name { url } { username } { password }

Required arguments


Optional arguments

urlAccess URL of the Management Server

usernameUsername for access to the Management Server

passwordPassword for access to the Management Server

List Management Serversncli> managementserver { list | ls } { name }

Required arguments

None


Optional arguments


List Management Serversncli> managementserver { list-types | ls-types }

Required arguments

None

Delete a Management Serverncli> managementserver { remove | rm } name

Required arguments


Rename a Management Serverncli> managementserver rename name new-name

Required arguments


new-nameNew name of the Management Server

protection-domain: Protection domain

Description A protection domain to be used for disasterrecovery 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 domainncli> protection-domain { abort-replication | abort-repl } name replication-ids

Required arguments

nameName of the Protection domain

replication-idsList of comma-separated identifier of replications

Mark Protection domain as activencli> protection-domain activate name { snap-id }

Required arguments


Optional arguments

snap-idId of the Snapshot to be restored while making Protection domain as active. By default, latestsnapshot is restored.

Create a new out of band snapshot schedule in a Protection domain to take a snapshot at a specified timencli> protection-domain { add-one-time-snapshot | create-one-time-snapshot } name {snap-time } { remote-sites } { retention-time }

Required arguments


Optional arguments

snap-timeSpecify time in format MM/dd/yyyy [HH:mm:ss [z]] at which snapshot is to be taken. If notspecified, snapshot will be taken immediately

remote-sitesComma-separated list of Remote Site to which snapshots are replicated. If not specified, remotereplication is not performed

retention-timeNumber of seconds to retain the snapshot. Aged snapshots will be garbage collected. Bydefault, snapshot is retained forever

Create a new active Protection domainncli> protection-domain { create | add } name


Required arguments


Mark Protection domain as inactivencli> protection-domain deactivate name

Required arguments


List all Protection domainsncli> protection-domain { list | ls } { name }

Required arguments

None

Optional arguments


Get the status of replication in a Protection domainncli> protection-domain { list-replication-status | ls-repl-status } { name }

Required arguments

None

Optional arguments


List Snapshots of a Protection domainncli> protection-domain { list-snapshots | ls-snaps } { name } { snap-id }

Required arguments

None

Optional arguments


snap-idId of the Snapshot

List all pending actions for Protection domainsncli> protection-domain ls-pending-actions { name }

Required arguments

None

Optional arguments


List out of band snapshot schedules of Protection domains


ncli> protection-domain ls-pending-one-time-snapshots { name }

Required arguments

None

Optional arguments


Get periodic snapshot schedule of Protection domainsncli> protection-domain { ls-schedule | ls-sched } { name }

Required arguments

None

Optional arguments


Mark Protection domain as inactive and failover to the specified Remote Sitencli> protection-domain migrate name remote-site

Required arguments


remote-siteRemote Site to be used for planned failover

Pause replications of a Protection domainncli> protection-domain { pause-replication | pause-repl } name replication-ids

Required arguments



Add Virtual Machines and NFS files to a Protection domainncli> protection-domain protect name { vm-names } { ctr-id } { host-id } { files } { cg-name } { ignore-duplicates }

Required arguments


Optional arguments

vm-namesComma-separated list of Virtual Machine names to be added in Protection domain

ctr-idAdd all Virtual Machines in a Storage Container to a Protection domain

host-idAdd all Virtual Machines in a Physical Host to a Protection domain


filesComma-separated list of NFS files to be added in Protection domain

cg-nameName of the Consistency group to which Virtual Machines are added. If not specified, eachVirtual Machines is added to a Consistency group which has same name as the Virtual Machinename

ignore-duplicatesWhether to ignore if any of the specified Virtual Machines already exist in the specifiedProtection domain

Default: true

Mark a Protection domain for removal. Protection domain will be removed from the appliance when alloutstanding operations on it are cancelledncli> protection-domain { remove | rm } name

Required arguments


Resume previously paused replications of a Protection domainncli> protection-domain { resume-replication | resume-repl } name replication-ids

Required arguments



Retain snaphots forever of a Protection domainncli> protection-domain { retain-snapshot | retain-snap } name snap-ids

Required arguments


snap-idsList of comma-separated identifier of Snapshots

Remove out of band snapshot schedules from a Protection domainncli> protection-domain rm-one-time-schedules name schedule-ids

Required arguments


schedule-idsList of comma-separated identifier of Out of band schedules

Set the periodic snapshot schedule of a Protection domainncli> protection-domain rm-schedule name

Required arguments



Remove snaphots of a Protection domainncli> protection-domain { rm-snapshot | rm-snap } name snap-ids

Required arguments


snap-idsList of comma-separated identifier of Snapshots

Rollback NFS files to a Snapshotncli> protection-domain rollback-nfs-files name files snap-id { replace-nfs-files } {path-prefix }

Required arguments


filesComma-separated list of NFS files to be restored

snap-idId of the Snapshot to be used for rollback

Optional arguments

replace-nfs-filesWhether the restored NFS files replace their corresponding live NFS files. If set to false, thenthe parameter path-prefix must be specified

Default: false

path-prefixThe path prefix that apply to the restored file paths. For example, if restoring file '/ctr/dir/file' witha prefix of '/prefix', then the restored files will be put in path '/ctr/prefix/dir/file'. If empty, then nopath prefix will be applied.

Rollback an active Protection domain to a snapshotncli> protection-domain rollback-pd name snap-id

Required arguments


snap-idSnapshot to which Protection domain is to be rollbacked

Rollback Virtual Machines to a Snapshotncli> protection-domain rollback-vms name vm-names snap-id { replace-vms } { path-prefix }

Required arguments


vm-namesComma-separated list of Virtual Machine ids to be restored

snap-idId of the Snapshot to be used for rollback


Optional arguments

replace-vmsWhether the restored Virtual Machines replace their corresponding live Virtual Machines. If setto false, then the parameter path-prefix must be specified

Default: false

path-prefixThe path prefix that apply to the restored file paths. For example, if restoring file '/ctr/dir/file' witha prefix of '/prefix', then the restored files will be put in path '/ctr/prefix/dir/file'. If empty, then nopath prefix will be applied.

Set the periodic snapshot schedule of a Protection domainncli> protection-domain set-schedule name retention-policy { start-time } { interval }{ min-snap-retention-count } { remote-sites } { remote-factors }

Required arguments


retention-policyComma-separated series of entries of the form <factor>:<quantity> to specify the retentionpolicy for the schedule. If factor=X and quantity=N, then the last N of every Xth snapshot takenis retained. Thus, if snapshot_interval_secs=60, and factor=30 and quantity=5, then last 5snapshots taken at half hour intervals are retained. The first entry for factor in retention-policymust be 1

Optional arguments

start-timeSpecify time in format MM/dd/yyyy [HH:mm:ss [z]] at which the schedule become active. If notspecified, schedule will become active immediately

intervalInterval in seconds at which periodic snapshots are taken. If not specified, default value will beset by Nutanix

min-snap-retention-countMinimum number of snapshots to retain. It is also applicable to out of band snapshots

Default: 5

remote-sitesComma-separated list of Remote Site to which snapshots are replicated

remote-factorsRemote factor list determines which of the periodic snapshots taken get transferred to thecorresponding 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 matchthe size of list specified for remote-sites. If not specified, every snapshot is transferred to allspecified remote sites

Mark Virtual Machines and NFS files for removal from a given Protection domain. They will be removed when alloutstanding operations on them are completed/cancelledncli> protection-domain unprotect name { files } { vm-names }

Required arguments



Optional arguments

filesComma-separated list of NFS files to be removed from Protection domain

vm-namesComma-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 unitncli> rackable-unit { edit | update } id location

Required arguments

idId of the Rackable unit

locationLocation of the Rackable unit

List Rackable unitncli> rackable-unit { list | ls }

Required arguments

None

Remove a Rackable unitncli> rackable-unit { remove | rm } id

Required arguments

idId of the Rackable unit

remote-site: Remote Site

Description A remote cluster to be used for replicating data

Alias rs

Operations • create | add• 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

nameName of the Remote Site

address-listList 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-bandwidthMaximum bandwidth (in kilobytes per sec) to be used while replicating to the remote site. If notspecified, restriction is not placed on maximum bandwidth used by replication

enable-proxyBoolean parameter to indicate whether the addresses specified in address-list can be used as aproxy to communicate with other Nutanix components on the remote site

enable-compressionEnable or disable compression of data during replication

vstore-mapBy 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, providecomma-separated list of <local vStore>:<target vStore> mapping. Mapping is not required if thenames of local and target vStore are same

Edit a Remote Sitencli> remote-site { edit | update } name { max-bandwidth } { enable-proxy } { enable-compression } { address-add } { address-del } { vstore-map-add } { vstore-map-del }

Required arguments


Optional arguments

max-bandwidthMaximum bandwidth (in kilobytes per sec) to be used while replicating to the remote site. If notspecified, restriction is not placed on maximum bandwidth used by replication

enable-proxyBoolean parameter to indicate whether the addresses specified in address-list can be used as aproxy to communicate with other Nutanix components on the remote site

enable-compressionEnable or disable compression of data during replication

address-addAddress to be included in the remote site address list. Address should be of the format <ip> orof the format <ip:port> and should conform to the format of the current remote site address list

address-delAddress to be removed from the remote site address list. Port number, if provided, is ignored

vstore-map-addEntry of the form <local vStore>:<target vStore> to be included in the vStore replication map. Ifmapping for a local vStore already exists, mapping is updated with the the new target vStore


vstore-map-delEntry of the form <local vStore>:<target vStore> to be removed from the vStore replication map

List Remote Sitesncli> remote-site { list | ls } { name }

Required arguments

None

Optional arguments


Mark a Remote Site for removal. Site will be removed from the appliance when all outstanding operations that areusing the remote site are cancelledncli> remote-site { remove | rm } name

Required arguments


servicecenter: Service Center

Description A Service Center

Alias sc

Operations • add• edit | update• list | ls• remove | rm

Create a new Service Centerncli> servicecenter add name username ip-address port

Required arguments

nameName of the Service Center

usernameUsername to access the Service Center

ip-addressIP Address of the Service Center

portPort number of the Service Center

Edit a Service Centerncli> servicecenter { edit | update } name { ip-address } { username } { port }

Required arguments



Optional arguments

ip-addressIP Address of the Service Center

usernameUsername to access the Service Center

portPort number of the Service Center

List Service Centersncli> servicecenter { list | ls } { name }

Required arguments

None

Optional arguments


Remove a Service Centerncli> servicecenter { remove | rm } name

Required arguments


snapshot: Snapshot

Description Snapshot of a Virtual Disk

Alias snap

Operations • clone• create | add• list | ls• list-stats | ls-stats• remove | rm

Create a (fast) clone based on a Snapshotncli> snapshot clone { name } { clone-names } { src-file } { dest-files } { allow-overwrite }

Required arguments

None

Optional arguments

nameName of the Snapshot

clone-namesA comma-separated list of names for the newly created Snapshots

src-fileAbsolute path of the NFS snapshot file


dest-filesAbsolute path(s) of the clone(s) to be created

allow-overwriteEnable overwriting if a NFS file already exists in the destination path

Default: false

Create a new Snapshot of a Virtual Disk or a NFS filencli> snapshot { create | add } { name } { vdisk-name } { src-file } { dest-file } {allow-overwrite }

Required arguments

None

Optional arguments

nameName 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-nameName of the Virtual Disk

src-fileAbsolute path of the NFS snapshot file

dest-fileAbsolute path of the snapshot file to be created

allow-overwriteEnable overwriting if a NFS file already exists in the destination path

Default: false

List Snapshotsncli> snapshot { list | ls } { name } { vdisk-name }

Required arguments

None

Optional arguments


vdisk-nameName of the corresponding Virtual Disk

Get stats data for Snapshotsncli> snapshot { list-stats | ls-stats } { name } { vdisk-name }

Required arguments

None

Optional arguments


vdisk-nameName of the corresponding Virtual Disk


Delete a Snapshotncli> snapshot { remove | rm } name

Required arguments


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 pairncli> snmp add-transport protocol port

Required arguments

protocolProtocol for the snmp agent or trap sink. Currently supported protocols are UDP, TCP andUDP_6

portPort 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 andauthentication informationncli> snmp add-trap username address { port } { protocol } { engine-id } { inform }

Required arguments

usernameIdentity of an snmp user

addressAddress of an snmp trap sink. This should be an IP address or FQDN

Optional arguments




engine-idEngine id of the snmp trap sink. This must be a hex string starting with 0x

informFlag that specifies whether a trap sink is actually an inform sink

Default: false

Add an snmp user along with its authentication and privacy keysncli> snmp add-user username auth-key auth-type { priv-key } { priv-type }

Required arguments


auth-keyAuthentication key for an snmp user

auth-typeAuthentication type for snmp user. Can be MD_5 or SHA

Optional arguments

priv-keyEncryption key for an snmp user

priv-typeEncryption 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 privacysettings and protocolncli> snmp { edit-trap | update-trap } address { port } { protocol } { engine-id } {inform }

Required arguments


Optional arguments



engine-idEngine id of the snmp trap sink. This must be a hex string starting with 0x

informFlag that specifies whether a trap sink is actually an inform sink

Modify the authentication and encrytption information of an existing snmp userncli> snmp { edit-user | update-user } username { auth-key } { auth-type } { priv-key }{ priv-type }


Required arguments


Optional arguments

auth-keyAuthentication key for an snmp user

auth-typeAuthentication type for snmp user. Can be MD_5 or SHA

priv-keyEncryption key for an snmp user

priv-typeEncryption type for an snmp user. Can be DES or AES

Returns the status of the snmp servicencli> snmp get-status

Required arguments

None

List all the transports specified for the snmp agent. Each transport is a protocol:port pairncli> 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


Lists all the snmp users along with their properties like authentication and privacy informationncli> snmp { list-users | ls-users } { username }

Required arguments

None

Optional arguments


Remove a transport from the list of snmp transportsncli> snmp { remove-transport | delete-transport } protocol port

Required arguments




Remove a trap from the list of snmp trapsncli> snmp { remove-trap | delete-trap } address

Required arguments


Remove a user from the list of snmp usersncli> snmp { remove-user | delete-user } username

Required arguments


Sets the status of the snmp servicencli> snmp set-status enable

Required arguments

enableEnable or disable snmp agent on a cluster {true, false}

storagepool: Storage Pool

Description A Pool of Physical Disks

Alias sp

Operations • create | add• edit | update• list | ls• list-stats | ls-stats• remove | rm

Create a new Storage Poolncli> storagepool { create | add } name { disk-ids } { add-all-free-disks } { ilm-thresh } { force }

Required arguments

nameName of the Storage Pool

Optional arguments

disk-idsIDs of Physical Disk in the Storage Pool

add-all-free-disksAdd all free disks that are not part of any storage pool?

ilm-threshILM down-migrate (%) threshold for a Storage Pool



Default: false

Edit a Storage Poolncli> 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

idID of the Storage Pool


new-nameName of the Storage Pool

add-all-free-disksAdd all free disks that are not part of any storage pool?

add-disk-idsA comma-separated list of Physical Disk IDs to be added to the Storage Pool

rm-disk-idsA comma-separated list of Physical Disk IDs to be removed from the Storage Pool

ilm-threshILM down-migrate (%) threshold for a Storage Pool


Default: false

List Storage Poolsncli> storagepool { list | ls } { id } { name }

Required arguments

None

Optional arguments



Get stats data for Storage Poolsncli> storagepool { list-stats | ls-stats } { id } { name }

Required arguments

None


Optional arguments



Delete a Storage Poolncli> storagepool { remove | rm } { id } { name }

Required arguments

None

Optional arguments



storagetier: Storage Tier

Description A Tier of physical storage

Alias tier

Operations • create | add• 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 Tierncli> storagetier { create | add } name type

Required arguments

nameName of the Storage Tier

typeType of Storage Tier (as provided by the 'list-types' operation)

List the (global) default I/O priority order of Storage Tiersncli> storagetier { get-default-io-priority-order | get-def-io-pri }

Required arguments

None

List Storage Tiersncli> storagetier { list | ls } { name } { type }


Required arguments

None

Optional arguments


typeType of Storage Tier (as provided by the 'list-types' operation)

List types of Storage Tiersncli> storagetier { list-types | ls-types }

Required arguments

None

Remove a Storage Tierncli> storagetier { remove | rm } name

Required arguments


Set the (global) default I/O priority order of Storage Tiersncli> storagetier { set-default-io-priority-order | set-def-io-pri } random-io-priority-order sequential-io-priority-order

Required arguments

random-io-priority-orderRandom I/O priority order (high to low) of Storage Tiers

sequential-io-priority-orderSequential 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 Userncli> user change-password current-password new-password

Required arguments

current-passwordCurrent password of the user

new-passwordNew password of the user

Add a new Userncli> user { create | add } user-name user-password first-name last-name email-id {middle-initial }

Required arguments

user-nameUser name of the user

user-passwordPassword of the user

first-nameFirst name of the user

last-nameLast name of the user

email-idEmail address of the user

Optional arguments

middle-initialMiddle Initial of the user

Delete a Userncli> user { delete | remove rm } user-name

Required arguments


Disable a Userncli> user disable user-name

Required arguments


Edit a Userncli> user { edit | update } user-name { first-name } { last-name } { middle-initial }{ email-id }

Required arguments



Optional arguments

first-nameFirst name of the user

last-nameLast name of the user

middle-initialMiddle Initial of the user

email-idEmail address of the user

Enable a Userncli> user enable user-name

Required arguments


Grant cluster administration role to a Userncli> user grant-cluster-admin-role user-name

Required arguments


Grant user administration role to a Userncli> user grant-user-admin-role user-name

Required arguments


List Usersncli> user { list | ls } { user-name }

Required arguments

None

Optional arguments


Reset the password of a Userncli> user reset-password user-name

Required arguments


Revoke cluster administration role from a Userncli> user revoke-cluster-admin-role user-name


Required arguments


Revoke user administration role from a Userncli> user revoke-user-admin-role user-name

Required arguments


Show profile of current Userncli> 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• list-stats | ls-stats• remove | rm• snapshot | snap

Create a (fast) clone of a Virtual Diskncli> vdisk clone name clone-names { snap-name }

Required arguments

nameName of the Virtual Disk

clone-namesA comma-separated list of names for the newly created Snapshots

Optional arguments

snap-nameName of the Snapshot on which the clone is based

Create a new Virtual Diskncli> vdisk { create | add } name max-capacity { ctr-id } { ctr-name } { res-capacity }{ fingerprint-on-write } { shared }

Required arguments



max-capacityMax Capacity (GB) of the Virtual Disk

Optional arguments

ctr-idID of the Storage Container for the Virtual Disk

ctr-nameName of the Storage Container for the Virtual Disk

res-capacityReserved Capacity (GB) of the Virtual Disk

fingerprint-on-writeFingerprint on writes to the Virtual Disk {on, off, none}. This VDisk level setting overrides thecontainer level setting

sharedIs this a shared Virtual Disk?

Default: false

Edit a Virtual Diskncli> vdisk { edit | update } name { max-capacity } { res-capacity } { fingerprint-on-write }

Required arguments


Optional arguments

max-capacityMax Capacity (GB) of the Virtual Disk

res-capacityReserved Capacity (GB) of the Virtual Disk

fingerprint-on-writeFingerprint on writes to the Virtual Disk {on, off, none}. This VDisk level setting overrides thecontainer level setting

List Virtual Disksncli> vdisk { list | ls } { names } { vm-id } { ctr-id }

Required arguments

None

Optional arguments

namesA comma-separated list of the names of the Virtual Disks

vm-idID of a Virtual Machine that the Virtual Disk is mapped to

ctr-idGet Virtual Disks in the specified Storage Container

List Snapshotsncli> vdisk { list-snapshots | ls-snaps } name


Required arguments


Get stats data for Virtual Disksncli> vdisk { list-stats | ls-stats } { names } { vm-id } { ctr-id }

Required arguments

None

Optional arguments

namesA comma-separated list of the names of the Virtual Disks

vm-idID of a Virtual Machine that the Virtual Disk is mapped to

ctr-idGet Virtual Disks in the specified Storage Container

Delete a Virtual Diskncli> vdisk { remove | rm } name

Required arguments


Create a new Snapshot of a Virtual Diskncli> vdisk { snapshot | snap } name { snap-name }

Required arguments


Optional arguments

snap-nameName of the Snapshot

virtualmachine: Virtual Machine

Description A Virtual Machine

Alias vm

Operations • list | ls• list-stats | ls-stats

List Virtual Machinencli> virtualmachine { list | ls } { name } { host-id } { get-unprotected-cbr-vms-only}

Required arguments

None


Optional arguments

nameName of the Virtual Machine

host-idID of the Physical Host running Virtual Machines

get-unprotected-cbr-vms-onlyGet only unprotected Virtual Machines that can participate in Nutanix Converged Backup andRecovery?

Default: false

Get stats data for Virtual Machinencli> virtualmachine { list-stats | ls-stats } { name } { host-id }

Required arguments

None

Optional arguments

nameName of the Virtual Machine

host-idID 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 vZonencli> vzone add-hosts name host-ids

Required arguments

nameName of the vZone

host-idsA comma-separated list of the ids of the Physical Hosts

Add Virtual Disks to a vZonencli> vzone add-vdisks name vdisk-names


Required arguments


vdisk-namesA comma-separated list of the names of the Virtual Disks

Create a new vZonencli> vzone { create | add } name

Required arguments


List vZonesncli> vzone { list | ls } { name }

Required arguments

None

Optional arguments


Delete avZonencli> vzone { remove | rm } name

Required arguments


Remove allVirtual Disks from a vZonencli> vzone remove-all-vdisks name

Required arguments


Remove Physical Hosts from a vZonencli> vzone remove-hosts name host-ids

Required arguments


host-idsA comma-separated list of the ids of the Physical Hosts

Remove Virtual Disks from a vZonencli> vzone remove-vdisks name vdisk-names

Required arguments



vdisk-namesA comma-separated list of the names of the Virtual Disks

Sync HACluster(s) with vZonesncli> vzone sync-haclusters ms-name datacenter-name

Required arguments



vstore: VStore

Description A file namespace in a container

Alias None

Operations • create | add• list | ls• protect• remove | rm• unprotect

Create a new VStorencli> vstore { create | add } { ctr-id } { ctr-name }

Required arguments

None

Optional arguments

ctr-idID of a Storage Container for the VStore

ctr-nameName of a Storage Container for the VStore

List VStoresncli> vstore { list | ls } { id } { name }

Required arguments

None

Optional arguments

idID of a VStore

nameName of a VStore

Protect a VStore. Files in a protected VStore are replicated to a Remote Site at a defined frequency and theseprotected files can be recovered in the event of a disasterncli> vstore protect { id } { name }


Required arguments

None

Optional arguments

idID of a VStore


Delete a VStorencli> vstore { remove | rm } { id } { name } { force }

Required arguments

None

Optional arguments

idID of a VStore


forceDelete a VStore

Default: false

Unprotect a VStorencli> vstore unprotect { id } { name }

Required arguments

None

Optional arguments

idID of a VStore
