Share via


Add-SBHost

Add-SBHost

You can use this cmdlet to add a machine on which the Service Bus for Windows Server has been installed to the farm.

Syntax

Parameter Set: Default
Add-SBHost -CertificateAutoGenerationKey <SecureString> -EnableFirewallRules <Boolean> -RunAsPassword <SecureString> -SBFarmDBConnectionString <String> [-ExternalBrokerPort <Int32> ] [-ExternalBrokerUrl <Uri> ] [ <CommonParameters>]

Detailed Description

Run Add-SBHost to add a host to the Service Bus for Windows Server farm. When a Service Bus for Windows Server farm is created, it contains no hosts and cannot provide any service. Only when the first host is added the farm is considered to be running.

Parameters

-CertificateAutoGenerationKey<SecureString>

Specifies a key that the farm uses to secure the auto generated certificates. This parameter is mandatory if you want to auto generate the certificates.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableFirewallRules<Boolean>

Enables or disables your firewall rules.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExternalBrokerPort<Int32>

Represents the port that the Service Bus for Windows Server uses for ExternalBroker communication.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExternalBrokerUrl<Uri>

Specifies a case-sensitive ExternalBroker URI.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsPassword<SecureString>

Specifies the password for the user account under which services are running on the farm.

If all the machines in a farm share the same service account and the security policy requires the service account password to be changed at regular intervals, you must perform specific actions on each machine in the farm to be able to continue adding and removing nodes in the farm. See the section titled "Managing Farm Password Changes Using Cmdlets" for this procedure.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SBFarmDBConnectionString<String>

Specifies the connection string for the SQL Server instance being added as the Service Bus for Windows Server management database.

Aliases

none

Required?

true

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

Add a machine on which the Service Bus for Windows Server has been installed to the Service Bus for Windows Server farm.

PS C:\> $myPassword=convertto-securestring '*************' -asplaintext -forcePS C:\> Add-SBHost -SBFarmDBConnectionString 'Data Source=localhost\sqlexpress;Initial Catalog=SbManagementDB;Integrated Security=True' -RunAsPassword $myPassword

Example 2

Add a machine on which the Service Bus for Windows Server has been installed and a certificate key is specified while initializing the farm.

PS C:\> $myPassword=convertto-securestring '*************' -asplaintext -forcePS C:\> $certKey=convertto-securestring '*************' -asplaintext -forcePS C:\> Add-SBHost -SBFarmDBConnectionString 'Data Source=localhost\sqlexpress;Initial Catalog=SbManagementDB;Integrated Security=True' -RunAsPassword $myPassword -CertificateAutoGenerationKey certKey

Service Bus 1.0 MSDN Community Forum