vSphere PowerCLI Reference

Set-VMHost

Synopsis

Changes the configuration of the host.

Syntax

Set-VMHost [-VMHost] <VMHost[]> [[-State] <VMHostState>] [-VMSwapfilePolicy <VMSwapfilePolicy>] [-VMSwapfileDatastore <Datastore>] [-Profile <VMHostProfile>] [-Evacuate] [-TimeZone <VMHostTimeZone>] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Add-VMHost
Get-VMHost
Move-VMHost
Remove-VMHost
Restart-VMHost
Start-VMHost
Stop-VMHost
Suspend-VMHost

Detailed Description

Changes the configuration of the host.

The State parameter is set to Connected.
- If the host is currently connected and is not in a maintenance mode, it does nothing.
- If the host is in a maintenance mode, it exits the maintenance mode.
- If the host is not connected or is not responding, it tries to reconnect.

The State parameter is set to Disconnected.
- If the host is currently connected, it attempts to disconnect.
- If the host is not connected or not responding, it does nothing.

The State parameter is set to Maintenance.
- If the host is currently connected and not in a maintenance mode, it enters a maintenance mode.
- If the host is currently connected and in a maintenance mode, it does nothing.
- If the host is not connected or not responding, it attempts to reconnect and enter maintenance mode.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
StateVMHostStateSpecify the state of the host. The valid values are Connected, Disconnected, and Maintenance. If there are powered on virtual machines on the host, you can set the host into a maintenance mode, only if it is part of a DRS-enabled cluster. Before entering the maintenance mode, if the host is fully automated, the cmdlet first relocates all powered on virtual machines. If the host is not automated or partially automated, you must first generate a DRS recommendation and wait until all powered on virtual machines are relocated or powered off. In this case, you must specify the RunAsync parameter, otherwise an error is thrown.falsefalse
VMHostVMHost[]Specify the host you want to configure.truetrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse$true
EvacuateSwitchParameterIf the value is $true, vCenter automatically reregisters the virtual machines that are compatible for reregistration. If they are not compatible, they remain on the host. If there are powered on virtual machines that cannot be reregistered the operation waits until they are powered off manually. The -Evacuate parameter is valid only when connected to a vCenter Server system and the -State parameter is set to Maintenance. Also, the virtual machine host must be in a DRS-enabled cluster.falsefalse
ProfileVMHostProfileSpecify a host profile you want to associate with the host. If the value of this parameter is $null, the current profile association is removed.falsefalse
RunAsyncSwitchParameterIndicate that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync" in the vSphere PowerCLI console.falsefalse
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
TimeZoneVMHostTimeZoneSpecify the time zone for the host by using its name or by providing the corresponding time zone object. Time zone names support wildcards. If the wildcards match more than one time zones, an error is reported. Time zone objects can only be applied to the hosts they originate from.falsefalse
VMSwapfileDatastoreDatastoreSpecify a datastore that is visible to the host and can be used for storing swapfiles for the virtual machines that run on this host. Using a host-specific swap location might degrade the VMotion performance.falsefalse
VMSwapfilePolicyVMSwapfilePolicySpecify the swapfile placement policy. The following values are valid:

InHostDataStore - Store the swapfile in the datastore specified by the VMSwapfileDatastoreID property of the virtual machine host. If the VMSwapfileDatastoreID property is not set or indicates a datastore with insufficient free space, the swapfile is stored in the same directory as the virtual machine. This setting might degrade the VMotion performance.

WithVM - Store the swapfile in the same directory as the virtual machine.
falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

VMHost

Notes

The -TimeZone parameter is supported only on ESX 3.5 /VirtualCenter 2.5, ES X 4.0/vCenter Server 4.0, and higher. The -Evacuate parameter is valid only when connected to a vCenter Server ho st and the host is a part of a DRS-enabled cluster.

Examples

-------------- Example 1 --------------

Set-VMHost -VMHost Host -State "Disconnected"

Resets the state of the Host virtual host to disconnected.

-------------- Example 2 --------------

$cluster = Get-Cluster -VMHost Host

$task = Set-VMHost -VMHost Host -State "Maintenance" -RunAsync

Get-DrsRecommendation -Cluster $cluster | where {$_.Reason -eq "Host is entering maintenance mode"} | Apply-DrsRecommendation

$host = Wait-Task $task

Activate a maintenance mode for a not automated host that is part of a DRS-enabled cluster and has powered on virtual machines on it.


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.