Connect-SqlMonitor
Published 14 February 2023
Initiates a connection with a SQL Monitor Server.
Syntax
Connect-SqlMonitor [-ServerUrl] <uri> [-AuthToken] <string> [-SkipCertificateCheck] [-SkipVersionsCompatibilityCheck] [<CommonParameters>]
Description
The Connect-SqlMonitor cmdlet attempts to initiate 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.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-AuthToken
<String>
The API Authorization Token. For more information, see https://www.red-gate.com/sm13/api/authentication.
| Aliases | None |
| Required? | true |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-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.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | False |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-SkipVersionsCompatibilityCheck
<SwitchParameter>
Skips checks if the PowerShell module used is compatible with the version of SQL Monitor it connects to. Discouraged, use at your own risk!
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | False |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<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.
Examples
-------------------------- EXAMPLE 1 --------------------------
Connect-SqlMonitor -ServerUrl "http://sql-monitor.example.com:8080" -AuthToken "GeneratedAuthenticationToken"
