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
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | 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 | Server | 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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Category | LcmImageCategory[] | named |
|
Specifies the categories of the vSphere Lifecycle Manager images you want to retrieve. |
| optional | Name | String[] | named |
|
Specifies the names of the vSphere Lifecycle Manager images you want to retrieve. |
| optional | Server | 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 | Type | 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 | Version | String[] | named |
|
Specifies the versions of the vSphere Lifecycle Manager images you want to retrieve. |
Output
VMware.VimAutomation.ViCore.Types.V1.Lcm.LcmImageExamples
Example 1
Get-LcmImage -Type BaseImage -Version '7.0 GA - 15843807'Retrieves an ESXi base image with version 7.0 and build number 15843807 from the default connected servers.
Example 2
Get-LcmImage -Type VendorAddOn -Category @('Bugfix', 'Enhancement')Retrieves vendor add-ons that are either bug fixes or enhancements from the default connected servers.
Related Commands
LcmClusterCompliance
This cmdlet tests cluster's hosts compliance respective to its target state.
LcmClusterDesiredState
This cmdlet exports the desired state of a vSphere Lifecycle Manager cluster.
This cmdlet imports a specification file to set a desired state of a vSphere Lifecycle Manager cluster.
LcmClusterDesiredStateRecommendation
This cmdlet generates a desired state recommendation of a vSphere Lifecycle Manager cluster.
LcmClusterHealth
This cmdlet tests cluster's hosts health respective to its target state.
LcmHardwareCompatibility
This cmdlet verifies that the components in the base image are compatible with all storage controllers on the hosts in the cluster in accordance with the VMware Compatibility Guide.
LcmImage
This cmdlet retrieves the vSphere Lifecycle Manager images available on a vCenter Server system.
LcmOfflineDepot
This cmdlet creates a new vSphere Lifecycle Manager offline depot.
LcmVMHostDesiredState
This cmdlet exports the desired state of an ESXi host that is managed by vSphere Lifecycle Manager. The desired state consists of the host's base image and the installed software packages.