Get-LcmImage
This cmdlet retrieves the vSphere Lifecycle Manager images available on a vCenter Server system. The cmdlet returns a set of vSphere Lifecycle Manager images that correspond to the filter criteria specified by the provided parameters. To specify a server different from the default one, use the -Server parameter.
Syntax
[-Name <String[]>]
[-Server <VIServer[]>]
[-Type <LcmImageType>]
[-Version <String[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
LcmImageCategory[] | named |
|
Specifies the categories of the vSphere Lifecycle Manager images you want to retrieve. | optional |
|
String[] | named |
|
Specifies the names of the vSphere Lifecycle Manager images you want to retrieve. | optional |
|
VIServer[] | named |
|
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 the Connect-VIServer cmdlet. | optional |
|
LcmImageType | named |
|
Specifies the type of the vSphere Lifecycle Manager images you want to retrieve. Note: LcmImageType is a flag enumeration. If you want to pass multiple image types, you might use "-bor" to group them in a single value (e.g., [LcmImageType]::BaseImage -bor [LcmImageType]::VendorAddOn). | optional |
|
String[] | named |
|
Specifies the versions of the vSphere Lifecycle Manager images you want to retrieve. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Specifies the IDs of the vSphere Lifecycle Manager images you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list. | optional |
|
VIServer[] | named |
|
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 the Connect-VIServer cmdlet. |
Output
VMware.VimAutomation.ViCore.Types.V1.Lcm.LcmImage
Examples
Example 1
Retrieves an ESXi base image with version 7.0 and build number 15843807 from the default connected servers.
Example 2
Retrieves vendor add-ons that are either bug fixes or enhancements from the default connected servers.
Related Commands
LcmClusterCompliance
LcmClusterDesiredState
LcmClusterDesiredStateRecommendation
LcmClusterHealth
LcmHardwareCompatibility
LcmImage
