This documentation is archived and is not being maintained.

MSFT_SIPIMMCUSetting

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 you to configure the listening address and port for group instant messaging (IM).

The property values for the MSFT_SIPIMMCUSetting class map to the settings found on the IM Conferencing tab of the Front End Server Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a front end server, pointing to Properties, and then clicking Front End Properties. (For an Enterprise Edition server, click Properties rather than Front End Properties.) In the Front End Server Properties dialog box, click the IM Conferencing tab. Note that these settings apply only to the specified 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_SIPIMMCUSetting
{
  [key] string InstanceID;
  string ListeningIPAddress;
  uint32 SIPListeningPort;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPIMMCUSetting class has the following properties.

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 Server Properties dialog box.

ListeningIPAddress

Data type: string

Access type: Read/Write

Required. The IP Address on which the IMMCU listens.

The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". A fully qualified domain name (FQDN) is not allowed. To listen to all available addresses that pass through the server, use "*".

The default value is "*".

The ListeningIPAddress property maps to the IP address dropdown list in the Front End Server Properties dialog box.

SIPListeningPort

Data type: uint32

Access type: Read/Write

Required. The port on which the IMMCU listens for Instant Message traffic.

The minimum value for this property is 1 and the maximum value is 65535.

The default value is 5062.

The SIPListeningPort property maps to the SIP listening port text box in the Front End Server Properties dialog box.

Remarks

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

Only one instance of this class can be present.

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 role: Front End Server.

Namespace: Defined in \root\cimv2.

Show: