MSFT_SIPClientPortSettings (New)

  • Article

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 the ports that are used by clients.

MSFT_SIPClientPortSettings

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_SIPClientPortSettings
{
  [key] string Backend;
  [key] string InstanceID;
  uint32 MaxMediaPort;
  uint32 MaxSipDynamicPort;
  uint32 MinMediaPort;
  uint32 MinSipDynamicPort;
  boolean PortRangeEnabled;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPClientPortSettings 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.

  • InstanceID
    Data type:

    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}".

  • MaxMediaPort
    Data type:

    Access type: Read/Write

    Required. The upper end of the media port range.

    Typically, this is set to 65335.

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

  • MaxSipDynamicPort
    Data type:

    Access type: Read/Write

    Required.

    Required. The upper end of the SIP session port range.

    Typically, this is set to 65335.

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

  • MinMediaPort
    Data type:

    Access type: Read/Write

    Required. The lower end of the media port range.

    Typically, this is set to 49152.

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

  • MinSipDynamicPort
    Data type:

    Access type: Read/Write

    Required. The lower end of the SIP session port range.

    Typically, this is set to 49152.

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

  • PortRangeEnabled
    Data type:

    Access type: Read/Write

    Required. Enables the port ranges for SIP and media transfer.

Remarks

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

Only one instance of this class can be present in the forest.

Instances of this class support the following interface methods:

  • 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 and Front End Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference