[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information about the static routes used in your organization.

Syntax


Get-CsStaticRoutingConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]


Get-CsStaticRoutingConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter	Required	Type	Description
Identity	Optional	Xds Identity	Unique identifier for the static routing configuration collection. To return information about the global collection, use this syntax: -Identity global. To retrieve information about a collection configured at the service scope, use syntax similar to this: -Identity "service:Registrar:atl-cs-001.litwareinc.com". Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards, use the –Filter parameter instead. If you do not include either the –Identity or the –Filter parameters then Get-CsStaticRoutingConfiguration returns information about all your static routing configuration collections.
Filter	Optional	String	Enables you to use wildcards when specifying the static routing configuration collection (or collections) to be returned. For example, this syntax returns all the static routing collections configured at the service scope: -Filter "service:*". Note that you cannot use both the –Identity and the –Filter parameters in the same command.
LocalStore	Optional	Switch Parameter

Parameter

Required

Type

Description

Identity

Optional

Xds Identity

Unique identifier for the static routing configuration collection. To return information about the global collection, use this syntax: -Identity global. To retrieve information about a collection configured at the service scope, use syntax similar to this: -Identity "service:Registrar:atl-cs-001.litwareinc.com". Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards, use the –Filter parameter instead.

If you do not include either the –Identity or the –Filter parameters then Get-CsStaticRoutingConfiguration returns information about all your static routing configuration collections.

Filter

Optional

String

Enables you to use wildcards when specifying the static routing configuration collection (or collections) to be returned. For example, this syntax returns all the static routing collections configured at the service scope: -Filter "service:*".

Note that you cannot use both the –Identity and the –Filter parameters in the same command.

LocalStore

Optional

Switch Parameter

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.

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). The Get-CsStaticRoutingConfiguration cmdlet provides a way for you to return information about all the static routing configuration collections in use in your organization. This includes the ability to return detailed information about each route assigned to a collection.

Return Types

Get-CsStaticRoutingConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SipProxy.RoutingSettings object.

Examples

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

	Copy Code
Get-CsStaticRoutingConfiguration

The command shown in Example 1 returns information about all the static routing configuration collections in use in your organization.

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

	Copy Code
Get-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com"

In Example 2, information about a single static routing configuration collection is returned: the collection with the Identity service:Registrar:atl-cs-001.litwareinc.com.

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

	Copy Code
Get-CsStaticRoutingConfiguration -Filter "service:*"

Example 3 uses the –Filter parameter to return information about the static routing configuration collections assigned to the service scope. The filter value "service:*" limits the returned data to collections that have an identity that begins with the string value "service:".

-------------------------- Example 4 ------------------------

	Copy Code
Get-CsStaticRoutingConfiguration \| Select-Object -ExpandProperty Route

The preceding command returns detailed route information for all the static routing configuration collections in use in the organization. To do this, the command first calls Get-CsStaticRoutingConfiguration without any parameters in order to return complete information for each static routing collection. This information is then piped to the Select-Object cmdlet, which uses the –ExpandProperty parameter to "expand" the value of the Route property. When you expand a property, all the objects and values contained within that property are displayed onscreen, and in easy-to-read fashion.

-------------------------- Example 5 ------------------------

	Copy Code
Get-CsStaticRoutingConfiguration \| Select-Object -ExpandProperty Route \| Where-Object {$_.MatchOnlyPhoneUri = $True}

The command shown in Example 5 returns information about all the static routes that are configured to only match telephone URIs. To carry out this task, the command first calls Get-CsStaticRoutingConfiguration without any parameters; this returns all the static routing configuration collections and their associated routes. This collection is then piped to the Select-Object cmdlet, which uses the –ExpandProperty to expand all the objects stored in the Route property. These route objects are then piped to the Where-Object cmdlet, which picks out only those routes where the MatchOnlyPhoneUri property is equal to (-eq) True ($True).