SPFarm members

Represents a Microsoft SharePoint Foundation farm.

The SPFarm type exposes the following members.

Constructors

	Name	Description
	SPFarm	Reserved for internal use only.

Top

Properties

	Name	Description
	AlternateUrlCollections	Gets the collection of alternate URL objects in the farm.
	BuildVersion	Gets the Microsoft SharePoint Foundation build version of the server farm.
	CanBackupRestoreAsConfiguration	Gets a value that indicates whether the farm object can be selected for inclusion in a configuration-only backup or restore operation.
	CanMigrate	Obsolete. Gets a Boolean value that indicates whether a server farm can be migrated from a Windows SharePoint Services 2.0 farm with which it is paired.
	CanRenameOnRestore	Gets a Boolean value that indicates whether the server farm can be renamed when it is restored.
	CanSelectForBackup	Gets or sets a Boolean value that specifies whether the server farm can be selected for backup in the Central Administration user interface.
	CanSelectForRestore	Gets or sets a Boolean value that specifies whether the server farm can be selected for restore operations in the Central Administration user interface.
	CanUpgrade	Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
	CEIPEnabled	Obsolete. Gets or sets a Boolean value that specifies whether Software Quality Metrics (SQM) data collection is enabled in the server farm to improve customer experience.
	DaysBeforePasswordExpirationToSendEmail	Number of days before password expiration to send email warning Used by the automatic password change feature.
	DefaultServiceAccount	Gets the default service process account.
	DeploymentLocked	(Inherited from SPPersistedObject.)
	DiagnosticsProviders	The diagnostics providers in the local farm
	DiskSizeRequired	Gets the amount of disk space that is required for a backup.
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	DownloadErrorReportingUpdates	Obsolete. Gets or sets a Boolean value that specifies whether to download updates for an application that performs crash data collection and error reporting within the server farm.
	EncodedFarmId	An uint id to identify the farm
	ErrorReportingAutomaticUpload	Obsolete. Gets or sets a Boolean value that specifies whether to trigger automatic upload of crash data collection and error reporting in the server farm.
	ErrorReportingEnabled	Obsolete. Gets or sets a Boolean value that specifies whether to enable an application that performs crash data collection and error reporting in the server farm.
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	FeatureDefinitions	Gets the collection of Feature definitions that are available in the server farm.
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	InitializationSettings
	IsBackwardsCompatible	Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
	IsPaired	Obsolete. Gets or sets a Boolean value that specifies whether the server farm is paired to a Windows SharePoint Services 2.0 farm.
	IsSPO
	Joined	Gets a Boolean value that indicates whether the local server has been joined to a server farm.
	Local	Gets an object that represents the local server farm.
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	NeedsUpgrade	Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
	NeedsUpgradeIncludeChildren	Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
	PairConnectionString	Obsolete. Gets or sets the connection string to the Windows SharePoint Services 2.0 server farm with which this farm is paired.
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	PasswordChangeEmailAddress	Email address to which to send password change notifcations Used by the automatic password change feature.
	PasswordChangeGuardTime	Number of seconds to wait to allow other machines to finish responding to password change events. Used by the automatic password change feature.
	PasswordChangeMaximumTries	Number of times to try changing the password before failing. Used by the automatic password change feature.
	PersistedFileChunkSize	Gets or sets the number of bytes to retrieve from or send to the configuration database during a read/write operation when transferring files.
	Products	Gets or sets a collection of IDs of products installed in this farm.
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	ServerDebugFlags	Server debug flags that can be added or removed to change the way certain operations or features work. The existence and behavior of these flags is not guaranteed in future versions of the product. Documentation in KBs and tech articles will provide instructions and details for usage.
	Servers	Gets the collection of all physical computers that are in the local server farm.
	ServiceApplicationProxyGroups	Gets a collection of service proxies in the server farm.
	ServiceProxies	Gets a collection of service proxies from this farm.
	Services	Gets the collection of all services that are in the server farm.
	ShouldDeferUpgradeActions	(Inherited from SPPersistedUpgradableObject.)
	SiteSubscriptions	Gets a collection of site subscriptions from this farm
	Solutions	Gets the collection of all solutions that are in the server farm.
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	TimerService	Gets the timer service that is associated with the server farm.
	TraceSessionGuid	Gets the static GUID that is used to register a trace session.
	TypeName	Gets the display name that is used to describe the object type in the Central Administration user interface. (Overrides SPPersistedObject.TypeName.)
	UpgradeContext	Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	UseMinWidthForHtmlPicker	Gets or sets the HTML select control.
	UserLicensingEnabled	Gets or sets whether per-user licensing is enabled.
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
	XsltTransformTimeOut	Specifies the seconds that a customized XSLT transformation is allowed to run.

