Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSFT_SIPRoutingTableData (Updated)
Collapse the table of content
Expand the table of content

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.

MSFT_SIPRoutingTableData

Defines a single static route entry in the Office Communications Server routing table.

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_SIPRoutingTableData
{
  [key] string Backend;
  boolean Enabled;
  [key] string InstanceID;
  string MatchURI;
  string NextHop;
  uint32 NextHopPort;
  string NextHopTransport;
  boolean ReplaceHostInRequestURI;
  uint8[] TLSCertIssuer;
  uint8[] TLSCertSN;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPRoutingTableData class has the following properties.

Backend

Data type: [key] string

Access type: Read-only

Must be empty when accessing data from Edge Server or Proxy Server roles. Required when accessing data from any role that belongs to a pool.

The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Office Communications Server 2007, 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

SQL_Instance_Name

Standard Edition

(local)\rtc

Access Edge Server and Forwarding Proxy

Empty string

Enabled

Data type: boolean

Access type: Read/Write

Required. Controls whether the route entry is enabled.

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.

InstanceID

Data type: [key] string

Access type: Read-only

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

MatchURI

Data type: string

Access type: Read/Write

Required. 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 length of the string is 454 characters. The value of this property is case-sensitive.

NextHop

Data type: string

Access type: Read/Write

Required. The address of the immediate destination for the routed message.

The value can be either a fully qualified domain name (FQDN) or an IP address. 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.

NextHopPort

Data type: uint32

Access type: Read/Write

Required. The port number for the next hop in the route.

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

NextHopTransport

Data type: string

Access type: Read/Write

Required. The transport protocol used by the next hop in the route.

The value of this property is not case-sensitive.

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

Access type: Read/Write

Required.

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.

TLSCertIssuer

Data type: uint8[]

Access type: Read/Write

Optional. A byte array representing the TLS certificate authority that issued the certificate.

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.

TLSCertSN

Data type: uint8[]

Access type: Read/Write

Optional. A byte array representing the serial number of the TLS certificate.

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

Remarks

This class gets and sets information at the following level(s): WMI, 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. 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::DeleteInstance(); Provider::EnumerateInstances(); Provider::GetObject(); Provider::PutInstance();

Where PutInstance() supports the following flag(s):

WBEM_FLAG_CREATE_ONLY WBEM_FLAG_UPDATE_ONLY WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Administrative Tools Server, Front End Server, Proxy Server.Namespace: Defined in \root\cimv2.


Reference

MSFT_SIPRoutingSetting
[<LinkCreatedDuringXmlConversion>]

Concepts

Show:
© 2015 Microsoft