SPFarm properties
The SPFarm type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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. |
.gif "Static member") |
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.) |
.gif "Protected property") |
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