Set-SqlHADREndpoint
Sets the properties of a database mirroring endpoint.
Syntax
Set-SqlHADREndpoint
[-Owner <String>]
[-Certificate <String>]
[-IpAddress <IPAddress>]
[-AuthenticationOrder <EndpointAuthenticationOrder>]
[-Encryption <EndpointEncryption>]
[-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
[-Port <Int32>]
[-State <EndpointState>]
[[-Path] <String>]
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-SqlHADREndpoint
[-Owner <String>]
[-Certificate <String>]
[-IpAddress <IPAddress>]
[-AuthenticationOrder <EndpointAuthenticationOrder>]
[-Encryption <EndpointEncryption>]
[-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
[-Port <Int32>]
[-State <EndpointState>]
[-InputObject] <Endpoint>
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-SqlHADREndpoint cmdlet changes the properties of a database mirroring endpoint.
Examples
Example 1: Set the port number of a database mirroring endpoint
PS C:\> Set-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance\Endpoints\MainDbmEndpoint" -Port 5050This command sets the port number of the database mirroring endpoint named MainDbmEndpoint to 5050 on the server instance named Computer\Instance.
Example 2: Start a database mirroring endpoint
PS C:\> Set-SqlHADREndpoint -Path "SQLSERVER:\Sql\Computer\Instance\Endpoints\MainDbmEndpoint" -State StartedThis command starts the database mirroring endpoint named MainDbmEndpoint on the server instance Computer\Instance.
Parameters
-AuthenticationOrder
Specifies the order and type of authentication that is used by the endpoint. . If the specified option calls for a certificate, the Certificate parameter must be set unless a certificate is already associated with the endpoint. Valid values are:
- Certificate
- CertificateKerberos
- CertificateNegotiate
- CertificateNtlm
- Kerberos
- KerberosCertificate
- Negotiate
- NegotiateCertificate
- Ntlm
- NtlmCertificate
| Type: | EndpointAuthenticationOrder |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Certificate
Specifies the name of the certificate the endpoint will use to authenticate connections. The far endpoint must have a certificate with the public key matching the private key of the specified certificate.
| Type: | String |
| 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 |
-Encryption
Specifies the endpoint encryption setting. Valid values are:
- Disabled
- Supported
- Required
| Type: | EndpointEncryption |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionAlgorithm
Specifies the form of encryption used by the endpoint. Valid values are:
- Aes
- AesRC4
- None
- RC4
- RC4Aes
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 improved security, use a newer algorithm such as one of the AES algorithms instead.
| Type: | EndpointEncryptionAlgorithm |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the endpoint that to modify. This must be a database mirroring endpoint.
| Type: | Endpoint |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IpAddress
Specifies the IP address on which the endpoint will listen.
| Type: | IPAddress |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Owner
Specifies the owner of the endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Specifies the path to the database mirroring endpoint. This is an optional parameter. If not specified, the current working location is used.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
Specifies the TCP port number used by the endpoint to listen for connections.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Script
Indicates that this cmdlet outputs a Transact-SQL script that performs the task.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-State
Specifies the state of the endpoint. Valid values are:
- Started
- Stopped
- Disabled
| Type: | EndpointState |
| Position: | Named |
| 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
SMO.Endpoint
Outputs
SMO.Endpoint