Remove-HpcNodeSet

Remove-HpcNodeSet

Removes a set of Azure nodes from an HPC cluster.

Syntax

Parameter Set: Default
Remove-HpcNodeSet -Template <HpcNodeTemplate> [-Async <Boolean> ] [-ClusterConnectionString <String[]> ] [-Comment <String> ] [-Force <Boolean> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Remove-HpcNodeSet cmdlet removes the set of Azure nodes that are associated with the specified node template from an HPC cluster.

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 set of nodes was 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 node set 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 in the node set should be forced offline as part of the removal process. A $False or 0 value indicates that the online nodes in the node set 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

-Scheduler<String[]>

Specifies the host name or IP address of the head node for the cluster that includes the set of Azure nodes that you want to remove. 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

-Template<HpcNodeTemplate>

Specifies an HpcNodeTemplate object that corresponds to the node template that is associated with the set of Azure nodes that you want to remove from the HPC cluster.

The node template that you specify must be a Azure node template. An error occurs if you specify a different type of node template.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.

  • An HpcNodeTemplate object

Outputs

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

  • None

Notes

  • All of the 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 Azure when you start the nodes. This set includes nodes that you add later by using the same node template.

  • Starting in HPC Pack 2012 R2, you can also remove one or more specified Azure nodes by using the Remove-HpcAzureNode cmdlet.

  • 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: Remove nodes from a node template

This command gets an HpcNodeTemplate object for the node template named MyWorkerNodeTemplate, and then removes all of the worker nodes that are associated with that node template from the HPC cluster and returns without waiting for the removal to take effect.


PS C:\> Get-HpcNodeTemplate -Name "MyWorkerNodeTemplate" | Remove-HpcNodeSet -Async $True

Related topics

Community Additions

ADD
Show: