SIPPeer Class

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.

The SIPPeer class includes members for viewing and modifying SIP peer configuration settings in Speech Server. Instances of the SIPPeer class represent the pool of SIP peers available to be added as trusted SIP peers to computers running Speech Server. These trusted SIP peers are represented on computers running Speech Server by instances of the TrustedSIPPeer class.

The SIPPeer class is only available if the Speech Server Administrator console is installed.

Warning

For each instance of TrustedSIPPeer on a computer running Speech Server, there must be a corresponding instance of the SIPPeer class on the computer used for Speech Server administration. Otherwise, the Speech Server Administrator console on the administration computer might not work properly.

The following syntax is simplified from Managed Object Format (MOF) code.

Syntax

class SIPPeer
{
????????string Name;
????????string Type;
????????string Address;
????????boolean UseDefaultPorts;
????????uint32 TCPPort;
????????uint32 TLSPort;
????????boolean UseMutualTLS;
};

Methods

The SIPPeer class has no methods.

Properties

The SIPPeer class has the following properties.

Name

Data type: string

Specifies the name of the SIP peer.

This property is exposed in the Speech Server Administrator console.

Type

Data type: string

Specifies the type of this SIP peer. This property has the following valid string values:

• Default ??? Applies to all SIP peers except Telephony Interface Manager Connector (TIMC).
• TIMC ??? Applies to TIMC only.

This property is exposed in the Speech Server Administrator console.

Address

Data type: string

Specifies the address of the SIP peer. The value of this property is the fully qualified domain name (FQDN) or IP address of the SIP peer.

Note

Do not begin the last name element of the SIP peer address with a number. For example, 1SIP is not an acceptable address. However, 1SIP.mydomain.com is acceptable.

This property is exposed in the Speech Server Administrator console.

UseDefaultPorts

Data type: boolean

Specifies whether to use the default IP ports on the SIP peer for standard and secure communication, using Transport Layer Security (TLS), with Speech Server. If this property is true, Speech Server sends data to ports 5060 (for standard communication) and 5061 (for secure communication) on the SIP peer. If false, Speech Server uses the values specified in the TCPPort and TLSPort properties.

The default value of UseDefaultPorts is true. This property is exposed in the Speech Server Administrator console.

TCPPort

Data type: uint32

Specifies the IP port number on the SIP peer to use for communication with Speech Server. The value specified in this property is ignored if the UseDefaultPorts property is set to true.

The default value of TCPPort is 5060. This property is exposed in the Speech Server Administrator console.

TLSPort

Data type: uint32

Specifies the IP port number on this SIP peer to use for secure communication, using Transport Layer Security (TLS), with Speech Server. The value specified in this property is ignored if the UseDefaultPorts property is set to true.

The default value of TLSPort is 5061. This property is exposed in the Speech Server Administrator console.

UseMutualTLS

Data type: boolean

Specifies whether Speech Server expects Mutual TLS (TLS) connections from the SIP peer. If the property is true, you must specify a security certificate for authenticating Speech Server with the SIP peer.

Note

If no SIP peer is configured to use Mutual TLS, calls to and from applications configured to use Secure RTP are declined by Speech Server.

The default value of UseMutualTLS is false. This property is exposed in the Speech Server Administrator console.

Windows Management Instrumentation (WMI) Script Example

strComputer = "." 
Set objWMIService = GetObject("winmgmts:\\" & strComputer & "\root\MSSV2") 
Set colItems = objWMIService.ExecQuery( _
    "SELECT * FROM SIPPeer",,48) 
For Each objItem in colItems 
    Wscript.Echo "-----------------------------------"
    Wscript.Echo "SIPPeer instance"
    Wscript.Echo "-----------------------------------"
    Wscript.Echo "Address: " & objItem.Address
    Wscript.Echo "Name: " & objItem.Name
    Wscript.Echo "TCPPort: " & objItem.TCPPort
    Wscript.Echo "TLSPort: " & objItem.TLSPort
    Wscript.Echo "Type: " & objItem.Type
    Wscript.Echo "UseMutualTLS: " & objItem.UseMutualTLS
Next

Requirements

Server: Requires Microsoft Windows Server 2003 with Speech Server

Namespace: Included in \root\mssv2

See Also

Other Resources

Speech Server Administration Through WMI
SIP Peers
SIP Peer Administration