Get-VMHostProfile

This cmdlet retrieves the available host profiles. A host profile encapsulates the host settings and helps to manage the host configuration.

Syntax

[-Description  <String[]>]
[-Entity  <InventoryItem[]>]
[-Id  <String[]>]
[-Name  <String[]>]
[-ReferenceHost  <VMHost[]>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Description
String[] named
  • wildcards
  • Specifies a phrase from the description of the host profiles you want to retrieve.
    optional
    Entity
    InventoryItem[] named
  • wildcards
  • pipeline
  • Specifies inventory objects associated with the host profiles you want to retrieve.
    optional
    Id
    String[] named
  • wildcards
  • Specifies the IDs of the host profiles you want to retrieve.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the host profiles you want to retrieve.
    optional
    ReferenceHost
    VMHost[] named
  • wildcards
  • Specifies the reference hosts of the profiles you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • pipeline
  • 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

    Get-VMHostProfile -Name Profile

    Retrieves the virtual machine host profile named Profile.

    Related Commands

    Feedback

    Was this page helpful?