Create a new static route.
Syntax
New-CsStaticRoutingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Route <PSListModifier>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Xds Identity |
Unique identifier for the new static routing collection to be created. New collections can only be created at the service scope, and can only be assigned to the Registrar service. Because of that, the Identity for a new collection must look similar to this: -Identity "service: Registrar:atl-cs-001.litwareinc.com". |
|
Route |
Optional |
PSList Modifier |
Individual static routes maintained within the collection. Routes to be added to a collection must either by copied from another collection or created using the New-CsStaticRoute cmdlet. See the Examples section of this help topic for more information. |
|
InMemory |
Optional |
SwitchParameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
When you send a SIP (Session Initiation Protocol) 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 a 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? Messages are not dynamically rerouted in the event of a network failure.
Microsoft Communications Server “14” enables you to set up static routes for proxy servers. The actual routes themselves are created using the New-CsSipProxyRoute cmdlet. However, these routes have a number of properties that must be created using additional cmdlets. For example, each route must have a Transport, a property that defines the network protocol used for transmitting messages along the route. This means that you need to use either New-CsSipProxyTCP or New-CsSipProxyTLS to create an object reference for that protocol. That object reference is then used to configure the Transport object.
When you install Microsoft Communications Server “14”, a global collection of static routes is automatically created for you. (The collection is created, but there are no routes assigned to that collection.) In addition, the software enables you to create additional collections applied to the service scope (these new collections can only be assigned to the Registrar service).
New static routing configuration collections are created using the New-CsStaticRoutingConfiguration cmdlet. New routes can only be created at the service scope, and can only be applied to the Registrar service; a command that attempts to assign a collection to a different service will fail. Likewise, your command will fail if it tries to assign a new collection to a service that already hosts a collection, or it tries to collection a new collection at the global scope.
Return Types
New-CsStaticRoutingConfiguration creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SipProxy.RoutingSettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
New-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" |
|
The preceding command creates a new static routing configuration collection, a collection that has the Identity service:Registrar:atl-cs-001.litwareinc.com. Because the –Route parameter is not included in the command, the new collection will not have any static routes assigned to it.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
$x = New-CsStaticRoute -TCPRoute -Destination "192.168.0.100" -Port 8025 -MatchUri "sip:*@litwareinc.com" New-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" -Route $x |
|
The commands shown in Example 2 create a new SIP proxy route that uses TCP as its transport; this new route is then added to a new static routing configuration collection. To do all this, the first command in the example uses New-CsStaticRoutre to create a new route that points to the next hop server with the IP address 192.168.1.100. This new route (stored in a variable named $x) also uses port 8025 and the MatchUri "sip:*@litwareinc.com".
When that’s done, New-CsStaticRoutingConfiguration is called to create a new collection (with the Identity service:Registrar:atl-cs-001.litwareinc.com), assigning the route stored in the variable $x to the Route property of the new collection.