Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-HpcImage

Gets one or more specified operating system images, or gets all of the operating system images in the image store for the HPC cluster.

Syntax

Get-HpcImage [-Scheduler <string>] [-WimFileName <string[]>] [[-Name] <string[]>] [<CommonParameters>]

Detailed Description

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.

Parameters

-Name <string[]>

Specifies a list of the names for the operating system images that you want to get.

 

Required?

false

Position?

1

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-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>

 

Required?

false

Position?

named

Default Value

%CCP_SCHEDULER%

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WimFileName <string[]>

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

 

Required?

false

Position?

named

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Input and Return Types

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

 

Input Type

None.

Return Type

One or more HpcImage objects.

Notes

If you do not specify any operating system images with the Name or WimFileName parameter, the Get-HpcImage cmdlet gets all of the operating system images in the image store for the HPC cluster.

Example 1

C:\PS>Get-HpcImage

Gets a list of all of the operating system images in the image store for the HPC cluster.

Example 2

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

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

Example 3

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

Gets the operating system image that has a name of Image 1 and that is in the MyImage.wim Windows image file.

See Also

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.