Set-CsStaticRoutingConfiguration

 

上一次修改主题: 2012-03-26

修改现有的静态路由配置设置集合。

语法

Set-CsStaticRoutingConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Route <PSListModifier>] [-WhatIf [<SwitchParameter>]]

Set-CsStaticRoutingConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Route <PSListModifier>] [-WhatIf [<SwitchParameter>]]

详细说明

向某人发送 SIP 消息时,该消息可能需要穿越多个子网和网络才能传送;该消息的传输路径通常称为路由。在网络中,有以下两种类型的路由:动态和静态。进行动态路由时,服务器使用算法确定消息应转发到的下一个位置,即下一个跃点。使用静态路由时,由系统管理员预先确定消息路径。服务器接收到消息后会检查消息地址,然后将消息转发到管理员预先配置的下一个跃点服务器。如果配置正确,静态路由有助于确保消息及时准确地送达,以及尽量减少服务器上的窃听情况。静态路由的不利方面就是,如果出现网络故障,将不会以动态方式重新路由消息。

当安装 Microsoft Lync Server 2010 时,系统将自动为您创建静态路由的一个全局集合。(虽然会创建集合,但该集合并未分配任何路由。)此外,借助软件可创建适用于服务作用域的其他集合(这些新集合只能分配到注册器服务)。使用 Set-CsStaticRoutingConfiguration cmdlet 可修改现有静态路由集合的属性值。这意味着可使用该 cmdlet 将新路由添加到集合,或从集合中删除现有路由。

谁能运行此 cmdlet:默认情况下,以下各组的成员有权在本地运行 Set-CsStaticRoutingConfiguration cmdlet:RTCUniversalServerAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsStaticRoutingConfiguration"}

参数

参数 必需 类型 描述

Identity

可选

Xds 标识

要修改的静态路由配置集合的唯一标识符。要修改全局集合,请使用此语法:-Identity global。要修改适用于服务作用域的集合,请使用类似语法:-Identity "service:Registrar:atl-cs-001.litwareinc.com"。指定 Identity 时,不能使用通配符。

如果不包括此参数,则 Set-CsStaticRoutingConfiguration 将自动修改全局集合。

Instance

可选

路由设置对象

允许您将对对象的引用传递到 cmdlet,而不是设置单个参数值。

Route

可选

PS 列表修饰符

集合中维护的单个静态路由。要添加到集合中的路由必须是从另一个集合复制的,或者是使用 New-CsStaticRoute cmdlet 创建的;要从集合中删除某个路由,必须首先创建该路由的对象引用。有关详细信息,请参阅帮助主题中的示例部分。

Force

可选

开关参数

禁止显示运行此命令时可能出现的任何非严重错误消息。

WhatIf

可选

开关参数

描述如果执行命令会发生什么情况(无需实际执行命令)。

Confirm

可选

开关参数

在执行命令之前提示您进行确认。

输入类型

Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings 对象。Set-CsStaticRoutingConfiguration 接受通过管道传递的静态路由设置对象的实例。

返回类型

Set-CsStaticRoutingConfiguration 不会返回值或对象。但此 cmdlet 配置 Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings 对象的实例。

示例

-------------------------- 示例 1 ------------------------

$x = Get-CsStaticRoutingConfiguration -Identity global | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True}

Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route @{Add=$x}

示例 1 中显示的命令从全局静态路由集合中复制了一条路由,然后将该路由分配到第二个静态路由集合,即 Identity 为 service:Registrar:atl-cs-001.litwareinc.com 的集合。要执行此任务,示例中的第一个命令将连接到全局集合,并返回具有 litwareinc.com MatchUri 的路由的对象引用,其中 MatchOnlyPhoneUri 等于 True。

为此,该命令调用 Get-CsStaticRoutingConfiguration 以从全局路由静态配置集合中返回信息。然后将此数据通过管道传递到 Select-Object cmdlet,后者将使用 ExpandProperty 参数来展开 Route 属性值。这些展开的值(表示分配到集合的单个路由)随后将通过管道传递到 Where-Object cmdlet,后者将挑选 MatchUri 属性等于 litwareinc.com 且 MatchOnlyPhoneUri 属性等于 True 的一条路由。返回的路由将存储在名为 $x 的变量中。

在对该路由进行检索后,示例中的第二个命令会将该路由添加到服务:Registrar:atl-cs-001.litwareinc.com 集合。为执行此操作,应调用带有 Route 参数的 Set-CsStaticRoutingConfiguration;参数值 @{Add=$x} 指示 Set-CsStaticRoutingConfiguration 将存储在变量 $x 中的路由追加到在路由属性中维护的路由集合中。

-------------------------- 示例 2 ------------------------

$x = Get-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True}

Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route @{Remove=$x}

上述命令将从静态路由集合中删除某条路由。为执行此操作,示例中的第一个命令将连接到 Identity 为 service:Registrar:atl-cs-001.litwareinc.com 的集合,并返回具有 litwareinc.com MatchUri 的路由的对象引用,其中 MatchOnlyPhoneUri 等于 True。为此,该命令调用 Get-CsStaticRoutingConfiguration 从 service:Registrar:atl-cs-001.litwareinc.com 集合中返回信息。然后将此数据通过管道传递到 Select-Object cmdlet,后者将使用 ExpandProperty 参数来展开 Route 属性值。这些展开的值(表示分配到集合的单个路由)随后将通过管道传递到 Where-Object cmdlet,后者将挑选 MatchUri 属性等于 litwareinc.com 且 MatchOnlyPhoneUri 属性等于 True 的一条路由。然后,返回的路由将存储在名为 $x 的变量中。

对该路由进行检索后,第二个命令将从集合中删除该路由。为执行此操作,调用了带有 Route 参数的 Set-CsStaticRoutingConfiguration;参数值 @{Remove=$x} 指示 Set-CsStaticRoutingConfiguration 删除存储在变量 $x 中的路由。

-------------------------- 示例 3 ------------------------

Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route $Null

示例 3 显示了如何删除分配到静态路由配置集合的所有路由。为执行此操作,只需包括 Route 参数并将其设置为空值。命令完成后,虽然该集合仍存在,但不会再向其分配任何路由。