New-CsStaticRoute

Syntax

New-CsStaticRoute
   -Destination <String>
   -MatchUri <String>
   [-Enabled <Boolean>]
   [-MatchOnlyPhoneUri <Boolean>]
   -Port <UInt16>
   [-ReplaceHostInRequestUri <Boolean>]
   [-TCPRoute]
   [<CommonParameters>]

New-CsStaticRoute
   -Destination <String>
   -MatchUri <String>
   [-Enabled <Boolean>]
   [-MatchOnlyPhoneUri <Boolean>]
   -Port <UInt16>
   [-ReplaceHostInRequestUri <Boolean>]
   [-TLSCertIssuer <String>]
   [-TLSCertSerialNumber <Byte[]>]
   [-TLSRoute]
   [-UseDefaultCertificate <Boolean>]
   [<CommonParameters>]

Description

When you send a SIP message to someone that message might need to traverse multiple subnets and networks before it is delivered; the path traveled by the message is often referred to as a route. In networking, there are two types of routes: dynamic and static. With dynamic routing, servers use algorithms to determine the next location (the next hop) where the message should be forwarded. With static routing, message paths are predetermined by system administrators. When a message is received by a server, the server checks the message address and then forwards the message to the next hop server that has been preconfigured by an administrator. If configured correctly, static routes help ensure timely and accurate, delivery of messages and with minimal overheard placed on servers. The downside to static routes is that messages are not dynamically rerouted in the event of a network failure.

New static routes are created by using the New-CsStaticRoute cmdlet. After a route has been created by using the New-CsStaticRoute cmdlet, you must then add the route to a collection of routing configuration settings by using the Set-CsStaticRoutingConfiguration cmdlet.

Examples

-------------------------- Example 1 ------------------------

$x = New-CsStaticRoute -TCPRoute -Destination "192.168.0.100" -Port 8025 -MatchUri "litwareinc.com"

Set-CsStaticRoutingConfiguration -Identity global -Route @{Add=$x}

The commands shown in Example 1 create a new static route and then add that route to the global static routing configuration collection. To carry out this task, the first command uses the New-CsStaticRoute cmdlet to create an in-memory-only route that uses TCP as its transport protocol. The route points to the next hop IP address 192.168.0.100, uses port 8025, and matches any URI from the domain litwareinc.com. The resulting route object is stored in a variable named $x.

The second command in the example then adds the new route to the global static routing configuration collection. This is done by calling the Set-CsStaticRoutingConfiguration cmdlet along with the Route parameter. The parameter value @{Add=$x} adds the route object stored in $x to the existing set of routes already in the global collection.

-------------------------- Example 2 ------------------------

$x = New-CsStaticRoute -TLSRoute -Destination "atl-proxy-001.litwareinc.com" -Port 8025 -MatchUri "*.litwareinc.com" -UseDefaultCertificate $True

Set-CsStaticRoutingConfiguration -Identity global -Route @{Add=$x}

Example 2 shows how you can create a new static route that uses TLS as its transport protocol, and then add that route to the global static routing configuration collection. To do this, the first command in the example uses the New-CsStaticRoute cmdlet to create an in-memory-only route that uses TLS as its transport protocol. The route points to the "atl-proxy-001.litwareinc.com" as its destination, uses port 8025 and matches any URI that uses the domain suffix "litwareinc.com". In addition, the new route object, which is stored in a variable named $x, uses the default certificate for authentication purposes (-UseDefaultCertificate $True).

After the route object has been created, the second command in the example then adds the new route to the global static routing configuration collection.

-------------------------- Example 3 --------------------------

$x = New-CsStaticRoute -TLSRoute -Destination "atl-proxy.litwareinc.com" -Port 5061 -MatchUri "litwareinc.com" -UseDefaultCertificate $False -TLSCertIssuer "CN=CertificateAuthority, DC=litwareinc, DC=com" -TLSCertSerialNumber 0x8f,0x33,0x70,0x93,0x70,0x05,0x33,0x00,0x02,0x33

Set-CsStaticRoutingConfiguration -Identity global -Route @{Add=$x}

Example 3 creates a new static route using TLS and a specific certificate; this is indicated by included the required TLS parameters.

After the route object has been created, the second command in the example then adds the new route to the global static routing configuration collection.

Parameters

-Destination

-Enabled

-MatchOnlyPhoneUri

-MatchUri

-Port

-ReplaceHostInRequestUri

-TCPRoute

-TLSCertIssuer

-TLSCertSerialNumber

-TLSRoute

-UseDefaultCertificate

Inputs

None. The New-CsStaticRoute cmdlet does not accept pipelined input.

Outputs

The New-CsStaticRoute cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Route object.

Related Links

• New-CsStaticRoutingConfiguration
• Set-CsStaticRoutingConfiguration