vSphere PowerCLI Reference

Set-EsxImageProfile

Synopsis

Syntax

Set-EsxImageProfile [-ImageProfile] <ImageProfile> [-Name <String>] [-Vendor <String>] [-SoftwarePackage <SoftwarePackage[]>] [-AcceptanceLevel <AcceptanceLevels>] [-Description <String>] [-ReadOnly] [-Force] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Detailed Description

Set-EsxImageProfile is used to modify a user-created image profile. The cmdlet returns the modified ImageProfile object, which can be piped into any other cmdlet taking image profiles as input. For details on persistence, see New-EsxImageProfile.


If the ReadOnly property of the image profile is true, you cannot modify the image profile.


Image Builder performs all image profile validation tests on the modified image profile.


The Name and Vendor of the modified image profile must be unique. If you attempt to change the Name and Vendor, and the new Name and Vendor are the same as an existing Name and Vendor, an error result.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
ImageProfileImageProfile(pipeline input, prompt) Specifies the image profile to edit.

Takes one of the following forms:

*Name of an image profile, as displayed in the Name column of Get-EsxImageProfile, or the Name property of any ImageProfile object

*ImageProfile object
truetrue (ByValue, ByPropertyName)
AcceptanceLevelAcceptanceLevelsOptional. Specifies the minimum acceptance level allowed for VIBs in the image profile, one of the following:

*VMwareCertified

*VMwareAccepted

*PartnerSupported

*CommunitySupported

If the acceptance level is raised above the lowest acceptance level of any VIB in the profile, an error results.
falsefalse
ConfirmSwitchParameterfalsefalse
DescriptionStringOptional. Long string describing the contents or purpose of the image profile.falsefalse
ForceSwitchParameterInstalls packages that break extensibility rules such as standard file path. Also bypasses dependency checks on packages. Use this option with care. Because it bypasses standard validation checks, an invalid image profile might result.falsefalse
NameStringString value to replace the current Name field with.falsefalse
ReadOnlySwitchParameterOptional. Makes the image profile read only. (not modifiable).falsefalse
SoftwarePackageSoftwarePackage[](pipeline input) One or more VIB software packages that the image profile should contain. Replaces the list of VIBs in the image profile.

The value takes one of the following forms:

*Name of a VIB, as displayed in the Name column of Get-EsxSoftwarePackage, or the Name property of any SoftwarePackage object. The cmdlet selects the highest available version of the named package.

*"<Name> <Version>", for specifying a specific version of a VIB named Name.

*SoftwarePackage object

*GUID of the VIB software package (from the Guid property of a SoftwarePackage)

*List containing a mix of any of the above

One of the "esx-base" packages is required for a valid image profile.
falsefalse
VendorStringString value to replace the current Vendor field with.falsefalse
WarningActionActionPreferencefalsefalse
WarningVariableStringfalsefalse
WhatIfSwitchParameterfalsefalse

Return Type

Notes

Examples

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

Set-EsxImageProfile -ImageProfile "Profile of a Fool" -SoftwarePackage esx-base,scsi-ips,esx-tboot

Modify the VIB list of an existing image profile

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

$myprofiles = Get-EsxImageProfile Set-EsxImageProfile -ImageProfile $myprofiles[2] -AcceptanceLevel PartnerSupported

Change the acceptance level (maybe so that some VIB with a lower acceptance level can be added) of the third image profile from a list (index starts at 0):

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

Get-EsxImageProfile | Set-EsxImageProfile -ReadOnly

Using pipelining to mark all profiles as read-only


Copyright © 1998 - 2011 VMware, Inc. All rights reserved.