ESXCLI Commands
esxcli vsan Commands
Command | Description | Options Help |
---|---|---|
vsan cluster get | Get information about the vSAN cluster that this host is joined to. |
|
vsan cluster join | Join the host to a vSAN cluster. |
|
vsan cluster leave | Leave the vSAN cluster the host is currently joined to. |
|
vsan cluster new | Create a vSAN cluster with current host joined. A random sub-cluster UUID will be generated. |
|
vsan cluster restore | Restore the persisted vSAN cluster configuration. |
|
vsan cluster preferredfaultdomain get | Get the preferred fault domain for a stretched cluster. |
|
vsan cluster preferredfaultdomain set | Set the preferred fault domain for a stretched cluster. |
|
vsan cluster unicastagent add | Add a unicast agent to the vSAN cluster configuration. |
|
vsan cluster unicastagent clear | Removes all unicast agents in the vSAN cluster configuration. |
|
vsan cluster unicastagent list | List all unicast agents in the vSAN cluster configuration. |
|
vsan cluster unicastagent remove | Remove a unicast agent from the vSAN cluster configuration. |
|
vsan cmmds timemachine get | Get vSAN CMMDS time machine configuration. |
|
vsan cmmds timemachine set | Configure vSAN CMMDS time machine. |
|
vsan datastore add | Add a new datastore to the vSAN cluster. This operation may be used to add either a new local datastore or a remote datastore. Adding local datastore is only allowed if vSAN is enabled on the host. In general, add should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync. |
|
vsan datastore clear | Remove all but the default datastore from the vSAN cluster. This operation is only allowed if vSAN is enabled on the host. In general, clear should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync. |
|
vsan datastore list | List datastores in the vSAN cluster. |
|
vsan datastore remove | Remove a datastore from the vSAN cluster. This operation is only allowed if vSAN is enabled on the host. In general, remove should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync. |
|
vsan datastore name get | Get vSAN datastore name. |
|
vsan datastore name set | Configure vSAN datastore name. In general, rename should always be done at cluster level. Across a vSAN cluster vSAN datastore name should be in sync. |
|
vsan debug advcfg list | List all advanced configuration options with non-default values. |
|
vsan debug controller list | Print detailed information about all vSAN disk controllers (output may change between releases) |
|
vsan debug disk list | Print detailed information about all vSAN disks in the cluster. |
|
vsan debug disk overview | Print overview information about all vSAN disks in the cluster. |
|
vsan debug disk summary get | Print summary information about all vSAN disks in the cluster. |
|
vsan debug evacuation precheck | Examine what it takes if an entity (disk group or host) is evacuated in various modes (Action). The result is accurate when all hosts in the vSAN cluster are of the same version and have the same disk format. |
|
vsan debug limit get | Print summary information about vSAN limits (output may change between releases) |
|
vsan debug memory list | Print both userworld and kernel memory consumptions of vSAN. |
|
vsan debug mob start | Start vSAN Managed Object Browser Service. |
|
vsan debug mob status | Query vSAN Managed Object Browser Service is running or not. |
|
vsan debug mob stop | Stop vSAN Managed Object Browser Service. |
|
vsan debug object list | Print detailed information about vSAN objects in the cluster. This command would only show 100 objects at most by default. |
|
vsan debug object overview | Print overview information about all vSAN objects in the cluster. This command would only show 100 objects at most by default. |
|
vsan debug object health summary get | Print health summary information about all vSAN objects in the cluster (output may change between releases) |
|
vsan debug resync list | Print detailed information about vSAN resyncing objects (output may change between releases) |
|
vsan debug resync summary get | Print summary information about vSAN resyncing objects (output may change between releases) |
|
vsan debug vmdk list | Print summary information about VMDKs on local vSAN datastore (output may change between releases) |
|
vsan encryption cert get | Get encryption KMS server certificate contents. |
|
vsan encryption cert path list | List encryption certificate file paths. |
|
vsan encryption hostkey get | Get host key from keycache used for vSAN encryption. |
|
vsan encryption info get | Get vSAN encryption infomation. |
|
vsan encryption kms list | List the KMS configurations used for vSAN encryption. |
|
vsan faultdomain get | Get the fault domain name for this host. |
|
vsan faultdomain reset | Reset Host fault domain to default value |
|
vsan faultdomain set | Set the fault domain for this host |
|
vsan health cluster get | Get a specific health check status and its details |
|
vsan health cluster list | List a cluster wide health check across all types of health checks |
|
vsan iscsi defaultconfig get | Get default values for vSAN iSCSI Target configurations. |
|
vsan iscsi defaultconfig set | Set default values for vSAN iSCSI Target configurations. |
|
vsan iscsi homeobject create | Create vSAN iSCSI target home object. Once created, the home object will be available for all the hosts in vSAN cluster. vSAN iSCSI target home object should be created only once for the vSAN cluster. |
|
vsan iscsi homeobject delete | Delete vSAN iSCSI target home object. This operation will destroy all vSAN iSCSI target configuration |
|
vsan iscsi homeobject get | Get status for the vSAN iSCSI target home object |
|
vsan iscsi homeobject set | Update configuration for the vSAN iSCSI target home object |
|
vsan iscsi initiatorgroup add | Add a new initiator group. An initiator group is a collection of iSCSI initiator hosts. A LUN can be exposed to multiple initiators via initiator group. |
|
vsan iscsi initiatorgroup get | Get initiator group properties. |
|
vsan iscsi initiatorgroup list | Get the list of initiator groups. |
|
vsan iscsi initiatorgroup remove | Remove an initiator group. Group should be empty. If you want to remove non-empty group use --force option. |
|
vsan iscsi initiatorgroup initiator add | Add new initiator iSCSI names to the vSAN iSCSI initiator group. |
|
vsan iscsi initiatorgroup initiator remove | Remove initiator iSCSI names from the vSAN iSCSI initiator group. |
|
vsan iscsi status get | Gets current status (Enabled or Disabled). |
|
vsan iscsi status set | Enable or disable iSCSI target support, query status |
|
vsan iscsi target add | Add a new vSAN iSCSI target. |
|
vsan iscsi target get | Get configuration for vSAN iSCSI target |
|
vsan iscsi target list | List vSAN iSCSI targets. |
|
vsan iscsi target remove | Remove a vSAN iSCSI target. |
|
vsan iscsi target set | Update configuration of the given iSCSI target. |
|
vsan iscsi target lun add | Add a new vSAN iSCSI LUN to specified target |
|
vsan iscsi target lun get | Get configuration for vSAN iSCSI LUN |
|
vsan iscsi target lun list | List vSAN iSCSI LUNs in specified target. |
|
vsan iscsi target lun remove | Remove a vSAN iSCSI LUN from specified target. |
|
vsan iscsi target lun set | Update configuration for given vSAN iSCSI target LUN. |
|
vsan maintenancemode cancel | Cancel an in-progress vSAN maintenance mode operation. |
|
vsan network clear | Clear the vSAN network configuration. |
|
vsan network list | List the network configuration currently in use by vSAN. |
|
vsan network remove | Remove an interface from the vSAN network configuration. |
|
vsan network restore | Restore the persisted vSAN network configuration. |
|
vsan network ip add | Add an IP interface to the vSAN network configuration. |
|
vsan network ip remove | Remove an IP interface from the vSAN network configuration. |
|
vsan network ip set | Reconfigure an IP interface in the vSAN network configuration. |
|
vsan network ipv4 add | Add an IP interface to the vSAN network configuration. |
|
vsan network ipv4 remove | Remove an IP interface from the vSAN network configuration. |
|
vsan network ipv4 set | Reconfigure an IP interface in the vSAN network configuration. |
|
vsan perf get | Gets current status (Enabled or Disabled). |
|
vsan perf set | Set vSAN performance service configuration. |
|
vsan perf diagnostic get | Gets current status about diagnostic mode. |
|
vsan perf diagnostic set | Set vSAN diagnostic mode configuration. |
|
vsan policy cleardefault | Clear default vSAN storage policy values. |
|
vsan policy getdefault | Get default vSAN storage policy values. |
|
vsan policy setdefault | Set default vSAN storage policy values. |
|
vsan resync bandwidth get | Get information about vSAN resync bandwidth in Mbps for the disk group with the heaviest resync workload. |
|
vsan resync throttle get | Get information about vSAN resync throttling |
|
vsan resync throttle set | Configure vSAN resync throttling |
|
vsan storage add | Add physical disk for vSAN usage. |
|
vsan storage list | List vSAN storage configuration. |
|
vsan storage remove | Remove physical disks from vSAN disk groups. |
|
vsan storage automode get | Get status of storage auto claim mode. |
|
vsan storage automode set | Configure storage auto claim mode |
|
vsan storage diskgroup mount | Mount a vSAN disk or disk group. |
|
vsan storage diskgroup rebuild | Rebuild a disk group. |
|
vsan storage diskgroup unmount | Unmount vSAN disk or disk group. |
|
vsan storage tag add | Add a vSAN storage tag. |
|
vsan storage tag remove | Remove a vSAN storage tag. |
|
vsan trace get | Get the vSAN tracing configuration. |
|
vsan trace set | Configure vSAN trace. Please note: This command is not thread safe. |
|