Export (0) Print
Expand All

Set-SBFarm

Updated: October 15, 2013

Set-SBFarm

You can use this cmdlet to modify certain properties of the Service Bus farm. Some of the changes supported by this cmdlet require you to stop the farm before calling the cmdlet. In some cases, after calling the cmdlet you must call update-SBHost on all of the farm’s nodes and restart the farm.

Syntax

Parameter Set: Default
Set-SBFarm [-AdminApiCredentials <PSCredential> ] [-AdminGroup <String> ] [-FarmDns <String> ] [-RunAsAccount <String> ] [-SBFarmDBConnectionString <String> ] [-TenantApiCredentials <PSCredential> ] [ <CommonParameters>]




Detailed Description

Run Set-SBFarm to modify the configuration of a Service Bus for Windows Server farm. When creating a Service Bus for Windows Server farm, many parameters have default values. You can use this cmdlet to change the settings of the farm, such as the ports, admin users, database locations, and more.

Parameters

-AdminApiCredentials<PSCredential>

Sets the resource provider credentials. The resource provider is a component that exposes the management API to the portal. There are two Service Bus management portals; the Admin portal (which provides a set of resource provider APIs for farm administration), and the Tenant portal (which is the Azure Management Portal). Use these credentials when you manually install the server farm and connect to the Admin portal.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AdminGroup<String>

The admin group that has access to all of the admin PowerShell cmdlets. While the admin group is composed of domain joined users or AD group, there are cases where you need to change it.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FarmDns<String>

The DNS prefix that is mapped to all server farm nodes. The server farm node value is returned when you call the Get-SBClientConfiguration cmdlet to request a connection string. This parameter is used to create connection strings shared with tenants when you do not want to expose the farm’s fully qualified domain names (FQDNs).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsAccount<String>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SBFarmDBConnectionString<String>

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 are running the set-SBFarm cmdlet remotely (not from a node that is part of the farm).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TenantApiCredentials<PSCredential>

Sets the resource provider credentials for the tenant portal. The resource provider is a component that exposes the management API to the portal. There are two Service Bus management portals; the Admin portal (which provides a set of resource provider APIs for farm administration), and the Tenant portal (which is the Azure Management Portal). Use these credentials when you manually install the server farm and connect to the tenant portal.


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 (http://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

 

Use the following set of cmdlets to modify the Service Bus run as account. Note, this cmdlet requires you to run the update-sbHost on all the farm’s nodes.


PS C:\> set-SBFarm –RunAsAccount mydomain\newServiceAccountPS C:\>update-SBHost –RunAsPassword $secureStringPasswordPS C:\>start-SBFarm

Service Bus 1.0 MSDN Community Forum

Community Additions

ADD
Show:
© 2014 Microsoft