All Cmdlets by Product VMware vSphere and vSAN LCM

Import-LcmClusterDesiredState

This cmdlet imports a specification file to set a desired state of a vSphere Lifecycle Manager cluster.Note: You can generate a specification file by exporting a desired state of a vSphere Lifecycle Manager cluster.

Syntax

Import-LcmClusterDesiredState
-Cluster  <Cluster[]>
-LocalSpecLocation  <String>
[-RunAsync]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Cluster
Cluster[] named
  • wildcards
  • pipeline
    •      		Specifies the name of the cluster whose desired state you want to set.
    required
    LocalSpecLocation
    		String named Specifies the path to a JSON metadata file located on the local file system.
    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.

    Import-LcmClusterDesiredState
    -Cluster  <Cluster[]>
    -RemoteSpecLocation  <String>
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Cluster
    		Cluster[] named
  • wildcards
  • pipeline
    •      		Specifies the name of the cluster whose desired state you want to set.
    required
    RemoteSpecLocation
    		String named Specifies the path to a remotely located JSON metadata file.
    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.

    Import-LcmClusterDesiredState
    -Cluster  <Cluster[]>
    -JsonSpecContent  <String>
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Cluster
    		Cluster[] named
  • wildcards
  • pipeline
    •      		Specifies the name of the cluster whose desired state you want to set.
    required
    JsonSpecContent
    		String named Specifies a JSON string containing a desired state metadata definition.
    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.Inventory.Cluster

    Examples

    Example 1

    PS C:\> Import-LcmClusterDesiredState -Cluster 'target-cluster' -LocalSpecLocation lcm-cluster-desired-state-spec.json

    Sets the desired state of the 'target-cluster' cluster to the one described in the 'lcm-cluster-desired-state-spec.json' file located on the local file system.

    Example 2

    PS C:\> Import-LcmClusterDesiredState -Cluster 'target-cluster' -RemoteSpecLocation 'https://dummy-address/lcm-cluster-desired-state-spec.json'

    Sets the desired state of the 'target-cluster' cluster to the one described in the file from the specified remote location.

    Related Commands

    LcmClusterCompliance

    Test-LcmClusterCompliance
    This cmdlet tests cluster's hosts compliance respective to its target state.

    LcmClusterDesiredState

    Export-LcmClusterDesiredState
    This cmdlet exports the desired state of a vSphere Lifecycle Manager cluster.
    Import-LcmClusterDesiredState
    This cmdlet imports a specification file to set a desired state of a vSphere Lifecycle Manager cluster.

    LcmClusterDesiredStateRecommendation

    Get-LcmClusterDesiredStateRecommendation
    This cmdlet generates a desired state recommendation of a vSphere Lifecycle Manager cluster.

    LcmClusterHealth

    Test-LcmClusterHealth
    This cmdlet tests cluster's hosts health respective to its target state.

    LcmHardwareCompatibility

    Get-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

    Get-LcmImage
    This cmdlet retrieves the vSphere Lifecycle Manager images available on a vCenter Server system.
    Feedback

    Was this page helpful?

    ©2021 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us