Syntax
Set-VMHostProfile [[-Name] <String>] [[-ReferenceHost] <VMHost>] [-Profile] <VMHostProfile[]> [-Description <String>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet modifies the specified host profile.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String | Specifies a new name for the host profile. | false | False | |
| ReferenceHost | VMHost | Specifies a reference host for the host profile. | false | False | |
| Profile | VMHostProfile[] | Specifies the host profile you want to modify. | true | True (ByValue) | |
| Confirm | SwitchParameter | If 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. | false | False | |
| Description | String | Specifies a new description for the host profile. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems 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. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
Zero or more VMHostProfile objectsNotes
Examples
-------------------------- Example 1 --------------------------
$profile = ( Get-VMHostProfile -Name Profile )[0] Set-VMHostProfile -Profile $profile -Description "New description."
Changes the description of the Profile host profile.