MSFT_SIPPoolConfigSetting
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.
Specifies configuration settings for a pool.
The property values for the MSFT_SIPPoolConfigSetting class map to the settings found on the Video tab of the Front End Properties dialog box and on the Media tab of the Pool dialog box. You can access the Front End Properties in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Properties, and then clicking Front End Properties. In the Front End Properties dialog box, click the Video tab. Note that these settings apply only to the specified pool or server.
You can access the media properties in Properties dialog box in the Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Properties, and then clicking Pool Properties. In the Pool Properties dialog box, click the Media tab. Note that these settings apply only to the specified pool or server.
MSFT_SIPPoolConfigSetting
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_SIPPoolConfigSetting
{
string ApplicationDataLocation;
[key] string Backend;
boolean DNATMode;
[key] string InstanceID;
uint32 LanguageIds;
string MaxVideoReceiveCapabilityAllowed;
uint32 MediaPortRangeFrom;
uint32 MediaPortRangeTo;
boolean ServerQoSEnabled;
};
Methods
This class does not define any methods.
Properties
The MSFT_SIPPoolConfigSetting class has the following properties.
ApplicationDataLocation
Data type: stringAccess type: Read/Write
Optional. The full path to the directory in which application data files are stored.
The maximum length of the string is 260 characters.
The ApplicationDataLocation property does not map to the Administration Tool user interface.
Backend
Data type: [key] stringAccess type: Read-only
Required: When accessing data from any role that belongs to a pool. This property must be empty when accessing data from the Edge Server or Proxy Server role.
This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.
The value for this property depends on the topology of Office Communications Server.
Topology
Value
Standard Edition
(local)\rtc
Enterprise Edition
(consolidated or expanded configuration)
computername\instancename
or
computername
For Enterprise Edition, computername identifies 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 host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.
The Backend property does not map to the Administration Tool user interface.
DNATMode
Data type: booleanAccess type: Read/Write
Required. Indicates whether the pool is behind a load balancer that is configured to perform Destination Network Address Translation (DNAT).
The DNATMode property does not map to the Administration Tool user interface.
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 Administration Tool user interface.
LanguageIds
Data type: uint32[]Access type: Read/Write
Optional: An array of National Language Support (NLS) locale ID (LCID) values that correspond to the languages allowed to be used for the pool.
LCID values are four-character hexadecimal values. Leading zeros do not need to be included as part of the LanguageID value. For example, Office Communications Server recognizes the LanguageID value 9 as equivalent to the LCID value 0009 (English).
The minimum value for this property is 1 and the maximum value is 65535.
The LanguageIDs property does not map to the Administration Tool user interface.
MaxVideoReceiveCapabilityAllowed
Data type: stringAccess type: Read/Write
Required. The maximum video quality for video clients.
The values for the following video qualities.
Value
Description
Hd720p-1.5M
High definition, with a resolution 1280 x 720, with the aspect ratio 16:9
VGA-600K
VGA, with a resolution 640 x 480, 25 fps with the aspect ratio 4:3
This is the default value.
CIF-250K
Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288
default
Unlimited band width
The MaxVideoReceiveCapabilityAllowed property maps to the Maximum video quality dropdown list in the Front End Properties dialog box.
MediaPortRangeFrom
Data type: uint32Access type: Read/Write
Required. The first port number in the range of ports used by A/V Authentication Server and all other applications performing media exchange.
This value must be at least 24 less than MediaPortRangeTo.
The minimum value for this property is 32768 and the maximum value is 65535.
The MediaPortRangeFrom property maps to the Media port range from text box in the Pool Properties dialog box.
MediaPortRangeTo
Data type: uint32Access type: Read/Write
Required. The last port number in the range of ports used by A/V Authentication Server and all other applications performing media exchange.
This value must be at least 24 greater than MediaPortRangeFrom.
The minimum value for this property is 32768 and the maximum value is 65535.
The MediaPortRangeTo property maps to the Media port range to text box in the Pool Properties dialog box.
ServerQoSEnabled
Data type: booleanAccess type: Read/Write
Required. Specifies whether QoS is enabled for servers in the pool.
The ServerQoS property does not map to the Administration Tool user interface.
Remarks
This class gets and sets information at the following level: SQL.
Only one instance of this class can be present in the pool.
Instances of this class support the following interface methods:
Provider::EnumerateInstances();
Provider::GetObject();
Provider::PutInstance();
Where PutInstance() supports the following flags:
WBEM_FLAG_UPDATE_ONLY
WBEM_FLAG_CREATE_OR_UPDATE
Requirements
Server: Installed on computers serving the following roles: Administrative Tools Server, Audio/Video Conferencing Server, Front End Server, Web Components Server, and Web Conferencing Server.
Namespace: Defined in \root\cimv2.