vSphere PowerCLI Reference

Set-VMHostProfile

Synopsis

Modifies the specified host profile.

Syntax

Set-VMHostProfile [[-Name] <String>] [[-ReferenceHost] <VMHost>] [-Profile] <VMHostProfile[]> [-Description <String>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Apply-VMHostProfile
Export-VMHostProfile
Get-VMHostProfile
Import-VMHostProfile
New-VMHostProfile
Remove-VMHostProfile
Test-VMHostProfileCompliance

Detailed Description

Modify the specified host profile.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecify a new name for the host profile.falsefalse
ReferenceHostVMHostSpecify a reference host for the host profile.falsefalse
ProfileVMHostProfile[]Specify the host profile you want to modify.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
DescriptionStringProvide a new description for the host profile.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
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

VMHostProfile

Notes

Examples

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

$profile = ( Get-VMHostProfile -Name Profile )[0]

Set-VMHostProfile -Profile $profile -Description "New description."

Changes the description of the Profile host profile.


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