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