Remove-HpcImage

Removes one or more specified operating system images from the image store for the HPC cluster.

Syntax

	Copy Code
Parameter Set: Name Remove-HpcImage [-WimFileName] <String[]> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: Image Remove-HpcImage -Image <HpcImage[]> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Copy Code

Parameter Set: Name


Remove-HpcImage [-WimFileName] <String[]> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Image


Remove-HpcImage -Image <HpcImage[]> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

Removes one or more specified operating system images from the image store for the HPC cluster. You can specify the operating system images by specifying HpcImage objects for the images or the names of the Windows Image (.wim) files that contain the images.

Parameters

-Image<HpcImage[]>

Specifies one or more HpcImage objects that correspond to the operating system images that you want to remove. Use the Get-HpcImage cmdlet to get the HpcImage objects for the operating system images. You cannot specify both the Image and WimFileName parameters.

Aliases	none
Required?	true
Position?	named
Default Value	no default
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster that includes the images. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

Aliases	none
Required?	false
Position?	named
Default Value	%CCP_SCHEDULER%
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WimFileName<String[]>

Specifies a list on one or more names of the .wim files that contain the operating system images that you want to remove. Use the Get-HpcImage cmdlet to view the names of the .wim files that contain the operating system images. You cannot specify both the WimFileName and Image parameters.

Aliases	none
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	true

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

One or more HpcImage objects.

Outputs

The output type is the type of the objects that the cmdlet emits.

None.

Notes

You cannot remove an operating system image if any node templates refer to the image or to other operating system images in the same .wim file as the image that you want to remove. If a .wim file contains multiple images, you cannot remove one of the images in the .wim file without removing the other images in the .wim file.
The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify –Confirm:$false. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify –Confirm or –Confirm:$true.
You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Removes the operating system images that the MyImages.wim file contains from the image store for the HPC cluster.

	Copy Code
Remove-HpcImage -WimFileName MyImages.wim

EXAMPLE 2

Gets an HPC image object for the operating system image named Image 1 in the MyImages.wim file, and removes that image from the image store for the HPC cluster.

	Copy Code
Get-HpcImage -Name "Image 1" -WimFileName MyImages.wim \| Remove-HpcImage