Stop-HpcAzureNode
Stop-HpcAzureNode
Stops one or more Windows Azure nodes.
Syntax
Parameter Set: Name
Stop-HpcAzureNode [-Name] <String[]> [-Async <Boolean> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: Node
Stop-HpcAzureNode -Node <HpcNode[]> [-Async <Boolean> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Stops one or more Windows Azure nodes. When you stop the nodes, you remove the corresponding 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 nodes were 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 specified nodes 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 should be forced offline as part of the process to stop the nodes. A $false or 0 value indicates that the online nodes 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 |
-Name<String[]>
Specifies a list of one or more names, separated by commas, of the nodes that you want to stop. You cannot specify both the Name and Node parameters.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Node<HpcNode[]>
Specifies a list of one or more HpcNode objects, separated by commas, for the nodes that you want to stop. You cannot specify both the Node and Name parameters.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Scheduler<String>
Specifies the host name or IP address of the head node for the cluster that includes the 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 |
<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.
- One or more HpcNode objects.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None.
Notes
Windows Azure nodes that are started automatically by an availability policy that is configured in the node template cannot be stopped by this cmdlet.
If all of the nodes in a Windows Azure deployment from a node template are stopped, the deployment is deleted.
If a problem exists with your Internet connection, 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 2012 R2. It is not supported in previous versions.
Examples
Example 1
Stops the Windows Azure node named AzureCN-0117 and returns without waiting for the node to stop.
PS C:\> Stop-HpcAzureNode –Name AzureCN-0117 -Async $true
Example 2
Gets an HpcNode object for the Windows Azure nodes that are in the Offline state, and then stops those Windows Azure nodes.
PS C:\> Get-HpcNode –GroupName AzureNodes –State Offline | Stop-HpcAzureNode