Get-SPService

  • Reference
Module:
SharePointServer
Applies to:
SharePoint Server 2016, SharePoint Server 2019

Gets a service in the farm.

Syntax

Get-SPService
   [[-Identity] <SPServicePipeBind>]
   [-All]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

The Get-SPService cmdlet gets a service in the farm.

Examples

Example 1

Get-SPService -Identity 'Microsoft SharePoint Server Diagnostics Service'

This example gets the Microsoft SharePoint Server Diagnostics Service in the farm.

Parameters

-All

Specifies all services in the farm.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2016, SharePoint Server 2019

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2016, SharePoint Server 2019

-Identity

Specifies the name of the service to get.

Type:SPServicePipeBind
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2016, SharePoint Server 2019

Inputs

Microsoft.SharePoint.PowerShell.SPServicePipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object