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

-Cluster  <Cluster[]>
[-Latest]
[-RunAsync]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Cluster
Cluster[] named
  • wildcards
  • pipeline
  • 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
    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.

    -Cluster  <Cluster[]>
    -Current
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Cluster
    Cluster[] named
  • wildcards
  • pipeline
  • 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
    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

    PS C:\> Get-LcmClusterDesiredStateRecommendation 'lcm-cluster'

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

    Example 2

    PS C:\> 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

    Feedback

    Was this page helpful?