Skip to content

Commit aa8bf9f

Browse files
authored
Merge pull request MicrosoftDocs#635 from tseward/patch-322
Update Set-SPFarmConfig.md
2 parents 76a4642 + 238f5d4 commit aa8bf9f

File tree

1 file changed

+17
-24
lines changed

1 file changed

+17
-24
lines changed

sharepoint/sharepoint-ps/sharepoint-server/Set-SPFarmConfig.md

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -39,29 +39,17 @@ For permissions and the most current information about Windows PowerShell for Sh
3939

4040
### ---------------------EXAMPLE--------------------------
4141
```
42-
C:\PS>$a = Get-SPFarmConfig
43-
44-
C:\PS>$a.AjaxTimeout = 200
45-
46-
C:\PS>$a | Set-SPFarmConfig
42+
PS C:\>Set-SPFarmConfig -WorkflowBatchSize 50
4743
```
4844

49-
This example uses the `Get-SPFarmConfig` cmdlet to add the Ajax Timeout setting to the PSCustomObject object, sets the value for Ajax Timeout and then passes PSCustomObject to the `Set-SPFarmConfig` cmdlet to change the Ajax Timeout setting.
50-
Ajax Timeout, a farm-wide setting, is a member of the SPWebService object and cannot be accessed by using a Windows PowerShell cmdlet.
51-
52-
You can perform the same operations with either of the following commands.
53-
45+
This example sets the WorkflowBatdhSize to 50.
5446

5547
## PARAMETERS
5648

5749
### -AssignmentCollection
58-
Manages objects for the purpose of proper disposal.
59-
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.
60-
Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory.
61-
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.
50+
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.
6251

63-
When the Global parameter is used, all objects are contained in the global store.
64-
If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur.
52+
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.
6553

6654
```yaml
6755
Type: SPAssignmentCollection
@@ -95,6 +83,7 @@ Accept wildcard characters: False
9583

9684
### -DataFormWebPartAutoRefreshEnabled
9785
Specifies whether any DataFormWebPart on any page in this farm is allowed to periodically refresh its contents asynchronously (after the page has finished rendering).
86+
9887
When set to false, all DataFormWebParts will ignore the automatic refresh interval provided in Web Part properties.
9988

10089
```yaml
@@ -195,6 +184,7 @@ Accept wildcard characters: False
195184

196185
### -WorkflowBatchSize
197186
Specifies the paging size for events delivered to a single workflow instance.
187+
198188
For each request, the events are streamed out 100 at a time.
199189

200190
Batch size is the number of events processed for a single workflow instance, which can have many events queued at the same time.
@@ -215,6 +205,7 @@ Accept wildcard characters: False
215205

216206
### -WorkflowEventDeliveryTimeout
217207
Specifies the time as an integer in which a workflow job must run without the job timing out.
208+
218209
If the workflow job does time out, it gets put back in the queue to be run again.
219210

220211
For example, if the value is set to 5, the workflow job must run within 5 minutes are the workflow job will time out.
@@ -250,7 +241,7 @@ Accept wildcard characters: False
250241
```
251242

252243
### -ASPScriptOptimizationEnabled
253-
{{Fill ASPScriptOptimizationEnabled Description}}
244+
Specifies if ASP Script optimization is enabled. The default value is false (off).
254245

255246
```yaml
256247
Type: Boolean
@@ -266,13 +257,13 @@ Accept wildcard characters: False
266257
```
267258

268259
### -UserAccountDirectoryPathIsImmutable
269-
{{Fill UserAccountDirectoryPathIsImmutable Description}}
260+
Specifies if the `UserAccountDirectoryPath` property on an `SPSite` object is immutable.
270261

271262
```yaml
272263
Type: SwitchParameter
273264
Parameter Sets: (All)
274265
Aliases:
275-
Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
266+
Applicable: SharePoint Server 2013, SharePoint Server 2016
276267
277268
Required: False
278269
Position: Named
@@ -282,7 +273,7 @@ Accept wildcard characters: False
282273
```
283274

284275
### -DefaultActivateOnSiteMasterValue
285-
{{Fill DefaultActivateOnSiteMasterValue Description}}
276+
Specifies whether to activate site master as default.
286277

287278
```yaml
288279
Type: Boolean
@@ -298,7 +289,7 @@ Accept wildcard characters: False
298289
```
299290

300291
### -MaxSiteSubscriptionSettingsValueLength
301-
{{Fill MaxSiteSubscriptionSettingsValueLength Description}}
292+
Sets the maximum size of a SiteSubscription property value.
302293

303294
```yaml
304295
Type: UInt32
@@ -314,7 +305,7 @@ Accept wildcard characters: False
314305
```
315306

316307
### -MaxTenantStoreValueLength
317-
{{Fill MaxTenantStoreValueLength Description}}
308+
Sets the maximum size of a Tenant Store property value.
318309

319310
```yaml
320311
Type: UInt32
@@ -330,7 +321,7 @@ Accept wildcard characters: False
330321
```
331322

332323
### -SiteMasterMode
333-
{{Fill SiteMasterMode Description}}
324+
Specifies if site master mode is turned on or off. The default value is off.
334325

335326
```yaml
336327
Type: SPSiteMasterMode
@@ -346,7 +337,9 @@ Accept wildcard characters: False
346337
```
347338

348339
### -SiteMasterValidationIntervalInHours
349-
{{Fill SiteMasterValidationIntervalInHours Description}}
340+
Determines the length of time, in hours, to validate the Site Master.
341+
342+
The default value is 24.
350343

351344
```yaml
352345
Type: UInt32

0 commit comments

Comments
 (0)