Restart-​Azure​Batch​Compute​Node

Reboots the specified compute node.

Syntax

Restart-AzureBatchComputeNode
       [[-ComputeNode] <PSComputeNode>]
       [[-RebootOption] <ComputeNodeRebootOption>]
       -BatchContext <BatchAccountContext>
       [<CommonParameters>]
Restart-AzureBatchComputeNode
       [-PoolId] <String>
       [-Id] <String>
       [[-RebootOption] <ComputeNodeRebootOption>]
       -BatchContext <BatchAccountContext>
       [<CommonParameters>]

Description

The Restart-AzureBatchComputeNode cmdlet reboots the specified compute node.

Examples

Example 1: Restart a compute node

PS C:\>Restart-AzureBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context

This command reboots the compute node with the ID "tvm-3257026573_2-20150813t200938z" in the pool MyPool.

Example 2: Restart every compute node in a pool

PS C:\>Get-AzureBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Restart-AzureBatchComputeNode -BatchContext $Context

This command reboots every compute node in the pool MyPool.

Required Parameters

-BatchContext

Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.

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

Specifies the ID of the compute node to reboot.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PoolId

Specifies the ID of the pool that contains the compute node.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-ComputeNode

Specifies the PSComputeNode object that represents the compute node to reboot.

Type:PSComputeNode
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-RebootOption

Specifies when to reboot the node and what to do with currently running tasks. The default is Requeue.

Type:ComputeNodeRebootOption
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False