This page will give an overview of how to access information about the PowerShell Cmdlets provided by the Redgate Monitor PowerShell Module.

Once you have imported the PowerShell Module, you can view a list of the available Cmdlets using the following command:

Get-Command -Module RedgateMonitor | where CommandType -eq Function | sort Name | select Name

This will give you output like this:

Name
----
Add-RedgateMonitorAccessRight
Add-RedgateMonitorAnnotation
Add-RedgateMonitorMonitoredObject
Add-RedgateMonitorSshPrivateKey
Add-RedgateMonitorTag
Connect-RedgateMonitor
Get-RedgateMonitorAlertSettings
Get-RedgateMonitorAlertSuppressionWindow
Get-RedgateMonitorAnnotation
Get-RedgateMonitorAvailabilityGroup
Get-RedgateMonitorBaseMonitor
Get-RedgateMonitorDatabase
Get-RedgateMonitorDetectedDatabase
Get-RedgateMonitorDisk
Get-RedgateMonitorElasticPool
Get-RedgateMonitorGroup
Get-RedgateMonitorInstance
Get-RedgateMonitorJob
Get-RedgateMonitorMainGroup
Get-RedgateMonitorMonitoredObject
Get-RedgateMonitorMonitoredObjectStatus
Get-RedgateMonitorPrincipal
Get-RedgateMonitorSshPrivateKey
Get-RedgateMonitorSubGroup
Get-RedgateMonitorTag
New-RedgateMonitorAlertSpecificSettings
New-RedgateMonitorAlertSuppressionWindow
New-RedgateMonitorAmazonAuroraCluster
New-RedgateMonitorAmazonRdsHost
New-RedgateMonitorAzureSqlDatabase
New-RedgateMonitorAzureSqlDatabaseCredential
New-RedgateMonitorAzureSqlManagedInstance
New-RedgateMonitorGroup
New-RedgateMonitorLinuxHost
New-RedgateMonitorPostgreSql
New-RedgateMonitorPrincipal
New-RedgateMonitorSqlServer
New-RedgateMonitorWindowsHost
Remove-RedgateMonitorAccessRight
Remove-RedgateMonitorAlertSuppressionWindow
Remove-RedgateMonitorAnnotation
Remove-RedgateMonitorGroup
Remove-RedgateMonitorMonitoredObject
Remove-RedgateMonitorPrincipal
Remove-RedgateMonitorSshPrivateKey
Remove-RedgateMonitorTag
Test-RedgateMonitorGroupAccess
Test-RedgateMonitorMonitoredObjectAccess
Update-RedgateMonitorAlertNotificationSettings
Update-RedgateMonitorAlertSettingsComment
Update-RedgateMonitorAlertSettingsStatus
Update-RedgateMonitorAlertSpecificSettings
Update-RedgateMonitorAlertSuppressionWindow
Update-RedgateMonitorAnnotation
Update-RedgateMonitorMonitoredObject
Update-RedgateMonitorMonitoredObjectSelectedDatabase
Update-RedgateMonitorMonitoredObjectSuspendedStatus
Update-RedgateMonitorPrincipal

For details on a specific Cmdlet, you can use the built-in PowerShell function Get-Help . For instance, if you wanted to find out the specifics of the Update-RedgateMonitorAlertSpecificSettings  Cmdlet, you would use:

Get-Help Update-RedgateMonitorAlertSpecificSettings

The output would look something like this:

Get-Help Update-RedgateMonitorAlertSpecificSettings

NAME
    Update-RedgateMonitorAlertSpecificSettings

SYNOPSIS
    Updates the alert settings for a specific alert type and target monitored object.


SYNTAX
    Update-RedgateMonitorAlertSpecificSettings [-MonitoredObject] <MonitoredObject> [-AlertType] <Int32> [-Settings] <SpecificAlertSettings> [<CommonParameters>]


DESCRIPTION
    Updates the alert settings for a specific alert type and monitored object. The alert settings object will depend on the alert type.


RELATED LINKS

REMARKS
    To see the examples, type: "Get-Help Update-RedgateMonitorAlertSpecificSettings -Examples"
    For more information, type: "Get-Help Update-RedgateMonitorAlertSpecificSettings -Detailed"
    For technical information, type: "Get-Help Update-RedgateMonitorAlertSpecificSettings -Full"

Many of the Cmdlets take in parameters of types defined by the Redgate Monitor PowerShell Module. For clarification on these types, view the Custom Types page. You can also consult the example scripts available in Redgate Monitor itself for further guidance.