MSFT_SIPRoutingTableData class

MSFT_SIPRoutingTableData

The MSFT_SIPRoutingTableData class defines a single static route entry in the Live Communications Server routing table.

The following syntax is simplified from MOF code and includes all inherited properties.

class MSFT_SIPRoutingTableData
{
  [key] string Backend;
  boolean DropRouteHeaders;
  boolean Enabled;
  [key] string InstanceID;
  string MatchURI;
  string NextHop;
  uint32 NextHopPort;
  string NextHopTransport;
  boolean ReplaceHostInRequestURI;
  uint8 [] TLSCertIssuer;
  uint8 [] TLSCertSN;
  boolean TreatAllConnectionsAsServer;
  boolean TreatAllConnetionsAsTrusted;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPRoutingTableData class has the following properties.

• Backend
  Data type: [key] string

  The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Microsoft® Office Live Communications Server 2005 with SP1, Back-End Database (configuration data is stored in the same SQL instance as user data, but in a different database). Indicates where this class is stored, which varies depending on the server role.

  Server Role	Acceptable Values
  Enterprise Edition	Backend_FQDN\SQL_Instance_Name
  Standard Edition	(local)\rtc
  Access Proxy and Proxy servers	Empty string

  This property cannot be updated.

• DropRouteHeaders
  Data type: boolean

  Drop all Route headers from messages arriving at this listening address.

  Value	Description
  false	Do not drop Route headers.
  true	Drop Route headers.

  The value cannot be NULL. This property is required on creation and can be updated.

• Enabled
  Data type: boolean

  If true, this route entry is enabled and any message that matches the URI pattern in MatchURI will be routed to the IP address/port specified by NextHop and NextHopPort. If false, the route is not enabled. This property cannot be NULL.

  This property is required on creation and can be updated.

• InstanceID
  Data type: [key] string

  A GUID value that uniquely identifies this routing table entry. The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

  This property is optional on creation and cannot be updated.

• MatchURI
  Data type: string

  A pattern that is matched against the Request-URI header of a SIP message. A valid value is any match pattern of the form sip:<user name>@<host address>[;<uri parameters>]. For example, sip:*@*.example.net is a valid match pattern. The maximum string length is 454. This property cannot be NULL.

  This property is required on creation and can be updated.

• NextHop
  Data type: string

  The address of the immediate destination for the routed message, as an IP address of the form "xxx.xxx.xxx.xxx" or as a fully qualified domain name. The domain name "*" is not valid, nor is the IP address "0.0.0.0". Multicast addresses in the ranges from 224.0.0.0 to 239.255.255.255 are also not valid. This property cannot be NULL.

  This property is required on creation and can be updated.

• NextHopPort
  Data type: uint32

  The port number for the next hop in the route. Valid values range from 1 to 65535. This property cannot be NULL.

  This property is required on creation and can be updated.

• NextHopTransport
  Data type: string

  The transport protocol used by the next hop in the route. This property is required on creation and can be updated. This property cannot be NULL.

  Value	Description
  "TCP"	The transport protocol for the next hop in the route is TCP.
  "TLS"	The transport protocol for the next hop in the route is TLS.

• ReplaceHostInRequestURI
  Data type: boolean

  If true, the host name portion of the Request-URI header value is replaced with the address specified in NextHop. If false, it is not changed. This property cannot be NULL.

  This property is required on creation and can be updated.

• TLSCertIssuer
  Data type: uint8 []

  The certificate authority that issued the certificate as a byte array.

  If MTLS is specified, this property must contain the fully qualified domain name of the certificate server. This value must be NULL for TCP connections, and can be not NULL for TLS connections.

  This property is optional on creation and can be updated.

• TLSCertSN
  Data type: uint8 []

  The serial number of the certificate as a byte array.

  This value must be NULL for TCP connections, and can be not NULL for TLS connections

  This property is optional on creation and can be updated.

• TreatAllConnectionsAsServer
  Data type: boolean

  Treat all connections on this listening address as originating from a server.

  Value	Description
  false	Do not treat all connections as server connections.
  true	Treat all connections as server connections.

  The value cannot be NULL. This property is required on creation and can be updated.

• TreatAllConnetionsAsTrusted
  Data type: boolean

  Treat all connections as trusted connections.

  Value	Description
  false	Do not treat all connections as trusted.
  true	Treat all connections as trusted.

  The value cannot be NULL. This property is required on creation and can be updated.

Remarks

Available actions for an instance of this class:

• Creation: The administrator can create instances of this class.
• Updates: The administrator can update instances of this class.
• Deletion: The administrator can delete instances of this class.

Requirements

Server: Installed on Windows Server 2003 with Live Communications Server 2005 with SP1.
Namespace: Defined in \root\cimv2.

See Also

MSFT_SIPRoutingSetting, Live Communications Server WMI Reference