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.

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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`CCredentials`	True	Named	False
Instance	Defines the discovered Microsoft SQL Server instance.	`VBRDiscoveredMSSQL`	True	Named	False
UseSAAccount	Applies use of Microsoft SQL Server authentication account for authentication instead of the supplied Windows OS credentials.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Examples

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"

$mssqlInstances = Get-VBRDiscoveredApplication -MSSQL -MSSQLEntityType -Instance

$mssqlInstance = $mssqlInstances[0]

$sqlcredentials = New-VBRMSSQLCredentialsOptions -Credentials $creds -Instance $mssqlInstance

Perform the following steps:

Run the Get-VBRCredentials cmdlet. Save the result to the $creds variable.
Run the Get-VBRDiscoveredApplication cmdlet. Specify the MSSQL, MSSQLEntityType and Instance parameters. Save the result to the $mssqlInstances 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. Save the result to the $sqlcredentials variable.