Remove-HpcAzureNode
Remove-HpcAzureNode
Removes one or more Windows Azure nodes from an HPC cluster.
Syntax
Parameter Set: Name
Remove-HpcAzureNode [-Name] <String[]> [-Async <Boolean> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: Node
Remove-HpcAzureNode -Node <HpcNode[]> [-Async <Boolean> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Removes one or more Windows Azure nodes from an HPC cluster. When you remove the nodes from the cluster, you also remove the corresponding role instances in Windows Azure.
Parameters
-Async<Boolean>
Specifies whether the cmdlet should return immediately without waiting for the node removal to take effect.
nonzero or $true value specifies that the cmdlet should return immediately without waiting for the node removal to take effect. A 0 or $false value specifies that the cmdlet should wait for the node removal to take effect 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 removed.
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 removal process, or should just be drained as part of the removal process.
A $true or nonzero value indicates that the online nodes should be forced offline as part of the removal process. A $false or 0 value indicates that the online nodes should not be forced offline as part of the removal 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 remove. 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 remove. 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 removed by this cmdlet. You can use the Remove-HpcNodeSet cmdlet instead.
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
Gets an HpcNode object for all the Windows Azure nodes that are in the cluster, and then removes the nodes while forcing any online Windows Azure nodes to be offline as part of the removal process.
PS C:\> Get-HpcNode –GroupName AzureNodes | Remove-HpcAzureNode –Force $true