├── docs ├── .gitignore ├── _config.yml ├── README.md ├── CHANGELOG.md └── LICENSE └── ESXi-Customizer-PS.ps1 /docs/.gitignore: -------------------------------------------------------------------------------- 1 | docs/ 2 | -------------------------------------------------------------------------------- /docs/_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-minimal -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | ## Welcome to the ESXi-Customizer-PS GitHub Pages 2 | 3 | Full documentation is currently available at the [V-Front.de web site](https://esxi-customizer-ps.v-front.de) and will be gradually migrated to this location. 4 | -------------------------------------------------------------------------------- /docs/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ### === Change History === 2 | 3 | ###### Version 2.9.0 (2022-10-11) 4 | (Alex) Made the script fully compatible with vSphere 8.0 5 | 6 | ###### Version 2.8.2 (2022-08-11) 7 | (Alex) minor formatting revisions & add workaround for WinError 10054 8 | 9 | ###### Version 2.8.1 (2020-08-02) 10 | (Vladislav) Enhanced `-pkgDir` switch to support a list of local directories 11 | 12 | ###### Version 2.8.0 (2020-04-02) 13 | (Alex) Made the script fully compatible with vSphere 7.0 14 | 15 | ###### Version 2.7.0 (2018-05-25) 16 | (Alex) Enhanced variable for better VMware.PowerCLI module version detection; script restructure 17 | (Andre) Added -pzip parameter to use an Offline patch bundle instead of the Online depot with -update 18 | 19 | ###### Version 2.6.0 (2018-04-18) 20 | Made the script fully compatible with vSphere 6.7 and PowerCLI 10 21 | 22 | ###### Version 2.5.1 (2017-09-07) 23 | Removed expired electronic signature 24 | Removed code to resize the console screen (caused too many issues) 25 | 26 | ###### Version 2.5 (2016-11-23) 27 | Made the script fully compatible with vSphere 6.5 and PowerCLI 6.5 28 | Enhanced script log file naming 29 | 30 | ###### Version 2.4.3 (2015-09-11) 31 | Updated electronic signature 32 | 33 | ###### Version 2.4.2 (2015-06-02) 34 | Fixed an issue with -izip -update, and the Input bundle containing multiple Imageprofiles: The script will now pick the latest standard profile from the list and update that. 35 | 36 | ###### Version 2.4.1 (2015-04-29) 37 | Fixed a small issue with the script not launching from a pure Powershell, but only from a PowerCLI session (Yikes!) 38 | 39 | ###### Version 2.4 (2015-04-24) 40 | Fixed launch of the script from a PowerCLI 6.0 console 41 | Updated help screen and Online doc for ESXi 6.0 42 | Added new switch -remove 43 | 44 | ###### Version 2.3 (2014-10-01) 45 | Implemented workaround for the problem described in KB2089217 46 | Added ability to add VIB files 47 | Improved error handling and logging 48 | Removed HP specific features (-hp and -hprel) 49 | 50 | ###### Version 2.2 (2014-02-12) 51 | Fixed the -update -izip logic to correctly update only existing packages 52 | Reverted the change to the add VIB logic introduced in 2.1 53 | 54 | ###### Version 2.1 (2014-02-11) 55 | Fixed the add VIB logic to never downgrade a package 56 | Added -load switch to add additional VIBs from any connected Online Depot 57 | Added -vft switch to connect the V-Front Online Depot 58 | Added -dpt switch to connect additional Online Depots by URL 59 | Added -v55 switch to limit image profile selection to ESXi 5.5 60 | 61 | ###### Version 2.0 (2013-11-23) 62 | Added -update switch to update a local ESXi Offline bundle with an ESXi patch from the VMware Online Depot 63 | Added -v51 switch to limit the focus to ESXi 5.1 (and ignore newer releases) 64 | Added -ipdesc option to set custom ImageProfile description 65 | Added -ipvendor option to set custom ImageProfile vendor 66 | Added console window re-sizing and coloring 67 | 68 | ###### Version 1.4.3 (2012-10-01) 69 | Fixed ImageProfile sorting and detection of recent release 70 | 71 | ###### Version 1.4.2 (2012-09-28) 72 | Added -force switch when adding packages (to prevent dependency checks) 73 | 74 | ###### Version 1.4.1 (2012-09-27) 75 | Added PowerCLI version check and compatibility to PowerCLI 5.1 76 | 77 | ###### Version 1.4 (2012-09-17) 78 | Added -v50 to limit the focus to ESXi 5.0 (and ignore newer releases) 79 | Added -ozip option to create an Offline Bundle instead of an ISO file 80 | Renamed -isoDir parameter to -outDir 81 | Added logic to export only the orig. VMware profile if -obDir and -hp are both not specified 82 | Added -nsc (-NoSignatureCheck) parameter for ISO export 83 | Added -izip option to use an ESXi Offline bundle (instead of the Online depot) for input 84 | Added electronic signature to script 85 | 86 | ###### Version 1.2 (2012-06-27) 87 | Added manual selection of ImageProfile to clone (-sip), naming of custom profile (-ipname) and HP Depot release selection (-hprel). Added cleanup at end of script. 88 | 89 | ###### Version 1.1 (2012-06-07) 90 | Fixed HP Online depot handling 91 | Introduced -test parameter to skip download and build 92 | 93 | ###### Version 1.0 (2012-05-31) 94 | Initial version 95 | -------------------------------------------------------------------------------- /ESXi-Customizer-PS.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################################# 2 | # 3 | # ESXi-Customizer-PS.ps1 - a script to build a customized ESXi installation ISO using ImageBuilder 4 | # 5 | # Version: 2.9.0 6 | # Author: Andreas Peetz (ESXi-Customizer-PS@v-front.de) 7 | # Info/Tutorial: https://esxi-customizer-ps.v-front.de/ 8 | # 9 | # Contributors: Alex Lopez, Andre Pett, Vladislav Grishenko 10 | # 11 | # License: 12 | # 13 | # This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License 14 | # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 15 | # 16 | # This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 17 | # of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 18 | # 19 | # A copy of the GNU General Public License is available at http://www.gnu.org/licenses/. 20 | # 21 | ############################################################################################################################# 22 | 23 | [CmdletBinding()] param( 24 | [string]$iZip = "", 25 | [string[]]$pkgDir = @(), 26 | [string]$outDir = $(Split-Path $MyInvocation.MyCommand.Path), 27 | [string]$ipname = "", 28 | [string]$ipvendor = "", 29 | [string]$ipdesc = "", 30 | [switch]$vft = $false, 31 | [string[]]$dpt = @(), 32 | [string[]]$load = @(), 33 | [string[]]$remove = @(), 34 | [switch]$test = $false, 35 | [switch]$sip = $false, 36 | [switch]$nsc = $false, 37 | [switch]$help = $false, 38 | [switch]$ozip = $false, 39 | [switch]$v50 = $false, 40 | [switch]$v51 = $false, 41 | [switch]$v55 = $false, 42 | [switch]$v60 = $false, 43 | [switch]$v65 = $false, 44 | [switch]$v67 = $false, 45 | [switch]$v70 = $false, 46 | [switch]$v80 = $false, 47 | [switch]$update = $false, 48 | [string]$pZip = "", 49 | [string]$log = ($env:TEMP + "\ESXi-Customizer-PS-" + $PID + ".log") 50 | ) 51 | 52 | # Constants 53 | $ScriptName = "ESXi-Customizer-PS" 54 | $ScriptVersion = "2.9.0" 55 | $ScriptURL = "https://ESXi-Customizer-PS.v-front.de" 56 | 57 | $AccLevel = @{"VMwareCertified" = 1; "VMwareAccepted" = 2; "PartnerSupported" = 3; "CommunitySupported" = 4} 58 | 59 | # Online depot URLs 60 | $vmwdepotURL = "https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/vmw-depot-index.xml" 61 | $vftdepotURL = "https://vibsdepot.v-front.de/" 62 | 63 | # Function to update/add VIB package 64 | function AddVIB2Profile($vib) { 65 | $AddVersion = $vib.Version 66 | $ExVersion = ($MyProfile.VibList | where { $_.Name -eq $vib.Name }).Version 67 | 68 | # Check for vib replacements 69 | $ExName = "" 70 | if ($ExVersion -eq $null) { 71 | foreach ($replaces in $vib.replaces) { 72 | $ExVib = $MyProfile.VibList | where { $_.Name -eq $replaces } 73 | if ($ExVib -ne $null) { 74 | $ExName = $ExVib.Name + " " 75 | $ExVersion = $ExVib.Version 76 | break 77 | } 78 | } 79 | } 80 | 81 | if ($AccLevel[$vib.AcceptanceLevel.ToString()] -gt $AccLevel[$MyProfile.AcceptanceLevel.ToString()]) { 82 | write-host -F Yellow -nonewline (" [New AcceptanceLevel: " + $vib.AcceptanceLevel + "]") 83 | $MyProfile.AcceptanceLevel = $vib.AcceptanceLevel 84 | } 85 | If ($MyProfile.VibList -contains $vib) { 86 | write-host -F Yellow " [IGNORED, already added]" 87 | } else { 88 | Add-EsxSoftwarePackage -SoftwarePackage $vib -Imageprofile $MyProfile -Force -ErrorAction SilentlyContinue | Out-Null 89 | if ($?) { 90 | if ($ExVersion -eq $null) { 91 | write-host -F Green " [OK, added]" 92 | } else { 93 | write-host -F Green (" [OK, replaced " + $ExName + $ExVersion + "]") 94 | } 95 | } else { 96 | write-host -F Red " [FAILED, invalid package?]" 97 | } 98 | } 99 | } 100 | 101 | # Function to test if entered string is numeric 102 | function isNumeric ($x) { 103 | $x2 = 0 104 | $isNum = [System.Int32]::TryParse($x, [ref]$x2) 105 | return $isNum 106 | } 107 | 108 | # Clean-up function 109 | function cleanup() { 110 | Stop-Transcript | Out-Null 111 | if ($DefaultSoftwaredepots) { Remove-EsxSoftwaredepot $DefaultSoftwaredepots } 112 | } 113 | 114 | # Write info and help if requested 115 | write-host ("`nThis is " + $ScriptName + " Version " + $ScriptVersion + " (visit " + $ScriptURL + " for more information!)") 116 | if ($help) { 117 | write-host "`nUsage:" 118 | write-host " ESXi-Customizer-PS [-help] | [-izip [-update]] [-sip] [-v80|-v70|-v67|-v65|-v60|-v55|-v51|-v50]" 119 | write-host " [-ozip] [-pkgDir [,...]] [-outDir ] [-vft] [-dpt depot1[,...]]" 120 | write-host " [-load vib1[,...]] [-remove vib1[,...]] [-log ] [-ipname ]" 121 | write-host " [-ipdesc ] [-ipvendor ] [-nsc] [-test]" 122 | write-host "`nOptional parameters:" 123 | write-host " -help : display this help" 124 | write-host " -izip : use the VMware Offline bundle as input instead of the Online depot" 125 | write-host " -update : only with -izip, updates a local bundle with an ESXi patch from the VMware Online depot," 126 | write-host " combine this with the matching ESXi version selection switch" 127 | write-host " -pzip : use an Offline patch bundle instead of the Online depot with -update." 128 | write-host " -pkgDir [,...]: local directories of Offline bundles and/or VIB files to add (if any, no default)" 129 | write-host " -ozip : output an Offline bundle instead of an installation ISO" 130 | write-host " -outDir : directory to store the customized ISO or Offline bundle (the default is the" 131 | write-host " script directory. If specified the log file will also be moved here.)" 132 | write-host " -vft : connect the V-Front Online depot" 133 | write-host " -dpt depot1[,...] : connect additional Online depots by URL or local Offline bundles by file name" 134 | write-host " -load vib1[,...] : load additional packages from connected depots or Offline bundles" 135 | write-host " -remove vib1[,...] : remove named VIB packages from the custom Imageprofile" 136 | write-host " -sip : select an Imageprofile from the current list" 137 | write-host " (default = auto-select latest available standard profile)" 138 | write-host " -v80 | -v70 |" 139 | write-host " -v67 | -v65 | -v60 |" 140 | write-host " -v55 | -v51 | -v50 : Use only ESXi 8.0/7.0/6.7/6.5/6.0/5.5/5.1/5.0 Imageprofiles as input, ignore other versions" 141 | write-host " -nsc : use -NoSignatureCheck with export" 142 | write-host " -log : Use custom log file " 143 | write-host " -ipname " 144 | write-host " -ipdesc " 145 | write-host " -ipvendor : provide a name, description and/or vendor for the customized" 146 | write-host " Imageprofile (the default is derived from the cloned input Imageprofile)" 147 | write-host " -test : skip package download and image build (for testing)`n" 148 | exit 149 | } else { 150 | write-host "(Call with -help for instructions)" 151 | if (!($PSBoundParameters.ContainsKey('log')) -and $PSBoundParameters.ContainsKey('outDir')) { 152 | write-host ("`nTemporarily logging to " + $log + " ...") 153 | } else { 154 | write-host ("`nLogging to " + $log + " ...") 155 | } 156 | # Stop active transcript 157 | try { Stop-Transcript | out-null } catch {} 158 | # Start own transcript 159 | try { Start-Transcript -Path $log -Force -Confirm:$false | Out-Null } catch { 160 | write-host -F Red "`nFATAL ERROR: Log file cannot be opened. Bad file path or missing permission?`n" 161 | exit 162 | } 163 | } 164 | 165 | # The main try ... 166 | 167 | $isModule = @{} 168 | try { 169 | 170 | # Check for and enable Ssl3 & Tls12 support for this session (WinError 10054 workaround, may still fail at times.) 171 | if ([Net.ServicePointManager]::SecurityProtocol -notcontains 'Ssl3') { 172 | [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Ssl3 | Out-Null 173 | } 174 | if ([Net.ServicePointManager]::SecurityProtocol -notcontains 'Tls12') { 175 | [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12 | Out-Null 176 | } 177 | 178 | # Check for and load required modules/snapins 179 | foreach ($comp in "VMware.VimAutomation.Core", "VMware.ImageBuilder", "VMware.PowerCLI") { 180 | if (Get-Module -ListAvailable -Name $comp -ErrorAction:SilentlyContinue) { 181 | $isModule[$comp] = $true 182 | if (!(Get-Module -Name $comp -ErrorAction:SilentlyContinue)) { 183 | if (!(Import-Module -PassThru -Name $comp -ErrorAction:SilentlyContinue)) { 184 | write-host -F Red "`nFATAL ERROR: Failed to import the $comp module!`n" 185 | exit 186 | } 187 | } 188 | } else { 189 | $isModule[$comp] = $false 190 | if (Get-PSSnapin -Registered -Name $comp -ErrorAction:SilentlyContinue) { 191 | if (!(Get-PSSnapin -Name $comp -ErrorAction:SilentlyContinue)) { 192 | if (!(Add-PSSnapin -PassThru -Name $comp -ErrorAction:SilentlyContinue)) { 193 | write-host -F Red "`nFATAL ERROR: Failed to add the $comp snap-in!`n" 194 | exit 195 | } 196 | } 197 | } else { 198 | write-host -F Red "`nFATAL ERROR: $comp is not available as a module or snap-in! It looks like there is no compatible version of PowerCLI installed!`n" 199 | exit 200 | } 201 | } 202 | } 203 | 204 | # Parameter sanity check 205 | if ( ($v50 -and ($v51 -or $v55 -or $v60 -or $v65 -or $v67 -or $v70 -or $v80)) -or ($v51 -and ($v55 -or $v60 -or $v65 -or $v67 -or $v70 -or $v80)) -or ($v55 -and ($v60 -or $v65 -or $v67 -or $v70 -or $v80)) -or ($v60 -and ($v65 -or $v67 -or $70 -or $v80)) -or ($v65 -and ($v67 -or $v70 -or $v80)) -or ($v70 -and ($v51 -or $v55 -or $v60 -or $v65 -or $v67 -or $v80)) -or ($v80 -and ($v51 -or $v55 -or $v60 -or $v65 -or $v67 -or $v70))) { 206 | write-host -F Yellow "`nWARNING: Multiple ESXi versions specified. Highest version will take precedence!" 207 | } 208 | if ($update -and ($izip -eq "")) { 209 | write-host -F Red "`nFATAL ERROR: -update requires -izip!`n" 210 | exit 211 | } 212 | 213 | # Check PowerShell and PowerCLI version 214 | if (!(Test-Path variable:PSVersionTable)) { 215 | write-host -F Red "`nFATAL ERROR: This script requires at least PowerShell version 2.0!`n" 216 | exit 217 | } 218 | $psv = $PSVersionTable.PSVersion | select Major,Minor 219 | 220 | if ($isModule["VMware.VimAutomation.Core"]) { 221 | $pcmv = (Get-Module VMware.PowerCLI).Version | select Major,Minor,Build,Revision 222 | write-host -F Yellow ("`nRunning with PowerShell version " + $psv.Major + "." + $psv.Minor + " and VMware PowerCLI version " + $pcmv.Major + "." + $pcmv.Minor + "." + $pcmv.Build + " build " + $pcmv.Revision ) 223 | } else { 224 | $pcv = Get-PowerCLIVersion | select major,minor,UserFriendlyVersion 225 | write-host -F Yellow ("`nRunning with PowerShell version " + $psv.Major + "." + $psv.Minor + " and " + $pcv.UserFriendlyVersion) 226 | if ( ($pcv.major -lt 5) -or (($pcv.major -eq 5) -and ($pcv.minor -eq 0)) ) { 227 | write-host -F Red "`nFATAL ERROR: This script requires at least PowerCLI version 5.1 !`n" 228 | exit 229 | } 230 | } 231 | 232 | if ($update) { 233 | # Try to add Offline bundle specified by -izip 234 | write-host -nonewline "`nAdding Base Offline bundle $izip (to be updated)..." 235 | if ($upddepot = Add-EsxSoftwaredepot $izip) { 236 | write-host -F Green " [OK]" 237 | } else { 238 | write-host -F Red "`nFATAL ERROR: Cannot add Base Offline bundle!`n" 239 | exit 240 | } 241 | if (!($CloneIP = Get-EsxImageprofile -Softwaredepot $upddepot)) { 242 | write-host -F Red "`nFATAL ERROR: No Imageprofiles found in Base Offline bundle!`n" 243 | exit 244 | } 245 | if ($CloneIP -is [system.array]) { 246 | # Input Offline bundle includes multiple Imageprofiles. Pick only the latest standard profile: 247 | write-host -F Yellow "Warning: Input Offline Bundle contains multiple Imageprofiles. Will pick the latest standard profile!" 248 | $CloneIP = @( $CloneIP | Sort-Object -Descending -Property @{Expression={$_.Name.Substring(0,10)}},@{Expression={$_.CreationTime.Date}},Name )[0] 249 | } 250 | } 251 | 252 | if ($update -and $pzip -ne "") { 253 | $vmwdepotURL = $pZip 254 | } 255 | 256 | if (($izip -eq "") -or $update) { 257 | # Connect the VMware ESXi base depot 258 | write-host -nonewline "`nConnecting the VMware ESXi Software depot ..." 259 | if ($basedepot = Add-EsxSoftwaredepot $vmwdepotURL) { 260 | write-host -F Green " [OK]" 261 | } else { 262 | write-host -F Red "`nFATAL ERROR: Cannot add VMware ESXi Online depot. Please check your Internet connectivity and/or proxy settings!`n" 263 | exit 264 | } 265 | } else { 266 | # Try to add Offline bundle specified by -izip 267 | write-host -nonewline "`nAdding base Offline bundle $izip ..." 268 | if ($basedepot = Add-EsxSoftwaredepot $izip) { 269 | write-host -F Green " [OK]" 270 | } else { 271 | write-host -F Red "`nFATAL ERROR: Cannot add VMware base Offline bundle!`n" 272 | exit 273 | } 274 | } 275 | 276 | if ($vft) { 277 | # Connect the V-Front Online depot 278 | write-host -nonewline "`nConnecting the V-Front Online depot ..." 279 | if ($vftdepot = Add-EsxSoftwaredepot $vftdepotURL) { 280 | write-host -F Green " [OK]" 281 | } else { 282 | write-host -F Red "`nFATAL ERROR: Cannot add the V-Front Online depot. Please check your internet connectivity and/or proxy settings!`n" 283 | exit 284 | } 285 | } 286 | 287 | if ($dpt -ne @()) { 288 | # Connect additional depots (Online depot or Offline bundle) 289 | $AddDpt = @() 290 | for ($i=0; $i -lt $dpt.Length; $i++ ) { 291 | write-host -nonewline ("`nConnecting additional depot " + $dpt[$i] + " ...") 292 | if ($AddDpt += Add-EsxSoftwaredepot $dpt[$i]) { 293 | write-host -F Green " [OK]" 294 | } else { 295 | write-host -F Red "`nFATAL ERROR: Cannot add Online depot or Offline bundle. In case of Online depot check your Internet" 296 | write-host -F Red "connectivity and/or proxy settings! In case of Offline bundle check file name, format and permissions!`n" 297 | exit 298 | } 299 | } 300 | } 301 | 302 | write-host -NoNewLine "`nGetting Imageprofiles, please wait ..." 303 | $iplist = @() 304 | if ($iZip -and !($update)) { 305 | Get-EsxImageprofile -Softwaredepot $basedepot | foreach { $iplist += $_ } 306 | } else { 307 | if ($v80) { 308 | $pcmv = (Get-Module VMware.PowerCLI).Version | select Major,Minor,Build,Revision 309 | if (( $pcmv.Major -le 12 ) -and ( $pcmv.Minor -le 7 )) { 310 | Write-Warning "*** This version of PowerCLI cannot be used to create an ESXi 8.x .iso, please update to a newer PowerCLI version if available...***`n`n(Refer to https://williamlam.com/2022/11/quick-tip-changes-to-building-custom-esxi-images-in-vsphere-8.html for more info...)" 311 | exit 312 | } else { 313 | Get-EsxImageprofile "ESXi-8.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 314 | } 315 | } elseif ($v70) { 316 | Get-EsxImageprofile "ESXi-7.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 317 | } elseif ($v67) { 318 | Get-EsxImageprofile "ESXi-6.7*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 319 | } elseif ($v65) { 320 | Get-EsxImageprofile "ESXi-6.5*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 321 | } elseif ($v60) { 322 | Get-EsxImageprofile "ESXi-6.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 323 | } elseif ($v55) { 324 | Get-EsxImageprofile "ESXi-5.5*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 325 | } elseif ($v51) { 326 | Get-EsxImageprofile "ESXi-5.1*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 327 | } elseif ($v50) { 328 | Get-EsxImageprofile "ESXi-5.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 329 | } else { 330 | # Workaround for http://kb.vmware.com/kb/2089217 331 | Get-EsxImageprofile "ESXi-5.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 332 | Get-EsxImageprofile "ESXi-5.1*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 333 | Get-EsxImageprofile "ESXi-5.5*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 334 | Get-EsxImageprofile "ESXi-6.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 335 | Get-EsxImageprofile "ESXi-6.5*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 336 | Get-EsxImageprofile "ESXi-6.7*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 337 | Get-EsxImageprofile "ESXi-7.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 338 | Get-EsxImageprofile "ESXi-8.0*" -Softwaredepot $basedepot | foreach { $iplist += $_ } 339 | } 340 | } 341 | 342 | if ($iplist.Length -eq 0) { 343 | write-host -F Red " [FAILED]`n`nFATAL ERROR: No valid Imageprofile(s) found!" 344 | if ($iZip) { 345 | write-host -F Red "The input file is probably not a full ESXi base bundle.`n" 346 | } 347 | exit 348 | } else { 349 | write-host -F Green " [OK]" 350 | $iplist = @( $iplist | Sort-Object -Descending -Property @{Expression={$_.Name.Substring(0,10)}},@{Expression={$_.CreationTime.Date}},Name ) 351 | } 352 | 353 | # if -sip then display menu of available image profiles ... 354 | if ($sip) { 355 | if ($update) { 356 | write-host "`nSelect Imageprofile to use for update:" 357 | } else { 358 | write-host "`nSelect Base Imageprofile:" 359 | } 360 | write-host "-------------------------------------------" 361 | for ($i=0; $i -lt $iplist.Length; $i++ ) { 362 | write-host ($i+1): $iplist[$i].Name 363 | } 364 | write-host "-------------------------------------------" 365 | do { 366 | $sel = read-host "Enter selection" 367 | if (isNumeric $sel) { 368 | if (([int]$sel -lt 1) -or ([int]$sel -gt $iplist.Length)) { $sel = $null } 369 | } else { 370 | $sel = $null 371 | } 372 | } until ($sel) 373 | $idx = [int]$sel-1 374 | } else { 375 | $idx = 0 376 | } 377 | if ($update) { 378 | $updIP = $iplist[$idx] 379 | } else { 380 | $CloneIP = $iplist[$idx] 381 | } 382 | 383 | write-host ("`nUsing Imageprofile " + $CloneIP.Name + " ...") 384 | write-host ("(Dated " + $CloneIP.CreationTime + ", AcceptanceLevel: " + $CloneIP.AcceptanceLevel + ",") 385 | write-host ($CloneIP.Description + ")") 386 | 387 | # If customization is required ... 388 | if ( ($pkgDir -ne @()) -or $update -or ($load -ne @()) -or ($remove -ne @()) ) { 389 | 390 | # Create your own Imageprofile 391 | if ($ipname -eq "") { $ipname = $CloneIP.Name + "-customized" } 392 | if ($ipvendor -eq "") { $ipvendor = $CloneIP.Vendor } 393 | if ($ipdesc -eq "") { $ipdesc = $CloneIP.Description + " (customized)" } 394 | $MyProfile = New-EsxImageprofile -CloneProfile $CloneIP -Vendor $ipvendor -Name $ipname -Description $ipdesc 395 | 396 | # Update from Online depot profile 397 | if ($update) { 398 | write-host ("`nUpdating with the VMware Imageprofile " + $UpdIP.Name + " ...") 399 | write-host ("(Dated " + $UpdIP.CreationTime + ", AcceptanceLevel: " + $UpdIP.AcceptanceLevel + ",") 400 | write-host ($UpdIP.Description + ")") 401 | $diff = Compare-EsxImageprofile $MyProfile $UpdIP 402 | $diff.UpgradeFromRef | foreach { 403 | $uguid = $_ 404 | $uvib = Get-EsxSoftwarePackage | where { $_.Guid -eq $uguid } 405 | write-host -nonewline " Add VIB" $uvib.Name $uvib.Version 406 | AddVIB2Profile $uvib 407 | } 408 | } 409 | 410 | # Loop over Offline bundles and VIB files 411 | if ($pkgDir -ne @()) { 412 | write-host "`nLoading Offline bundles and VIB files from" $pkgDir ... 413 | foreach ($dir in $pkgDir) { 414 | foreach ($obundle in Get-Item $dir\*.zip) { 415 | write-host -nonewline " Loading" $obundle ... 416 | if ($ob = Add-EsxSoftwaredepot $obundle -ErrorAction SilentlyContinue) { 417 | write-host -F Green " [OK]" 418 | $ob | Get-EsxSoftwarePackage | foreach { 419 | write-host -nonewline " Add VIB" $_.Name $_.Version 420 | AddVIB2Profile $_ 421 | } 422 | } else { 423 | write-host -F Red " [FAILED]`n Probably not a valid Offline bundle, ignoring." 424 | } 425 | } 426 | foreach ($vibFile in Get-Item $dir\*.vib) { 427 | write-host -nonewline " Loading" $vibFile ... 428 | try { 429 | $vib1 = Get-EsxSoftwarePackage -PackageUrl $vibFile -ErrorAction SilentlyContinue 430 | write-host -F Green " [OK]" 431 | write-host -nonewline " Add VIB" $vib1.Name $vib1.Version 432 | AddVIB2Profile $vib1 433 | } catch { 434 | write-host -F Red " [FAILED]`n Probably not a valid VIB file, ignoring." 435 | } 436 | } 437 | } 438 | } 439 | # Load additional packages from Online depots or Offline bundles 440 | if ($load -ne @()) { 441 | write-host "`nLoad additional VIBs from Online depots ..." 442 | for ($i=0; $i -lt $load.Length; $i++ ) { 443 | if ($ovib = Get-ESXSoftwarePackage $load[$i] -Newest) { 444 | write-host -nonewline " Add VIB" $ovib.Name $ovib.Version 445 | AddVIB2Profile $ovib 446 | } else { 447 | write-host -F Red " [ERROR] Cannot find VIB named" $load[$i] "!" 448 | } 449 | } 450 | } 451 | # Remove selected VIBs 452 | if ($remove -ne @()) { 453 | write-host "`nRemove selected VIBs from Imageprofile ..." 454 | for ($i=0; $i -lt $remove.Length; $i++ ) { 455 | write-host -nonewline " Remove VIB" $remove[$i] 456 | try { 457 | Remove-EsxSoftwarePackage -ImageProfile $MyProfile -SoftwarePackage $remove[$i] | Out-Null 458 | write-host -F Green " [OK]" 459 | } catch { 460 | write-host -F Red " [FAILED]`n VIB does probably not exist or cannot be removed without breaking dependencies." 461 | } 462 | } 463 | } 464 | 465 | } else { 466 | $MyProfile = $CloneIP 467 | } 468 | 469 | 470 | # Build the export command: 471 | $cmd = "Export-EsxImageprofile -Imageprofile " + "`'" + $MyProfile.Name + "`'" 472 | 473 | if ($ozip) { 474 | $outFile = "`'" + $outDir + "\" + $MyProfile.Name + ".zip" + "`'" 475 | $cmd = $cmd + " -ExportTobundle" 476 | } else { 477 | $outFile = "`'" + $outDir + "\" + $MyProfile.Name + ".iso" + "`'" 478 | $cmd = $cmd + " -ExportToISO" 479 | } 480 | $cmd = $cmd + " -FilePath " + $outFile 481 | if ($nsc) { $cmd = $cmd + " -NoSignatureCheck" } 482 | $cmd = $cmd + " -Force" 483 | 484 | # Run the export: 485 | write-host -nonewline ("`nExporting the Imageprofile to " + $outFile + ". Please be patient ...") 486 | if ($test) { 487 | write-host -F Yellow " [Skipped]" 488 | } else { 489 | write-host "`n" 490 | Invoke-Expression $cmd 491 | } 492 | 493 | write-host -F Green "`nAll done.`n" 494 | 495 | # The main catch ... 496 | } catch { 497 | write-host -F Red ("`n`nAn unexpected error occurred:`n" + $Error[0]) 498 | write-host -F Red ("`nIf requesting support please be sure to include the log file`n " + $log + "`n`n") 499 | 500 | # The main cleanup 501 | } finally { 502 | cleanup 503 | if (!($PSBoundParameters.ContainsKey('log')) -and $PSBoundParameters.ContainsKey('outDir') -and ($outFile -like '*zip*')) { 504 | $finalLog = ($outDir + "\" + $MyProfile.Name + ".zip" + "-" + (get-date -Format yyyyMMddHHmm) + ".log") 505 | Move-Item $log $finalLog -force 506 | write-host ("(Log file moved to " + $finalLog + ")`n") 507 | } elseif (!($PSBoundParameters.ContainsKey('log')) -and $PSBoundParameters.ContainsKey('outDir') -and ($outFile -like '*iso*')) { 508 | $finalLog = ($outDir + "\" + $MyProfile.Name + ".iso" + "-" + (Get-Date -Format yyyyMMddHHmm) + ".log") 509 | Move-Item $log $finalLog -force 510 | write-host ("(Log file moved to " + $finalLog + ")`n") 511 | } 512 | } 513 | -------------------------------------------------------------------------------- /docs/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------