Register-WASImage
Register-WASImage
Imports an image into inventory.
Syntax
Parameter Set: Default
Register-WASImage [-ImagePath] <String> [[-ImageName] <String> ] [[-ImageType] <String> ] [[-DeploymentInfo] <String> ] [[-UnattendPath] <String> ] [ <CommonParameters>]
Detailed Description
The Register-WASImage cmdlet imports images (specifically its metadata) into the Windows Assessment Services inventory. The image that is being imported must be in the \relax\images share on the Windows Assessment Services server. By default, the cmdlet assumes images are .wim files and imports all images in the WIM file. If you are not using the WIM image format, you must specify the image type. The ImagePath parameter is required.
Parameters
-DeploymentInfo<String>
Specifies a deployment solution other than Windows Assessment Services. This parameter is ignored if the ImagePath parameter points to a WIM file. The format of the string is dictated by the alternative deployment solution you choose.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ImageName<String>
Specifies the name of the image that you want to import. The full name of the image is required. Wildcards aren't accepted. If this parameter isn't specified, all images are imported. To get the name of the image inside the WIM file, use the DISM Get-Image command.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ImagePath<String>
Specifies the path to the image file you want to register. This must be the full path to the image, using the fully qualified domain name of the server. This parameter is required.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ImageType<String>
Specifies the type of image you want to import, if you are not using a WIM file. By default the only image type supported is WIM. For more information about using custom image types, see the Windows Assessment Services documentation.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UnattendPath<String>
Specifies the path to the unattended answer file. These files must be stored in the \relax\unattendfiles share on the Windows Assessment Services server.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
Imports the image with index 1 in the WasTestImage.wim, from the \relax\images\ share, into the Windows Assessment Services inventory.
PS C:\> Register-WasImage -ImagePath 'C:\relax\images\WasTestImage.wim' -ImageName 'Windows Test Image' -ImageType 'wim' -DeploymentInfo 'imageindex=1'