Get-HpcImage

Reference

Module:: HPCPack2016

Gets operating system images for an HPC cluster.

Syntax

Get-HpcImage
   [[-Name] <String[]>]
   [-WimFileName <String[]>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Description

The Get-HpcImage cmdlet gets one or more specified operating system images, or gets all of the operating system images in the image store for the HPC cluster. You can specify the operating system images by name, or by the name of the Windows Image (.wim) file that contains the image.

Examples

Example 1: Get all operating system images

PS C:\>Get-HpcImage

This command gets all of the operating system images in the image store for the HPC cluster.

Example 2: Get operating system images by name

PS C:\>Get-HpcImage -Name "My Test Image"

This command gets the operating system images that have a name of My Test Image. Operating system images do not necessarily have unique names.

Example 3: Get an operating system image by name and .wim file name

PS C:\>Get-HpcImage -Name "Image 01" -WimFileName "MyImages.wim"

This command gets the operating system image named Image 01 and that is in the MyImage.wim Windows image file.

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

-Name

Specifies an array of the names for the operating system images to get.

Type:	String[]
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
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

-WimFileName

Specifies a list of the names of the .wim files that contain the operating system images to get.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

HpcImage

This cmdlet returns an array of HpcImage objects.

Notes

You must be a cluster administrator to run this cmdlet successfully.