MSFT_SIPRoutingTableData

  • 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.

Enables you to define the static routes to be used by the servers in this pool. A static route is composed of a fixed Uniform Resource Identifier (URI) for an outbound network connection and the fully qualified domain name (FQDN) or IP address of the next hop computer on the route.

The property values for the MSFT_SIPRoutingTableData class map to the settings found on the Routing tab of the Front End Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Properties, and then clicking Front End Properties. In the Front End Properties dialog box, click the Routing tab. Note that these settings apply only to the specified pool or server.

MSFT_SIPRoutingTableData

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

    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.

    The Backend property does not map to the Front End Properties dialog box.

  • 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 is routed to the IP address/port specified by NextHop and NextHopPort. If False, the route is not enabled.

    The Enabled property maps to the checkbox in the Front End Properties dialog box.

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

    The InstanceID property does not map to the Front End Properties dialog box.

  • 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.

    The MatchURI property maps to the MatchingURI setting in the Front End Properties dialog box.

  • 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.

    The NextHop property maps to the Next Hop setting in the Front End Properties dialog box.

  • 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.

    The NextHopPort property maps to the Port setting in the Front End Properties dialog box.

  • 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.

    The NextHopTransport property maps to the Transport setting in the Front End Properties dialog box.

  • ReplaceHostInRequestURI
    Data type: boolean

    Access type: Read/Write

    Required. Specifies whether to replace the host name portion of the Request-URI header value with the address specified in NextHop.

    If this value is False, the host name portion of the Request-URI header value is not changed.

    The ReplaceHostInRequestURI property does not map to the Office Communications Server Global Properties dialog box.

  • 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.

    The TLSCertIssuer property does not map to the Office Communications Server Global Properties dialog box.

  • 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.

    The TLSCertSN property does not map to the Office Communications Server Global Properties dialog box.

Remarks

This class gets and sets information at the following levels: WMI and 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 flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Front End Server, and Proxy Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

MSFT_SIPRoutingSetting

Office Communications Server WMI Reference