Set-SqlAuthenticationMode

Module:

SQLServer

Configures the authentication mode of the target instance of SQL Server.

Syntax

Set-SqlAuthenticationMode
   [-Mode] <ServerLoginMode>
   [[-SqlCredential] <PSCredential>]
   [-ForceServiceRestart]
   [-NoServiceRestart]
   [-Path <String[]>]
   [-Credential] <PSCredential>
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SqlAuthenticationMode
   [-Mode] <ServerLoginMode>
   [[-SqlCredential] <PSCredential>]
   [-ForceServiceRestart]
   [-NoServiceRestart]
   -InputObject <Server[]>
   [-Credential] <PSCredential>
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SqlAuthenticationMode
   [-Mode] <ServerLoginMode>
   [[-SqlCredential] <PSCredential>]
   [-ForceServiceRestart]
   [-NoServiceRestart]
   -ServerInstance <String[]>
   [-Credential] <PSCredential>
   [-AutomaticallyAcceptUntrustedCertificates]
   [-ManagementPublicPort <Int32>]
   [-RetryTimeout <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-SqlAuthenticationMode cmdlet configures the authentication mode of the target instance of SQL Server.

SQL ServerCloud Adapter must be running and accessible on the computer that hosts the instance of SQL Server.

This cmdlet supports the following modes of operation:

• Specify the instance Windows PowerShell path.
• Specify the server object.
• Specify the ServerInstance object of the target instance of SQL Server.

Note: This cmdlet ceased to work a long time ago. It's been removed in version 22 of the module.

Examples

Example 1: Configure the SQL Server authentication mode

PS C:\> CD SQLSERVER:\SQL\Computer\Instance;
PS SQLSERVER:\SQL\Computer\Instance> Set-SqlAuthenticationMode -Credential $Credential -Mode Integrated -ForceServiceRestart -AcceptSelfSignedCertificate

Example 2: Configure the SQL Server authentication mode on all SQL Server instances

PS C:\> Get-SqlInstance -Credential $Credential -MachineName "Computer005" | Set-SqlAuthenticationMode -Credential $Credential -Mode Mixed -SqlCredential $sqlCredential -NoServiceRestart -AcceptSelfSignedCertificate

This command gets all instances of SQL Server on the computer named Computer005 and configures the authentication mode to Mixed, with the provided SQL credentials for each one of them. The SQL Server service is not restarted automatically. The self-signed certificate of the target machine is automatically accepted without prompting the user.

Parameters

-AutomaticallyAcceptUntrustedCertificates

Indicates that this cmdlet automatically accepts untrusted certificates.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies a user account with Windows Administrator credentials on the target computer.

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

-ForceServiceRestart

Indicates that this cmdlet forces the SQL Server service to restart, if necessary, without prompting the user.

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

-InputObject

Specifies the server object, as an array, of the target instance.

Type:	Server[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ManagementPublicPort

Specifies the public management port on the target computer. This parameter should be used when the ports of the target computer are not directly accessible but are exposed through endpoints, which means that this cmdlet needs to connect to a different port.

SQL Server Cloud Adapter must be accessible by this port.

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

-Mode

Specifies the authentication mode that will be configured on the target instance of SQL Server.

Type:	ServerLoginMode
Accepted values:	Normal, Integrated, Mixed, Unknown
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoServiceRestart

Indicates that this cmdlet prevents a restart of the SQL Server service without prompting the user.

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

-Path

Specifies the path to the instance of SQL Server, as an array, on which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet defaults to the current working location.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RetryTimeout

Specifies the time period to retry the command on the target sever. After the timeout expires, no retry will be attempted.

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

-ServerInstance

Specifies, as a string array, the name of an instance of SQL Server that becomes the target of the operation.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SqlCredential

Specifies the administrator credentials that is created in the target instance of SQL Server if Mixed mode authentication is enabled.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.SqlServer.Management.Smo.Server[]

System.String[]

Related Links

• SQLServer_Cmdlets