SentryOne PowerShell Module

Getting Started

The SentryOne installation package includes a PowerShell module that can be used to manage your SentryOne environment through PowerShell. This topic includes a walkthrough of that functionality.

Importing the module

You'll find the PowerShell module in the SentryOne program directory (which varies depending on the installed <Version>):

C:\Program Files\SentryOne\<Version>\Intercerve.SQLSentry.Powershell.psd1

Import the SentryOne PowerShell module by using the Import-Module command. 

Import-Module command example for version 19.x:

Import-Module "C:\Program Files\SentryOne\19.0\Intercerve.SQLSentry.Powershell.psd1"

Import-Module command example for version 20.x:

Import-Module "C:\Program Files\SentryOne\20.0\Intercerve.SQLSentry.Powershell.psd1"

Import-Module Example with version 2020.0

Verify that the module imported correctly by running the Get-Module command. You should see a listing for Intercerve.SentryOne.Powershell. 

Get-Module Example showing the Intercerve.SentryOne.PowerShell

Command Details

See the Command Examples section for more information on using available commands.

Get-Help

Use Get-Help followed by a command to get information about the available commands in the table above. For example, to learn more about Get-Connection:

Get-Help Get-Connection

Get-Help Get-Connection Example

Command Examples

Import the SentryOne PowerShell Module

<# Import the SentryOne PowerShell Module #>
Import-Module "C:\Program Files\SentryOne\2020.0\Intercerve.SQLSentry.Powershell.psd1"

Connect to SentryOne Installation

<# Connect to a specific SentryOne Installation #>
Connect-SQLSentry -ServerName server.domain.com -DatabaseName SentryOne

Get SentryOne Installation Information

<# Get Information about your SentryOne Installation #>
Get-SQLSentryConfiguration 

Get SentryOne Information for Sites

<# Get Information about the Sites in your SentryOne Installation -use parameters to find information for a specific site #>
Get-Site 

Get SentryOne Information for Instances

<# Get Information about the Connections (Instances) in your SentryOne Installation -use parameters to find information for a specific connection #>
Get-Connection 

Get SentryOne Information for Targets

<# Get Information about the Computers (Targets) in your SentryOne Installation -use parameters to find information for a specific connection #>
Get-Computer 

Get SentryOne Information for Specific Target

<# Get Information about the Connections in your SentryOne Installation -use parameters to find information for a specific connection #>
Get-Connection 

Register a Target

<# Register Computers (Targets), so that they can be watched in your environment #>
Register-Computer -ComputerType Windows -Name server.domain.com -AccessLevel Full Register-Computer -ComputerType Windows - Name server.domain.com -AccessLevel Limited 

Register a Target (non Windows)

<# Register a Target that cannot utilize Windows Authentication (e.g., Azure SQL Database) #>
Register-Computer -ComputerType AzureSqlDatabase -Name example.database.windows.net -DatabaseName dbName -Login username -Password password -AccessLevel Full -UseIntegratedSecurity 0 

Register Instances

<# Register Connections (Instances), so that they can be watched in your environment #>
Register-Connection -ConnectionType SqlServerAnalysisServices -Name server.domain.com Register-Connection -ConnectionType SqlServer -Name server.domain.com 

Watch a Windows Target

<# Watch Windows Computer (Target) with Performance Analysis and Event Calendar | -Pipe in the Computer #>
Get-Computer -Name server.domain.com -NamedServerComputerType Windows | Invoke-WatchComputer 

Watch a Hyper-V Host Target

<# Watch Hyper-V Host (Target) with Performance Analysis and Event Calendar (core-based licensing) | -Pipe in the Computer #>
Get-Computer -Name server.domain.com -NamedServerComputerType Windows | Invoke-WatchComputer -LicenseMode CoreBased 

Watch a SQL Server Target

<# Watch SQLServer Connection (Instance) with Performance Analysis and Event Calendar | -Pipe in the Connection #>
Get-Connection -Name server.domain.com -NamedServerConnectionType SqlServer | Invoke-WatchConnection 

Watch a SSAS Target

<# Watch SSAS Connection (Instance) with Performance Analysis and Event Calendar | -Pipe in the Connection #>
Get-Connection -Name server.domain.com -NamedServerConnectionType SqlServerAnalysisServices | Invoke-WatchConnection 

Unwatch Target

<# Unwatch Windows computer (Target) #>
Get-Computer -Name server.domain.com -NamedServerComputerType Windows | Invoke-UnwatchComputer

Unwatch SSAS Connection

<# Unwatch SSAS connection #>
Get-Connection -Name server.domain.com -NamedServerConnectionType SqlServerAnalysisServices | Invoke-UnwatchConnection

Unwatch SQL Server Connection

<# Unwatch SQLServer connection #>
Get-Connection -Name server.domain.com -NamedServerConnectionType SqlServer| Invoke-UnwatchConnection

User cmdlets

<# User cmdlets #>
 Register-User -FirstName Test -LastName user -Email tuser@test.net -PagerAddress tuser@testPager.net -Description Tester -Login domain\username Get-User -FirstName Test Get-User -Name "Test User" Disable-User -Name "Test User" Enable-User -Name "Test User" Unregister-User -Name "Test User"

Group cmdlets

<# Group cmdlets #>
Register-Group -Name "Test Group" -Description "A Group" -Login Domain\TestGroup Get-Group -Name "Test Group" Disable-Group -Name "Test Group" Enable-Group -Name "Test Group" Unregister-Group -Name "Test Group"

User and Group cmdlets

 <# User = and - to the Group cmdlets #>
Get-User -Name "Test User" | Add-GroupUser -GroupName "Test Group" Get-User -Name "Test User" | Remove-GroupUser -GroupName "Test Group"

Watch all targets listed in text file

<#Change this to match the name of the server housing the SentryOne database and the name of the SentryOne database #>
Connect-SQLSentry -ServerName servername -DatabaseName SentryOne

<#Change this to match the name of the text file that includes all the names of all the servers you want to watch #>
$Servers = Get-Content C:\Powershell\TestWatch.txt

Foreach ($Server in $Servers)
{
    Register-Connection -ConnectionType SqlServer -Name $Server
    Get-Connection -Name $Server -NamedServerConnectionType SqlServer| Invoke-WatchConnection
}

Watch all targets listed in text file (Azure)

<#Specify the server housing the SentryOne database and the name of the SentryOne database #>
Connect-SQLSentry -ServerName sqlserver -DatabaseName SentryOne

<#Change this to match the Site into which you are adding the targets #>
$Site= Get-Site -Name DefaultSite

<#Change this to match the name of the text file that includes all the names of the Azure SQL Database targets you want to watch #>
$Servers = Get-Content C:\Powershell\TestWatch.txt

<#Change this to match the name of the text file that includes all the names of Azure SQL Database databases #> 
$DatabaseName = Get-Content C:\Powershell\Databases.txt

<#Username: change this to match the name of the Azure SQL Database login #>
$user= "login"

<#Password: change this to match the name of the Azure SQL Database password #>
$pass= "pass"

Foreach ($Server in $Servers)
{
Register-Computer -ComputerType AzureSqlDatabase -Name $Servers -DatabaseName $DatabaseName -Login $user -Password $pass -AccessLevel Full -UseIntegratedSecurity 0 -TargetSite $Site| Invoke-WatchComputer
}