Stop-VsanCluster Command | Vmware PowerCLI Reference

Stop-VsanCluster

This cmdlet powers off a vSAN cluster.

Syntax

Stop-VsanCluster
-Cluster < Cluster >
-PowerOffReason < String >
[-InfraVMs < VirtualMachine[] > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Cluster Cluster named
  • pipeline
 Specifies the vSAN cluster to power off.
required
 PowerOffReason String named
Specifies the reason for powering off. The allowed length is up to 512 characters.
optional InfraVMs VirtualMachine[] named
Specifies the UUIDs of infrastructure VMs that will be forced to power off during the vSAN cluster power-off and will be automatically powered on afterwards. Some VMs are deployed with vCeter Server-dependent services such as DNS. You can use this parameter to power off such VMs as they must power off together with their vCenter Server.
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

Output

Examples

Example 1 

Stop-VsanCluster -Cluster "VSAN-Cluster"

Powers off the specified cluster.

Related Commands

VsanCluster

This cmdlet executes vSAN cluster power on.

This cmdlet powers off a vSAN cluster.

VsanClusterConfiguration

This cmdlet retrieves vSAN related configuration data from clusters.

This cmdlet modifies vSAN configuration settings for a cluster.

VsanClusterDiskUpdate

This cmdlet starts the update of all vSAN disks of a cluster to the latest vSAN disk format version supported by the cluster.

VsanClusterHealth

This cmdlet runs a health test on the specified vSAN clusters and returns the test results.

VsanClusterPowerState

This cmdlets retrieves the power state of a vSAN cluster.

VsanClusterRebalance

This cmdlet starts the proactive rebalance of the vSAN objects on the cluster hosts based on the vSAN disks usage when the disks are in imbalanced state.

This cmdlet stops the proactive rebalance of the vSAN objects on the cluster hosts.