New-CsVoiceRoute
トピックの最終更新日: 2012-03-26
新しいボイス ルートを作成します。ボイス ルートには、エンタープライズ VoIP ユーザーからの呼び出しを公衆交換電話網 (PSTN) または構内交換機 (PBX) の電話番号へルーティングする方法についての Microsoft Lync Server 2010 に対する指示が含まれます。
構文
New-CsVoiceRoute -Identity <XdsGlobalRelativeIdentity> [-AlternateCallerId <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-NumberPattern <String>] [-Priority <Int32>] [-PstnGatewayList <PSListModifier>] [-PstnUsages <PSListModifier>] [-SuppressCallerId <Nullable>] [-WhatIf [<SwitchParameter>]]
New-CsVoiceRoute -Name <String> [-AlternateCallerId <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-NumberPattern <String>] [-Priority <Int32>] [-PstnGatewayList <PSListModifier>] [-PstnUsages <PSListModifier>] [-SuppressCallerId <Nullable>] [-WhatIf [<SwitchParameter>]]
解説
新しいボイス ルートを作成する場合は、このコマンドレットを使用します。すべてのボイス ルートはグローバル スコープで作成されます。ただし、複数のグローバル ボイス ルートを定義することができます。これは、一意のルート名を必要とする Identity パラメーターによって定義できます。
ボイス ルートは、PSTN 使用法によって音声ポリシーに関連付けられます。ボイス ルートには、指定のボイス ルート経由でルーティングされる電話番号を識別する正規表現が含まれます。正規表現に一致する電話番号が、そのルートを介してルーティングされます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが、New-CsVoiceRoute コマンドレットをローカルでの実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsVoiceRoute"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
XdsIdentity |
ボイス ルートを一意に識別する名前です。ボイス ルートはグローバル スコープでのみ定義できるため、ID がそのままルートの名前になります(ルート名には Test Route などのようにスペースを入れることができますが、New-CsVoiceRoute を呼び出す際にはすべての文字列を二重引用符で囲む必要があります)。 Identity が指定されている場合は、名前は空白にしておく必要があります。Identity の値が名前に割り当てられます。 |
Name |
必須 |
文字列 |
ボイス ルートの一意の名前です。このパラメーターが設定されていると、その値が自動的にボイス ルート ID に適用されます。ID と名前を両方指定することはできません。 |
AlternateCallerId |
省略可能 |
文字列 |
SuppressCallerId パラメーターが True に設定されていると、発信者の実際の番号ではなく AlternateCallerId パラメーターの値が受信者側に対して表示されます。この番号は有効な番号である必要があり、サポートや人事など組織内の部署を示す場合もあります。 SuppressCallerId パラメーターが False に設定されていると、AlternateCallerId パラメーターは無視されます。 この値は、正規表現 (\+)?[1-9]\d*(;ext=[1-9]\d*)? に一致する必要があります。つまり、この値の頭に正符号 (+) が付く場合はありますが、必ずしも正符号が付いている必要はありません。この値は任意の数の数字で構成され、その後に内線番号を付けることができます。この内線番号は、;ext= およびその後に続く任意の数の数字で構成されます(内線番号を追加する場合、その文字列を二重引用符で囲む必要がありますので注意してください)。 |
Description |
省略可能 |
文字列 |
このボイス ルートの目的の説明です。 |
NumberPattern |
省略可能 |
文字列 |
このルートの適用する電話番号を指定する正規表現です。このパターンと一致する番号が、残りのルーティング設定に従ってルーティングされます。 既定値は次のとおりです。[0-9]{10} |
Priority |
省略可能 |
Int32 |
番号が複数のボイス ルートに解決される場合があります。複数のルートが利用可能な場合、この優先度によって、適用されるルートの順序が決定されます。 |
PstnGatewayList |
省略可能 |
PSListModifier |
Lync Server 2010 では、仲介サーバー は複数のゲートウェイに関連付けることができます。このパラメーターには、このボイス ルートに関連付けられているゲートウェイの一覧が含まれます。この一覧の各メンバーは、PSTN ゲートウェイか 仲介サーバー のサービス ID である必要があります。この値が 仲介サーバー を参照できるのは、仲介サーバー が Microsoft Office Communications Server 2007 または Microsoft Office Communications Server 2007 R2 に対して構成されている場合に限ります。Lync Server 2010 の場合、PSTN ゲートウェイを使用する必要があります。サービス ID は、<ServiceRole>:<FQDN> という形式の文字列です。ServiceRole はサービス ロール名 (PSTNGateway)、FQDN はサーバーのプールまたは IP アドレスの完全修飾ドメイン名 (FQDN) です。たとえば、PSTNGateway:redmondpool.litwareinc.com です。サービス ID は、Get-CsService | Select-Object Identity コマンドを呼び出すと取得できます。 既定では、この一覧は空です。ただし、新しいボイス ルートを作成する場合にこのパラメーターを空白のままにすると、警告メッセージが表示されます。 |
PstnUsages |
省略可能 |
PSListModifier |
このボイス ルートに適用できる (ローカルや市外通話などの) PSTN 使用法一覧。PSTN 使用法は、既存の使用法である必要があります(PSTN 使用法は、Get-CsPstnUsage コマンドレットを呼び出すことで取得できます)。 既定では、この一覧は空です。ただし、新しいボイス ルートを作成する場合にこのパラメーターを空白のままにすると、警告メッセージが表示されます。 |
SuppressCallerId |
省略可能 |
ブール値 |
発信通話で発信者 ID を表示するかどうかを決定します。このパラメーターが True に設定されていると、発信者 ID が表示されません。実際の ID の代わりに AlternateCallerId の値が表示されます。SuppressCallerId を True に設定する場合は、AlternateCallerId に値を指定する必要があります。 |
Force |
省略可能 |
SwitchParameter |
変更を行う前に表示されるように設定されているすべての確認メッセージを表示しないようにします。 |
InMemory |
省略可能 |
SwitchParmeter |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
WhatIf |
省略可能 |
SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
文字列 |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
なし。
戻り値の種類
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route 型のオブジェクトを作成します。
例
-------------------------- 例 1 --------------------------
New-CsVoiceRoute -Identity Route1
この例のコマンドを実行すると、Route1 という ID を持つ新しいボイス ルートが作成されます。その他のプロパティはすべて既定値に設定されます。
-------------------------- 例 2 --------------------------
New-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"} -PstnGatewayList @{add="PstnGateway:redmondpool.litwareinc.com"}
この例のコマンドを実行すると、Route1 という ID を持つ新しいボイス ルートが作成されます。また、使用法の一覧に PSTN 使用法 (市外通話) が、PSTN ゲートウェイの一覧にサービス ID PstnGateway:redmondpool.litwareinc.com が追加されます。
-------------------------- 例 3 --------------------------
$x = (Get-CsPstnUsage).Usage
New-CsVoiceRoute -Identity Route1 -PstnUsages @{add=$x}
この例では、Route1 という新しいボイス ルートを作成し、そのルートの PSTN 使用法の一覧を、組織の既存のすべての使用法に設定しています。この例では、1 番目のコマンドを実行してグローバル PSTN の使用法一覧を取得しています。Get-CsPstnUsage の呼び出しがかっこで囲まれていることに注意してください。これは、PSTN 使用法の情報が含まれるオブジェクトを最初に取得することを示しています(グローバルの PSTN 使用法が 1 つしかないため、取得するオブジェクトは 1 つだけです)。次に、このオブジェクトの Usage プロパティを取得しています。このプロパティには使用法の一覧が含まれており、変数 $x に割り当てられます。この例では、2 行目で New-CsVoiceRoute を呼び出して新しいボイス ルートを作成しています。このボイス ルートの ID は Route1 となります。PstnUsages パラメーターに渡される値 @{add=$x} に注意してください。この値により、$x の内容をこのルートの PSTN 使用法の一覧に追加するよう指示しています。$x には、行 1 で取得した電話使用法の一覧が含まれます。