Share via

New-SqlHADREndpoint

Module:
SQLPS Module

Creates a database mirroring endpoint on a SQL Server instance.

Syntax

ByPath (Default) 

New-SqlHADREndpoint
    [-Name] <String>
    [[-Path] <String>]
    [-Port <Int32>]
    [-Owner <String>]
    [-Certificate <String>]
    [-IpAddress <IPAddress>]
    [-AuthenticationOrder <EndpointAuthenticationOrder>]
    [-Encryption <EndpointEncryption>]
    [-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
    [-Script]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject 

New-SqlHADREndpoint
    [-Name] <String>
    [-InputObject] <Server>
    [-Port <Int32>]
    [-Owner <String>]
    [-Certificate <String>]
    [-IpAddress <IPAddress>]
    [-AuthenticationOrder <EndpointAuthenticationOrder>]
    [-Encryption <EndpointEncryption>]
    [-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
    [-Script]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-SqlHADREndpoint cmdlet creates a database mirroring endpoint on a SQL Server instance. This endpoint is required on every server instance that hosts an availability replica for any availability group. Each server instance can only have one database mirroring endpoint. If a server instance possesses a database mirroring endpoint, use the existing endpoint.

Examples

Example 1: Create a database mirroring endpoint

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint"

This command creates a database mirroring endpoint named MainEndpoint on the server instance located at the specified path. This endpoint uses the default port, 5022.

Example 2: Create a database mirroring endpoint that requires encryption

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Port 4022 -EncryptionAlgorithm Aes' -Encryption Required

This command creates a database mirroring endpoint named MainEndpoint on the server instance located at the specified path. This endpoint listens on port 4022. The endpoint uses the AES algorithm for encryption and requires that connections use encryption.

Example 3: Create a database mirroring endpoint that is encrypted with a certificate

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -AuthenticationOrder
Certificate -Certificate "EncryptionCertificate"

This command creates a database mirroring endpoint named MainEndpoint on the server instance located at the specified path. This endpoint uses the certificate named EncryptionCertificate to authenticate connections.

Example 4: Create a database mirroring endpoint script

PS C:\> New-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance" -Name "MainEndpoint" -Script

This command outputs the Transact-SQL script that creates a database mirroring endpoint named MainEndpoint on the server instance located at the specified path. The endpoint is not actually created by this command.

Parameters

-AuthenticationOrder

Specifies the order and type of authentication that is used by the endpoint. Valid values are:

  • Certificate
  • CertificateKerberos
  • CertificateNegotiate
  • CertificateNtlm
  • Kerberos
  • KerberosCertificate
  • Negotiate
  • NegotiateCertificate
  • Ntlm
  • NtlmCertificate.

If the specified option calls for a certificate, the Certificate parameter must be set.

Parameter properties

Type:EndpointAuthenticationOrder
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Certificate

Specifies the name of the certificate that the endpoint will use to authenticate connections. The far endpoint must have a certificate with the public key matching the private key of the certificate.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Encryption

Specifies the encryption option for the endpoint. Valid values are:

  • Disabled
  • Supported
  • Required

Required is the default value.

Parameter properties

Type:EndpointEncryption
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EncryptionAlgorithm

Specifies the form of encryption used by the endpoint. Valid values are:

  • Aes
  • AesRC4
  • None
  • RC4
  • RC4Aes

By default the endpoint will use Aes encryption.

The RC4 algorithm is only supported for backward compatibility. New material can only be encrypted using RC4 or RC4_128 when the database is in compatibility level 90 or 100, but this is not recommended. For increased security, use a newer algorithm such as one of the AES algorithms instead.

Parameter properties

Type:EndpointEncryptionAlgorithm
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the server object of the SQL Server instance where the endpoint is created.

Parameter properties

Type:Server
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByObject
Position:3
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IpAddress

Specifies the IP address of the endpoint. The default is ALL, which indicates that the listener accepts a connection on any valid IP address.

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the endpoint name. This parameter is required.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Owner

Specifies the login of the owner of the endpoint. By default, this is the current login.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Path

Specifies the path to the SQL Server instance of the endpoint. This parameter is optional. If not specified, the current working location is used.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByPath
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Port

Specifies the TCP port on which the endpoint will listen for connections. The default is 5022.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Script

Indicates that this cmdlet returns a Transact-SQL script that performs the task.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

SMO.Server

Outputs

SMO.Endpoint