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
-LocalSpecLocation <String>
[-RunAsync]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
Cluster[] | named |
|
Specifies the name of the cluster whose desired state you want to set. | required |
|
String | named |
|
Specifies the path to a JSON metadata file located on the local file system. | optional |
|
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 |
|
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. |
-RemoteSpecLocation <String>
[-RunAsync]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
Cluster[] | named |
|
Specifies the name of the cluster whose desired state you want to set. | required |
|
String | named |
|
Specifies the path to a remotely located JSON metadata file. | optional |
|
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 |
|
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. |
-JsonSpecContent <String>
[-RunAsync]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
Cluster[] | named |
|
Specifies the name of the cluster whose desired state you want to set. | required |
|
String | named |
|
Specifies a JSON string containing a desired state metadata definition. | optional |
|
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 |
|
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. |
Output
VMware.VimAutomation.ViCore.Types.V1.Inventory.Cluster
Examples
Example 1
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
Sets the desired state of the 'target-cluster' cluster to the one described in the file from the specified remote location.
Related Commands
LcmClusterCompliance
LcmClusterDesiredState
LcmClusterDesiredStateRecommendation
LcmClusterHealth
LcmHardwareCompatibility
LcmImage