Share via

Get-ServiceFabricClusterConfiguration

  • Reference
Module:
ServiceFabric

Gets the latest JSON format cluster configuration for a standalone deployment.

Syntax

Get-ServiceFabricClusterConfiguration
   [-UseApiVersion]
   [-ApiVersion <String>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

The Get-ServiceFabricClusterConfiguration cmdlet gets the latest cluster configuration JavaScript Object Notation (JSON) format.

To run this cmdlet, you must first establish a connection by using the Connect-ServiceFabricCluster cmdlet.

This cmdlet is only applicable to on premise Standalone deployments. If executed against a cluster that does not have the UpgradeOrchestrationService Fabric system service, the request will time out.

Examples

Example 1: Get cluster configuration

PS C:\> Connect-ServiceFabricCluster -ConnectionEndpoint "ServiceFabric01.ContosoCloudApp.net:19000"
PS C:\> Get-ServiceFabricClusterConfiguration -UseApiVersion -ApiVersion 05-2017

The first command creates a connection to the specified cluster.

The second command gets the latest cluster configuration in JSON format.

Parameters

-ApiVersion

Api version on cluster json configuration.

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

-TimeoutSec

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

-UseApiVersion

True to indicate that ApiVersion parameter is required.

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

Inputs

None

Outputs

System.Object