New-CsStaticRoute
トピックの最終更新日: 2012-03-26
新しい静的電話ルートを作成します。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
New-CsStaticRoute -Destination <String> -MatchUri <String> -Port <UInt16> -TLSRoute <SwitchParameter> [-Enabled <$true | $false>] [-MatchOnlyPhoneUri <$true | $false>] [-ReplaceHostInRequestUri <$true | $false>] [-TLSCertIssuer <String>] [-TLSCertSerialNumber <Byte[]>] [-UseDefaultCertificate <$true | $false>] <COMMON PARAMETERS>
New-CsStaticRoute -Destination <String> -MatchUri <String> -Port <UInt16> -TCPRoute <SwitchParameter> [-Enabled <$true | $false>] [-MatchOnlyPhoneUri <$true | $false>] [-ReplaceHostInRequestUri <$true | $false>] <COMMON PARAMETERS>
COMMON PARAMETERS:
例
例 1
例 1 のコマンドで、新しい静的ルートを作成し、そのルートをグローバル静的ルーティング構成コレクションに追加します。このタスクを実行するために、最初のコマンドで New-CsStaticRoute コマンドレットを使用して、トランスポート プロトコルとして TCP を使用するメモリ内専用ルートを作成します。このルートは、次ホップ IP アドレス 192.168.0.100 を指し、ポート 8025 を使用し、ドメイン litwareinc.com のすべての URI に適用されます。作成されたルート オブジェクトは $x という名前の変数に格納されます。
例の 2 つ目のコマンドを使用して、新しいルートをグローバル静的ルーティング構成コレクションに追加します。Route パラメーターを指定して Set-CsStaticRoutingConfiguration コマンドレットを呼び出すことで、これを行っています。パラメーター値 @{Add=$x} により、$x に格納されているルート オブジェクトをグローバル コレクション内の既存のルート セットに追加します。
$x = New-CsStaticRoute -TCPRoute -Destination "192.168.0.100" -Port 8025 -MatchUri "litwareinc.com"
Set-CsStaticRoutingConfiguration -Identity global -Route @{Add=$x}
例 2
例 2 は、トランスポート プロトコルとして TLS を使用する新しい静的ルートを作成し、そのルートをグローバル静的ルーティング構成コレクションに追加する方法を示しています。これを行うために、例の最初のコマンドで New-CsStaticRoute コマンドレットを使用して、トランスポート プロトコルとして TLS を使用するメモリ内専用ルートを作成します。このルートは、宛先として "atl-proxy-001.litwareinc.com" を指し、ポート 8025 を使用し、ドメイン サフィックス "litwareinc.com" を使用するすべての URI に適用されます。また、$x という名前の変数に格納されている新しいルート オブジェクトで、認証用に既定の証明書を使用します (-UseDefaultCertificate $True)。
ルート オブジェクトを作成した後で、例の 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}
例 3
例 3 では、TLS と特定の証明書を使って新しい静的ルートを作成します。必要な TLS パラメーターを追加するときに指示されます。
ルート オブジェクトを作成した後で、例の 2 つ目のコマンドを使用して、新しいルートをグローバル静的ルーティング構成コレクションに追加します。
$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}
解説
他のユーザーに SIP メッセージを送信する場合、配信される前に、そのメッセージが複数のサブネットやネットワークを通過することが必要になる場合があります。多くの場合、メッセージが通過するパスをルートと呼びます。ネットワークでは、動的ルートと静的ルートの 2 種類のルートがあります。動的ルートでは、サーバーは、アルゴリズムを使用してメッセージを転送する次の場所 (次ホップ) を判断します。静的ルートでは、メッセージ パスはシステム管理者があらかじめ設定します。メッセージがサーバーによって受信されると、サーバーは、メッセージのアドレスを確認し、そのメッセージを管理者があらかじめ設定した次ホップ サーバーに転送します。正しく構成されている場合、静的ルートによって、メッセージを適切なタイミングで正確に配信でき、サーバーにかかるオーバーヘッドが最小限になります。静的ルートの欠点は、ネットワーク障害が発生した場合に、メッセージが動的に再ルーティングされないという点です。
新しい静的ルートは、New-CsStaticRoute コマンドレットを使用して作成します。New-CsStaticRoute コマンドレットを使用してルートを作成した後で、Set-CsStaticRoutingConfiguration コマンドレットを使用して、そのルートをルーティング構成設定のコレクションに追加する必要があります。
このコマンドレットを実行できるメンバー。既定では、次のグループのメンバーが、New-CsStaticRoute コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsStaticRoute"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Destination |
必須 |
System.String |
ルートがトランスポート プロトコルとしてトランスポート層セキュリティ (TLS) を使用する場合、Destination は次ホップ サーバーの完全修飾ドメイン名 (FQDN) です。次に例を示します。-Destination "atl-proxy-001.litwareinc.com"。 ルートがトランスポート プロトコルとして伝送制御プロトコル (TCP) を使用する場合、Destination は次ホップ ルーターの IP アドレスです。次に例を示します。-Destination "192.168.0.240"。 |
MatchUri |
必須 |
System.String |
このルートで処理されるユーザーにメッセージを送信するかどうかを指定するために使用する、FQDN またはドメイン サフィックス。たとえば、"litwareinc.com" という FQDN を使用する場合、このパターンで、末尾が "litwareinc.com" というドメイン名の SIP アドレスを持つユーザーを照合します。 ドメインの子ドメインを照合するために、"*.litwareinc.com" などのワイルドカード値を使用できます。その値で、末尾が "litwareinc.com" のドメインを照合します。次に例を示します。northamerica.litwareinc.com、asia.litwareinc.com、および europe.litwareinc.com。 |
Port |
必須 |
System.UInt16 |
SIP ルーティングに使用するポート番号。次に例を示します。-Port 7742。 |
TCPRoute |
必須かどうか |
System.Management.Automation.SwitchParameter |
新しいルートのトランスポート プロトコルとして TCP を構成します。 |
TLSRoute |
必須 |
System.Management.Automation.SwitchParameter |
新しいルートのトランスポート プロトコルとして TLS を構成します。 |
Enabled |
省略可能 |
System.Boolean |
True に設定するとルートが有効になり、MatchURI パターンと一致するすべてのメッセージが次ホップ サーバーにルーティングされます。False に設定するとルートが無効になり、メッセージのルーティングに使用されません。既定値は True です。 |
MatchOnlyPhoneUri |
省略可能 |
System.Boolean |
True に設定すると、電話の URI (Uniform Resource identifier) (たとえば sip:kenmmyer@litwareinc.com;user=phone) が宛先となっているメッセージのみ照合されて、ルーティングされる可能性があります。False (既定値) に設定すると、すべてのメッセージが照合されます。 |
ReplaceHostInRequestUri |
省略可能 |
System.Boolean |
True ($True) に設定すると、Request-URI のホスト部分が次ホップ サーバーのアドレスに置き換えられます。False に設定すると、Request-URI がそのまま使用されます。Request-URI は、要求 (メッセージ) の宛先であるユーザーまたはサービスの URI を表します。既定値は False です。 |
TLSCertIssuer |
省略可能 |
System.String |
静的ルートで使用する証明書を発行した証明機関 (CA) の名前。トランスポート プロトコルとして TCP を構成している場合、このパラメーターは使用しません。 TLSCertIssuer パラメーターを使用する場合、TLSCertSerialNumber パラメーターも使用する必要があります。 |
TLSCertSerialNumber |
省略可能 |
System.Byte[] |
静的ルートで使用する TLS 証明書のシリアル番号。シリアル番号は、バイト配列として渡す必要があります。つまり、2 文字の値の配列として渡す必要があります。次に例を示します。-TLSCertSerialNumber 0x01, 0xA4, 0xD5, 0x67, 0x89。 トランスポート プロトコルとして TCP を構成している場合、このパラメーターは使用しません。 TLSCertSerialNumber パラメーターを使用する場合、TLSCertIssuer パラメーターも使用する必要があります。 |
UseDefaultCertificate |
省略可能 |
System.Boolean |
認証証明書として既定の Lync Server 証明書を使用するためのルートを構成します。既定の証明書を使用しない場合、TLSCertIssuer パラメーターと TLSCertSerialNumber パラメーターを使用して、別の証明書を指定する必要があります。 既定の証明書を表示するには、次のコマンドを使用します。 Get-CsCertificate | Where-Object {$_.Use -eq "urn:certref:Default"} |
入力の種類
なし。New-CsStaticRoute コマンドレットは、パイプ処理された入力を受け入れません。
戻り値の種類
New-CsStaticRoute コマンドレットを実行すると、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Route オブジェクトの新しいインスタンスが作成されます。