New-HpcImage

New-HpcImage

Creates an operating system image and adds it to the image store for an HPC cluster.

Syntax

Parameter Set: Media
New-HpcImage [-WimFileName] <String> [-ClusterConnectionString <String[]> ] [-Path <String> ] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: Node
New-HpcImage [-WimFileName] <String> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-TargetNodeName <String> ] [ <CommonParameters>]




Detailed Description

The New-HpcImage cmdlet creates an operating system image from the installation directory or installation media for the operating system or from the operating system on the specified node, and then adds the image to the image store for an HPC cluster.

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

-Path<String>

Specifies the directory in the installation media or installation folder that contains the Setup.exe file for installing the operating system. The New-HpcImage cmdlet generates the operating system image from the data at this location.


Aliases

none

Required?

false

Position?

named

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 to which you want to add 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

-TargetNodeName<String>

Specifies the name of the node from which you want to create the operating system image. The node must be in the Offline state before you can create an image from it. Use the Set-HpcNodeState cmdlet to take a node offline.

This parameter was introduced in HPC Pack 2008 R2. It is not available in previous versions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WimFileName<String>

Specifies the name of the Windows Image (.wim) file to create. One .wim file can contain multiple images. An error occurs if you specify a .wim file that already exists in the image store for the HPC cluster.


Aliases

none

Required?

true

Position?

1

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

  • The New-HpcImage cmdlet creates a.wim file for the operating system image, and then saves it in the Data\InstallShare\Images subfolder of the installation folder for HPC Pack.

    If you already have an operating system image in a .wim file, use the Add-HpcImage cmdlet to add the image to the image store for the HPC cluster.

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

Examples

Example 1: Create a system image from installation media

This command creates an operating system image from the installation media in drive D, and then saves the image in the NewImage.wim file. This example assumes that the root directory of the installation media contains the Setup.exe file for installing the operating system.


PS C:\> New-HpcImage -Path "D:\ -WimFileName NewImage.wim"

Example 2: Create a system image from a specified node

This command creates a new operating system image from the node named ComputeNode01, and then saves the image in the ComputeNode.wim file.


PS C:\> New-HpcImage -TargetNodeName "ComputeNode01" -WimFileName "ComputeNode.wim"

Related topics

Community Additions

ADD
Show: