Stop-HpcNodeSet
Stop-HpcNodeSet
Stops a set of Windows Azure nodes.
Syntax
Parameter Set: Default
Stop-HpcNodeSet -Template <HpcNodeTemplate> [-Async <Boolean> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Stops the set of Windows Azure nodes that use the specified node template. When you stop a set of nodes, you remove the set of role instances in Windows Azure and reset the state of the nodes to Not Deployed.
Parameters
-Async<Boolean>
Specifies whether the cmdlet should return immediately without waiting for the nodes to stop.
A nonzero or $true value specifies that the cmdlet should return immediately without waiting for the nodes to stop. A 0 or $false value specifies that the cmdlet should wait for the nodes to stop before returning.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
$false |
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 |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force<Boolean>
Specifies whether the online nodes in the node set should be forced offline as part of the process to stop the nodes, or should just be drained as part of that process.
A $true or nonzero value indicates that the online nodes in the node set should be forced offline as part of the process to stop the nodes. A $false or 0 value indicates that the online nodes in the node set should not be forced offline as part of that process, but should just be drained instead.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
$false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Scheduler<String>
Specifies the host name or IP address of the head node for the cluster that includes the set of Windows Azure nodes that you want to stop. 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 |
%CCP_SCHEDULER% |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Template<HpcNodeTemplate>
Specifies an HpcNodeTemplate object that corresponds to the node template that is associated with the set of Windows Azure nodes that you want to stop.
The node template that you specify must be a Windows Azure node template. An error occurs if you specify a different type of node template.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- An HpcNodeTemplate object.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None.
Notes
All of the Windows Azure nodes that you add to an HPC cluster by using a specific node template define a set of nodes that are deployed and can be managed together in Windows Azure when you start the nodes. This set includes nodes that you add later by using the same node template.
Starting in , you can also stop one or more specified Windows Azure nodes by using the Stop-HpcAzureNode cmdlet.
If a problem exists with your Internet connection or with the connection information for Windows Azure in the specified node template, the process of stopping the nodes can fail.
You must be a cluster administrator to run this cmdlet successfully.
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 1 (SP1). It is not supported in previous versions.
Examples
Example 1
Gets an HpcNodeTemplate object for the node template named MyWorkerNodeTemplate, then stops all of the worker nodes that are associated with that node template from the HPC cluster and returns without waiting for the nodes to stop.
PS C:\>Get-HpcNodeTemplate -Name MyWorkerNodeTemplate | Stop-HpcNodeSet -Async $true