TopologyManager Class

The TopologyManager class represents the top-level class for configuring and managing the topology of a server farm.

System.Object

Microsoft.SharePoint.Portal.Topology.TopologyManager

Public Constructors

The following table shows the constructors of the TopologyManager class and a brief description of each.

Name Description
TopologyManager Initializes a new instance of the TopologyManager class.
TopologyManager Initializes a new instance of the TopologyManager class based on the specified Server and Database objects.
TopologyManager Initializes a new instance of the TopologyManager class based on the specified ConfigurationDatabase.

Public Methods

The following table shows the public methods of the TopologyManager class and a brief description of each.

Name Description
Create(String, String) Creates the topology of a server farm using the specified database as the configuration database.
GetClassification Returns the classification of the topology.
Join Adds the Server object that represents the local server computer to the topology of the server farm.
Open Returns a TopologyManager object from the default configuration database.
Open(Microsoft.SharePoint.Portal.Topology.ConfigurationDatabase) Returns a TopologyManager object from the specified configuration database.
Open(String, String) Returns a TopologyManager object from the specified configuration database.
Services(System.Guid) Returns the collection of Service objects from the topology of the server farm.
Unjoin Removes the Server object that represents the local server computer from the topology of the server farm.

Public Properties

The following table shows the properties of the TopologyManager class, the data type of each property, and a brief description of each.

Name Data type Description
AlertsServices Microsoft.SharePoint.Portal.Topology.AlertsServiceCollection Gets the collection of AlertService objects in the topology of the server farm.
ConfigurationDatabase Microsoft.SharePoint.Portal.Topology.ConfigurationDatabase Gets the configuration database in the topology of the server farm.
DatabaseServices Microsoft.SharePoint.Portal.Topology.DatabaseServiceCollection Gets the collection of DatabaseService objects in the topology of the server farm.
Databases Microsoft.SharePoint.Portal.Topology.DatabaseCollection Gets the collection of content databases in the topology of the server farm.
DefaultApplicationPoolName String Gets or sets the name of the default application pool in Microsoft Internet Information Services (IIS).
DefaultConfigurationDatabase Property Microsoft.SharePoint.Portal.Topology.ConfigurationDatabase Gets the default ConfigurationDatabase object.
DefaultSqlConnectionString Property Microsoft.SharePoint.Portal.Topology.SqlConnectionString Gets the default database connection string. Reserved for internal use only.
DocumentServices Microsoft.SharePoint.Portal.Topology.DocumentServiceCollection Gets the collection of DocumentService objects in the topology of the server farm.
DocumentWorkspaces Microsoft.SharePoint.Portal.Topology.DocumentWorkspaceCollection Gets the collection of DocumentWorkspace objects in the topology of the server farm.
GlobalProperties Microsoft.SharePoint.Portal.Topology.GlobalProperties Gets the collection of GlobalProperties objects for Microsoft Office SharePoint Portal Server that apply across the server farm.
Globals Microsoft.SharePoint.Portal.Topology.Globals Gets the collection of Globals objects for Windows SharePoint Services that apply across the server farm.
IndexServices Microsoft.SharePoint.Portal.Topology.IndexServiceCollection Gets the collection of IndexService objects in the topology of the server farm.
IsJoined Boolean Gets a value that indicates whether the local server is part of an existing topology.
IsStandalone System.Boolean Gets a value that indicates whether the topology is a single server deployment.
IsSupportedTopology System.Boolean Gets a value that indicates whether the topology configuration is supported. Reserved for internal use only.
Lock Microsoft.SharePoint.Portal.Topology.TopologyLock Gets the temporary lock to use for operations performed by the Topology namespace.
PortalSites Microsoft.SharePoint.Portal.Topology.PortalSiteCollection Gets the collection of PortalSite objects in the topology of the server farm.
PortalUrls Microsoft.SharePoint.Portal.Topology.PortalUrlCollection Gets the collection of PortalURL objects in the topology of the server farm.
RequireSupportedTopology System.Boolean Gets a value that indicates whether a supported topology must result from any configuration changes. Reserved for internal use only.
SearchServices Microsoft.SharePoint.Portal.Topology.SearchServiceCollection Gets the collection of SearchService objects in the topology of the server farm.
ServerId System.Guid Gets the ID of the local server computer.
Servers Microsoft.SharePoint.Portal.Topology.ServerCollection Gets the collection of Server objects that represent server computers in the topology of the server farm.
SmtpServices Microsoft.SharePoint.Portal.Topology.SmtpServiceCollection Gets the collection of SmtpService objects in the topology of the server farm.
TeamSites Microsoft.SharePoint.Portal.Topology.TeamSiteCollection Gets the collection of TeamSite objects in the topology of the server farm.
TeamWebServices Microsoft.SharePoint.Portal.Topology.TeamWebServiceCollection Gets the collection of TeamWebService objects in the topology of the server farm.
TemplatePath System.String Gets the path to site definitions that apply to the topology of the server farm.
VirtualServers Microsoft.SharePoint.Portal.Topology.VirtualServerCollection Gets the collection of VirtualServer objects in the topology of the server farm.
WebServices Microsoft.SharePoint.Portal.Topology.WebServiceCollection Gets the collection of WebService objects in the topology of the server farm.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.

Remarks

To use the properties and methods of the objects in the Topology namespace you must be a member of the local STS_WPG and SPS_WPG security groups, and a member of the db_owner database role for the configuration database.

In addition, for certain methods, such as those that create a portal site, you must be a member of the local Administrators group, and have membership in the Database Creators and Security Administrators server roles in the SQL Server instance that hosts the configuration database.

Requirements

Namespace: Microsoft.SharePoint.Portal.Topology

Platforms: Microsoft Windows Server 2003

Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Security: Code Access Security