Get‐SoftpaqList
Summary
Get a list of SoftPaqs for a platform
Syntax
Get-SoftpaqList [[-Platform] <String>] [[-Bitness] <Int32>] [[-Os] <String>] [[-OsVer] <String>] [[-ReferenceUrl] <String>] [[-Quiet]] [[-Format] <String>] [[-Overwrite] <String>] [[-Category] <String[]>] [[-ReleaseType] <String[]>] [[-Characteristic] <String[]>] [[-CacheDir] <DirectoryInfo>] [[-MaxRetries] <Int32>] [[-PreferLTSC]] [[-SoftpaqUrl] <String>] [<CommonParameters>]
Get-SoftpaqList [-Platform <String>] [-Bitness <Int32>] [-Os <String>] [-OsVer <String>] [-ReferenceUrl <String>] [-Quiet] [-Format <String>] [[-DownloadDirectory] <String>] [[-Download]] [[-DownloadMetadata]] [[-DownloadNotes]] [[-FriendlyName]] [-Overwrite <String>] [-Category <String[]>] [-ReleaseType <String[]>] [-Characteristic <String[]>] [-CacheDir <DirectoryInfo>] [-MaxRetries <Int32>] [-PreferLTSC] [-SoftpaqUrl <String>] [<CommonParameters>]
Description
This function gets a list of latest SoftPaqs for a specified platform ID, or the current computer.
Get-SoftpaqList functionality is not supported in WinPE.
Parameters
| Name | Argument | Description |
|---|---|---|
| Platform | <String> | The platform ID for which to retrieve the list of SoftPaqs. If not available, the current platform ID is used. |
| Bitness | <Int32> | the platform bitness (32 or 64). If not available, the current platform bitness is used. |
| Os | <String> | filter for the specified OS. The OS may be one of win7, win8, win8.1, win10. If not specified, current platform OS is used. |
| OsVer | <String> | filter for the specified OS Version. Applies to Win10 only. This is a string value, specifying the target OS Version (e.g. 1709, 1803, 21H1 etc). If the parameter is not specified, current operating system version will be assumed, which may not be what is intended. For windows versions other than windows 10, this is silently ignored. |
| ReferenceUrl | <String> | specify an alternate location for the HP Image Assistant(HPIA) Reference files. This URL must be http, https, or ftp. The Reference files are expected to be at the location pointed to by this URL inside a directory named after the platform ID you want a SoftPaq list for. If not specified, ftp.hp.com is used via HTTPS protocol. For example, If you want to point to 83b2 Win10 OSVer 2009 reference files, Get-SoftpaqList will try to find them in this directory structure: $ReferenceUrl/83b2/83b2_64_10.0.2009.cab |
| Quiet | Suppress non-error progress messages | |
| Format | <String> | Display results in a specified format (Json, XML, or CSV). If not specified, results are returned as PowerShell objects |
| DownloadDirectory | <String> | specify a directory for the downloaded files |
| Download | download matching SoftPaqs | |
| DownloadMetadata | also download CVA files (metadata) for matching SoftPaqs | |
| DownloadNotes | also download note files (human readable info files) for matching SoftPaqs | |
| FriendlyName | if specified, retrieve the SoftPaq metadata and create a friendly file name based on the SoftPaq title. Applies if -download is specified. | |
| Overwrite | <String> | This parameter controls the overwrite behavior. Options may be "no" to not overwrite existing files, "yes" to force overwrite, and "skip" to skip existing files without an error. Default is 'no' if overwrite is not specified. |
| Category | <String[]> | The category field filters to a specific category of SoftPaqs. It must be one (or more) of "Bios", "Firmware", "Driver", "Software", "OS", "Manageability", "Diagnostic", "Utility", "Driverpack", "Dock", "UWPPack". |
| ReleaseType | <String[]> | filter to specified release type. The release type must be one (or more) of "Critical", "Recommended", "Routine". |
| Characteristic | <String[]> | Specify additional filter characteristics for the softpaq list. The characteristic must be one (or more) of "SSM", "DPB", "UWP". |
| CacheDir | <DirectoryInfo> | Custom location for caching data files. If not specified, the user-specific TEMP directory is used. |
| MaxRetries | <Int32> | Maximum number of retries allowed to obtain an exclusive lock to downloaded files. This is relevant only when files are downloaded into a shared directory and multiple processes may be reading or writing from the same location. Current default value is 10 retries, and each retry includes a 30 second pause, which means the maximum time the default value will wait for an exclusive logs is 300 seconds or 5 minutes. |
| PreferLTSC | if specified and if data file exists, retrieves the LTSB/LTSC Reference file for the entered Platform. If data file doesn't exists- falls back to regular Reference file for that platform. |
|
| SoftpaqUrl | <String> | specify an alternate location for the SoftPaq URL. This URL must be http, https, or ftp. The SoftPaqs are expected to be at the location pointed to by this URL. If not specified, ftp.hp.com is used via HTTPS protocol. |
Notes
The response is a record set composed of zero or more SoftPaq records. The definition of a record is as follows:
| Field | Description |
|---|---|
| Id | The SoftPaq identifier |
| Name | The SoftPaq name (title) |
| Category | The SoftPaq category |
| Version | The SoftPaq version |
| Vendor | The author of the SoftPaq |
| ReleaseType | The SoftPaq release type |
| SSM | This flag indicates this SoftPaq support unattended silent install |
| DPB | This flag indicates this SoftPaq is included in driver pack builds |
| Url | The SoftPaq download URL |
| ReleaseNotes | The URL to a human-readable rendering of the SoftPaq release notes |
| Metadata | The URL to the SoftPaq metadata (CVA) file |
| MD5 | (where available) The MD5 value for this softpaq |
| Size | The SoftPaq size, in bytes |
| ReleaseDate | The date the SoftPaq was published |
| UWP | (where available) This flag indicates this SoftPaq contains Universal Windows Platform applications |
Examples
PS C:\> Get-SoftpaqList -Download
PS C:\> Get-SoftpaqList -Bitness 64 -Os win10 -OsVer 1903
PS C:\> Get-SoftpaqList -Platform 83b2 -Os win10 -OsVer "21H1"
PS C:\> Get-SoftpaqList -Platform 8444 -Category Diagnostic -Format json
PS C:\> Get-SoftpaqList -Category Driverpack
PS C:\> Get-SoftpaqList -ReleaseType Critical -Characteristic SSM
PS C:\> Get-SoftpaqList -Platform 83b2 -Category Dock,Firmware -ReleaseType Routine,Critical
PS C:\> Get-SoftpaqList -Platform 2216 -Category Driverpack -Os win10 -OsVer 1607 -PreferLTSC