Start-ServiceFabricNode
Start-ServiceFabricNode
Starts a Service Fabric node.
Syntax
Parameter Set: Default
Start-ServiceFabricNode [-NodeName] <String> [[-NodeInstanceId] <BigInteger]> ] [[-IpAddressOrFQDN] <String> ] [[-ClusterConnectionPort] <Int32]> ] [-CommandCompletionMode <CompletionMode]> ] [-TimeoutSec <Int32]> ] [ <CommonParameters>]
Detailed Description
The Start-ServiceFabricNode cmdlet starts the node specified by the NodeName parameter that has been stopped using the Stop-ServiceFabricNode cmdlet, StopNodeAsync, or a representational state transfer (REST) equivalent. If the cmdlet succeeds, the intent is recorded but the node may not be immediately available.
Use this cmdlet to test your service along the failover recovery paths. This cmdlet helps to test when nodes are added to the cluster to restore the state of persisted replicas, and helps to test load balancing when capacity is added to the system.
If you specify the NodeInstanceId parameter, then you can only use this cmdlet to start a node with that instance ID. If you specify 0 for the NodeInstanceId parameter, it is ignored.
The optional IpAddressOrFQDN and ClusterConnectionPort parameters must be used together. If you specify one, you must also specify the other. If you do not specify the IpAddressOrFQDN and ClusterConnectionPort parameters, the system performs an internal query to determine how to forward the command. If some system services are in quorum loss, the internal query will fail. In this case, be sure to specify the IpAddressOrFQDN and ClusterConnectionPort parameters. In general, you should not specify IpAddressOrFQDN or ClusterConnectionPort. You should use the Start-ServiceFabricNode cmdlet only on nodes that were stopped using the Stop-ServiceFabricNode cmdlet.
Before using this cmdlet, connect to the Service Fabric cluster.
Parameters
-ClusterConnectionPort<Int32]>
Specifies the cluster connection port for the node to start.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CommandCompletionMode<CompletionMode]>
Specifies whether the action waits for the restart to complete.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IpAddressOrFQDN<String>
Specifies the IP address or fully qualified domain name (FQDN) for the node to start. You can use the Get-ServiceFabricNode cmdlet to get the FQDN or IP address of a node.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NodeInstanceId<BigInteger]>
Specifies a node instance ID. Unless you specify 0, the node instance ID that you specify is matched against the current node before the node is started.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NodeName<String>
Specifies the name of a Service Fabric node. The cmdlet starts the node that you specify.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TimeoutSec<Int32]>
Specifies the time-out period, in seconds, for the operation.
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.
string
Specifies the name of a Service Fabric node.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Object
This cmdlet returns a System.Fabric.Testability.StartNodeResult object that represents the operation result.
Examples
Example 1: Start a node
This command starts the node named Node01 and does not wait for the start to complete.
PS C:\> Start-ServiceFabricNode -NodeName "Node01" -CommandCompletionMode DoNotVerify
Example 2: Start a node with a specific NodeInstanceId
This command starts the node named Node02 with a NodeInstanceId value of 1234 and does not wait for the start to complete.
PS C:\> Start-ServiceFabricNode -NodeName "Node02" –NodeInstanceId 1234 -CommandCompletionMode DoNotVerify
Example 3: Start a node and specify the IPAddressOrFQDN and ClusterConnectionPort parameters
This command starts the node named Node03, which has the IP address 172.16.0.0 and a cluster connection port of 10555. You can get the IP address and cluster connection port of a node by using the Get-ServiceFabricNode cmdlet.
PS C:\> Start-ServiceFabricNode -NodeName "Node03" –IpAddressOrFQDN 172.16.0.0 –ClusterConnectionPort 10555 -CommandCompletionMode DoNotVerify