| 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 iscsi defaultconfig get |
Get default values for VSAN iSCSI Target configurations. |
- --help
- Show the help message.
|
| vsan iscsi defaultconfig set |
Set default values for VSAN iSCSI Target configurations. |
- --authtype | -m
- Provide default authentication type. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].
- --interface | -n
- The name of the default network interface through which the target is accessible.
- --mutual-secret | -S
- The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --mutual-userid | -U
- The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --port | -p
- The default network port number through which the target will be accessible.
- --secret | -s
- The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --userid | -u
- The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --help
- Show the help message.
|
| vsan iscsi homeobject create |
Create Virtual SAN iSCSI target home object. Once created, the home object will be available for all the hosts in Virtual SAN cluster. Virtual SAN iSCSI target home object should be created only once for the Virtual SAN cluster. |
- --authtype | -m
- Provide default authentication type. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].
- --interface | -n
- The name of the default network interface. (required)
- --mutual-secret | -S
- The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --mutual-userid | -U
- The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --policy | -P
- Virtual SAN storage policy for Virtual SAN iSCSI target home object, in the form of a string. Please check 'esxcli vsan policy setdefault --help' for details on policy options.
- --port | -p
- The port number of the default network port. If not provided, default network port: 3260.
- --secret | -s
- The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --userid | -u
- The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --help
- Show the help message.
|
| vsan iscsi homeobject delete |
Delete Virtual SAN iSCSI target home object. This operation will destroy all Virtual SAN iSCSI target configuration |
- --help
- Show the help message.
|
| vsan iscsi homeobject get |
Get status for the Virtual SAN iSCSI target home object |
- --help
- Show the help message.
|
| vsan iscsi homeobject set |
Update configuration for the Virtual SAN iSCSI target home object |
- --policy | -P
- New Virtual SAN storage policy for Virtual SAN iSCSI target home object, in the form of a string. Please check 'esxcli vsan policy setdefault --help' for details on policy options.
- --help
- Show the help message.
|
| 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. |
- --name | -n
- The name of the new initiator group. Group name must be unique within the VSAN cluster. (required)
- --help
- Show the help message.
|
| vsan iscsi initiatorgroup get |
Get initiator group properties. |
- --name | -n
- Initiator group name. (required)
- --help
- Show the help message.
|
| vsan iscsi initiatorgroup list |
Get the list of initiator groups. |
- --help
- Show the help message.
|
| vsan iscsi initiatorgroup remove |
Remove an initiator group. Group should be empty. If you want to remove non-empty group use --force option. |
- --force | -f
- Force deletion of the initiator group even if it is not empty.
- --name | -n
- The name of the initiator group to remove. (required)
- --help
- Show the help message.
|
| vsan iscsi initiatorgroup initiator add |
Add new initiator iSCSI names to the VSAN iSCSI initiator group. |
- --group | -g
- The name of the initiator group. (required)
- --names | -n
- Specify initiator iSCSI names to be added to the initiator group. Multiple initiator iSCSI names can be provided using format -n initiator1 -n initiator2. (required)
- --help
- Show the help message.
|
| vsan iscsi initiatorgroup initiator remove |
Remove initiator iSCSI names from the VSAN iSCSI initiator group. |
- --group | -g
- The name of the initiator group. (required)
- --names | -n
- Specify initiator iSCSI names to be removed from the initiator group. Multiple initiator iSCSI names can be provided using format -n initiator1 -n initiator2.the initiator group. (required)
- --help
- Show the help message.
|
| vsan iscsi status get |
Gets current status (Enabled or Disabled). |
- --help
- Show the help message.
|
| vsan iscsi status set |
Enable or disable iSCSI target support, query status |
- --enabled
- Sets status, enabling or disabling VSAN iSCSI target support on the way. The new status survives a reboot (required)
- --help
- Show the help message.
|
| vsan iscsi target add |
Add a new VSAN iSCSI target. |
- --alias | -a
- The alias of the target. The alias has to be unique. (required)
- --authtype | -m
- Provide authentication type for target. If not provided, target can be accessed through without authentication. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].
- --initiator-add | -A
- Specify initiator iSCSI names or initiator groups to be added to the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -A initiator1 -A initiator2.
- --interface | -n
- The name of the network interface through which the target is accessible. If not provided, the target will be accessible through default network interface.
- --iqn | -i
- The iSCSI Qualified Name (IQN) of the target. This parameter is optional and should be unique if provided. If not provided, appropriate IQN will be generated by the system.
- --mutual-secret | -S
- The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --mutual-userid | -U
- The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --policy | -P
- VSAN storage policy for target namespace, in the form of a string. Please check 'esxcli vsan policy setdefault --help' for details on policy options.
- --port | -p
- The name of the network port through which the target is accessible. If not provided, the target will be accessible through default network port: 3260.
- --secret | -s
- The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --userid | -u
- The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --help
- Show the help message.
|
| vsan iscsi target get |
Get configuration for VSAN iSCSI target |
- --alias | -a
- The iSCSI Target alias. (required)
- --help
- Show the help message.
|
| vsan iscsi target list |
List VSAN iSCSI targets. |
- --help
- Show the help message.
|
| vsan iscsi target remove |
Remove a VSAN iSCSI target. |
- --alias | -a
- The alias of the VSAN iSCSI target to be removed. (required)
- --help
- Show the help message.
|
| vsan iscsi target set |
Update configuration of the given iSCSI target. |
- --alias | -a
- The alias of the target which needs to be modified. (required)
- --authtype | -m
- Provides authentication type for the target. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual]
- --initiator-add | -A
- Specify initiator iSCSI names or initiator groups to be added to the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -A initiator1 -A initiator2.
- --initiator-remove | -R
- Specify initiator iSCSI names or initiator groups to be removed from the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -R initiator1 -R initiator2.
- --interface | -n
- The name of the new network interface through which the target is accessible.
- --mutual-secret | -S
- The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --mutual-userid | -U
- The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
- --new-alias | -N
- The new alias of the target.
- --policy | -P
- New VSAN storage policy for target namespace, in the form of a string. Please check 'esxcli vsan policy setdefault --help' for details on policy options.
- --port | -p
- The port number of the network port through which the target is accessible
- --secret | -s
- The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --userid | -u
- The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
- --help
- Show the help message.
|
| vsan iscsi target lun add |
Add a new VSAN iSCSI LUN to specified target |
- --alias | -a
- An optional alias for LUN. Can be used to indicate additional info about the LUN.
- --id | -i
- The optional ID of the LUN [0..255]. If not provided, next free identifier will be used. If provided, ID must be unique within target.
- --policy | -P
- VSAN storage policy for LUN, in the form of a string. Please check 'esxcli vsan policy setdefault --help' for more detail on policy options.
- --size | -s
- Size of the LUN object. Eg: 5GB. Supported units: MB, GB, TB, MiB, GiB, TiB. (required)
- --target | -t
- Name of the VSAN iSCSI target to which the LUN will be added. (required)
- --help
- Show the help message.
|
| vsan iscsi target lun get |
Get configuration for VSAN iSCSI LUN |
- --id | -i
- The ID for the LUN. (required)
- --target | -t
- The iSCSI Target alias. (required)
- --help
- Show the help message.
|
| vsan iscsi target lun list |
List VSAN iSCSI LUNs in specified target. |
- --target | -t
- The alias of the VSAN iSCSI target whose LUNs should be listed. (required)
- --help
- Show the help message.
|
| vsan iscsi target lun remove |
Remove a VSAN iSCSI LUN from specified target. |
- --id | -i
- Identifier of the LUN to be removed. (required)
- --target | -t
- Name of the VSAN iSCSI target from which the LUN will be removed. (required)
- --help
- Show the help message.
|
| vsan iscsi target lun set |
Update configuration for given VSAN iSCSI target LUN. |
- --alias | -a
- The new alias for the LUN. Can be used to indicate additional info about the LUN.
- --id | -i
- The ID of the LUN. (required)
- --new-id | -n
- The new ID of the LUN [0..255]. If provided, ID must be unique within this target.
- --policy | -P
- New policy for LUN, in the form of a string. Please check 'esxcli vsan policy setdefault --help' for more detail on policy options.
- --size | -s
- The new size of the LUN object with optional units. If provided, it should be greater than existing size i.e. LUNs are only allowed to grow. Supported unit types are MB, MiB, GB, GiB and TB, TiB (case-insensitive). If not specified, default unit is MiB.
- --status | -S
- Change the LUN status to [online, offline]. offline: Bring the LUN offline. Offline LUNs are inaccessible. It's allowed to do backup and some disruptive management operations like changing LUN ID when a LUN is offline. online: Bring the LUN online. Online LUNs are accessible.
- --target | -t
- Alias of the VSAN iSCSI target for which the LUN needs to be updated. (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.
- --traffic-type | -T
- Network transmission type of Virtual SAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general Virtual SAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, Virtual SAN vmknic is used for Virtual SAN witness transmission. Once a virtual adapter is configured with witness traffic type, Virtual SAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
- --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.
- --traffic-type | -T
- Network transmission type of Virtual SAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general Virtual SAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, Virtual SAN vmknic is used for Virtual SAN witness transmission. Once a virtual adapter is configured with witness traffic type, Virtual SAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
- --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.
- --traffic-type | -T
- Network transmission type of Virtual SAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general Virtual SAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, Virtual SAN vmknic is used for Virtual SAN witness transmission. Once a virtual adapter is configured with witness traffic type, Virtual SAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
- --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.
- --traffic-type | -T
- Network transmission type of Virtual SAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general Virtual SAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, Virtual SAN vmknic is used for Virtual SAN witness transmission. Once a virtual adapter is configured with witness traffic type, Virtual SAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
- --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. When the fault tolerance method is mirroring: to tolerate "n" failures, "n+1" copies of the object are created and "2n+1" hosts contributing storage are required (if fault domains are configured, "2n+1" fault domains with hosts contributing storage are required). When the fault tolerance method is erasure coding: to tolerate 1 failure, 4 hosts (or fault domains) are required; and to tolerate 2 failures, 6 hosts (or fault domains) are required. 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 - Defines the method used to tolerate failures. RAID-1 achieves failure tolerance using mirrors, which provides better performance. RAID-5/6 achieves failure tolerance using parity blocks, which provides better space efficiency. RAID-5/6 is only available on All-flash and when the number of failures to tolerate is set to 1 or 2: a value of 1 implies a RAID-5 configuration, and a value of 2 implies a RAID-6 configuration. Default value: RAID-1. (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 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 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. |
- --logtosyslog | -l
- Boolean value to enable or disable logging urgent traces to syslog.
- --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.
|