New-PxeImage - vSphere ImageBuilder Reference

PowerCLI Reference

vSphere ImageBuilder Reference

New-PxeImage

Synopsis

This cmdlet generates a PXE image by using the specified software depot and software specification.

Syntax

New-PxeImage [-Depots] <String[]> [-SoftwareSpec] <String> [-KernelOptions <String[]>] [-CheckAcceptance] [-LiveImage] [-Overwrite] -Destination <String> [<CommonParameters>]

Related Commands

Get-DepotAddons
Get-DepotBaseImages
Get-DepotComponents
Get-DepotInfo
Get-DepotVibs
New-IsoImage

Detailed Description

This cmdlet generates a PXE image by using the specified software depot and software specification at the specified file path. Optionally, you can pass additional kernel options, create a live image instead, overwrite existing files, or check acceptance levels for individual VIBs used during the creation of the image.

Parameters

Name Type Description Required? Pipeline Input Default Value
Depot String[] Specifies one or more locations of software depots that contain the payloads to create the image. The value can be either a file path to an offline depot in the format of "C:\<depot>.zip" or an URL address to the index file of the online depot in the format of "https://<address-to-depot>/index.xml". true false None
SoftwareSpec String Specifies a software specification to use for the creation of the image. The software specification describes what building blocks to use when creating the PXE. All requirements in the specification need to be satisfied by the specified software depots. true false None
KernelOptions String[] Indicates that you want to set additional kernel options for the image. The value must be a comma-separated array in the format of "<option>=<value>". false false None
CheckAcceptance SwitchParameter Indicates that you want to validate the acceptance level of individual VIBs used for the creation of the image. false false False
LiveImage SwitchParameter Indicates that you want to create a live image instead of an installer image. false false False
Overwrite SwitchParameter Indicates that you want to overwrite existing files when writing the image. false false False
Destination String Indicates that you want to store the newly created image at the specified destination. true false None

Return Type

No return type

Notes

No notes

Examples

-------------- Create a PXE image --------------

C:\PS>New-PxeImage "C:\<depot>.zip", "https://<address-to-depot>/index.xml" "C:\<spec>.json" -Destination "C:\<name-of-pxe-directory>"

Creates a new PXE image by using the depots located at "C:\<depot>.zip" and "https://<address-to-depot>/index.xml" (one offline and one online depot, can be used in any number and combination). Uses the software specification located at "C:\<spec>.json" to construct the image and saves the PXE files to "C:\<name-of-pxe-directory>" afterwards.

-------------- Create an PXE image with kernel options --------------

C:\PS>New-PXEImage "C:\<depot>.zip", "https://<address-to-depot>/index.xml" "C:\<spec>.json" -Destination "C:\<name-of-pxe-directory>" -KernelOptions "option1=value1", "option2=value2"

Creates a new PXE image by using the depots located at "C:\<depot>.zip" and "https://<address-to-depot>/index.xml" (one offline and one online depot, can be used in any number and combination). Uses the software specification located at "C:\<spec>.json" to construct the image and include the additional kernel options "option1=value1", "option2=value2" provided with -KernelOptions. Saves the PXE files to "C:\<name-of-pxe-directory>" afterwards.


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