Top

Methods

	Name	Description
	AddBackupObjects	Adds the server farm and its children to the backup/restore operation.
	AddSPPersistedChildren	014 bug 291541 - Added this specific method. Generic SPBackupRestoreObject.AddSPPersistedChildren is avoided to support specific logic to SPFarm
	Clone	Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
	Create(SqlConnectionStringBuilder)	Creates a server farm, its associated configuration database, and a farm account on the local computer.
	Create(String)	Creates a server farm, its associated configuration database, and a farm account on the local computer.
	Create(SqlConnectionStringBuilder, String, SecureString)	Obsolete. Creates a server farm and its associated configuration database, based on the specified user and password. This method is obsolete. Use the Create() method that takes a passphrase.
	Create(SqlConnectionStringBuilder, String, String)	Obsolete. Creates a server farm and its associated configuration database, based on the specified user and password.
	Create(SqlConnectionStringBuilder, SqlConnectionStringBuilder, String, SecureString)	Obsolete. Creates a server farm and its associated configuration database based on the specified content database, user, and password.
	Create(SqlConnectionStringBuilder, String, SecureString, SecureString)	Creates a server farm and its associated configuration database, based on the specified user and password.
	Create(SqlConnectionStringBuilder, SqlConnectionStringBuilder, String, SecureString, SecureString)	Creates a server farm and its associated configuration database, based on the specified user and password.
	CurrentUserIsAdministrator()	Returns a Boolean value that indicates whether the current user is an administrator in the server farm.
	CurrentUserIsAdministrator(Boolean)	Returns a Boolean value that indicates whether the current user is an administrator in the server farm.
	Delete	Deletes the object. (Inherited from SPPersistedObject.)
	DisableCaching	Disables the file system and in-memory caches of configuration objects in the server farm.
	EnableCaching	Enables the file system and in-memory caches of configuration objects in the server farm.
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetFeatureDefinitionsByVersion	Get the feature definition collection for the specified compatibility level.
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetObject(Guid)	Returns the specified object based on its associated GUID.
	GetObject(String, Guid, Type)	Returns the specified object based on its associated name, GUID, and type.
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetPersistedFeatureDefinition(Guid, Int32)	Returns the [T:HYPERLINK"https://msdn2.microsoft.com/EN-US/library/ms472446"\t"_blank"Microsoft.SharePoint.Administration.SPFeatureDefinition] object for the given compatibility level based on the featureId parameter value. If the [T:HYPERLINK"https://msdn2.microsoft.com/EN-US/library/ms472446"\t"_blank"Microsoft.SharePoint.Administration.SPFeatureDefinition] object is not found for the specified compatibilityLevel, a null reference (Nothing in Visual Basic) is returned.
	GetPersistedFeatureDefinition(Guid, Int32, Boolean)	Returns the [T:HYPERLINK"https://msdn2.microsoft.com/EN-US/library/ms472446"\t"_blank"Microsoft.SharePoint.Administration.SPFeatureDefinition] object for the given compatibilityLevel and featureId values. If the fallback parameter value is true and a match cannot be found for the given compatibilityLevel and featureId values, the method will attempt to return a [T:HYPERLINK"https://msdn2.microsoft.com/EN-US/library/ms472446"\t"_blank"Microsoft.SharePoint.Administration.SPFeatureDefinition] object with a lower compatibilityLevel value. If a corresponding [T:HYPERLINK"https://msdn2.microsoft.com/EN-US/library/ms472446"\t"_blank"Microsoft.SharePoint.Administration.SPFeatureDefinition] object cannot be found with the given featureId using either the given compatibilityLevel or an earlier (fallback) build version, a null reference (Nothing in Visual Basic) is returned.
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	Invalidate	Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
	Join()	Adds the local computer to the server farm.
	Join(Boolean, Nullable<SPServerRole>)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	Migrate()	Obsolete. Migrates settings from the Windows SharePoint Services 2.0 server farm with which this farm is paired.
	Migrate(Boolean)	Obsolete. Migrates settings from a Windows SharePoint Services 2.0 server farm with which this farm is paired, with the option of including all children.
	MigrateGroup	Similar to MigrateUserAccount, except for groups
	MigrateUserAccount(String, String, Boolean)	Migrates a user account in SharePoint Foundation to a new login name and binary ID.
	MigrateUserAccount(Guid, String, String, Boolean)	Migrates a user account in SharePoint Foundation to a new login name and binary ID.
	OnAbort	Raises the Abort (backup) event.
	OnBackup	Raises the Backup event.
	OnBackupComplete	Raises the BackupComplete event.
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPostFarmJoin
	OnPostRestore	Raises the PostRestore event.
	OnPreCreate	(Overrides SPPersistedObject.OnPreCreate().)
	OnPreFarmJoin
	OnPrepareBackup	Raises the PrepareBackup event.
	OnPreRestore	Raises the PreRestore event.
	OnRestore	Raises the Restore event.
	Open(String)	Returns an object that represents a remote server farm based on the specified connection string.
	Open(SqlConnectionStringBuilder, SecureString)	Returns an object representing a remote server SPFarm object based on the specified connection string.
	Open(SqlConnectionStringBuilder, String, SecureString)	Obsolete. Obsolete. Use the Open() method that takes a passphrase. Returns an object representing a remote SPFarm.
	Open(SqlConnectionStringBuilder, String, String)	Obsolete. Returns a remote server farm based on the specified connection string, user name, and password. Obsolete. Use the Open() method that takes a passphrase.
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	RemoveObsoleteClass	Removes all references to an obsolete class. This includes base classes and child objects from the configuration database.
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unjoin	Removes the local server from the farm.
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	Update()	Obsolete. (Overrides SPPersistedObject.Update().)
	Update(Boolean)	Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	UpdateServerDebugFlags	Used after setting a value in ServerDebugFlags to trigger the operation or activate the feature behind it. The existence and behavior of this method is not guaranteed in future versions of the product. Documentation in KBs and tech articles will provide instructions and details for usage.
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Upgrade()	Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
	Upgrade(Boolean)	Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
	Validate	Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
	ValidateBackwardsCompatibility	Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)

Top

Events

	Name	Description
	ObjectChanged	Raised after any configuration object in the system that is above the level of a site collection (SPSite) is changed. This event is raised on all computers in the server farm after the caches have been refreshed, but it is not raised if caching is disabled for the process.
	ObjectCreated	Raised after any configuration object in the system above the level of a site collection (SPSite) is created. This event is raised on all computers in the server farm after the caches have been refreshed, but it is not raised if caching is disabled for the process.
	ObjectDeleted	Raised after any configuration object in the system above the level of a site collection (SPSite) is deleted. This event is raised on all computers in the server farm after the caches have been refreshed, but it is not raised if caching is disabled for the process.
	ObjectsRestored	Raised after any configuration object in the system above the level of a site collection (SPSite) is restored. This event is raised on all computers in the server farm after the caches have been refreshed, but it is not raised if caching is disabled for the process.

Top

See also

Reference

SPFarm class

Microsoft.SharePoint.Administration namespace