Set-VMHostProfile

This cmdlet modifies the specified host profile.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Profile
VMHostProfile[] 2
  • wildcards
  • pipeline
  • Specifies the host profile you want to modify.
    optional
    ReferenceHost
    VMHost 1
  • wildcards
  • Specifies a reference host for the host profile.
    optional
    Description
    String named Specifies a new description for the host profile.
    optional
    Name
    String named Specifies a new name for the host profile.
    optional
    Server
    VIServer[] named
  • wildcards
  • 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 Connect-VIServer.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Host.Profile.VMHostProfile

    Examples


    Example 1

    $profile = ( Get-VMHostProfile -Name Profile )[0]
    Set-VMHostProfile -Profile $profile -Description "New description."

    Changes the description of the Profile host profile.

    Related Commands

    Feedback

    Was this page helpful?