Set-LCMClusterRuleWithTransform
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.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
DeployRule | DeployRuleWrapper | named |
|
|
| required
|
LcmCluster | VIObjectCore | named |
|
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 |
| optional | AllHosts | SwitchParameter | named |
|
Specify AllHosts to apply the new rule to all hosts managed by VMware Auto Deploy. Hosts are managed by VMware Auto Deploy if the DHCP server directs them to the Auto Deploy TFTP configuration file. |
| optional | Force | SwitchParameter | named |
|
If passed as true, and rule is non editable a new rule will be created and older rule will be deleted. |
| optional | Item | VIObjectCore[] | named |
|
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. |
| optional | NoSignatureCheck | SwitchParameter | named |
|
Indicates if a signature verification of the VIBs to be used for bootstraping should be performed. |
| optional | Pattern | String[] | named |
|
Set of hosts the new rule should apply to. Pattern strings use the following syntax: <attr>==<value> Adds a pattern that exactly matches the specified value against the specified attribute. Use this syntax if you need to match a string that contains a comma. <attr>=<Val1 >[,val2,... ,valN] Adds a pattern that matches against the comma-separated list of values. Supported value types are: string Exact string match <ip1>-<ip2> Range of IPv4 addresses. |
| optional | ProgressAction | ActionPreference | named |
|
Output
Examples
Example 1
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
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
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.
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.