Get-ServiceFabricClusterConfiguration
Gets the latest JSON format cluster configuration for a standalone deployment.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TimeoutSec
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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseApiVersion
True to indicate that ApiVersion parameter is required.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.