Initates a connection with a SQL Monitor Server.

Syntax

Connect-SqlMonitor [-ServerUrl] <uri> [-AuthToken] <string> [-SkipCertificateCheck] [<CommonParameters>]
 

Description

The Connect-SqlMonitor cmdlet attempts to initate a connection with a SQL Monitor Server.

Must be called atleast once before any other SQL Monitor Cmdlets.

Parameters

-ServerUrl <Uri>

The SQL Monitor Url.

-AuthToken <String>

The API Authorization Token. For more information, see https://documentation.red-gate.com/sm10/api/authentication.

-SkipCertificateCheck <SwitchParameter>

Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. Using this parameter is not secure and is not recommended. This switch is only intended to be used against known hosts using a self-signed certificate for testing purposes. Use at your own risk.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• None.
  You cannot pipe input to this cmdlet.

Return values

The output type is the type of the objects that the cmdlet emits.

• None.
  You cannot pipe input to this cmdlet.

Examples

-------------------------- EXAMPLE 1 --------------------------

Connect-SqlMonitor -ServerUrl "http://sql-monitor.example.com:8080" -AuthToken "GeneratedAuthenticationToken"