functions/Get-DbaService.ps1
|
function Get-DbaService { <# .SYNOPSIS Gets the SQL Server related services on a computer. .DESCRIPTION Gets the SQL Server related services on one or more computers. Requires Local Admin rights on destination computer(s). .PARAMETER ComputerName The target SQL Server instance or instances. .PARAMETER InstanceName Only returns services that belong to the specific instances. .PARAMETER Credential Credential object used to connect to the computer as a different user. .PARAMETER Type Use -Type to collect only services of the desired SqlServiceType. Can be one of the following: "Agent", "Browser", "Engine", "FullText", "SSAS", "SSIS", "SSRS", "PolyBase", "Launchpad" .PARAMETER ServiceName Can be used to specify service names explicitly, without looking for service types/instances. .PARAMETER AdvancedProperties Collect additional properties from the SqlServiceAdvancedProperty Namespace This collects information about Version, Service Pack Level", SkuName, Clustered status and the Cluster Service Name This adds additional overhead to the command. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: Service, SqlServer, Instance, Connect Author: Klaas Vandenberghe ( @PowerDBAKlaas ) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Get-DbaService .EXAMPLE PS C:\> Get-DbaService -ComputerName sqlserver2014a Gets the SQL Server related services on computer sqlserver2014a. .EXAMPLE PS C:\> 'sql1','sql2','sql3' | Get-DbaService -AdvancedProperties Gets the SQL Server related services on computers sql1, sql2 and sql3. Includes Advanced Properties from the SqlServiceAdvancedProperty Namespace .EXAMPLE PS C:\> $cred = Get-Credential WindowsUser PS C:\> Get-DbaService -ComputerName sql1,sql2 -Credential $cred | Out-GridView Gets the SQL Server related services on computers sql1 and sql2 via the user WindowsUser, and shows them in a grid view. .EXAMPLE PS C:\> Get-DbaService -ComputerName sql1,sql2 -InstanceName MSSQLSERVER Gets the SQL Server related services related to the default instance MSSQLSERVER on computers sql1 and sql2. .EXAMPLE PS C:\> Get-DbaService -ComputerName $MyServers -Type SSRS Gets the SQL Server related services of type "SSRS" (Reporting Services) on computers in the variable MyServers. .EXAMPLE PS C:\> $MyServers = Get-Content .\servers.txt PS C:\> Get-DbaService -ComputerName $MyServers -ServiceName MSSQLSERVER,SQLSERVERAGENT Gets the SQL Server related services with ServiceName MSSQLSERVER or SQLSERVERAGENT for all the servers that are stored in the file. Every line in the file can only contain one hostname for a server. .EXAMPLE PS C:\> $services = Get-DbaService -ComputerName sql1 -Type Agent,Engine PS C:\> $services.ChangeStartMode('Manual') Gets the SQL Server related services of types Sql Agent and DB Engine on computer sql1 and changes their startup mode to 'Manual'. .EXAMPLE PS C:\> (Get-DbaService -ComputerName sql1 -Type Engine).Restart($true) Calls a Restart method for each Engine service on computer sql1. #> [CmdletBinding(DefaultParameterSetName = "Search")] param ( [parameter(ValueFromPipeline, Position = 1)] [Alias("cn", "host", "Server")] [DbaInstanceParameter[]]$ComputerName = $env:COMPUTERNAME, [Parameter(ParameterSetName = "Search")] [Alias("Instance")] [string[]]$InstanceName, [PSCredential]$Credential, [Parameter(ParameterSetName = "Search")] [ValidateSet("Agent", "Browser", "Engine", "FullText", "SSAS", "SSIS", "SSRS", "PolyBase", "Launchpad")] [string[]]$Type, [Parameter(ParameterSetName = "ServiceName")] [string[]]$ServiceName, [switch]$AdvancedProperties, [switch]$EnableException ) begin { #Dictionary to transform service type IDs into the names from Microsoft.SqlServer.Management.Smo.Wmi.ManagedComputer.Services.Type $ServiceIdMap = @( @{ Name = "Engine"; Id = 1 }, @{ Name = "Agent"; Id = 2 }, @{ Name = "FullText"; Id = 3, 9 }, @{ Name = "SSIS"; Id = 4 }, @{ Name = "SSAS"; Id = 5 }, @{ Name = "SSRS"; Id = 6 }, @{ Name = "Browser"; Id = 7 }, @{ Name = "PolyBase"; Id = 10, 11 }, @{ Name = "Launchpad"; Id = 12 }, @{ Name = "Unknown"; Id = 8 } ) if ($PsCmdlet.ParameterSetName -match 'Search') { if ($Type) { $searchClause = "" foreach ($itemType in $Type) { foreach ($id in ($ServiceIdMap | Where-Object { $_.Name -eq $itemType }).Id) { if ($searchClause) { $searchClause += ' OR ' } $searchClause += "SQLServiceType = $id" } } } else { $searchClause = "SQLServiceType > 0" } } elseif ($PsCmdlet.ParameterSetName -match 'ServiceName') { if ($ServiceName) { $searchClause = "" foreach ($sn in $ServiceName) { if ($searchClause) { $searchClause += ' OR ' } $searchClause += "ServiceName = '$sn'" } } else { $searchClause = "SQLServiceType > 0" } } } process { foreach ($Computer in $ComputerName.ComputerName) { $Server = Resolve-DbaNetworkName -ComputerName $Computer -Credential $credential if ($Server.FullComputerName) { $Computer = $server.FullComputerName $services = @() $outputServices = @() if (!$Type -or 'SSRS' -in $Type) { Write-Message -Level Verbose -Message "Getting SQL Reporting Server services on $Computer" -Target $Computer $reportingServices = Get-DbaReportingService -ComputerName $Computer -InstanceName $InstanceName -Credential $Credential -ServiceName $ServiceName $outputServices += $reportingServices } Write-Message -Level Verbose -Message "Getting SQL Server namespaces on $Computer" -Target $Computer try { $namespaces = Get-DbaCmObject -ComputerName $Computer -Namespace root\Microsoft\SQLServer -Query "Select Name FROM __NAMESPACE WHERE Name Like 'ComputerManagement%'" -EnableException -Credential $credential | Sort-Object Name -Descending } catch { Write-Message -Level Verbose -Message "Failed to get SQL Server namespaces on $Computer." -Target $Computer -ErrorRecord $_ } if ($namespaces) { Write-Message -Level Verbose -Message "The following namespaces have been found: $($namespaces.Name -join ', ')." ForEach ($namespace in $namespaces) { try { Write-Message -Level Verbose -Message "Getting Cim class SqlService in Namespace $($namespace.Name) on $Computer." -Target $Computer foreach ($service in (Get-DbaCmObject -ComputerName $Computer -Namespace "root\Microsoft\SQLServer\$($namespace.Name)" -Query "SELECT * FROM SqlService WHERE $searchClause" -EnableException -Credential $credential)) { Write-Message -Level Verbose -Message "Found service $($service.ServiceName) in namespace $($namespace.Name)." $services += $service } # Use highest namespace available, so break if services have been found break } catch { Write-Message -Level Verbose -Message "Failed to acquire services from namespace $($namespace.Name)." -Target $Computer -ErrorRecord $_ } } } #remove services returned by the SSRS namespace $services = $services | Where-Object ServiceName -NotIn $reportingServices.ServiceName #Add custom properties and methods to the service objects ForEach ($service in $services) { Add-Member -Force -InputObject $service -MemberType NoteProperty -Name ComputerName -Value $service.HostName Add-Member -Force -InputObject $service -MemberType NoteProperty -Name ServiceType -Value ($ServiceIdMap | Where-Object { $_.Id -contains $service.SQLServiceType }).Name Add-Member -Force -InputObject $service -MemberType NoteProperty -Name State -Value $(switch ($service.State) { 1 { 'Stopped' } 2 { 'Start Pending' } 3 { 'Stop Pending' } 4 { 'Running' } }) Add-Member -Force -InputObject $service -MemberType NoteProperty -Name StartMode -Value $(switch ($service.StartMode) { 1 { 'Unknown' } 2 { 'Automatic' } 3 { 'Manual' } 4 { 'Disabled' } }) if ($service.ServiceName -in ("MSSQLSERVER", "SQLSERVERAGENT", "ReportServer", "MSSQLServerOLAPService", "MSSQLFDLauncher", "SQLPBDMS", "SQLPBENGINE", "MSSQLLAUNCHPAD")) { $instance = "MSSQLSERVER" } else { if ($service.ServiceType -in @("Agent", "Engine", "SSRS", "SSAS", "FullText", "PolyBase", "Launchpad")) { if ($service.ServiceName.indexof('$') -ge 0) { $instance = $service.ServiceName.split('$')[1] } else { $instance = "Unknown" } } else { $instance = "" } } $priority = switch ($service.ServiceType) { "Engine" { 200 } default { 100 } } #If only specific instances are selected if (!$InstanceName -or $instance -in $InstanceName) { #Add other properties and methods Add-Member -Force -InputObject $service -NotePropertyName InstanceName -NotePropertyValue $instance Add-Member -Force -InputObject $service -NotePropertyName ServicePriority -NotePropertyValue $priority Add-Member -Force -InputObject $service -MemberType ScriptMethod -Name "Stop" -Value { param ([bool]$Force = $false) Stop-DbaService -InputObject $this -Force:$Force } Add-Member -Force -InputObject $service -MemberType ScriptMethod -Name "Start" -Value { Start-DbaService -InputObject $this } Add-Member -Force -InputObject $service -MemberType ScriptMethod -Name "Restart" -Value { param ([bool]$Force = $false) Restart-DbaService -InputObject $this -Force:$Force } Add-Member -Force -InputObject $service -MemberType ScriptMethod -Name "ChangeStartMode" -Value { param ( [parameter(Mandatory)] [string]$Mode ) $supportedModes = @("Automatic", "Manual", "Disabled") if ($Mode -notin $supportedModes) { Stop-Function -Message ("Incorrect mode '$Mode'. Use one of the following values: {0}" -f ($supportedModes -join ' | ')) -EnableException $false -FunctionName 'Get-DbaService' Return } Set-ServiceStartMode -InputObject $this -Mode $Mode -ErrorAction Stop $this.StartMode = $Mode } if ($AdvancedProperties) { $namespaceValue = $service.CimClass.ToString().ToUpper().Replace(":SQLSERVICE", "").Replace("ROOT/MICROSOFT/SQLSERVER/", "") $serviceAdvancedProperties = Get-DbaCmObject -ComputerName $Computer -Namespace "root\Microsoft\SQLServer\$($namespaceValue)" -Query "SELECT * FROM SqlServiceAdvancedProperty WHERE ServiceName = '$($service.ServiceName)'" Add-Member -Force -InputObject $service -MemberType NoteProperty -Name Version -Value ($serviceAdvancedProperties | Where-Object PropertyName -eq 'VERSION' ).PropertyStrValue Add-Member -Force -InputObject $service -MemberType NoteProperty -Name SPLevel -Value ($serviceAdvancedProperties | Where-Object PropertyName -eq 'SPLEVEL' ).PropertyNumValue Add-Member -Force -InputObject $service -MemberType NoteProperty -Name SkuName -Value ($serviceAdvancedProperties | Where-Object PropertyName -eq 'SKUNAME' ).PropertyStrValue $ClusterServiceTypeList = @(1, 2, 5, 7) if ($ClusterServiceTypeList -contains $service.SQLServiceType) { Add-Member -Force -InputObject $service -MemberType NoteProperty -Name Clustered -Value ($serviceAdvancedProperties | Where-Object PropertyName -eq 'CLUSTERED' ).PropertyNumValue Add-Member -Force -InputObject $service -MemberType NoteProperty -Name VSName -Value ($serviceAdvancedProperties | Where-Object PropertyName -eq 'VSNAME' ).PropertyStrValue } else { Add-Member -Force -InputObject $service -MemberType NoteProperty -Name Clustered -Value '' Add-Member -Force -InputObject $service -MemberType NoteProperty -Name VSName -Value '' } } $outputServices += $service } } if ($AdvancedProperties) { $defaults = "ComputerName", "ServiceName", "ServiceType", "InstanceName", "DisplayName", "StartName", "State", "StartMode", "Version", "SPLevel", "SkuName", "Clustered", "VSName" } else { $defaults = "ComputerName", "ServiceName", "ServiceType", "InstanceName", "DisplayName", "StartName", "State", "StartMode" } if ($outputServices) { $outputServices | Select-DefaultView -Property $defaults -TypeName DbaSqlService } else { Stop-Function -Message "No services found in relevant namespaces on $Computer. Please note that this function is available from SQL 2005 up." } } else { Stop-Function -EnableException $EnableException -Message "Failed to connect to $Computer" -Continue } } } } |