< Back
New-DbaEndpoint
Post
NAME New-DbaEndpoint
SYNOPSIS
Creates endpoints on a SQL Server instance.
SYNTAX
New-DbaEndpoint [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Name] <String>] [[-Type] <String>] [[-Protocol] <String>] [[-Role] <String>]
[[-EndpointEncryption] <String>] [[-EncryptionAlgorithm] <String>] [[-Certificate] <String>] [[-Port] <Int>]
[[-SslPort] <Int>] [[-Owner] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates endpoints on a SQL Server instance.
PARAMETERS
-Certificate [<String>]
Database certificate used for authentication.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EncryptionAlgorithm [<String>]
Specifies an encryption algorithm used on an endpoint. Defaults to Aes.
Options are:
AesRC4
Aes
None
RC4
RC4Aes
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EndpointEncryption [<String>]
Used to specify the state of encryption on the endpoint. Defaults to required.
Disabled
Required
Supported
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The name of the endpoint. If a name is not specified, one will be auto-generated.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Owner [<String>]
Owner of the endpoint. Defaults to sa.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Port [<Int>]
Port for TCP. If one is not provided, it will be auto-generated.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Protocol [<String>]
The type of protocol. Defaults to tcp. Options: Tcp, NamedPipes, Http, Via, SharedMemory
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Role [<String>]
The type of role. Defaults to All. Options: All, None, Partner, Witness
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SslPort [<Int>]
Port for SSL
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<String>]
The type of endpoint. Defaults to DatabaseMirroring. Options: DatabaseMirroring, ServiceBroker, Soap, TSql
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Endpoint
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaEndpoint -SqlInstance localhost\\sql2017 -Type DatabaseMirroring
Creates a database mirroring endpoint on localhost\\sql2017 which using the default port
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaEndpoint -SqlInstance localhost\\sql2017 -Type DatabaseMirroring -Port 5055
Creates a database mirroring endpoint on localhost\\sql2017 which uses alternative port 5055
RELATED LINKS
https://dbatools.io/New-DbaEndpoint
SYNOPSIS
Creates endpoints on a SQL Server instance.
SYNTAX
New-DbaEndpoint [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Name] <String>] [[-Type] <String>] [[-Protocol] <String>] [[-Role] <String>]
[[-EndpointEncryption] <String>] [[-EncryptionAlgorithm] <String>] [[-Certificate] <String>] [[-Port] <Int>]
[[-SslPort] <Int>] [[-Owner] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates endpoints on a SQL Server instance.
PARAMETERS
-Certificate [<String>]
Database certificate used for authentication.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EncryptionAlgorithm [<String>]
Specifies an encryption algorithm used on an endpoint. Defaults to Aes.
Options are:
AesRC4
Aes
None
RC4
RC4Aes
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EndpointEncryption [<String>]
Used to specify the state of encryption on the endpoint. Defaults to required.
Disabled
Required
Supported
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The name of the endpoint. If a name is not specified, one will be auto-generated.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Owner [<String>]
Owner of the endpoint. Defaults to sa.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Port [<Int>]
Port for TCP. If one is not provided, it will be auto-generated.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Protocol [<String>]
The type of protocol. Defaults to tcp. Options: Tcp, NamedPipes, Http, Via, SharedMemory
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Role [<String>]
The type of role. Defaults to All. Options: All, None, Partner, Witness
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SslPort [<Int>]
Port for SSL
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<String>]
The type of endpoint. Defaults to DatabaseMirroring. Options: DatabaseMirroring, ServiceBroker, Soap, TSql
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Endpoint
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaEndpoint -SqlInstance localhost\\sql2017 -Type DatabaseMirroring
Creates a database mirroring endpoint on localhost\\sql2017 which using the default port
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaEndpoint -SqlInstance localhost\\sql2017 -Type DatabaseMirroring -Port 5055
Creates a database mirroring endpoint on localhost\\sql2017 which uses alternative port 5055
RELATED LINKS
https://dbatools.io/New-DbaEndpoint