Get-SBFarm
Get-SBFarm
You can use this cmdlet to retrieve the configuration of the Service Bus for Windows Server farm.
Syntax
Parameter Set: Default
Get-SBFarm [-SBFarmDBConnectionString <String> ] [ <CommonParameters>]
Detailed Description
Run Get-SBFarm to get the configuration of a Service Bus for Windows Server farm. When creating Service Bus for Windows Server farm many parameters have default values. With this cmdlet, you can see all of the settings of the farm either provided during configuration time or defaults. The farm configuration contains a list of the hosts (computers), ports, admin users, database locations, and more.
Parameters
-SBFarmDBConnectionString<String>
Represents the connection string for the SQL Server instance that is used as the Service Bus for Windows Server management database. Use this parameter if you wish to retrieve the configuration of a remote Service Bus for Windows Server farm.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
Retrieves the configuration of the Service Bus for Windows Server farm to which the current host belongs.
PS C:\> Get-SBFarm
Example 2
Retrieves the configuration of the Service Bus for Windows Server farm stored in the database server myDBServer.
PS C:\> Get-SBFarm -SBFarmDBConnectionString “Data Source=myDBServer;Initial Catalog=SbManagementDB;Integrated Security=True”