Add-HpcBatchPool

Adds an Azure Batch pool to the HPC cluster.

Syntax

Add-HpcBatchPool
   -Template <HpcNodeTemplate>
   -ComputeNodeNumber <Int32>
   -Size <String>
   [-MaxTaskPerComputeNode <Int32>]
   [-OsFamily <WorkerOSFamily>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Description

The Add-HpcBatchPool cmdlet adds an Azure Batch pool to the HPC cluster.

Required Parameters

-ComputeNodeNumber

Specifies the number of compute nodes in the Azure Batch pool.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Size

Specifies the role size of the compute nodes in the Azure Batch pool.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Template

Specifies an HpcNodeTemplate object for the node template that you want to apply to the specified nodes. Use the Get-HpcNodeTemplate cmdlet to get the HpcNodeTemplate object for a node template. You cannot specify the Template parameter if you also specify either the Name or the Maintain parameter.

Type:HpcNodeTemplate
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-ClusterConnectionString

Specifies an array of cluster connection strings for the cluster on which you perform the operation. 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
Accept pipeline input:False
Accept wildcard characters:False
-MaxTaskPerComputeNode

Specifies the maximum number of tasks that can run parallel on each compute node in the Azure Batch pool.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OsFamily

Specifies the OS family version of the compute nodes in the Azure Batch pool.

The acceptable values for this parameter are:

  • Win2008
  • Win2008R2
  • Win8
  • Win8R2
Type:WorkerOSFamily
Parameter Sets:Win2008, Win2008R2, Win8, Win8R2, Win2016
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Scheduler

Specifies an array of host names or IP addresses of the head node for the cluster. 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
Accept pipeline input:False
Accept wildcard characters:False