vSphere PowerCLI Reference

Get-VMHostProfile

Synopsis

Retrieves the available host profiles.

Syntax

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

Related Commands

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

Detailed Description

Retrieves the available host profiles. A host profile encapsulates the host settings and helps to manage the host configuration.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specify the names of the host profiles you want to retrieve.falsefalse
DescriptionString[]Specify a phrase from the description of the host profiles you want to retrieve.falsefalse
EntityInventoryItem[]Specify inventory objects associated with the host profiles you want to retrieve.falsetrue (ByValue)
IdString[]Specify the Ids of the host profiles you want to retrieve.falsefalse
ReferenceHostVMHost[]Specify the reference hosts of the profiles you want to retrieve.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.falsetrue (ByValue)

Return Type

VMHostProfile

Notes

Examples

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

Get-VMHostProfile -Name Profile

Retrieves the virtual machine host profile named Profile.


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