1 out of 1 rated this helpful - Rate this topic

Get-SPFarm

SharePoint 2013

SharePoint 2010

Published: July 16, 2012

Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise

Returns the local SharePoint farm.

Get-SPFarm [-AssignmentCollection <SPAssignmentCollection>]

Parameters

Parameter

Required

Type

Description

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

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.

Detailed Description

The Get-SPFarm cmdlet returns the local SharePoint farm. No parameters are used.

Input Types

Return Types

SPFarm

Example

$f = Get-SPFarm

This example stores the local farm in a variable.

Change History

Date	Description
July 16, 2012	Initial publication

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)