powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-EsxImageProfile



NAME
Set-EsxImageProfile

SYNOPSIS


SYNTAX
Set-EsxImageProfile [-ImageProfile] [-Name ] [-Vendor ] [-SoftwarePackage ackage[]>] [-AcceptanceLevel ] [-Description ] [-ReadOnly] [-Force] [-WarningAction onPreference>] [-WarningVariable ] [-WhatIf] [-Confirm] []


DESCRIPTION
Set-EsxImageProfile is used to modify a user-created image profile. The cmdlet returns the modified ImageProfile ob
ject, 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
-ImageProfile
(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

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Name
String value to replace the current Name field with.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Vendor
String value to replace the current Vendor field with.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SoftwarePackage
(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 Software
Package object. The cmdlet selects the highest available version of the named package.
*" ", 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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-AcceptanceLevel
Optional. 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
.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Description
Optional. Long string describing the contents or purpose of the image profile.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ReadOnly
Optional. Makes the image profile read only. (not modifiable).

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force
Installs 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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningAction


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningVariable


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS



NOTES




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

C:\PS>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 ----------

C:\PS>$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):


RELATED LINKS