New-CsServerApplication
トピックの最終更新日: 2012-03-26
新しいサーバー アプリケーションを作成します。サーバー アプリケーションは、Microsoft Lync Server 2010 によってホストされるアプリケーションです。
構文
New-CsServerApplication -Identity <XdsIdentity> -Uri <String> [-Confirm [<SwitchParameter>]] [-Critical <$true | $false>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Priority <Int32>] [-ScriptName <String>] [-WhatIf [<SwitchParameter>]]
New-CsServerApplication -Name <String> -Parent <String> -Uri <String> [-Confirm [<SwitchParameter>]] [-Critical <$true | $false>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Priority <Int32>] [-ScriptName <String>] [-WhatIf [<SwitchParameter>]]
解説
サーバー アプリケーションは Microsoft Lync Server 2010 の下で実行する個々のプログラムを参照します。New-CsServerApplication コマンドレットを実行すると、管理者は新しいサーバー アプリケーションを構成できます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが、New-CsServerApplication コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsServerApplication"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Identity |
省略可能 |
Xds Identity |
作成するサーバー アプリケーションの一意の識別子です。サーバー アプリケーションの Identity は、アプリケーションをホストしているサービスとアプリケーション名から構成されます。たとえば、QoEAgent という名前のサーバー アプリケーションは、次のような Identity を持ちます。service:Registrar:atl-cs-001.litwareinc.com/QoEAgent。 |
Parent |
必須 |
文字列 |
新しいサーバー アプリケーションをホストするサービスを指定します。Identity パラメーターを使用する場合、アプリケーションの Identity は Parent プロパティおよび Name プロパティの値の組み合わせであるため、Parent パラメーターまたは Name パラメーターを使用する必要はありません。ただし、代わりに Parent および Name パラメーターを使用する場合は、Identity パラメーターを省略することができます。この場合、Parent パラメーターは次のようにする必要があります。-Parent "Registrar:atl-cs-001.litwareinc.com" |
Name |
必須 |
文字列 |
サービスのフレンドリ名です。Identity パラメーターを使用する場合、新しいサービスを作成するときに Name パラメーターを指定する必要はありません。代わりに、アプリケーション Identity の名前部分を使用して Name プロパティが設定されます。たとえば、service:Registrar:atl-cs-001.litwareinc.com/TestService という Identity を持つ新しいアプリケーションを作成すると、アプリケーションの名前は自動的に TestService になります。Name パラメーターは、Parent パラメーターを使用する場合にのみ必要です。 |
Uri |
必須 |
文字列 |
アプリケーションの一意の Uniform Resource ID (URI)。たとえば、QoEAgent アプリケーションの URI は、https://www.microsoft.com/LCS/QoEAgent になります。 |
Enabled |
省略可能 |
ブール値 |
アプリケーションを有効にするには、この値を True に設定します。アプリケーションを無効にする場合は、値を False に設定します。このパラメーターを指定しない場合は、Enabled プロパティが False に設定され、新しいアプリケーションは無効になります。 |
Critical |
省略可能 |
ブール値 |
True に設定すると、当該アプリケーションが起動するまで、Lync Server は起動しません。False に設定すると、Lync Server は、アプリケーションが起動しているかどうかに関係なく、起動します。このパラメーターを指定しない場合は、Critical プロパティが True に設定されます。 |
ScriptName |
省略可能 |
文字列 |
アプリケーションによって使用される Microsoft SIP 処理言語 (MSPL) スクリプトへのパス (該当する場合)。MSPL は SIP メッセージのフィルター処理およびルーティング用に使用されるスクリプト言語です。 |
Priority |
省略可能 |
整数 |
サーバー アプリケーションの実行順序を指定します。優先度 0 のアプリケーションが最初に開始され、次に優先度 1 のアプリケーションが開始され、以降も同様に開始されます。なお、サーバー アプリケーションをホストする各サービスには、一意の優先度のセットが付与されます。たとえば、レジストラー サービスで 3 つのアプリケーションをホストしていて、各アプリケーションに優先順位 0、1、および 2 が付いている場合があります。同様に、エッジ サーバー サービスには 4 つのアプリケーションがあり、それぞれ、優先順位 0、1、2、および 3 が付いている場合があります。 優先度を指定しない場合、そのアプリケーションは、自動的に優先度のリストの最下位に追加されます。アプリケーションを追加または削除した場合、それに従って他のアプリケーションの優先度が調整されます。たとえば、優先度 0 のアプリケーションを削除した場合、以前は優先度が 1 であったアプリケーションの優先度が自動的に 0 に設定されます。 |
InMemory |
省略可能 |
スイッチ パラメーター |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
なし。New-CsServerApplication は、パイプライン処理された入力を受け入れません。
戻り値の種類
New-CsServerApplication を実行すると、Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application オブジェクトの新しいインスタンスが作成されます。
例
-------------------------- 例 1 ------------------------
New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" -Uri http://www.litwareinc.com/edgemonitor -Critical $False
例 1 では、EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor という Identity を持つ新しいサーバー アプリケーションを作成します。Identity を指定する以外に、パラメーター Uri および Critical を指定します。これらのパラメーターを使用して、アプリケーション URI を指定し、アプリケーションが重要と見なされないよう指定します。
-------------------------- 例 2 ------------------------
$x = New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" -InMemory
$x.Uri = "http://www.litwareinc.com/edgemonitor"
$x.Critical = $False
Set-CsServerApplication -Instance $x
例 2 のコマンドは、最初はメモリ内にのみ存在する新しいサーバー アプリケーションを作成する方法を示しています。これを実行するために、最初のコマンドは、New-CsServerApplication を次の 2 つのパラメーターと共に呼び出します。Identity (アプリケーションの Identity を指定します)、および InMemory (新しいアプリケーションをメモリ内のみに作成する必要があることを示します)。結果のサーバー アプリケーション オブジェクトは、変数 $x に格納されます。
この仮想サーバー アプリケーションを作成した後で、コマンド 2 および 3 を使用して、Uri プロパティおよび Critical プロパティの値をそれぞれ変更します。最後に、コマンド 4 を使用して、仮想サーバー アプリケーションを実際のサーバー アプリケーションに変換します。この最後のコマンドは必須であることに注意してください。Set-CsServerApplication を呼び出さない場合は、EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor にアプリケーションが構成されないため、Windows PowerShell セッションを終了するか変数 $x を削除するとすぐに、仮想アプリケーションが失われます。