Syntax
Get-VMHostProfile [[-Name] <String[]>] [-Description <String[]>] [-Entity <InventoryItem[]>] [-Id <String[]>] [-ReferenceHost <VMHost[]>] [-Server <VIServer[]>] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet retrieves the available host profiles. A host profile encapsulates the host settings and helps to manage the host configuration.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specifies the names of the host profiles you want to retrieve. | false | False | |
| Description | String[] | Specifies a phrase from the description of the host profiles you want to retrieve. | false | False | |
| Entity | InventoryItem[] | Specifies inventory objects associated with the host profiles you want to retrieve. | false | True (ByValue) | |
| Id | String[] | Specifies the IDs of the host profiles you want to retrieve.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | false | False | |
| ReferenceHost | VMHost[] | Specifies the reference hosts of the profiles you want to retrieve. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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. | false | True (ByValue) |
Return Type
Zero or more VMHostProfile objectsNotes
Examples
-------------------------- Example 1 --------------------------
Get-VMHostProfile -Name Profile
Retrieves the virtual machine host profile named Profile.