Stop-HpcBatchPool

Windows Server 2016 and Windows 10

Stop-HpcBatchPool

Stop an Azure Batch pool in an HPC cluster.

Syntax

Parameter Set: Name
Stop-HpcBatchPool [-Name] <String[]> [-Async] [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Force] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: Node
Stop-HpcBatchPool -Node <HpcNode[]> [-Async] [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Force] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Stop-HpcBatchPool cmdlet stops an Azure Batch pool in an HPC cluster.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

-Comment<String>

Specifies the reason that the set of nodes was stopped.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Node<HpcNode[]>

Specifies one or more HpcNode objects for the Azure Batch pools that you want to stop. You cannot specify both the Node and Name parameters.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-Scheduler<String[]>

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


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.

Outputs

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

Related topics

Community Additions

ADD
Show: