Export-LcmClusterDesiredState

This cmdlet exports the desired state of a vSphere Lifecycle Manager cluster as a JSON metadata file, as an installable ISO image, or as a ZIP offline bundle. The exported files can be imported in other clusters managed by vSphere Lifecycle Manager.Note: The JSON metadata file is always exported.

Syntax

-Cluster < Cluster[] >

[-Destination < String > ]

[-ExportIsoImage ]

[-ExportOfflineBundle ]

[-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 export.
optional	Destination	String	named		Specifies a local directory where you want to save the JSON metadata file, the installable ISO image, or the ZIP offline bundle. Note: If no value is provided, your current directory will be used.
optional	ExportIsoImage	SwitchParameter	named		Specifies whether to export the ESXi base image as an installable ISO image.
optional	ExportOfflineBundle	SwitchParameter	named		Specifies whether to export an offline ZIP bundle containing all software packages that can be imported into the vSphere Lifecycle Manager depot.
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

System.IO.FileInfo

Examples

Example 1

Export-LcmClusterDesiredState -Cluster 'lcm-cluster' -Destination './desired-state'

Exports metadata for the desired state of the 'lcm-cluster' cluster in the 'desired-state' subdirectory.

Example 2

Get-Cluster 'lcm-cluster' | Export-LcmClusterDesiredState -ExportIsoImage

Exports metadata for the desired state of the 'lcm-cluster' and the ESXi base ISO image in the current directory.

Related Commands

LCMClusterRuleWithTransform

New-LCMClusterRuleWithTransform

Create LCM cluster rule with transform

Reset-LCMClusterRuleWithTransform

Update LCM cluster rule with transform

Set-LCMClusterRuleWithTransform

Update LCM cluster rule with transform

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.

LcmOfflineDepot

New-LcmOfflineDepot

This cmdlet creates a new vSphere Lifecycle Manager offline depot.

LcmVMHostDesiredState

Export-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.