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]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlHADREndpoint
   [-Owner <String>]
   [-Certificate <String>]
   [-IpAddress <IPAddress>]
   [-AuthenticationOrder <EndpointAuthenticationOrder>]
   [-Encryption <EndpointEncryption>]
   [-EncryptionAlgorithm <EndpointEncryptionAlgorithm>]
   [-Port <Int32>]
   [-State <EndpointState>]
   [-InputObject] <Endpoint>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-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 5050

This 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 Started

This command starts the database mirroring endpoint named MainDbmEndpoint on the server instance Computer\Instance.

Parameters

-AccessToken

The access token used to authenticate to SQL Server, as an alternative to user/password or Windows Authentication.

This can be used, for example, to connect to SQL Azure DB and SQL Azure Managed Instance using a Service Principal or a Managed Identity.

The parameter to use can be either a string representing the token or a PSAccessToken object as returned by running Get-AzAccessToken -ResourceUrl https://database.windows.net.

This parameter is new in v22 of the module.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:EndpointAuthenticationOrder
Accepted values:Ntlm, Kerberos, Negotiate, Certificate, NtlmCertificate, KerberosCertificate, NegotiateCertificate, CertificateNtlm, CertificateKerberos, CertificateNegotiate
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

-Encrypt

The encryption type to use when connecting to SQL Server.

This value maps to the Encrypt property SqlConnectionEncryptOption on the SqlConnection object of the Microsoft.Data.SqlClient driver.

In v22 of the module, the default is Optional (for compatibility with v21). In v23+ of the module, the default value will be 'Mandatory', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encryption

Specifies the endpoint encryption setting.

Type:EndpointEncryption
Accepted values:Disabled, Supported, Required
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.

NOTE: 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
Accepted values:None, RC4, Aes, AesRC4, RC4Aes
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

The host name to be used in validating the SQL Server TLS/SSL certificate. You must pass this parameter if your SQL Server instance is enabled for Force Encryption and you want to connect to an instance using hostname/shortname. If this parameter is omitted then passing the Fully Qualified Domain Name (FQDN) to -ServerInstance is necessary to connect to a SQL Server instance enabled for Force Encryption.

This parameter is new in v22 of the module.

Type:String
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:1
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. If not specified, the current working location is used.

Type:String
Position:1
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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

Type:ActionPreference
Aliases:proga
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.

Type:EndpointState
Accepted values:Started, Stopped, Disabled
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustServerCertificate

Indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.

In v22 of the module, the default is $true (for compatibility with v21). In v23+ of the module, the default value will be '$false', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

Type:SwitchParameter
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

Microsoft.SqlServer.Management.Smo.Endpoint

Outputs

SMO.Endpoint