Citrix Virtual Apps and Desktops SDK

Set-TrustDBCredentials

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2311

Configures the database server SQL credentials for the Trust Service.

Syntax

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

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

Description

Specifies SQL credentials to be used by the currently selected Citrix Trust 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 Trust 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 Trust SDK cmdlet.

Examples

EXAMPLE 1

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

Set-TrustDBCredentials
<!--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-TrustDBCredentials $sqlCred
<!--NeedCopy-->

EXAMPLE 3

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

$password = ConvertTo-SecureString 'P@ssW0rd' -AsPlainText -Force
Set-TrustDBCredentials '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-TrustDBCredentials $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

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 this cmdlet call forms a part of. Citrix Studio and 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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-TrustDBCredentials

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Set-TrustDBCredentials

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

Parameters

-Credentials

-Login

-Password

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

None

Related Links

In this article