Set-LCMClusterRuleWithTransform - vSphere Auto Deploy Reference

Set-LCMClusterRuleWithTransform

Synopsis

Update LCM cluster rule spec with transform.

Syntax

Set-LCMClusterRuleWithTransform -Pattern <String[]> -Item <VIObjectCore[]> -lifecycleCluster <VIObjectCore> -force -noSignatureCheck -AllHosts [<CommonParameters>]

Related Commands

Add-DeployRule
Copy-DeployRule
Set-DeployRule

Detailed Description

Updates a Rule based on the provided parameters. This API takes in a list of Rule.Pattern items and a Lifecycle managed Cluster which is to be used to retrieve the desired software specification and any Host Profile attached to the target Cluster. This API will also generate and cache a new PxeProfile (if needed) based on the desired software specification retrieved from the Lifecycle managed Cluster. All the resulting items will be populated in the Rule.Spec object associated with the updated Rule. Any existing items in the associated Rule.Spec will be removed as part of the update operation so the resulting Rule.Spec will contain on the relevant items.

Parameters

Name	Type	Description	Required?	Pipeline Input
Pattern	String[]	A list of one or more Rule.Pattern items used to identify the host(s) to be bootstrapped with this Rule	true	false
Item	VIObjectCore[]	Item the rule should apply to the hosts. Can be an image profile, a script bundle, a host profile, or a folder or cluster on the vCenter Server system to add the host to.	false	true (ByValue)
LifecycleCluster	VIObjectCore	A vCenter Cluster managed by Lifecycle to be used as a source for the desired soft specification and Host Profile to be used for the host(s) bootstrap	true	true (ByValue)
Force	SwitchParameter	If passed as true, and rule is non editable a new rule will be created and older rule will be deleted	true	false
NoSignatureCheck	SwitchParameter	Indicates if a signature verification of the VIBs to be used for bootstraping should be performed.	true	false
AllHosts	SwitchParameter	Specify AllHosts to apply the new rule to all hosts managed by VMware Auto Deploy. Hosts are managed by VMware Auto Deplo y if the DHCP server directs them to the Auto Deploy TFTP configuration file.	true	false

Examples

-------------- Example 1 --------------

C:\PS> Set-LCMClusterRuleWithTransform -DeployRule NAME_TEST_RULE -AllHosts -LcmCluster LCM_CLUSTER_NAME -Force

Updates a Rule based on the provided parameters. Use -Force option if the Rule is not editable.

-------------- Example 2 --------------

C:\PS> Set-LCMClusterRuleWithTransform -DeployRule NAME_TEST_RULE -Pattern "vendor=dell","vendor==vmware, Inc." -LcmCluster LCM_CLUSTER_NAME -Force

Updates a Rule based on the provided parameters. Pattern as set of hosts the new rule should apply to. Use -Force option if the Rule is not editable.

-------------- Example 3 --------------

C:\PS> Set-LCMClusterRuleWithTransform -DeployRule NAME_TEST_RULE -Pattern "vendor=dell","vendor==vmware, Inc." -Item "scriptbundle" -LcmCluster LCM_CLUSTER_NAME -Force

Updates a Rule based on the provided parameters. Pattern as set of hosts the new rule should apply to. Use -Force option if the Rule is not editable.

PowerCLI Reference

vSphere Auto Deploy Reference

Set-LCMClusterRuleWithTransform

Synopsis