Stop-HpcAzureNode

Stop-HpcAzureNode

Stops Azure nodes.

Syntax

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

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




Detailed Description

The Stop-HpcAzureNode cmdlet stops one or more Azure nodes. When you stop the nodes, you remove the corresponding role instances in Azure and reset the state of the nodes to Not Deployed.

Parameters

-Async<Boolean>

Indicates 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

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


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

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 stop. 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 stop. 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 stopped by this cmdlet.

  • If all of the nodes in an 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: Stop an Azure node by name

This command stops the 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: Get Azure nodes by state and stop them

This command gets an HpcNode object for the Azure nodes that are in the Offline state, and then stops those Azure nodes.


PS C:\> Get-HpcNode –GroupName "AzureNodes" –State Offline | Stop-HpcAzureNode

Related topics

Community Additions

ADD
Show: