Redgate Monitor 14

Help for older versions available.

Where are you using Redgate Monitor? (pick the closest answer)
View Results

PowerShell Cmdlets

Page last updated 13 January 2025

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:

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

This will give you output like this:

  1. Name
  2. ----
  3. Add-RedgateMonitorAccessRight
  4. Add-RedgateMonitorAnnotation
  5. Add-RedgateMonitorMonitoredObject
  6. Add-RedgateMonitorServicePrincipalCredential
  7. Add-RedgateMonitorSshPrivateKey
  8. Add-RedgateMonitorTag
  9. Connect-RedgateMonitor
  10. Get-RedgateMonitorAlertSettings
  11. Get-RedgateMonitorAlertSuppressionWindow
  12. Get-RedgateMonitorAnnotation
  13. Get-RedgateMonitorAvailabilityGroup
  14. Get-RedgateMonitorBaseMonitor
  15. Get-RedgateMonitorDatabase
  16. Get-RedgateMonitorDetectedDatabase
  17. Get-RedgateMonitorDisk
  18. Get-RedgateMonitorElasticPool
  19. Get-RedgateMonitorGroup
  20. Get-RedgateMonitorInstance
  21. Get-RedgateMonitorJob
  22. Get-RedgateMonitorMainGroup
  23. Get-RedgateMonitorMonitoredObject
  24. Get-RedgateMonitorMonitoredObjectStatus
  25. Get-RedgateMonitorPrincipal
  26. Get-RedgateMonitorServicePrincipalCredential
  27. Get-RedgateMonitorSshPrivateKey
  28. Get-RedgateMonitorSubGroup
  29. Get-RedgateMonitorTag
  30. New-RedgateMonitorAlertSpecificSettings
  31. New-RedgateMonitorAlertSuppressionWindow
  32. New-RedgateMonitorAmazonAuroraCluster
  33. New-RedgateMonitorAmazonRdsHost
  34. New-RedgateMonitorAzureFlexHost
  35. New-RedgateMonitorAzureSqlDatabase
  36. New-RedgateMonitorAzureSqlDatabaseCredential
  37. New-RedgateMonitorAzureSqlManagedInstance
  38. New-RedgateMonitorGroup
  39. New-RedgateMonitorLinuxHost
  40. New-RedgateMonitorPostgreSql
  41. New-RedgateMonitorPrincipal
  42. New-RedgateMonitorSqlServer
  43. New-RedgateMonitorWindowsHost
  44. Remove-RedgateMonitorAccessRight
  45. Remove-RedgateMonitorAlertSuppressionWindow
  46. Remove-RedgateMonitorAnnotation
  47. Remove-RedgateMonitorGroup
  48. Remove-RedgateMonitorMonitoredObject
  49. Remove-RedgateMonitorPrincipal
  50. Remove-RedgateMonitorServicePrincipalCredential
  51. Remove-RedgateMonitorSshPrivateKey
  52. Remove-RedgateMonitorTag
  53. Test-RedgateMonitorGroupAccess
  54. Test-RedgateMonitorMonitoredObjectAccess
  55. Update-RedgateMonitorAlertNotificationSettings
  56. Update-RedgateMonitorAlertSettingsComment
  57. Update-RedgateMonitorAlertSettingsStatus
  58. Update-RedgateMonitorAlertSpecificSettings
  59. Update-RedgateMonitorAlertSuppressionWindow
  60. Update-RedgateMonitorAnnotation
  61. Update-RedgateMonitorMonitoredObject
  62. Update-RedgateMonitorMonitoredObjectSelectedDatabase
  63. Update-RedgateMonitorMonitoredObjectSuspendedStatus
  64. 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:

  1. Get-Help Update-RedgateMonitorAlertSpecificSettings

The output would look something like this:

  1. Get-Help Update-RedgateMonitorAlertSpecificSettings
  2.  
  3. NAME
  4.     Update-RedgateMonitorAlertSpecificSettings
  5.  
  6. SYNOPSIS
  7.     Updates the alert settings for a specific alert type and target monitored object.
  8.  
  9.  
  10. SYNTAX
  11.     Update-RedgateMonitorAlertSpecificSettings [-MonitoredObject] <MonitoredObject> [-AlertType] <Int32> [-Settings] <SpecificAlertSettings> [<CommonParameters>]
  12.  
  13.  
  14. DESCRIPTION
  15.     Updates the alert settings for a specific alert type and monitored object. The alert settings object will depend on the alert type.
  16.  
  17.  
  18. RELATED LINKS
  19.  
  20. REMARKS
  21.     To see the examples, type: "Get-Help Update-RedgateMonitorAlertSpecificSettings -Examples"
  22.     For more information, type: "Get-Help Update-RedgateMonitorAlertSpecificSettings -Detailed"
  23.     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.

Didn't find what you were looking for?

Product Articles

Tips and how-to guides for Redgate products

University

Easy to follow video courses

Community Forums

Ask, discuss, and solve questions about Redgate's tools

Events & Friends

Meet us at an event, get sponsored, and join our Friends of Redgate

Simple Talk

In-depth articles and opinion from Redgate's technical journal

Cookies on red-gate.com

This website stores cookies on your computer.

These cookies are used to improve your website experience and provide more personalized services to you, both on this website and through other media.

To find out more about the cookies we use, see our Privacy Policy