Export (0) Print
Expand All
Expand Minimize

MSFT_SIPProxySecuritySetting

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.

Enables to to specify the authentication protocols supported by the servers in this pool.

The property values for the MSFT_SIPProxySecuritySetting class map to the settings found on the Authentication tab of the Front End Properties dialog box. You can access these values 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 Authentication tab. Note that these settings apply only to the specified pool or server.

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_SIPProxySecuritySetting
{
  [key] string Backend;
  string[] ClientToProxyAuth;
  boolean DefaultRealm;
  [key] string InstanceID;
  string Realm;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPProxySecuritySetting class has the following properties.

Backend

Data type: [key] string

Access 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 Front End Properties dialog box.

ClientToProxyAuth

Data type: string[]

Access type: Read/Write

Required. Specifies the security providers supported by the proxy.

The value of this property is not case-sensitive. This array must contain one or more of the following string values.

Value

Description

Kerberos

The Kerberos security provider is supported.

NTLM

The NTLM security provider is supported.

The default is an array containing both values ({"Kerberos","NTLM"}).

The ClientToProxyAuth property maps to the Authentication protocol dropdown list in the Front End Server Properties dialog box.

DefaultRealm

Data type: boolean

Access type: Read/Write

Required. Specifies whether the security credentials are supplied by the default realm or the realm specified by the Realm property.

If True, the realm for the supplied security credentials is the default realm: "SIP Communications Service". If False, the realm is specified in the Realm property.

The default value is True.

The DefaultRealm property does not map to the Front End Properties dialog box.

InstanceID

Data type: [key] string

Access 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 Front End Properties dialog box.

Realm

Data type: string

Access type: Read/Write

Optional. The realm in which these security credentials are accepted.

The realm must be the same for all servers in the Office Communications Server deployment.

The value of this property is case-sensitive. The maximum length of the string is 255 characters. The value cannot be NULL if DefaultRealm is False.

The default value is NULL.

The Realm property does not map to the Front End Properties dialog box.

Remarks

This class gets and sets information at the following levels: WMI and SQL.

If this class is installed on a server whose role has "Pool" scope, the scope of this class is "Pool" and settings are stored in SQL. In this case, only one instance of this class can be present in the pool. For a list of server roles and their corresponding WMI class scopes, see WMI Class Management Scopes and Roles.

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Access Edge Server, Front End Server, and Proxy Server.

Namespace: Defined in \root\cimv2.

Show:
© 2014 Microsoft