Export (0) Print
Expand All
Expand Minimize

Get-HpcImage

Updated: January 10, 2014

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

Parameter Set: Default
Get-HpcImage [[-Name] <String[]> ] [-Scheduler <String> ] [-WimFileName <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.


Aliases

none

Required?

false

Position?

1

Default Value

no default

Accept Pipeline Input?

false

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 of the names of the .wim files that contain the operating system images that you want to get.


Aliases

none

Required?

false

Position?

named

Default Value

no default

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.

  • None.

Outputs

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

  • One or more HpcImage objects.

Notes

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

Examples

EXAMPLE 1

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


PS C:\>Get-HpcImage

EXAMPLE 2

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


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

EXAMPLE 3

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


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft