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

Image Profiles, Table 7, Image Profile Requirements, Image Profile Validation

Page 228 highlights

vSphere Installation and Setup Run Get-Help cmdlet_name at the PowerCLI prompt for detailed reference information. Table 7‑15. Image Builder Cmdlets Cmdlet Description Add-EsxSoftwareDepot Adds the software depot or ZIP file at the specified location to your current environment. Downloads metadata from the depot and analyzes VIBs for dependencies. RemoveEsxSoftwareDepot Disconnects from the specified software depot. Get-EsxSoftwareDepot Returns a list of software depots that are in the current environment. If you want to examine and manage image profiles and VIBs, you must first add the corresponding software depot to your environment. GetEsxSoftwarePackage Returns a list of software package objects (VIBs). Use this cmdlet's options to filter the results. Get-EsxImageProfile Returns an array of ImageProfile objects from all currently added depots. New-EsxImageProfile Creates a new image profile. In most cases, creating a new profile by cloning an existing profile is recommended. See "Create an Image Profile," on page 235. Set-EsxImageProfile Modifies a local ImageProfile object and performs validation tests on the modified profile. The cmdlet returns the modified object but does not persist it. ExportEsxImageProfile Exports an image profile as either an ESXi ISO image for ESXi installation, or as a ZIP file. CompareEsxImageProfile Returns an ImageProfileDiff structure that shows whether the two profiles have the same VIB list and acceptance level. See "Acceptance Levels," on page 229. RemoveEsxImageProfile Removes the image profile from the software depot. AddEsxSoftwarePackage Adds one or more new packages (VIBs) to an existing image profile. RemoveEsxSoftwarePackage Removes one or more packages (VIBs) from an image profile. Image Profiles Image profiles define the set of VIBs that an ESXi installation or update process uses. Image profiles apply to hosts provisioned with Auto Deploy and to other ESXi 5.x hosts. You define and manipulate image profiles with the Image Builder PowerCLI. Image Profile Requirements You can create a custom image profile from scratch or clone an existing profile and add or remove VIBs. A profile must meet the following requirements to be valid. n Each image profile must have a unique name and vendor combination. n Each image profile has an acceptance level. When you add a VIB to an image profile with an Image Builder PowerCLI cmdlet, Image Builder checks that the VIB matches the acceptance level defined for the profile. n You cannot remove VIBs that are required by other VIBs. n You cannot include two versions of the same VIB in an image profile. When you add a new version of a VIB, the new version replaces the existing version of the VIB. Image Profile Validation An image profile and its VIBs must meet several criteria to be valid. n Image profiles must contain at least one base VIB and one bootable kernel module. 228 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

Run
Get-Help
cmdlet_name
at the PowerCLI prompt for detailed reference information.
Table 7
15.
Image Builder Cmdlets
Cmdlet
Description
Add-EsxSoftwareDepot
Adds the software depot or ZIP file at the specified location to your current environment.
Downloads metadata from the depot and analyzes VIBs for dependencies.
Remove-
EsxSoftwareDepot
Disconnects from the specified software depot.
Get-EsxSoftwareDepot
Returns a list of software depots that are in the current environment. If you want to examine
and manage image profiles and VIBs, you must first add the corresponding software depot
to your environment.
Get-
EsxSoftwarePackage
Returns a list of software package objects (VIBs). Use this cmdlet's options to filter the
results.
Get-EsxImageProfile
Returns an array of
ImageProfile
objects from all currently added depots.
New-EsxImageProfile
Creates a new image profile. In most cases, creating a new profile by cloning an existing
profile is recommended. See
“Create an Image Profile,”
on page 235.
Set-EsxImageProfile
Modifies a local
ImageProfile
object and performs validation tests on the modified profile.
The cmdlet returns the modified object but does not persist it.
Export-
EsxImageProfile
Exports an image profile as either an ESXi ISO image for ESXi installation, or as a ZIP file.
Compare-
EsxImageProfile
Returns an
ImageProfileDiff
structure that shows whether the two profiles have the
same VIB list and acceptance level. See
“Acceptance Levels,”
on page 229.
Remove-
EsxImageProfile
Removes the image profile from the software depot.
Add-
EsxSoftwarePackage
Adds one or more new packages (VIBs) to an existing image profile.
Remove-
EsxSoftwarePackage
Removes one or more packages (VIBs) from an image profile.
Image Profiles
Image profiles define the set of VIBs that an ESXi installation or update process uses. Image profiles apply to
hosts provisioned with Auto Deploy and to other ESXi 5.x hosts. You define and manipulate image profiles
with the Image Builder PowerCLI.
Image Profile Requirements
You can create a custom image profile from scratch or clone an existing profile and add or remove VIBs. A
profile must meet the following requirements to be valid.
n
Each image profile must have a unique name and vendor combination.
n
Each image profile has an acceptance level. When you add a VIB to an image profile with an Image
Builder PowerCLI cmdlet, Image Builder checks that the VIB matches the acceptance level defined for
the profile.
n
You cannot remove VIBs that are required by other VIBs.
n
You cannot include two versions of the same VIB in an image profile. When you add a new version of a
VIB, the new version replaces the existing version of the VIB.
Image Profile Validation
An image profile and its VIBs must meet several criteria to be valid.
n
Image profiles must contain at least one base VIB and one bootable kernel module.
vSphere Installation and Setup
228
VMware, Inc.