< Back
Get-VMHostProfile
Post
NAME Get-VMHostProfile
SYNOPSIS
This cmdlet retrieves the available host profiles.
SYNTAX
Get-VMHostProfile [[-Name] <String[]>] [-Description <String[]>] [-Entity <InventoryItem[]>] [-Id <String[]>]
[-ReferenceHost <VMHost[]>] [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the available host profiles. A host profile encapsulates the host settings and helps to
manage the host configuration.
PARAMETERS
-Description <String[]>
Specifies a phrase from the description of the host profiles you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Entity <InventoryItem[]>
Specifies inventory objects associated with the host profiles you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the host profiles you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-ReferenceHost <VMHost[]>
Specifies the reference hosts of the profiles you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more VMHostProfile objects
NOTES
-------------------------- Example 1 --------------------------
Get-VMHostProfile -Name Profile
Retrieves the virtual machine host profile named Profile.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ofile.html
Invoke-VMHostProfile
Export-VMHostProfile
Import-VMHostProfile
New-VMHostProfile
Remove-VMHostProfile
Set-VMHostProfile
Test-VMHostProfileCompliance
SYNOPSIS
This cmdlet retrieves the available host profiles.
SYNTAX
Get-VMHostProfile [[-Name] <String[]>] [-Description <String[]>] [-Entity <InventoryItem[]>] [-Id <String[]>]
[-ReferenceHost <VMHost[]>] [-Server <VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the available host profiles. A host profile encapsulates the host settings and helps to
manage the host configuration.
PARAMETERS
-Description <String[]>
Specifies a phrase from the description of the host profiles you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Entity <InventoryItem[]>
Specifies inventory objects associated with the host profiles you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the host profiles you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-ReferenceHost <VMHost[]>
Specifies the reference hosts of the profiles you want to retrieve.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more VMHostProfile objects
NOTES
-------------------------- Example 1 --------------------------
Get-VMHostProfile -Name Profile
Retrieves the virtual machine host profile named Profile.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ofile.html
Invoke-VMHostProfile
Export-VMHostProfile
Import-VMHostProfile
New-VMHostProfile
Remove-VMHostProfile
Set-VMHostProfile
Test-VMHostProfileCompliance