Start-HpcBatchPool

Reference

Module:: HPCPack2019

Starts an Azure Batch pool in the HPC cluster.

Syntax

Start-HpcBatchPool
     [-Async <Boolean>]
     [-Name] <String[]>
     [-ClusterConnectionString <String[]>]
     [-Scheduler <String[]>]
     [<CommonParameters>]

Start-HpcBatchPool
     [-Async <Boolean>]
     -Node <HpcNode[]>
     [-ClusterConnectionString <String[]>]
     [-Scheduler <String[]>]
     [<CommonParameters>]

Description

The Start-HpcBatchPool cmdlet starts an Azure Batch pool in the HPC cluster.

Examples

1:

Parameters

-Async

Indicates that the cmdlet returns immediately without waiting for the nodes to start. If you do not specify this parameter the cmdlet waits for the nodes to start before it returns.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterConnectionString

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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specifies a list of the names of the Azure Batch pools that you want to start. You cannot specify both the Name and Node parameters.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Node

Specifies one or more HpcNode objects for the Azure Batch pools that this cmdlet starts. You cannot specify both the Node and Name parameters.

Type:	HpcNode[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Scheduler

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