Get-LcmClusterDesiredStateRecommendation Command | Vmware PowerCLI Reference

Get-LcmClusterDesiredStateRecommendation

This cmdlet generates a desired state recommendation of a vSphere Lifecycle Manager cluster.By default, a recommendation based on the latest ESXi base image version is generated.If you specify the -Current parameter, a recommendation based on the latest patch or update of the currently installed ESXi base image version is generated.

Syntax

Get-LcmClusterDesiredStateRecommendation
-Cluster < Cluster[] >
-Current
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Cluster Cluster[] named
  • pipeline
  • wildcards
Specifies the name of the cluster that you want to get a desired state recommendation for.
required
Current SwitchParameter named
If specified, creates a desired state recommendation based on the currently installed ESXi major base image version. The system recommends installing the latest patch or update of the currently installed major base image version. For example, if you have ESXi base image version 6.5 installed and ESXi 6.7 U2 is the last release for the 6.0 major version, the system recommends installing ESXi 6.7 U2.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
optional Server VIServer[] named
  • wildcards
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.
Get-LcmClusterDesiredStateRecommendation
-Cluster < Cluster[] >
[-Latest ]
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Cluster Cluster[] named
  • pipeline
  • wildcards
Specifies the name of the cluster that you want to get a desired state recommendation for.
optional Latest SwitchParameter named
If specified creates a desired state recommendation based on the latest ESXi base image version. For example, if you have ESXi base image version 6.5 installed and ESXi 7.0 is the latest version available, the system will recommend installing ESXi 7.0.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
optional Server VIServer[] named
  • wildcards
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.LcmDesiredState

Examples

Example 1

Get-LcmClusterDesiredStateRecommendation 'lcm-cluster'

Creates a desired state recommendation based on the latest ESXi base image version.

Example 2

Get-LcmClusterDesiredStateRecommendation 'lcm-cluster' -Current

Creates a desired state recommendation based on the currently installed ESXi major base image version. The system recommends installing the latest patch or update of the currently installed major base image version.

Related Commands

LCMClusterRuleWithTransform

Create LCM cluster rule with transform

Update LCM cluster rule with transform

Update LCM cluster rule with transform

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.