SPFarm Methods

Include Protected Members
Include Inherited Members

The SPFarm type exposes the following members.

Methods

	Name	Description
	AddBackupObjects	Adds the server farm and its children to the backup/restore operation.
	AddSPPersistedChildren
	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.)
	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.)
	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.
	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
	MigrateUserAccount	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.)
	OnPostRestore	Raises the PostRestore event.
	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.
	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.)
	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

See Also

Reference

SPFarm Class

Microsoft.SharePoint.Administration Namespace