Remove-HpcImage
Removes operating system images from the image store for an HPC cluster.
Syntax
Remove-HpcImage
[-WimFileName] <String[]>
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-HpcImage
-Image <HpcImage[]>
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-HpcImage cmdlet 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.
Examples
Example 1: Remove operating system images from the image store
PS C:\>Remove-HpcImage -WimFileName "MyImages.wim"
This command removes the operating system images that the MyImages.wim file contains from the image store for the HPC cluster.
Example 2: Remove a specified operating system image from the image store
PS C:\>Get-HpcImage -Name "Image 01" -WimFileName "MyImages.wim" | Remove-HpcImage
This command gets an HPC image object for the operating system image named Image 01 in the MyImages.wim file, and removes that image from the image store for the HPC cluster.
Parameters
-ClusterConnectionString
Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers.
The value format is host1,host2,host3.
If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies.
To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>
.
This parameter was introduced in HPC Pack 2016.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Image
Specifies an array of 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.
Type: | HpcImage[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Scheduler
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\>
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WimFileName
Specifies an array of 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.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
HpcImage
This cmdlet returns an array of HpcImage objects.
Outputs
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.