New-SqlHADREndpoint

Creates a database mirroring endpoint on a SQL Server instance.

语法

ByPath (默认值)

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>]

说明

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.

示例

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.

参数

-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.

参数属性

类型:EndpointAuthenticationOrder
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值: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.

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

Prompts you for confirmation before running the cmdlet.

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Encryption

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

  • Disabled
  • Supported
  • Required

Required is the default value.

参数属性

类型:EndpointEncryption
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值: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.

参数属性

类型:EndpointEncryptionAlgorithm
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InputObject

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

参数属性

类型:Server
默认值:None
支持通配符:False
不显示:False

参数集

ByObject
Position:3
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值: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.

参数属性

类型:IPAddress
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

Specifies the endpoint name. This parameter is required.

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:2
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Owner

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值: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.

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ByPath
Position:3
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Port

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

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Script

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

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

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:wi

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值: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.

输入

SMO.Server

输出

SMO.Endpoint