Update-SBHost
Update-SBHost
You can use this cmdlet to update the password or to update the machine.
Syntax
Parameter Set: Default
Update-SBHost [-CertificateAutoGenerationKey <SecureString> ] [-ExternalBrokerPort <Int32> ] [-ExternalBrokerUrl <Uri> ] [-SBFarmDBConnectionString <String> ] [ <CommonParameters>]
Detailed Description
Run Update-SBHost to update the password of the RunAsAccount account or to update the machine after auto-generated certificates have been regenerated. If you only update a password, pass it as a parameter and you do not have to pass CertAutogenerationKey. Only pass CertAutogenerationKey if auto-generated certificates have been updated.
Parameters
-CertificateAutoGenerationKey<SecureString>
This passphrase is required for certificate auto generation. This parameter is mandatory if you want certificates to be auto generated.
Aliases |
none |
Required? |
false |
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 |
-SBFarmDBConnectionString<String>
Represents a connection string of the Service Bus for Windows Server database.
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
Update all settings on the local host. Provide the certificate key if you are using an auto generated certificate. Provide the password of the runAs account Service uses.
PS C:\> $mycert=ConvertTo-SecureString -string myPassword1 -force -AsPlainText
$mypassword=ConvertTo-SecureString -string myAccountPassword1 -force -AsPlainText
Update-SBHost –CertAutogenerationKey $mycert -RunAsPassword $mypassword