esxcli vsan Commands

Command Description Options Help
vsan cluster get Get information about the Virtual SAN cluster that this host is joined to.
--help
Show the help message.
vsan cluster join Join the host to a Virtual SAN cluster.
--cluster-uuid | -u
Virtual SAN cluster UUID of the cluster instance which the host will join, or create, in the form "nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn" where n are hexadecimal digits. (required)
--wait | -w
Wait until the host joins the cluster.
--witness-node | -t
Join the host as a witness node to the cluster. It is required to specify "--witness-preferred-fault-domain" when this parameter is set.
--witness-preferred-fault-domain | -p
Specify the fault domain that witness node prefers to respond in case of network partition. It should be either of the two fault domains for existing data sites. This parameter is useful only when "--witness-node" is set.
--help
Show the help message.
vsan cluster leave Leave the Virtual SAN cluster the host is currently joined to.
--help
Show the help message.
vsan cluster new Create a Virtual SAN cluster with current host joined. A random sub-cluster UUID will be generated.
--help
Show the help message.
vsan cluster restore Restore the persisted Virtual SAN cluster configuration.
--boot
Set when restoring the cluster during boot (internal only!)
--help
Show the help message.
vsan cluster preferredfaultdomain get Get the preferred fault domain for a stretched cluster.
--help
Show the help message.
vsan cluster preferredfaultdomain set Set the preferred fault domain for a stretched cluster.
--preferred-fault-domain-name | -n
Preferred Fault domain name to use for a stretched cluster. (required)
--help
Show the help message.
vsan cluster unicastagent add Add a unicast agent to the Virtual SAN cluster configuration.
--addr | -a
IP address of the unicast agent. (required)
--bound-interface-name | -i
Name of the bound outgoing network interface.
--port | -p
Port the unicast agent is listening on.
--help
Show the help message.
vsan cluster unicastagent list List all unicast agents in the Virtual SAN cluster configuration.
--help
Show the help message.
vsan cluster unicastagent remove Remove a unicast agent from the Virtual SAN cluster configuration.
--addr | -a
IP address of the unicast agent. (required)
--port | -p
Port the unicast agent is listening on.
--help
Show the help message.
vsan datastore name get Get VSAN datastore name.
--help
Show the help message.
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.
--newname
Set VSAN datastore name. (required)
--help
Show the help message.
vsan faultdomain get Get the fault domain name for this host.
--help
Show the help message.
vsan faultdomain reset Reset Host fault domain to default value
--help
Show the help message.
vsan faultdomain set Set the fault domain for this host
--fdname | -n
Fault domain name to use for this host. Empty string means reset to default. (required)
--help
Show the help message.
vsan maintenancemode cancel Cancel an in-progress VSAN maintenance mode operation.
--help
Show the help message.
vsan network clear Clear the VSAN network configuration.
--help
Show the help message.
vsan network list List the network configuration currently in use by VSAN.
--help
Show the help message.
vsan network remove Remove an interface from the VSAN network configuration.
--force | -f
Notify VSAN subsystem of removal, even if not configured.
--interface-name | -i
Interface name. (required)
--help
Show the help message.
vsan network restore Restore the persisted VSAN network configuration.
--help
Show the help message.
vsan network ip add Add an IP interface to the VSAN network configuration.
--agent-mc-addr | -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port | -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr | -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port | -c
Unicast address port for host unicast channel.
--interface-name | -i
Interface name. (required)
--master-mc-addr | -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port | -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr | -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl | -t
Time-to-live for multicast packets.
--help
Show the help message.
vsan network ip remove Remove an IP interface from the VSAN network configuration.
--force | -f
Notify VSAN subsystem of removal, even if not configured.
--interface-name | -i
Interface name. (required)
--help
Show the help message.
vsan network ip set Reconfigure an IP interface in the VSAN network configuration.
--agent-mc-addr | -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port | -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr | -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port | -c
Unicast address port for host unicast channel.
--interface-name | -i
Interface name. (required)
--master-mc-addr | -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port | -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr | -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl | -t
Time-to-live for multicast packets.
--help
Show the help message.
vsan network ipv4 add Add an IP interface to the VSAN network configuration.
--agent-mc-addr | -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port | -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr | -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port | -c
Unicast address port for host unicast channel.
--interface-name | -i
Interface name. (required)
--master-mc-addr | -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port | -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr | -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl | -t
Time-to-live for multicast packets.
--help
Show the help message.
vsan network ipv4 remove Remove an IP interface from the VSAN network configuration.
--force | -f
Notify VSAN subsystem of removal, even if not configured.
--interface-name | -i
Interface name. (required)
--help
Show the help message.
vsan network ipv4 set Reconfigure an IP interface in the VSAN network configuration.
--agent-mc-addr | -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port | -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr | -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port | -c
Unicast address port for host unicast channel.
--interface-name | -i
Interface name. (required)
--master-mc-addr | -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port | -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr | -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl | -t
Time-to-live for multicast packets.
--help
Show the help message.
vsan policy cleardefault Clear default VSAN storage policy values.
--help
Show the help message.
vsan policy getdefault Get default VSAN storage policy values.
--policy-class | -c
VSAN policy class whose default value to get. If not provided, defaults for all classes will be retrieved. Options are: [cluster, vdisk, vmnamespace, vmswap, vmem].
--help
Show the help message.
vsan policy setdefault Set default VSAN storage policy values.
--policy | -p
VSAN policy to set as default, in the form of a string. Options are: 1)cacheReservation - Flash capacity reserved as read cache for the storage object. Specified as a percentage of the logical size of the object. To be used only for addressing read performance issues. Reserved flash capacity cannot be used by other objects. Unreserved flash is shared fairly among all objects. It is specified in parts per million. Default value: 0, Maximum value: 1000000. 2)forceProvisioning - If this option is "1" the object will be provisioned even if the policy specified in the storage policy is not satisfiable with the resources currently available in the cluster. Virtual SAN will try to bring the object into compliance if and when resources become available. Default value: 0. 3)hostFailuresToTolerate - Defines the number of host, disk or network failures a storage object can tolerate. For n failures tolerated, "n+1" copies of the object are created and "2n+1" hosts contributing storage are required if replicaPreference is specified as "Performance". If fault domains are configured, "2n+1" fault domains with hosts contributing storage are required. Accordingly, when replicaPreference is specified as "Capacity", the required hosts or fault domains are 4 and 6 if hostFailuresToTolerate is set to 1 and 2 respectively. Note: A host which is not part of a fault domain is counted as its own single-host fault domain. Default value: 1, Maximum value: 3. 4)stripeWidth - The number of HDDs across which each replica of storage object is striped. A value higher than 1 may result in better performance (for e.g when flash read cache misses need to get serviced from HDD), but also results in higher used of system resources. Default value: 1, Maximum value: 12. 5)proportionalCapacity - Percentage of the logical size of the storage object that will be reserved (thick provisioning) upon VM provisioning. The rest of the storage object is thin provisioned. Default value: 0%, Maximum value: 100%. 6)iopsLimit - Defines upper IOPS limit for a disk. IO rate that has been serviced on a disk will be measured and if the rate exceeds the IOPS limit, IO will be delayed to keep it under the limit. Zero value means no limit. Default value: 0. 7)replicaPreference - Specify a replication method to tolerate failures, which could be optimized for: Performance or Capacity. Note: Capacity is only effective when the number of failures to tolerate is set to 1 or 2. Default value: Performance. (required)
--policy-class | -c
VSAN policy class whose default value to set. Options are: [cluster, vdisk, vmnamespace, vmswap, vmem]. (required)
--help
Show the help message.
vsan storage add Add physical disk for VSAN usage.
--disks | -d
Specify hdds to add for use by VSAN. Expects an empty disk with no partitions in which case the disk will be partitioned and formatted. Otherwise this operation will fail. The command expects the device name for the disk to be to be provided, e.g.: mpx.vmhba2:C0:T1:L0. Multiple hdds can be provided using format -d hdd1 -d hdd2 -d hdd3 (required)
--ssd | -s
Specify ssd to add for use by VSAN. Expects an empty ssd with no partitions in which case the ssd will be partitioned and formatted. Otherwise this operation will fail. If an ssd which is already added for use by VSAN, is provided along with '-d/--disks', then the disk mentioned with '-d' will be added to the existing diskgroup created under this ssd and in which case, the ssd won't be partitioned and formatted. The command expects the device name for the disk to be to be provided, e.g.: mpx.vmhba2:C0:T1:L0 (required)
--help
Show the help message.
vsan storage list List VSAN storage configuration.
--device | -d
Filter the output of this command to only show a single device with specified device name.
--uuid | -u
Filter the output of this command to only show a single device with specified uuid.
--help
Show the help message.
vsan storage remove Remove physical disks from VSAN disk groups.
--disk | -d
Specify individual hdd to remove from VSAN usage.e.g.: mpx.vmhba2:C0:T1:L0
--evacuation-mode | -m
Action the VSAN service must take before the host can enter maintenance mode (default noAction). Allowed values are: ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the VSAN cluster, before removing the disk. evacuateAllData: Evacuate all data from the disk before removing it. noAction: Do not move VSAN data out of the disk before removing it.
--ssd | -s
Specify a disk group's fronting ssd to remove the ssd and each backing hdd from VSAN usage.e.g.: mpx.vmhba2:C0:T1:L0
--uuid | -u
Specify UUID of VSAN disk.e.g.: 52afa1de-4240-d5d6-17f9-8af1ec8509e5
--help
Show the help message.
vsan storage automode get Get status of storage auto claim mode.
--help
Show the help message.
vsan storage automode set Configure storage auto claim mode
--enabled
Changing this value to true will result in enabling auto disk claim mode. Disks will be claimed by the VSAN service in next storage event, e.g.: adapter rescan and disk hot-plug. Set to false to disable storage auto claim mode. (required)
--help
Show the help message.
vsan storage diskgroup mount Mount a VSAN disk or disk group.
--disk | -d
Specify the disk to mount for use by VSAN.e.g.: mpx.vmhba0:C0:T1:L0
--ssd | -s
Specify a disk group's fronting ssd to mount the ssd and each backing hdd for use by VSAN.e.g.: mpx.vmhba2:C0:T1:L0
--uuid | -u
Specify a VSAN UUID of the disk or fronting ssd to mount for use by VSAN.e.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e
--help
Show the help message.
vsan storage diskgroup unmount Unmount VSAN disk or disk group.
--disk | -d
Specify the hdd to unmount from VSAN usage.e.g.: mpx.vmhba0:C0:T1:L0
--ssd | -s
Specify a disk group's fronting ssd to unmount the ssd and each backing hdd from VSAN usage.e.g.: mpx.vmhba2:C0:T1:L0
--help
Show the help message.
vsan storage tag add Add a VSAN storage tag.
--disk | -d
Name of the disk to which the tag should be added. (required)
--tag | -t
Tag to be added to disk. Supported tags are [capacityFlash]. (required)
--help
Show the help message.
vsan storage tag remove Remove a VSAN storage tag.
--disk | -d
Name of the disk from which the tag should be removed. (required)
--tag | -t
Tag to be removed from disk. Supported tags are [capacityFlash]. (required)
--help
Show the help message.
vsan trace get Get the VSAN tracing configuration.
--help
Show the help message.
vsan trace set Configure VSAN trace. Please note: This command is not thread safe.
--numfiles | -f
Log file rotation for VSAN trace files.
--path | -p
Path to store VSAN trace files.
--reset | -r
When set to true, reset defaults for VSAN trace files.
--size | -s
Maximum size of VSAN trace files in MB.
--help
Show the help message.