New-VBRMSSQLCredentialsOptions

Short Description

Creates Microsoft SQL Server credentials configuration that defines the connection between Veeam Backup & Replication and a discovered Microsoft SQL Server instance for Veeam Plug-In for Microsoft SQL Server backup operations.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

New-VBRMSSQLCredentialsOptions -Instance <VBRDiscoveredMSSQL> -Credentials <CCredentials> [-UseSAAccount] [<CommonParameters>]

Detailed Description

This cmdlet applies to application backup policies for Veeam Plug-In for Microsoft SQL Server.

Use this cmdlet to set authentication credentials for the Microsoft SQL Server instance.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Instance	Defines the discovered Microsoft SQL Server instance.	VBRDiscoveredMSSQL	True	Named	False
Credentials	Specifies the credentials used to connect to the Microsoft SQL Server instance.	Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.	True	Named	False
UseSAAccount	Applies use of Microsoft SQL Server system administrator account for authentication instead of the supplied credentials.	SwitchParameter	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example

Associate Discovered Microsoft SQL Server Instance with Specific Credentials

This example shows how to apply stored service account credentials to the discovered Microsoft SQL Server instance.

$creds = Get‑VBRCredentials -Name "SQL_Account"

$sqlcredentials = New‑VBRMSSQLCredentialsOptions -Credentials $creds -Instance SQLSRV1

Perform the following steps:

Run the Get‑VBRCredentials cmdlet. Save the result to the $creds variable.
Run the New‑VBRMSSQLCredentialsOptions cmdlet. Specify the Credentials parameter with the $creds variable. Specify the Instance parameter with the name of the Microsoft SQL Server instance.