Get-​Service​Fabric​Deployed​Replica​Detail

Gets information about Service Fabric replicas from a host process.

Syntax

Get-ServiceFabricDeployedReplicaDetail
   [-NodeName] <String>
   [-PartitionId] <Guid>
   [-ReplicaOrInstanceId] <Int64>
   [-ReplicatorDetail]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

The Get-ServiceFabricDeployedReplicaDetail cmdlet gets information about Service Fabric replicas from the host process in which they run. This provides additional information such as the status of currently executing APIs on the service and details from the Service Fabric replicator about the progress of this replica.

Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.

Examples

Example 1: Get Replica Detail for a replica running on a node

PS C:\> Get-ServiceFabricDeployedReplicaDetail -NodeName "DB.41" -PartitionId 7B7D6D73-3D41-42A9-B7DF-B9D93A386BFF -ReplicaOrInstanceId 130705747836122602

This command gets details about a replica running on a node from the service host process.

Example 2: Get Replica Detail for a replica running on a node including the replicator detail

PS C:\> Get-ServiceFabricDeployedReplicaDetail -NodeName "DB.41" -PartitionId 7B7D6D73-3D41-42A9-B7DF-B9D93A386BFF -ReplicaOrInstanceId 130705747836122602 -ReplicatorDetail

This command gets details about the replica and replicator running on a node from the service host process. It also returns additional information from the Service Fabric replicator about the progress of the replica. See Replicator​Status Class (https://docs.microsoft.com/dotnet/api/system.fabric.query.replicatorstatus) for more information.

Required Parameters

-NodeName

Specifies the name of a Service Fabric node. This cmdlet gets details about replicas that run in this node.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PartitionId

Specifies the ID of a Service Fabric partition. This parameter identifies the partition that has the replica or instance ID.

Type:Guid
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ReplicaOrInstanceId

Specifies the Service Fabric service replica or instance ID for which to get information.

Type:Int64
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ReplicatorDetail

Indicates that this cmdlet gets information from the Service Fabric replicator. See Remote​Replicator​Status Class (https://docs.microsoft.com/dotnet/api/system.fabric.query.remotereplicatorstatus) for details regarding the additional returned information.

Type:SwitchParameter
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String, System.Guid, Int64

This parameter accepts a string that represents a Service Fabric node name, or the GUID of a Service Fabric partition, or an integer replica or instance ID.

Outputs

System.Object

This cmdlet returns a DeployedServiceReplicaDetail (https://docs.microsoft.com/dotnet/api/system.fabric.query.deployedservicereplicadetail) object that contains information about a Service Fabric replica.