Get-HpcImage

Get-HpcImage

Gets operating system images for an HPC cluster.

Syntax

Parameter Set: Default
Get-HpcImage [[-Name] <String[]> ] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-WimFileName <String[]> ] [ <CommonParameters>]




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

Parameters

-ClusterConnectionString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

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

none

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 to get.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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.

  • HpcImage

    This cmdlet returns an array of HpcImage objects.


Notes

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

Examples

Example 1: Get all operating system images

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


PS C:\> Get-HpcImage

Example 2: Get operating system images by name

This command 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: Get an operating system image by name and .wim file name

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


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

Related topics

Community Additions

ADD
Show: