Published: May 12, 2010
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
This example stores the local farm in a variable.
Reference
Get-SPFarmConfig
Set-SPFarmConfig
Backup-SPFarm
Restore-SPFarm
Change History
|
Date
|
Description
|
Reason
|
|
May 12, 2010
|
Initial publication
|
|