Developer Documentation
Citrix Daas SDK

Set-BrokerDBCredentials

August 9, 2024
Contributed by: 
C

Configures the database server SQL credentials for the Broker Service.

Syntax

Set-BrokerDBCredentials
   [-Credentials] <PSCredential>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-BrokerDBCredentials
   [-Login] <String>
   [-Password] <SecureString>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Specifies SQL credentials to be used by the currently selected Citrix Broker Service instance to authenticate with the database server. By default Windows authentication is used and no SQL credentials are required.

If used, SQL credentials must be specified before the service’s schema is obtained and created, and before the database connection string is set. The credentials must also be specified for each additional Broker Service prior to it being added to the site.

If the database connection string is already set and Windows authentication is in use, it is not possible to specify SQL credentials, however, if SQL credentials are already in use then they can be changed.

The current service instance is the one on the local machine, or the one most recently specified using the -AdminAddress parameter of a Broker SDK cmdlet.

Examples

EXAMPLE 1

Prompts for SQL credentials and sets them for use by the current service instance.

Set-BrokerDBCredentials
<!--NeedCopy-->

EXAMPLE 2

Prompts for SQL credentials and sets them for use by the current service instance. This form is useful where the same credentials are being used multiple times.

$sqlCred = Get-Credential
Set-BrokerDBCredentials $sqlCred
<!--NeedCopy-->

EXAMPLE 3

Sets the SQL credentials to the explicitly specified login and password values.

$password = ConvertTo-SecureString 'P@ssW0rd' -AsPlainText -Force
Set-BrokerDBCredentials 'CvadLogin' $password
<!--NeedCopy-->

EXAMPLE 4

Clears previously set SQL credentials and reverts to use of the default Windows authentication. This can only be done if no connection string is set.

Set-BrokerDBCredentials $null
<!--NeedCopy-->

Parameters

-Credentials

A PSCredential object containing the SQL credentials to be used. This can be created using the Get-Credential cmdlet. The credentials required are the SQL server login and its associated password.

Type: PSCredential
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Login

The SQL login to be used for SQL authentication.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Password

The password to be used for SQL authentication.

Type: SecureString
Position: 3
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You cannot pipe input into this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Set-BrokerDBCredentials
August 9, 2024
Contributed by: 
C
August 9, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.