Add-HpcBatchPool

Windows Server 2016 and Windows 10

Add-HpcBatchPool

Adds an Azure Batch pool to the HPC cluster.

Syntax

Parameter Set: Default
Add-HpcBatchPool -ComputeNodeNumber <Int32> -Size <String> -Template <HpcNodeTemplate> [-ClusterConnectionString <String[]> ] [-MaxTaskPerComputeNode <Int32> ] [-OsFamily <WorkerOSFamily> {Win2008 | Win2008R2 | Win8 | Win8R2} ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-ClusterConnectionString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputeNodeNumber<Int32>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaxTaskPerComputeNode<Int32>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OsFamily<WorkerOSFamily>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Size<String>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Template<HpcNodeTemplate>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByValue)

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.

Outputs

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

Related topics

Community Additions

ADD
Show: