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.
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
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
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
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
DontShow:
False
パラメーター セット
(All)
配置:
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
DontShow:
False
パラメーター セット
(All)
配置:
Named
必須:
False
パイプラインからの値:
False
プロパティ名別のパイプラインからの値:
False
残りの引数からの値:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
パラメーターのプロパティ
型:
SwitchParameter
規定値:
False
ワイルドカードのサポート:
False
DontShow:
False
Aliases:
cf
パラメーター セット
(All)
配置:
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
DontShow:
False
パラメーター セット
(All)
配置:
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
DontShow:
False
パラメーター セット
(All)
配置:
Named
必須:
False
パイプラインからの値:
False
プロパティ名別のパイプラインからの値:
False
残りの引数からの値:
False
-InputObject
Specifies the server object of the SQL Server instance where the endpoint is created.
パラメーターのプロパティ
型:
Server
規定値:
None
ワイルドカードのサポート:
False
DontShow:
False
パラメーター セット
ByObject
配置:
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
DontShow:
False
パラメーター セット
(All)
配置:
Named
必須:
False
パイプラインからの値:
False
プロパティ名別のパイプラインからの値:
False
残りの引数からの値:
False
-Name
Specifies the endpoint name.
This parameter is required.
パラメーターのプロパティ
型:
String
規定値:
None
ワイルドカードのサポート:
False
DontShow:
False
パラメーター セット
(All)
配置:
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
DontShow:
False
パラメーター セット
(All)
配置:
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
DontShow:
False
パラメーター セット
ByPath
配置:
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
DontShow:
False
パラメーター セット
(All)
配置:
Named
必須:
False
パイプラインからの値:
False
プロパティ名別のパイプラインからの値:
False
残りの引数からの値:
False
-Script
Indicates that this cmdlet returns a Transact-SQL script that performs the task.
パラメーターのプロパティ
型:
SwitchParameter
規定値:
None
ワイルドカードのサポート:
False
DontShow:
False
パラメーター セット
(All)
配置:
Named
必須:
False
パイプラインからの値:
False
プロパティ名別のパイプラインからの値:
False
残りの引数からの値:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
パラメーターのプロパティ
型:
SwitchParameter
規定値:
False
ワイルドカードのサポート:
False
DontShow:
False
Aliases:
wi
パラメーター セット
(All)
配置:
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.