FabricClient.TestManagementClient.StartNodeTransitionAsync Method

Definition

Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in an object of type NodeStartDescription into the description parameter. To stop a node, pass in an object of type NodeStopDescription. After this API returns, call GetNodeTransitionProgressAsync() to get progress on the operation.

public System.Threading.Tasks.Task StartNodeTransitionAsync (System.Fabric.Description.NodeTransitionDescription description, TimeSpan operationTimeout, System.Threading.CancellationToken token);
member this.StartNodeTransitionAsync : System.Fabric.Description.NodeTransitionDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function StartNodeTransitionAsync (description As NodeTransitionDescription, operationTimeout As TimeSpan, token As CancellationToken) As Task

Parameters

description
NodeTransitionDescription

An object which describes what type of node transition to perform. The transition can be to start or stop a node.

operationTimeout
TimeSpan

The timeout for this API call.

token
CancellationToken

The cancellationToken

Returns

A task

Exceptions

The ErrorCode property will indicate the reason. If the errorCode is InstanceIdMismatch, the nodeInstance provided does not match the instance of the node that was stopped.

The operation timed out.

An argument with a value of null was passed in.

Remarks

The FaultAnalysisService must be enabled to use this API.

Applies to