Import-LcmClusterDesiredState Command | Vmware PowerCLI Reference

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 >
[-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 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 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.
Import-LcmClusterDesiredState
-Cluster < Cluster[] >
-RemoteSpecLocation < String >
[-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 whose desired state you want to set.
required
 RemoteSpecLocation String named
Specifies the path to a remotely located JSON metadata file.
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.
Import-LcmClusterDesiredState
-Cluster < Cluster[] >
-JsonSpecContent < String >
[-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 whose desired state you want to set.
required
 JsonSpecContent String named
Specifies a JSON string containing a desired state metadata definition.
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.Inventory.Cluster

Examples

Example 1 

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 

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

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.