VMware VS4-ENT-PL-A Setup Guide - Page 166

Command, Description, the cmdlet. Supplying parameters in interactive mode is not recommended.

Page 166 highlights

vSphere Installation and Setup n Detailed help: Get-Help cmdlet_name -Detailed NOTE When you run Auto Deploy cmdlets, provide all parameters on the command line when you invoke the cmdlet. Supplying parameters in interactive mode is not recommended. Table 7‑6. Rule Engine PowerCLI Cmdlets Command Get-DeployCommand New-DeployRule Set-DeployRule Get-DeployRule Copy-DeployRule Add-DeployRule Remove-DeployRule Set-DeployRuleset Get-DeployRuleset Switch-ActiveDeployRuleset Get-VMHostMatchingRules Test-DeployRulesetCompliance Repair-DeployRulesetCompliance Apply-EsxImageProfile Get-VMHostImageProfile Repair-DeployImageCache Get-VMHostAttributes Get-DeployMachineIdentity Set-DeployMachineIdentity Description Returns a list of Auto Deploy cmdlets. Creates a new rule with the specified items and patterns. Updates an existing rule with the specified items and patterns. You cannot update a rule that is part of a rule set. Retrieves the rules with the specified names. Clones and updates an existing rule. Adds one or more rules to the working rule set and, by default, also to the active rule set. Use the NoActivate parameter to add a rule only to the working rule set. Removes one or more rules from the working rule set and from the active rule set. Run this command with the Delete parameter to completely delete the rule. Explicitly sets the list of rules in the working rule set. Retrieves the current working rule set or the current active rule set. Activates a rule set so that any new requests are evaluated through the rule set. Retrieves rules matching a pattern. For example, you can retrieve all rules that apply to a host or hosts. Use this cmdlet primarily for debugging. Checks whether the items associated with a specified host are in compliance with the active rule set. Given the output of Test-DeployRulesetCompliance, this cmdlet updates the image profile, host profile, and location for each host in the vCenter Server inventory. The cmdlet might apply image profiles, apply host profiles, or move hosts to prespecified folders or clusters on the vCenter Server system. Associates the specified image profile with the specified host. Retrieves the image profile in use by a specified host. This cmdlet differs from the Get-EsxImageProfile cmdlet in the Image Builder PowerCLI. Use this cmdlet only if the Auto Deploy image cache is accidentally deleted. Retrieves the attributes for a host that are used when the Auto Deploy server evaluates the rules. Returns a string value that Auto Deploy uses to logically link an ESXi host in vCenter to a physical machine. Logically links a host object in the vCenter Server database to a physical machine. Use this cmdlet to add hosts without specifying rules. 166 VMware, Inc.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276

n
Detailed help:
Get-Help
cmdlet_name
-Detailed
N
OTE
When you run Auto Deploy cmdlets, provide all parameters on the command line when you invoke
the cmdlet. Supplying parameters in interactive mode is not recommended.
Table 7
6.
Rule Engine PowerCLI Cmdlets
Command
Description
Get-DeployCommand
Returns a list of Auto Deploy cmdlets.
New-DeployRule
Creates a new rule with the specified items and patterns.
Set-DeployRule
Updates an existing rule with the specified items and
patterns. You cannot update a rule that is part of a rule set.
Get-DeployRule
Retrieves the rules with the specified names.
Copy-DeployRule
Clones and updates an existing rule.
Add-DeployRule
Adds one or more rules to the working rule set and, by
default, also to the active rule set. Use the
NoActivate
parameter to add a rule only to the working rule set.
Remove-DeployRule
Removes one or more rules from the working rule set and
from the active rule set. Run this command with the
-
Delete
parameter to completely delete the rule.
Set-DeployRuleset
Explicitly sets the list of rules in the working rule set.
Get-DeployRuleset
Retrieves the current working rule set or the current active
rule set.
Switch-ActiveDeployRuleset
Activates a rule set so that any new requests are evaluated
through the rule set.
Get-VMHostMatchingRules
Retrieves rules matching a pattern. For example, you can
retrieve all rules that apply to a host or hosts. Use this
cmdlet primarily for debugging.
Test-DeployRulesetCompliance
Checks whether the items associated with a specified host
are in compliance with the active rule set.
Repair-DeployRulesetCompliance
Given the output of
Test-DeployRulesetCompliance
,
this cmdlet updates the image profile, host profile, and
location for each host in the vCenter Server inventory. The
cmdlet might apply image profiles, apply host profiles, or
move hosts to prespecified folders or clusters on the
vCenter Server system.
Apply-EsxImageProfile
Associates the specified image profile with the specified
host.
Get-VMHostImageProfile
Retrieves the image profile in use by a specified host. This
cmdlet differs from the
Get-EsxImageProfile
cmdlet in
the Image Builder PowerCLI.
Repair-DeployImageCache
Use this cmdlet only if the Auto Deploy image cache is
accidentally deleted.
Get-VMHostAttributes
Retrieves the attributes for a host that are used when the
Auto Deploy server evaluates the rules.
Get-DeployMachineIdentity
Returns a string value that Auto Deploy uses to logically
link an ESXi host in vCenter to a physical machine.
Set-DeployMachineIdentity
Logically links a host object in the vCenter Server database
to a physical machine. Use this cmdlet to add hosts without
specifying rules.
vSphere Installation and Setup
166
VMware, Inc.