net472/VMware.ImageBuilder.Cmdlets.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ImageBuilderCommand</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ImageBuilderCommand</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ImageBuilderCommand</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-EsxSoftwareDepot</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>EsxSoftwareDepot</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Adds an ESX software depot or offline depot ZIP file to the current PowerCLI session. Use this cmdlet right after you start Image Builder by adding the Image Builder snap-in. The cmdlet imports metadata from the specified depots. You can then create new image profiles and generate ISOs from the image profiles and VIBs in the depots. The metadata from the depots is kept in memory until the PowerCLI session ends. When you run the cmdlet, Image Builder downloads and parses the metadata from the depot and analyzes the VIBs for dependencies. The depot will be added to the list of depots maintained in the implicit session variable $DefaultSoftwareDepots that stores all software depots (similar to $DefaultVIServers). If the software depot was previously added, metadata from the depot will be downloaded again.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EsxSoftwareDepot</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>DepotUrl</maml:name> <maml:description> <maml:para>Either a string or an array of strings; each string represents the URL of a depot or a file path to an offline depot ZIP file. The offline depot ZIP file must have the .zip extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>DepotUrl</maml:name> <maml:description> <maml:para>Either a string or an array of strings; each string represents the URL of a depot or a file path to an offline depot ZIP file. The offline depot ZIP file must have the .zip extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>Returns zero or more SoftwareDepot objects corresponding to the successfully attached software depots.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-EsxSoftwareDepot https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/vmw-depot-index.xml</dev:code> <dev:remarks> <maml:para>Connect to a depot.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$depot = Add-EsxSoftwareDepot https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/vmw-depot-index.xml</dev:code> <dev:remarks> <maml:para>Connect to a depot, saving it to a variable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-EsxSoftwarePackage</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>EsxSoftwarePackage</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Adds new VIBs to an image profile or updates existing VIBs in an image profile. For each package, if it is newer or older than an existing package in the profile, the existing package will be replaced. Image Builder performs all image profile validation tests on the modified image profile. The output of this cmdlet may be piped into any other cmdlet taking image profiles as input. Note that the image profile object that is passed in will have its VibList modified. Please see the New-EsxImageProfile cmdlet for details about persistence of image profiles. Modification is not possible if the ReadOnly property of an ImageProfile is true.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EsxSoftwarePackage</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(pipeline input, prompt) 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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "2" > <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>(pipeline input, prompt) List of software packages to add to the profile.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. Image Builder selects the highest available version of the named package.*"<Name> <Version>", for specifying a specific version of a VIB.*SoftwarePackage object*GUID of the VIB (from the Guid property of a SoftwarePackage object)*A list containing a mix of any of the aboveIf more than one vendor provides a package with the same name, then a non-terminating error results and the cmdlet skips that package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwarePackage[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(pipeline input, prompt) 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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ImageProfile</command:parameterValue> <dev:type> <maml:name>ImageProfile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2"> <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>(pipeline input, prompt) List of software packages to add to the profile.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. Image Builder selects the highest available version of the named package.*"<Name> <Version>", for specifying a specific version of a VIB.*SoftwarePackage object*GUID of the VIB (from the Guid property of a SoftwarePackage object)*A list containing a mix of any of the aboveIf more than one vendor provides a package with the same name, then a non-terminating error results and the cmdlet skips that package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwarePackage[]</command:parameterValue> <dev:type> <maml:name>SoftwarePackage[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>The modified, validated ImageProfile object that was passed in.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-EsxSoftwarePackage -ImageProfile "My custom profile" -SoftwarePackage net-bnx2</dev:code> <dev:remarks> <maml:para>Add a package by name to an image profile:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-EsxSoftwarePackage -ImageProfile "My custom profile" -SoftwarePackage "net-bnx2 1.6.7-0.1OEM1"</dev:code> <dev:remarks> <maml:para>Add a package of a specific name and version:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-EsxImageProfile -CloneProfile "ESX-5.0-234567-standard" -Name "My custom profile" | \ Add-EsxSoftwarePackage net-bnx2</dev:code> <dev:remarks> <maml:para>Clone an image profile, then add a package by name, in one line using pipelining:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Compare-EsxImageProfile</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Compare</command:verb> <command:noun>EsxImageProfile</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Returns an ImageProfileDiff object that specifies whether two profiles have the same VIB list and acceptance level. If two profiles are different, the ImageProfileDiff object specifies the differences.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Compare-EsxImageProfile</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>ReferenceProfile</maml:name> <maml:description> <maml:para>(pipeline input, prompt) Specifies the reference image profile for comparison.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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>ComparisonProfile</maml:name> <maml:description> <maml:para>(prompt) The image profile to compare against. 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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ReferenceProfile</maml:name> <maml:description> <maml:para>(pipeline input, prompt) Specifies the reference image profile for comparison.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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ImageProfile</command:parameterValue> <dev:type> <maml:name>ImageProfile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ComparisonProfile</maml:name> <maml:description> <maml:para>(prompt) The image profile to compare against. 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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ImageProfile</command:parameterValue> <dev:type> <maml:name>ImageProfile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Compare-EsxImageProfile "Profile 1" "Profile 2"</dev:code> <dev:remarks> <maml:para>Compares Profile 1 with Profile 2.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-EsxImageProfile</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Export</command:verb> <command:noun>EsxImageProfile</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Exports an Image Profile object as either an ESXi ISO image that can be booted up and used as an ESXi installer, or an offline depot ZIP file that contains metadata plus the VIB packages. In both cases, downloads the VIB binaries and validates the VIB signatures. You can perform the following tasks with the offline depot ZIP file: *Import the ZIP into VMware Update Manager for patch remediation *Download the ZIP to an ESXi host and used with esxcli for installation *Re-import the ZIP into ImageBuilder itself using Add-EsxSoftwareDepot You can specify either -ExportToIso or -ExportToBundle but not both.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-EsxImageProfile</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(pipeline input, prompt) Specifies the image profile to export.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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>FilePath</maml:name> <maml:description> <maml:para>Required; specifies the destination for the ISO or the ZIP file path. Include the extension, either .iso or .zip. Offline depots must be named with .zip at the end. If the file already exists, it will not be overwritten unless -Force is specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ExportToIso</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>Optional. If specified, the cmdlet overwrites an existing destination file with the same name.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NoSignatureCheck</maml:name> <maml:description> <maml:para>Optional. If specified, disables VIB signature validation. The use of this option may lead to debilitating security vulnerabilities.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-EsxImageProfile</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(pipeline input, prompt) Specifies the image profile to export.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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>FilePath</maml:name> <maml:description> <maml:para>Required; specifies the destination for the ISO or the ZIP file path. Include the extension, either .iso or .zip. Offline depots must be named with .zip at the end. If the file already exists, it will not be overwritten unless -Force is specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ExportToBundle</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>Optional. If specified, the cmdlet overwrites an existing destination file with the same name.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NoSignatureCheck</maml:name> <maml:description> <maml:para>Optional. If specified, disables VIB signature validation. The use of this option may lead to debilitating security vulnerabilities.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(pipeline input, prompt) Specifies the image profile to export.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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ImageProfile</command:parameterValue> <dev:type> <maml:name>ImageProfile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Required; specifies the destination for the ISO or the ZIP file path. Include the extension, either .iso or .zip. Offline depots must be named with .zip at the end. If the file already exists, it will not be overwritten unless -Force is specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportToIso</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Optional. If specified, the cmdlet overwrites an existing destination file with the same name.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoSignatureCheck</maml:name> <maml:description> <maml:para>Optional. If specified, disables VIB signature validation. The use of this option may lead to debilitating security vulnerabilities.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportToBundle</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>None</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Export-EsxImageProfile -ImageProfile "Evan's Profile" -ExportToIso -FilePath c:\isos\evans-iso.iso</dev:code> <dev:remarks> <maml:para>Export an ISO image</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-EsxImageProfile -CloneProfile "ESXi-5.0.0-234567-standard" -Name "Evan's Profile" Add-EsxSoftwarePackage -ImageProfile "Evan's Profile" -SoftwarePackage cisco-vem-v140 Export-EsxImageProfile -ImageProfile "Evan's Profile" -ExportToBundle -FilePath c:\isos\base-plus-vem.zip</dev:code> <dev:remarks> <maml:para>Clone an image profile, add a software package, then export to offline bundle.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DepotAddons</command:name> <maml:description> <maml:para>This cmdlet retrieves basic information about addons in the software depot.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DepotAddons</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves an array of objects that provide basic information about addons in the software depot. Optionally, you can use the -Id parameter to get an object with detailed information about the addon with the specified ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DepotAddons</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the addons. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of an addon contained in the specified software depot. The ID value must be in the format of"<name>:<version>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the addons. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of an addon contained in the specified software depot. The ID value must be in the format of"<name>:<version>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Array of AddonInfo. Optionally, Addon.</maml:name> <maml:uri /> <maml:description> <maml:para>Array of AddonInfo - data structure that provides basic information about an addon. Optionally, an Addon object - a data structure that provides detailed information about an addon, if the -Id parameter was passed.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- List addons in depot (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotAddons "C:\<depot>.zip"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the addons contained in the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- List addons in depot (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotAddons "https://<address-of-depot>/index.xml"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the addons contained in the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get addon by id (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotAddons "C:\<depot>.zip" -Id "<addon-id>"</dev:code> <dev:remarks> <maml:para>Retrieves detailed information about the addon with ID "<addon-id>" from the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get addon by id (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotAddons "https://<address-of-depot>/index.xml" -Id "<addon-id>"</dev:code> <dev:remarks> <maml:para>Retrieves detailed information about the addon with ID "<addon-id>" from the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DepotBaseImages</command:name> <maml:description> <maml:para>This cmdlet retrieves basic information about base images in the software depot.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DepotBaseImages</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves an array of objects that provide basic information about base images in the software depot. Optionally, you can use the -Version parameter to get an object with detailed information about the base image with the specified version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DepotBaseImages</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the base images. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of a base image contained in the specified software depot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the base images. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of a base image contained in the specified software depot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Array of BaseImageInfo. Optionally, BaseImage.</maml:name> <maml:uri /> <maml:description> <maml:para>Array of BaseImageInfo - data structure that provides basic information about a base image. Optionally, an BaseImage object - a data structure that provides detailed information about an a base image, if the -Version parameter was passed.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- List base images in depot (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotBaseImages "C:\<depot>.zip"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the base images contained in the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- List base images in depot (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotBaseImages "https://<address-of-depot>/index.xml"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the base images contained in the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get base image by version (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotBaseImages "C:\<depot>.zip" -Version "<baseimage-version>"</dev:code> <dev:remarks> <maml:para>Retrieves detailed information about the base image with version "<baseimage-version>" from the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get base image by version (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotBaseImages "https://<address-of-depot>/index.xml" -Id "<baseimage-version>"</dev:code> <dev:remarks> <maml:para>Retrieves detailed information about the base image with version "<baseimage-version>" from the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DepotComponents</command:name> <maml:description> <maml:para>This cmdlet retrieves basic information about components in the software depot.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DepotComponents</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves an array of objects that provide basic information about components in the software depot. Optionally, you can use the -Id parameter to get an object with detailed information about the component with the specified ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DepotComponents</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the components. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a component contained in the specified software depot. The ID value must be in the format of "<name>:<version>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the components. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a component contained in the specified software depot. The ID value must be in the format of "<name>:<version>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Array of ComponentInfo. Optionally, Component.</maml:name> <maml:uri /> <maml:description> <maml:para>Array of ComponentInfo - data structure that provides basic information about a component. Optionally, an Addon object - a data structure that provides detailed information about a component, if the -Id parameter was passed.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- List components in depot (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotComponents "C:\<depot>.zip"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the components contained in the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- List components in depot (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotComponents "https://<address-of-depot>/index.xml"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the components contained in the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get component by id (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotComponents "C:\<depot>.zip" -Id "<component-id>"</dev:code> <dev:remarks> <maml:para>Retrieves detailed information about the component with ID "<component-id>" from the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get component by id (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotComponents "https://<address-of-depot>/index.xml" -Id "<component-id>"</dev:code> <dev:remarks> <maml:para>Retrieves detailed information about the component with ID "<component-id>" from the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DepotInfo</command:name> <maml:description> <maml:para>This cmdlet retrieves basic information about the specified software depot.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DepotInfo</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves basic information about the software depot located at the specified file path or URL address.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DepotInfo</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DepotInfo</maml:name> <maml:uri /> <maml:description> <maml:para>A data structure that provides basic information about a software depot.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get depot info (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepoInfo "C:\<depot>.zip"</dev:code> <dev:remarks> <maml:para>Retrieves basic information about the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get depot info (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotInfo "https://<address-of-depot>/index.xml"</dev:code> <dev:remarks> <maml:para>Retrieves basic information about the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DepotVibs</command:name> <maml:description> <maml:para>This cmdlet retrieves basic information about VIBs in the software depot.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DepotVibs</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves an array of objects that provide basic information about VIBs in the software depot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DepotVibs</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the VIBs. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Depot</maml:name> <maml:description> <maml:para>Specifies the location of the software depot that contains the VIBs. 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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Array of VibInfo</maml:name> <maml:uri /> <maml:description> <maml:para>Array of VibInfo - data structure that provides basic information about a VIB.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- List vibs in depot (offline) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotVibs "C:\<depot>.zip"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the VIBs contained in the software depot located at "C:\<depot>.zip".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- List vibs in depot (online) -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DepotVibs "https://<address-of-depot>/index.xml"</dev:code> <dev:remarks> <maml:para>Retrieves an array of all the VIBs contained in the software depot located at "https://<address-of-depot>/index.xml".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-EsxImageProfile</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EsxImageProfile</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Lists the image profiles from software depots as well as image profiles created by the user. The output is in table form by default. Pass the image profile in the -ImageProfile parameter to the New-EsxImageProfile, Export-EsxImageProfile, Set-EsxImageProfile, Add-EsxSoftwarePackage, Remove-EsxSoftwarePackage, and Compare-EsxImageProfile cmdlets in one of these ways: *Use the name of the image profile *Pipe the output of this cmdlet into the cmdlets See each cmdlet's examples for details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsxImageProfile</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the output to list only image profiles whose Name field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Vendor</maml:name> <maml:description> <maml:para>Filters the output to list only image profiles whose Vendor field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "3" > <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Filters the output to list only image profiles whose AcceptanceLevel field matches one of the strings supplied. Must be one of the following values:*VMwareCertified*VMwareAccepted*PartnerSupported*CommunitySupported</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >AcceptanceLevels[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "4" > <maml:name>SoftwareDepot</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwareDepot[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the output to list only image profiles whose Name field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Vendor</maml:name> <maml:description> <maml:para>Filters the output to list only image profiles whose Vendor field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3"> <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Filters the output to list only image profiles whose AcceptanceLevel field matches one of the strings supplied. Must be one of the following values:*VMwareCertified*VMwareAccepted*PartnerSupported*CommunitySupported</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AcceptanceLevels[]</command:parameterValue> <dev:type> <maml:name>AcceptanceLevels[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>SoftwareDepot</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwareDepot[]</command:parameterValue> <dev:type> <maml:name>SoftwareDepot[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>Zero or more ImageProfile objects.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxImageProfile</dev:code> <dev:remarks> <maml:para>Display all image profiles from depots and all image profiles the user created during this PowerCLI session:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxImageProfile -Name "ESX-5.0*"</dev:code> <dev:remarks> <maml:para>Display all ESX 5.0 profiles:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxImageProfile | ? {$_.Vendor -ne "VMware"}</dev:code> <dev:remarks> <maml:para>Display all image profiles from vendors other than VMware:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>(Get-EsxImageProfile -Name "Profile A").VibList</dev:code> <dev:remarks> <maml:para>List all the VIB packages from a particular image profile:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-EsxSoftwareDepot</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EsxSoftwareDepot</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsxSoftwareDepot</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-EsxSoftwarePackage</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EsxSoftwarePackage</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Returns a list of SoftwarePackage (VIB) objects from all the connected depots, filtered by one or more options. The output is in table form by default. You can pass VIB package names and versions to the New-EsxImageProfile, Set-EsxImageProfile, Add-EsxSoftwarePackage, and Remove-EsxSoftwarePackage cmdlets via the -SoftwarePackage parameter. The output of this cmdlet can also be piped into Add-EsxSoftwarePackage and Remove-EsxSoftwarePackage. See the examples under those cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsxSoftwarePackage</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Name field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Version</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Version field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Vendor</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Vendor field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Tag</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Tag field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose acceptance level matches one of the strings supplied. Must be one of the following values:* VMwareCertified* VMwareAccepted* PartnerSupported* CommunitySupported</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >AcceptanceLevels[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CreatedBefore</maml:name> <maml:description> <maml:para>Filters the output list to only VIBs whose CreationDate is at the latest the DateTime value supplied. Can be a string of the form MM/DD/YY.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CreatedAfter</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose CreationDate is at the earliest the DateTime value supplied. Can be a string of the form MM/DD/YY.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Newest</maml:name> <maml:description> <maml:para>Filters the output to list only the newest versions of all VIBs. For example, if there are two versions of the "Base-ESX" VIB, "5.0.0-10", and "5.0.0-456", returns only Base-ESX version "5.0.0-456".</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>SoftwareDepot</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwareDepot[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EsxSoftwarePackage</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PackageUrl</maml:name> <maml:description> <maml:para>Loads packages from package (.vib) files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Name field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Version field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Vendor</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Vendor field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose Tag field matches one of the strings supplied. Wildcard characters are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose acceptance level matches one of the strings supplied. Must be one of the following values:* VMwareCertified* VMwareAccepted* PartnerSupported* CommunitySupported</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AcceptanceLevels[]</command:parameterValue> <dev:type> <maml:name>AcceptanceLevels[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedBefore</maml:name> <maml:description> <maml:para>Filters the output list to only VIBs whose CreationDate is at the latest the DateTime value supplied. Can be a string of the form MM/DD/YY.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedAfter</maml:name> <maml:description> <maml:para>Filters the output to list only VIBs whose CreationDate is at the earliest the DateTime value supplied. Can be a string of the form MM/DD/YY.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Newest</maml:name> <maml:description> <maml:para>Filters the output to list only the newest versions of all VIBs. For example, if there are two versions of the "Base-ESX" VIB, "5.0.0-10", and "5.0.0-456", returns only Base-ESX version "5.0.0-456".</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SoftwareDepot</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwareDepot[]</command:parameterValue> <dev:type> <maml:name>SoftwareDepot[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PackageUrl</maml:name> <maml:description> <maml:para>Loads packages from package (.vib) files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>Zero or more SoftwarePackage objects.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxSoftwarePackage</dev:code> <dev:remarks> <maml:para>List all the VIBs from all depots in table form:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxSoftwarePackage | Sort-Object CreationDate | Format-Table -Property Name,Version,Vendor</dev:code> <dev:remarks> <maml:para>List all the VIBs, sorted by date:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxSoftwarePackage -Vendor "VMware","Cisco" -CreatedAfter 1/1/2010</dev:code> <dev:remarks> <maml:para>List all the VIBs from VMware and Cisco created after Jan 1, 2010:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxSoftwarePackage | ? {$_.Vendor -ne "VMware"}</dev:code> <dev:remarks> <maml:para>List all the VIBs from vendors other than VMware</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxSoftwarePackage -Name "esx-base" -Version "5.0.0-*"</dev:code> <dev:remarks> <maml:para>List all the base VIBs for the 5.0.0 release:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 6 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$vibs = Get-EsxSoftwarePackage -Name "esx-base" -Version "5.0.0-*"</dev:code> <dev:remarks> <maml:para>Save the results of a VIB query for later:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-EsxImageProfile</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>EsxImageProfile</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates an image profile on the client machine, either by cloning or from scratch. Image Bulder performs the complete set of image profile validation tests on the new image profile and displays all errors found during validation. You pass the new image profile into the Set-EsxImageProfile, Export-EsxImageProfile, Add-EsxSoftwarePackage, and Remove-EsxSoftwarePackage cmdlets in the -ImageProfile parameter as follows: *Use the image profile name, as specified in the -Name parameter. *Pipe the output of New-EsxImageProfile to the commandlet. The resulting image profile will be preserved for the current session only. To preserve an image profile across sessions, use the Export-EsxImageProfile cmdlet. The created image profile does not have to be assigned to a variable; it is preserved in memory automatically and will be listed with the Get-EsxImageProfile cmdlet. Specify either -NewProfile or -CloneProfile, but not both. If you want to edit an image profile published in a depot, you must clone the image profile before you edit it. When you clone an image profile, specify a Name parameter for the clone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EsxImageProfile</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NewProfile</maml:name> <maml:description> <maml:para>Specify -NewProfile to create a new profile (as opposed to cloning an existing one.</maml:para> </maml:description> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>(prompt) A short string that together with Creator uniquely describes the profile. Required to create a profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Vendor</maml:name> <maml:description> <maml:para>(prompt) A short string describing the organization that created the profile. Required to create a profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "3" > <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>(Pipeline input) One or more VIB software packages that the image profile should contain. Required to create a profile.The value can take one of the following forms:*Name of a VIB, as displayed in the Name column of Get-EsxSoftwarePackage, or in the Name property of any SoftwarePackage object. Image Builder selects the highest available version of the named package.*"<Name> <Version>", for adding a specific version of a VIB named Name to the image profile.*A SoftwarePackage object*The GUID of the VIB (from the Guid property of a SoftwarePackage)*A list containing a mix of any of the above elementsYou must include one of the "esx-base" packages to create a valid image profile.When cloning a profile, any VIBs you specify in this field replace the previous profile's SoftwarePackages field. Pipeline input is allowed when creating a new profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwarePackage[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Optional. Specifies the minimum acceptance level required for VIBs in the image profile. Defaults to "PartnerSupported".Must be one of the following values:*VMwareCertified*VMwareAccepted*PartnerSupported*CommunitySupported</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >AcceptanceLevels</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Description</maml:name> <maml:description> <maml:para>Optional. A long string describing the contents or purpose of the image profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optional. Makes the image profile read only. If you make an image profile read only when you create it, you cannot make it modifyable later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-EsxImageProfile</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>CloneProfile</maml:name> <maml:description> <maml:para>Specifies an image profile to clone from. Takes one of the following forms:*Name of an image profile, as displayed in the Name column of Get-EsxImageProfile, or from the Name property of any ImageProfile object*An ImageProfile objectYou must specify a -Name parameter that differs from the name of the original you create the clone from. You can also specify the -Vendor parameter to change the Vendor field of the clone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>(prompt) A short string that together with Creator uniquely describes the profile. Required to create a profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Vendor</maml:name> <maml:description> <maml:para>(prompt) A short string describing the organization that created the profile. Required to create a profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>(Pipeline input) One or more VIB software packages that the image profile should contain. Required to create a profile.The value can take one of the following forms:*Name of a VIB, as displayed in the Name column of Get-EsxSoftwarePackage, or in the Name property of any SoftwarePackage object. Image Builder selects the highest available version of the named package.*"<Name> <Version>", for adding a specific version of a VIB named Name to the image profile.*A SoftwarePackage object*The GUID of the VIB (from the Guid property of a SoftwarePackage)*A list containing a mix of any of the above elementsYou must include one of the "esx-base" packages to create a valid image profile.When cloning a profile, any VIBs you specify in this field replace the previous profile's SoftwarePackages field. Pipeline input is allowed when creating a new profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwarePackage[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Optional. Specifies the minimum acceptance level required for VIBs in the image profile. Defaults to "PartnerSupported".Must be one of the following values:*VMwareCertified*VMwareAccepted*PartnerSupported*CommunitySupported</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >AcceptanceLevels</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Description</maml:name> <maml:description> <maml:para>Optional. A long string describing the contents or purpose of the image profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optional. Makes the image profile read only. If you make an image profile read only when you create it, you cannot make it modifyable later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewProfile</maml:name> <maml:description> <maml:para>Specify -NewProfile to create a new profile (as opposed to cloning an existing one.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>(prompt) A short string that together with Creator uniquely describes the profile. Required to create a profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Vendor</maml:name> <maml:description> <maml:para>(prompt) A short string describing the organization that created the profile. Required to create a profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="3"> <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>(Pipeline input) One or more VIB software packages that the image profile should contain. Required to create a profile.The value can take one of the following forms:*Name of a VIB, as displayed in the Name column of Get-EsxSoftwarePackage, or in the Name property of any SoftwarePackage object. Image Builder selects the highest available version of the named package.*"<Name> <Version>", for adding a specific version of a VIB named Name to the image profile.*A SoftwarePackage object*The GUID of the VIB (from the Guid property of a SoftwarePackage)*A list containing a mix of any of the above elementsYou must include one of the "esx-base" packages to create a valid image profile.When cloning a profile, any VIBs you specify in this field replace the previous profile's SoftwarePackages field. Pipeline input is allowed when creating a new profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwarePackage[]</command:parameterValue> <dev:type> <maml:name>SoftwarePackage[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Optional. Specifies the minimum acceptance level required for VIBs in the image profile. Defaults to "PartnerSupported".Must be one of the following values:*VMwareCertified*VMwareAccepted*PartnerSupported*CommunitySupported</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AcceptanceLevels</command:parameterValue> <dev:type> <maml:name>AcceptanceLevels</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional. A long string describing the contents or purpose of the image profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optional. Makes the image profile read only. If you make an image profile read only when you create it, you cannot make it modifyable later.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>CloneProfile</maml:name> <maml:description> <maml:para>Specifies an image profile to clone from. Takes one of the following forms:*Name of an image profile, as displayed in the Name column of Get-EsxImageProfile, or from the Name property of any ImageProfile object*An ImageProfile objectYou must specify a -Name parameter that differs from the name of the original you create the clone from. You can also specify the -Vendor parameter to change the Vendor field of the clone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ImageProfile</command:parameterValue> <dev:type> <maml:name>ImageProfile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>Returns a new, validated ImageProfile object.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-EsxImageProfile -CloneProfile "ESX-5.0-234567-standard" \ -Name "My custom profile" -AcceptanceLevel CommunitySupported</dev:code> <dev:remarks> <maml:para>Clone an image profile, give it a new name, and change the acceptance level. (NOTE: The '\' is used to continue the second line of input; either press ENTER after \ or enter everything on one line without the '\').</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$ip = New-EsxImageProfile -NewProfile -Name "Built from scratch!" -Vendor "NotVmware" \ -SoftwarePackage esx-base,esx-tboot,native-misc-drivers</dev:code> <dev:remarks> <maml:para>Create an image profile from scratch, assigning the result to a variable. Software packages are specified by name.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxSoftwarePackage -Name esx-base,esx-tboot,native-misc-drivers | \ New-EsxImageProfile -NewProfile -Name "Built from scratch!" -Vendor "NotVmware"</dev:code> <dev:remarks> <maml:para>Create an image profile from scratch, passing in software packages via pipeline</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-IsoImage</command:name> <maml:description> <maml:para>This cmdlet generates an ISO image by using the specified software depot and software specification at the specified location.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>IsoImage</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet generates an ISO 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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-IsoImage</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depots</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>SoftwareSpec</maml:name> <maml:description> <maml:para>Specifies a software specification to use for the creation of the image. The software specification describes what building blocks to use when creating the ISO. All requirements in the specification need to be satisfied by the specified software depots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KernelOptions</maml:name> <maml:description> <maml:para>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>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CheckAcceptance</maml:name> <maml:description> <maml:para>Indicates that you want to validate the acceptance level of individual VIBs used for the creation of the image.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>LiveImage</maml:name> <maml:description> <maml:para>Indicates that you want to create a live image instead of an installer image.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that you want to overwrite existing files when writing the image.</maml:para> </maml:description> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Destination</maml:name> <maml:description> <maml:para>Indicates that you want to store the newly created image at the specified destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Depots</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SoftwareSpec</maml:name> <maml:description> <maml:para>Specifies a software specification to use for the creation of the image. The software specification describes what building blocks to use when creating the ISO. All requirements in the specification need to be satisfied by the specified software depots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>KernelOptions</maml:name> <maml:description> <maml:para>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>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckAcceptance</maml:name> <maml:description> <maml:para>Indicates that you want to validate the acceptance level of individual VIBs used for the creation of the image.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiveImage</maml:name> <maml:description> <maml:para>Indicates that you want to create a live image instead of an installer image.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that you want to overwrite existing files when writing the image.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Indicates that you want to store the newly created image at the specified destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Create an ISO image -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-IsoImage "C:\<depot>.zip", "https://<address-to-depot>/index.xml" "C:\<spec>.json" -Destination "C:\<image-name>.iso"</dev:code> <dev:remarks> <maml:para>Creates a new ISO 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 it to "C:\<image-name>.iso" afterwards.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>None </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Create an ISO image with kernel options -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-IsoImage "C:\<depot>.zip", "https://<address-to-depot>/index.xml" "C:\<spec>.json" -Destination "C:\<image-name>.iso" -KernelOptions "option1=value1", "option2=value2"</dev:code> <dev:remarks> <maml:para>Creates a new ISO image by using the depots located at "C:\<depot>.zip", "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 image to "C:\<image-name>.iso" afterwards.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>None </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-OfflineBundle</command:name> <maml:description> <maml:para>This cmdlet generates an offline bundle at the specified destination by using the specified software depots and software specification</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>OfflineBundle</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet generates an offline bundle at the specified destination by using the specified software depots and software specification. The resulting bundle is vLCM-compliant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-OfflineBundle</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depots</maml:name> <maml:description> <maml:para>Specifies one or more locations of software depots that contain the payloads to create the offline bundle. The value can be either a file path to an offline depot in the format of "<path-to-offline-depot>.zip" on your respective platform or an URL address to the index file of the online depot in the format of "https://<address-to-depot>/index.xml".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>SoftwareSpec</maml:name> <maml:description> <maml:para>Specifies a software specification to use for the creation of the offline bundle. The software specification describes what building blocks to use when creating the bundle. All requirements in the specification need to be satisfied by the specified software depots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "3" > <maml:name>Destination</maml:name> <maml:description> <maml:para>Indicates that you want to store the newly created offline bundle at the specified destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VendorName</maml:name> <maml:description> <maml:para>Specifies the name of the vendor of the bundle. The vendor name must be 1 to 20 alphanumeric characters, commas, periods, or spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VendorCode</maml:name> <maml:description> <maml:para>Specifies the code of the vendor of the bundle. The vendor code must be 3 alphanumeric characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NoSignatureCheck</maml:name> <maml:description> <maml:para>If specified, disables VIB signature validation. The use of this option may lead to debilitating security vulnerabilities.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If specified, existing files at the destination will be overwritten when creating the offline bundle.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Depots</maml:name> <maml:description> <maml:para>Specifies one or more locations of software depots that contain the payloads to create the offline bundle. The value can be either a file path to an offline depot in the format of "<path-to-offline-depot>.zip" on your respective platform or an URL address to the index file of the online depot in the format of "https://<address-to-depot>/index.xml".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SoftwareSpec</maml:name> <maml:description> <maml:para>Specifies a software specification to use for the creation of the offline bundle. The software specification describes what building blocks to use when creating the bundle. All requirements in the specification need to be satisfied by the specified software depots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Indicates that you want to store the newly created offline bundle at the specified destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VendorName</maml:name> <maml:description> <maml:para>Specifies the name of the vendor of the bundle. The vendor name must be 1 to 20 alphanumeric characters, commas, periods, or spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VendorCode</maml:name> <maml:description> <maml:para>Specifies the code of the vendor of the bundle. The vendor code must be 3 alphanumeric characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoSignatureCheck</maml:name> <maml:description> <maml:para>If specified, disables VIB signature validation. The use of this option may lead to debilitating security vulnerabilities.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If specified, existing files at the destination will be overwritten when creating the offline bundle.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Create an offline bundle -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-OfflineBundle -Depots "<path-to-offline-depot>.zip", "https://<address-to-depot>/index.xml" -SoftwareSpec "C:\<spec>.json" -VendorName "VMware" -VendorCode "VMW" -Destination "C:\<bundle-name>.zip"</dev:code> <dev:remarks> <maml:para>Creates a new offline bundle by using the depots located at "<path-to-offline-depot>.zip" and "https://<address-to-depot>/index.xml" (one offline and one online depot, any number and combination of depots are supported). Uses the software specification located at "C:\<spec>.json" to construct the offline bundle and saves it to "C:\<bundle-name>.zip" afterwards.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>None </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PxeImage</command:name> <maml:description> <maml:para>This cmdlet generates a PXE image by using the specified software depot and software specification.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>PxeImage</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PxeImage</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Depots</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>SoftwareSpec</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KernelOptions</maml:name> <maml:description> <maml:para>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>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CheckAcceptance</maml:name> <maml:description> <maml:para>Indicates that you want to validate the acceptance level of individual VIBs used for the creation of the image.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>LiveImage</maml:name> <maml:description> <maml:para>Indicates that you want to create a live image instead of an installer image.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that you want to overwrite existing files when writing the image.</maml:para> </maml:description> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Destination</maml:name> <maml:description> <maml:para>Indicates that you want to store the newly created image at the specified destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Depots</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SoftwareSpec</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>KernelOptions</maml:name> <maml:description> <maml:para>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>".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckAcceptance</maml:name> <maml:description> <maml:para>Indicates that you want to validate the acceptance level of individual VIBs used for the creation of the image.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiveImage</maml:name> <maml:description> <maml:para>Indicates that you want to create a live image instead of an installer image.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that you want to overwrite existing files when writing the image.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Indicates that you want to store the newly created image at the specified destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para>None</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para>None</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Create a PXE image -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-PxeImage "C:\<depot>.zip", "https://<address-to-depot>/index.xml" "C:\<spec>.json" -Destination "C:\<name-of-pxe-directory>"</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>None </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Create a PXE image with kernel options -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>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"</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>None </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-EsxImageProfile</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>EsxImageProfile</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Removes existing image profiles. You cannot remove an image profile if its ReadOnly property is True.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EsxImageProfile</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(Pipeline input, prompt) Specifies the image profile to remove. 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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >ImageProfile[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(Pipeline input, prompt) Specifies the image profile to remove. 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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ImageProfile[]</command:parameterValue> <dev:type> <maml:name>ImageProfile[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-EsxImageProfile -ImageProfile "My custom profile"</dev:code> <dev:remarks> <maml:para>Remove image profile "My custom profile".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-EsxSoftwareDepot</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>EsxSoftwareDepot</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Disconnects the current PowerCLI session from the specified software depots. Updates the $DefaultSoftwareDepots session variable. The depots and their VIBs and image profiles will no longer be available. If you do not specify the -SoftwareDepot parameter, PowerCLI prompts for an answer. You can type in the URL of the depot you wish to disconnect from.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EsxSoftwareDepot</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>SoftwareDepot</maml:name> <maml:description> <maml:para>(Pipeline input, prompt) Takes one of the following forms:* URL string of the depot to remove* Single instance of a SoftwareDepot object, as returned by Add-EsxSoftwareDepot* List of SoftwareDepot objects or URL strings The depot must be connected to the session. If you specify a depot that is not connected to the session, an error message results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwareDepot[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>SoftwareDepot</maml:name> <maml:description> <maml:para>(Pipeline input, prompt) Takes one of the following forms:* URL string of the depot to remove* Single instance of a SoftwareDepot object, as returned by Add-EsxSoftwareDepot* List of SoftwareDepot objects or URL strings The depot must be connected to the session. If you specify a depot that is not connected to the session, an error message results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwareDepot[]</command:parameterValue> <dev:type> <maml:name>SoftwareDepot[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>None</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-EsxSoftwareDepot https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/vmw-depot-index.xml [... do something ...] Remove-EsxSoftwareDepot https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/vmw-depot-index.xml</dev:code> <dev:remarks> <maml:para>Connect to a depot, then disconnect from it by URL.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$depot = Add-EsxSoftwareDepot https://hostupdate.vmware.com/software/VUM/PRODUCTION/main/vmw-depot-index.xml [... do something ...] $depot | Remove-EsxSoftwareDepot</dev:code> <dev:remarks> <maml:para>Connect to a depot, saving it to a variable, then disconnect from it later. Also an example of pipeline input.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-EsxSoftwareDepot $DefaultSoftwareDepots</dev:code> <dev:remarks> <maml:para>Disconnect from all software depots</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-EsxSoftwarePackage</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>EsxSoftwarePackage</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Removes existing packages from an image profile. The output of this cmdlet is an image profile object that you can pipe into any other cmdlet taking image profiles as input. You cannot modify an image profile if its ReadOnly property is true. ImageBuilder runs the modified image profile through all image profile validation tests. The modified image profile must have at least a boot kernel so that it can boot. You cannot remove a package if another package depends on it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EsxSoftwarePackage</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "2" > <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>List of software packages to remove from the profile. Specify packages that exist in the profiel. You can specify one or more SoftwarePackage objects, or strings representing package names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwarePackage[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ImageProfile</command:parameterValue> <dev:type> <maml:name>ImageProfile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2"> <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>List of software packages to remove from the profile. Specify packages that exist in the profiel. You can specify one or more SoftwarePackage objects, or strings representing package names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwarePackage[]</command:parameterValue> <dev:type> <maml:name>SoftwarePackage[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>The modified, validated ImageProfile object.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-EsxSoftwarePackage -ImageProfile "My custom profile" -SoftwarePackage foo</dev:code> <dev:remarks> <maml:para>Remove package foo from my custom profile:</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-EsxImageProfile</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>EsxImageProfile</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EsxImageProfile</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" > <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(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</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ImageProfile</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>String value to replace the current Name field with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Vendor</maml:name> <maml:description> <maml:para>String value to replace the current Vendor field with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>(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 aboveOne of the "esx-base" packages is required for a valid image profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SoftwarePackage[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Optional. Specifies the minimum acceptance level allowed for VIBs in the image profile, one of the following:*VMwareCertified*VMwareAccepted*PartnerSupported*CommunitySupportedIf the acceptance level is raised above the lowest acceptance level of any VIB in the profile, an error results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >AcceptanceLevels</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Description</maml:name> <maml:description> <maml:para>Optional. Long string describing the contents or purpose of the image profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optional. Makes the image profile read only. (not modifiable).</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ImageProfile</maml:name> <maml:description> <maml:para>(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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ImageProfile</command:parameterValue> <dev:type> <maml:name>ImageProfile</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>String value to replace the current Name field with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Vendor</maml:name> <maml:description> <maml:para>String value to replace the current Vendor field with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SoftwarePackage</maml:name> <maml:description> <maml:para>(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 aboveOne of the "esx-base" packages is required for a valid image profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SoftwarePackage[]</command:parameterValue> <dev:type> <maml:name>SoftwarePackage[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptanceLevel</maml:name> <maml:description> <maml:para>Optional. Specifies the minimum acceptance level allowed for VIBs in the image profile, one of the following:*VMwareCertified*VMwareAccepted*PartnerSupported*CommunitySupportedIf the acceptance level is raised above the lowest acceptance level of any VIB in the profile, an error results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AcceptanceLevels</command:parameterValue> <dev:type> <maml:name>AcceptanceLevels</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional. Long string describing the contents or purpose of the image profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optional. Makes the image profile read only. (not modifiable).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>The modified, validated ImageProfile object (modified from original, not a new copy).</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-EsxImageProfile -ImageProfile "Profile of a Fool" -SoftwarePackage esx-base,scsi-ips,esx-tboot</dev:code> <dev:remarks> <maml:para>Modify the VIB list of an existing image profile</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$myprofiles = Get-EsxImageProfile Set-EsxImageProfile -ImageProfile $myprofiles[2] -AcceptanceLevel PartnerSupported</dev:code> <dev:remarks> <maml:para>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):</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-EsxImageProfile -Name "User Created Profile" | Set-EsxImageProfile -ReadOnly</dev:code> <dev:remarks> <maml:para>Using pipelining to mark the user-created profile as read-only</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |