Redgate Monitor 14

Add-RedgateMonitorAnnotation

Adds an annotation to a SQL Server instance for display on the server overview.

Syntax

Add-RedgateMonitorAnnotation [-Target] <MonitoredObject> [[-Description] <string>] [-UtcDate] <datetime> [[-Url] <string>] [[-Source] <string>] [[-DatabaseName] <string>] [[-SpecificInfo] <string>] [<CommonParameters>]

Description

The Add-RedgateMonitorAnnotation cmdlet adds an annotation to a SQL Server instance on Redgate Monitor Server.

Parameters

-Target <MonitoredObject>

The SQL Server instance to apply the annotation to. See Get-RedgateMonitorInstance.

Aliases None
Required? true
Position? 1
Default Value None
Accept Pipeline Input True (ByValue)
Accept Wildcard Characters false

-Description <String>

A textual description of the annotation.

Aliases None
Required? false
Position? 2
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-UtcDate <DateTime>

The time for the annotation to appear. Typically you should use ([datetime]::UtcNow).

Aliases None
Required? true
Position? 3
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-Url <String>

URL to navigate to if the annotation is clicked.

Aliases None
Required? false
Position? 4
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-Source <String>

("Deployment", "Error", "Permissions Change", "Configuration Change", "SQL Update", "Octopus", "Flyway") are special values that will set the Icon used.

Aliases None
Required? false
Position? 5
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-DatabaseName <String>

Unused for now.

Aliases None
Required? false
Position? 6
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-SpecificInfo <String>

Information that is used differently based on the Source. For example, place the sql version when using SQL Update, or the deploying product when using deployment.

Aliases None
Required? false
Position? 7
Default Value None
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 --------------------------

Add-RedgateMonitorAnnotation -Target $instance -Description "Deployment" -UtcDate ([datetime]::UtcNow)


Didn't find what you were looking for?