Get-DepotBaseImages - vSphere ImageBuilder Reference

PowerCLI Reference

vSphere ImageBuilder Reference

Get-DepotBaseImages

Synopsis

This cmdlet retrieves basic information about base images in the software depot.

Syntax

Get-DepotBaseImages [-Depot] <String> [[-Version] <String>] [<CommonParameters>]

Related Commands

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

Detailed Description

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.

Parameters

Name Type Description Required? Pipeline Input Default Value
Depot String 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". true false None
Version String Specifies the version of a base image contained in the specified software depot. false false None

Return Type

BaseImage/array of BaseImageInfo

Notes

No notes

Examples

-------------- List base images in depot (offline) --------------

C:\PS>Get-DepotBaseImages "C:\<depot>.zip"

Retrieves an array of all the base images contained in the software depot located at "C:\<depot>.zip".

-------------- List base images in depot (online) --------------

C:\PS>Get-DepotBaseImages "https://<address-of-depot>/index.xml"

Retrieves an array of all the base images contained in the software depot located at "https://<address-of-depot>/index.xml".

-------------- Get base image by version (offline) --------------

C:\PS>Get-DepotBaseImages "C:\<depot>.zip" -Version "<baseimage-version>"

Retrieves detailed information about the base image with version "<baseimage-version>" from the software depot located at "C:\<depot>.zip".

-------------- Get base image by version (online) --------------

C:\PS>Get-DepotBaseImages "https://<address-of-depot>/index.xml" -Id "<baseimage-version>"

Retrieves detailed information about the base image with version "<baseimage-version>" from the software depot located at "https://<address-of-depot>/index.xml".

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