esxcli vsan Commands

Command Description Options Help
vsan cluster get Get the information of the VSAN cluster that this host is joined to.
--help
Show the help message.
vsan cluster join Join the host to a given VSAN cluster.
--cluster-uuid | -u
VSAN 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 node joins the cluster
--help
Show the help message.
vsan cluster leave Leave the VSAN cluster the host is currently joined to.
--help
Show the help message.
vsan cluster restore Restore the persisted VSAN cluster configuration.
--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 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 ipv4 add Add an IPv4 interface to the VSAN network configuration.
--agent-mc-addr | -d
Optional IPv4 multicast address for agent (also called as downstream) group.
--agent-mc-port | -p
Optional multicast address port for agent (also called as downstream) group.
--interface-name | -i
Interface name. (required)
--master-mc-addr | -u
Optional IPv4 multicast address for master (also called as upstream) group.
--master-mc-port | -o
Optional multicast address port for master (also called as upstream) group.
--multicast-ttl | -t
Optional time-to-live for multicast packets.
--help
Show the help message.
vsan network ipv4 remove Remove an IPv4 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 IPv4 interface in the VSAN network configuration.
--agent-mc-addr | -d
Optional IPv4 multicast address for agent (also called as downstream) group.
--agent-mc-port | -p
Optional multicast address port for agent (also called as downstream) group.
--interface-name | -i
Interface name. (required)
--master-mc-addr | -u
Optional IPv4 multicast address for master (also called as upstream) group.
--master-mc-port | -o
Optional multicast address port for master (also called as upstream) group.
--multicast-ttl | -t
Optional 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].
--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. (required)
--policy-class | -c
VSAN policy class whose default value to set. Options are: [cluster, vdisk, vmnamespace, vmswap]. (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. 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.
--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
--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 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.