MSFT_SIPPoolSetting
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Defines an Office Communications Server Enterprise Edition pool or Standard Edition pool.
Some of the property values for the MSFT_SIPPSTNConferencingSetting class map to the settings found on the Forest Status pane in the Office Communications Server 2007 R2 Administration Tool. You can access these values in the Administration Tool by clicking Forest, and then, in the Statuspane, expanding Pool View.
MSFT_SIPPoolSetting
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.
Syntax
class MSFT_SIPPoolSetting
{
string[] Applications;
string[] ApplicationServerList;
string AppPoolType;
string BackEndDBPath;
string DefaultLocationProfile;
string DomainFQDN;
[key] string InstanceID;
uint32 MajorVersion;
string[] MCUFactoryList;
uint32 MinorVersion;
string PoolDisplayName;
string PoolDN;
string PoolFQDN;
string[] PoolMemberList;
string PoolType;
boolean SupportIMPresence;
boolean SupportMeeting;
string TrustedMRASServer;
string TrustedQoSServer;
string[] WebComponentsServerList;
};
Methods
This class does not define any methods.
Properties
The MSFT_SIPPoolSetting class has the following properties.
Applications
Data type: string []Access type: Read-only
Optional. An array of identifiers of applications on the pool.
The value of this property is not case-sensitive.
The Applications property does not map to the Pool View node in the Status pane.
ApplicationServerList
Data type: string []Access type: Read-only
Optional. A list of the fully qualified domain names (FQDNs) of UC Application Servers (UCAS) belonging to an Enterprise Edition pool or Standard Edition pool. In the case of a Standard Edition pool, there will be only one server in the list.
The value of this property is not case-sensitive.
The ApplicationServerList property does not map to the Pool View node in the Status pane.
AppPoolType
Data type: stringAccess type: Read-only
Optional. Specifies the application pool type for Office Communications Server.
Value
Description
None
The Application Server is on the same host computer as the other Server Roles.
This is the default value for AppPoolType.
This is the only type available for this release of Office Communications Server.
AppServerHomePool
This type is currently not supported.
AppServerFEPool
This type is currently not supported.
The AppPoolType property does not map to the Pool View node in the Status pane.
BackEndDBPath
Data type: stringAccess type: Read-only
Required. This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.
The value generated as part of the creation of a pool. The value of this property is not case-sensitive.
An instance of SQL Server is specified by one of the following two strings:
computername\instancename
or
computername
The value computername uses either the FQDN or the NetBIOS name of the host computer for SQL Server, and instancename identifies a named instance of SQL Server on the specified computer. The value computername by itself is used only if the Back-End Database Server uses the default instance of SQL Server on the host computer.
The BackendDBPath property does not map to the Pool View node in the Status pane.
DefaultLocationProfile
Data type: stringAccess type: Read/Write
Optional. The distinguished name of the Location profile for this pool.
The value of this property is not case-sensitive.
The DefaultLocationProfile property does not map to the Pool View node in the Status pane.
DomainFQDN
Data type: stringAccess type: Read-only
Optional. The fully qualified domain name (FQDN) of the domain.
The value must be an FQDN. An IP address is not allowed.
The DomainFQDN property does not map to the Pool View node in the Status pane.
InstanceID
Data type: [key] stringAccess type: Read-only
Required. A GUID value that uniquely identifies an instance of this class.
The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".
The InstanceID property does not map to the Pool View node in the Status pane.
MajorVersion
Data type: uint32Access type: Read-only
Required. The major Office Communications Server version number.
Value
Description
2
Office Live Communications Server 2005
3
Office Communications Server 2007
4
Office Communications Server 2007 R2
The MajorVersion property does not map to the Pool View node in the Status pane.
MCUFactoryList
Data type: string[]Access type: Read-only
Optional. A list of the distinguished names of the MCU Factories that this pool supports.
The value of this property is not case-sensitive.
The MCUFactoryList property does not map to the Pool View node in the Status pane.
MinorVersion
Data type: uint32Access type: Read-only
Required. The minor Office Communications Server version number.
Value
Description
0
Original release to market
1
Service Pack 1 release
The MinorVersion property does not map to the Pool View node in the Status pane.
PoolDisplayName
Data type: stringAccess type: Read-only
Required. The name of the pool as it appears in the Microsoft Management Console.
The value of this property is not case-sensitive.
The PoolDisplayName property maps to the Pool Name setting in the Pool View node in the Status pane.
PoolDN
Data type: stringAccess type: Read-only
Required. The distinguished name of the pool object in Active Directory.
The value of this property is not case-sensitive.
The PoolDN property does not map to the Pool View node in the Status pane.
PoolFQDN
Data type: stringAccess type: Read-only
Required. The fully qualified domain name (FQDN) of the pool.
The certificate for the pool must match this name. The value must be an FQDN. An IP address is not allowed.
The PoolFQDN property does not map to the Pool View node in the Status pane.
PoolMemberList
Data type: string[]Access type: Read-only
Optional. A list of the fully qualified domain name(s) (FQDN) of servers belonging to an Enterprise Edition pool or Standard Edition pool. In the case of a Standard Edition pool, there will be only one server in the list.
The value of this property is not case-sensitive.
The PoolMemberList property does not map to the Pool View node in the Status pane.
PoolType
Data type: stringAccess type: Read-only
Required. Specifies whether the pool is an Enterprise Edition pool or a Standard Edition pool.
The value of this property is not case-sensitive.
Value
Description
HomeServerPool
A Standard Edition pool.
FEPool
An Enterprise Edition pool.
The PoolType property maps to the Pool Type setting in the Pool View node in the Status pane.
SupportIMPresence
Data type: booleanAccess type: Read-only
Reserved. Do not use.
The SupportIMPresence property maps to the IM setting in the Pool View node in the Status pane.
SupportMeeting
Data type: booleanAccess type: Read-only
Reserved. Do not use.
The SupportMeeting property maps to the Meeting setting in the Pool View node in the Status pane.
TrustedMRASServer
Data type: stringAccess type: Read/Write
Optional. The distinguished name for the Trusted MRAS Server that serves this pool.
The value of this property is not case-sensitive.
The TrustedMRASServer property does not map to the Pool View node in the Status pane.
TrustedQoSServer
Data type: stringAccess type: Read/Write
Optional. The distinguished name for the QoS Server that serves this pool.
The value of this property is not case-sensitive.
The TrustedQoSServer property does not map to the Pool View node in the Status pane.
WebComponentsServerList
Data type: string[]Access type: Read-only
Optional. A list of the distinguished names of the Web servers that this pool supports.
The value of this property is not case-sensitive.
The WebComponentsServerList property does not map to the Pool View node in the Status pane.
Remarks
This class gets and sets information at the following level: Active Directory.
Instances of this class support the following interface methods:
Provider::EnumerateInstances();
Provider::GetObject();
Provider::PutInstance();
Where PutInstance() supports the following flag:
- WBEM_FLAG_UPDATE_ONLY
Requirements
Server: Installed on computers serving the following roles: Administrative Tools Server, Audio/Video Conferencing Server, Front End Server, Proxy Server, Web Components Server, and Web Conferencing Server.
Namespace: Defined in \root\cimv2.