Skip to content

Commit e5f48fd

Browse files
authored
Update Stop-SPService.md
updated missing text during the migration
1 parent a94a5f7 commit e5f48fd

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

sharepoint/sharepoint-ps/sharepoint-server/Stop-SPService.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Stop-SPService
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Disables a service in the farm.
1212

1313
## SYNTAX
1414

@@ -18,22 +18,26 @@ Stop-SPService [-Identity] <SPServicePipeBind> [-AssignmentCollection <SPAssignm
1818
```
1919

2020
## DESCRIPTION
21-
{{Fill in the Description}}
21+
The Stop-SPService cmdlet disables a service in the farm. Service instances for this service will be stopped on the appropriate servers in the farm.
22+
23+
**Note**: This cmdlet only controls service instances on servers that are managed by MinRole. The behavior for the Custom server role has changed with the November 2016 Public Update (PU). Please see the **IncludeCustomServerRole** parameter for additional information.
2224

2325
## EXAMPLES
2426

2527
### ---------------EXAMPLE--------------
2628
```
27-
PS C:\> {{ Add example code here }}
29+
Stop-SPService -Identity "Microsoft SharePoint Foundation Sandboxed Code Service"
2830
```
2931

30-
{{ Add example description here }}
32+
This example disables the Microsoft SharePoint Foundation Sandboxed Code Service in the farm.
3133

3234

3335
## PARAMETERS
3436

3537
### -AssignmentCollection
36-
{{Fill AssignmentCollection Description}}
38+
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.
39+
40+
**Note**: 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.
3741

3842
```yaml
3943
Type: SPAssignmentCollection
@@ -65,7 +69,7 @@ Accept wildcard characters: False
6569
```
6670
6771
### -Identity
68-
{{Fill Identity Description}}
72+
Specifies the name of the service to disable.
6973
7074
```yaml
7175
Type: SPServicePipeBind
@@ -81,7 +85,8 @@ Accept wildcard characters: False
8185
```
8286
8387
### -IncludeCustomServerRole
84-
{{Fill IncludeCustomServerRole Description}}
88+
Creates a timer job that also stops service instances on servers that are assigned to the custom server role.
89+
**Note**: This is a one-time Timer job. MinRole will make no further attempts to manage the service instances on servers assigned to the Custom server role.
8590
8691
```yaml
8792
Type: SwitchParameter

0 commit comments

Comments
 (0)