Remove-HpcAzureNode

Remove-HpcAzureNode

Removes one or more Azure nodes from an HPC cluster.

Syntax

Parameter Set: Name
Remove-HpcAzureNode [-Name] <String[]> [-Async <Boolean> ] [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: Node
Remove-HpcAzureNode -Node <HpcNode[]> [-Async <Boolean> ] [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Remove-HpcAzureNode cmdlet removes one or more Azure nodes from an HPC cluster. When you remove the nodes from the cluster, you also remove the corresponding role instances in Azure.

Parameters

-Async<Boolean>

Indicates whether the cmdlet should return immediately without waiting for the node removal to take effect.

A 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

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 nodes were removed.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force<Boolean>

Indicates 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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of 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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Node<HpcNode[]>

Specifies an array of 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

none

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

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.

  • HpcNode[]

Outputs

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

  • None

Notes

  • 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: Remove nodes by group name

This command gets an HpcNode object for all the Azure nodes that are in the cluster, and then removes the nodes while forcing any online Azure nodes to be offline as part of the removal process.


PS C:\> Get-HpcNode –GroupName "AzureNodes" | Remove-HpcAzureNode –Force $True

Related topics

Community Additions

ADD
Show: