Set-CsClientVersionPolicyRule
トピックの最終更新日: 2012-03-26
組織用に現在構成されている 1 つ以上のクライアント バージョン ポリシー ルールを変更します。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
Set-CsClientVersionPolicyRule [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Set-CsClientVersionPolicyRule [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Action <Allow | AllowAndUpgrade | AllowWithUrl | Block | BlockAndUpgrade | BlockWithUrl>] [-ActionUrl <String>] [-BuildNumber <UInt16>] [-CompareOp <EQL | NEQ | GTR | GEQ | LSS | LEQ>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-MajorVersion <UInt16>] [-MinorVersion <UInt16>] [-Priority <Int32>] [-QfeNumber <UInt16>] [-Tenant <Guid>] [-UserAgent <String>] [-UserAgentFullName <String>] [-WhatIf [<SwitchParameter>]]
例
例 1
例 1 に示すコマンドを実行すると、ID が site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820 のクライアント バージョン ポリシーが無効にされます。ルールを無効にするため、このコマンドでは Enabled パラメーターを指定し、パラメーター値を $False にしています。
Set-CsClientVersionPolicyRule -Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820 -Enabled $False
例 2
例 2 では、Redmond サイトに割り当てられたすべてのクライアント バージョン ポリシー ルールに一般的な説明を追加します。これを行うため、このコマンドでまず、Filter パラメーターを指定して Get-CsClientVersionPolicyRule コマンドレットを呼び出します。フィルター値 "site:Redmond*" により、戻されるデータを Redmond サイトに割り当てられているポリシー ルールに制限します。次に、このコレクションを Set-CsClientVersionPolicyRule コマンドレットにパイプ処理して、このコレクション内の各項目に "Client policy rules for Redmond" という Description を割り当てます。
Get-CsClientVersionPolicyRule -Filter "site:Redmond*" | Set-CsClientVersionPolicyRule -Description "Client policy rules for Redmond"
例 3
例 3 では、ユーザー エージェントとして Unified Communications Client Platform (UCCP) を参照するすべてのクライアント バージョン ポリシー ルールで、UCCP クライアントの使用がブロックされます。このタスクを実行するため、このコマンドではまず、Get-CsClientVersionPolicyRule コマンドレットを呼び出して、現在使用中のすべてのクライアント ポリシー ルールのコレクションを取得します。次に、このコレクションを Where-Object コマンドレットにパイプ処理して、UserAgent プロパティが UCCP と等しい (-eq) ルールを選び出します。このフィルターしたコレクションを Set-CsClientVersionPolicyRule コマンドレットにパイプ処理し、コレクションの各項目を取得して Action プロパティを Block に設定します。
Get-CsClientVersionPolicyRule | Where-Object {$_.UserAgent -eq "UCCP"} | Set-CsClientVersionPolicyRule -Action "Block"
解説
クライアント バージョン ルールを使用して、Lync Server へのログオンを許可するクライアント アプリケーションを指定するために使用します。ユーザーが Lync Server へのログインを試みると、そのユーザーのクライアント アプリケーションは SIP ヘッダーをサーバーに送信します。このヘッダーには、ソフトウェアのメジャー バージョン、マイナー バージョン、ビルド番号などのアプリケーション自体の詳細な情報が含まれます。次に、バージョン情報がクライアント バージョン ルールのコレクションと照合され、その特定のアプリケーションに適用されるルールがあるかどうかが確認されます。たとえば、Microsoft Office Communicator 2007 R2 を使用してユーザーがログオンを試みるとします。ユーザーが Lync Server にログオンする前に、システムは Office Communicator 2007 R2 に適用されるクライアント バージョン ルールがあるかどうかを確認します。ルールが存在する場合、次に Lync Server はルールで特定された処理を実行します。その処理は、必ず次のいずれかになります。
Allow。ユーザーはログオンできます。
AllowAndUpgrade。ユーザーはログオンでき、使用している Communicator 2007 R2 は Lync の最新バージョンに自動的にアップグレードされます。システムを構成した方法に応じ、Microsoft Update または Windows Server Update Services のいずれかを使用してアップグレードが実行されます。
AllowWithUrl。ユーザーはログオンでき、Lync の最新バージョンをダウンロードおよびインストールできる URL を示すメッセージが表示されます。URL には、自身が作成した Web サイトを指定する必要があります。Lync Server のインストール時に、そのようなサイトは作成されません。
Block。ユーザーはログオンできません。
BlockAndUpgrade。ユーザーはログオンできませんが、使用している Communicator 2007 R2 は Lync の最新バージョンに自動的にアップグレードされます。その後、ユーザーは新しいクライアント アプリケーションを使用してログオンを試みることができます。システムを構成した方法に応じて、Microsoft Update または Windows Server Update Services のいずれかを使用してアップグレードが実行されます。
BlockWithUrl。ユーザーはログオンできませんが、Lync の最新バージョンをダウンロードおよびインストールできる URL を示すメッセージが表示されます。URL には、自身が作成した Web サイトを指定する必要があります。Lync Server のインストール時に、そのようなサイトは作成されません。
クライアント バージョン ルールはクライアント バージョン ポリシー内に集められています。これは、グローバル スコープ、サイト スコープ、サービス スコープ (レジストラー サービス)、またはユーザーごとのスコープで構成可能なポリシーです。Set-CsClientVersionPolicyRule コマンドレットにより、既存のクライアント バージョン ルールのプロパティを変更できます。
クライアント バージョン ポリシーはフェデレーション ユーザーには適用されないことに注意する必要があります。代わりに、フェデレーション ユーザーは、フェデレーション組織で使用されているクライアント バージョン ポリシーに拘束されます。たとえば、フェデレーション ユーザーが、フェデレーション組織で許可されているクライアントである、クライアント A を使用しているとします。フェデレーション組織がクライアント A の使用を許可する限り、このユーザーはそのクライアントを使用して、自組織と通信することができます。このことは、自組織のクライアント バージョン ポリシーでクライアント A の使用を禁止している場合でも同じです。自組織に適用されているクライアント バージョン ポリシーが、フェデレーション組織で使用されているクライアント バージョン ポリシーを上書きしません。
このコマンドレットを実行できるメンバー。既定では、次のグループのメンバーが、Set-CsClientVersionPolicyRule コマンドレットをローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsClientVersionPolicyRule"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Action |
省略可能 |
Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Action |
ルールがトリガーされると (つまり、指定のソフトウェアを使用してユーザーがログオンを試みると) 常に実行されるアクション。有効な値は次のとおりです。 Allow。ユーザーはログオンできます。 AllowWithUrl。ユーザーはログオンでき、Lync の最新バージョンをダウンロードおよびインストールできる URL を示すメッセージが表示されます。 AllowAndUpgrade。ユーザーはログオンでき、使用している Communicator は Lync の最新バージョンに自動的にアップグレードされます。 Block。ユーザーはログオンできません。 BlockWithUrl。ユーザーはログオンできませんが、Lync の最新バージョンをダウンロードおよびインストールできる URL を示すメッセージが表示されます。 BlockAndUpgrade。ユーザーはログオンできませんが、使用している Communicator は Lync の最新バージョンに自動的にアップグレードされます。その後、ユーザーは新しいクライアント アプリケーションを使用してログオンを試みることができます。 |
ActionUrl |
省略可能 |
System.String |
ユーザーが Lync の最新バージョンをダウンロードすることができる URL。Action を BlockWithUrl または AllowWithUrl に設定している場合、このプロパティは必須です。 |
BuildNumber |
省略可能 |
System.UInt16 |
ソフトウェアのビルド番号。たとえば、使用している Communicator がバージョン 2.0.6362.111 の場合、BuildNumber は 6362 です。ビルド番号は、開発プロセスにおけるソフトウェアの内部バージョンを表し、プレリリース バージョンではなく最終リリース バージョンを使用していることを確認するのに役立ちます。 |
CompareOp |
省略可能 |
Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.CompareOp |
ログオンを試みているクライアント ソフトウェアが、ルールで指定されているバージョンより前、後、または同時期にリリースされたものかどうかを判断するために使用される比較演算子。有効な値は次のとおりです。 EQL (等しい) NEQ (等しくない) GTR (より大きい) GEQ (以上) LSS (より小さい) LEQ (以下) |
Confirm |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
Description |
省略可能 |
System.String |
管理者は、クライアント バージョン ルールに関する追加情報を入力できます。たとえば Description には、ルールを変更する必要がある場合に連絡する担当者についての情報も含めることができます。 |
Enabled |
省略可能 |
System.Boolean |
クライアント バージョン ルールを使用するかどうかを示します。Enabled プロパティを False に設定している場合、ユーザーが指定のソフトウェアでログオンを試みると常にルールは無視されます。既定値は True です。 |
Force |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
Identity |
省略可能 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
変更するクライアント ポリシー ルールの一意の識別子。クライアント バージョン ルールの Identity は、ルールが構成されたスコープと、グローバル一意識別子 (GUID) で構成されています。これは、ルールの Identity が次のようになることを意味します。site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83。 |
Instance |
省略可能 |
ルール オブジェクト |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
MajorVersion |
省略可能 |
System.UInt16 |
ソフトウェアのメジャー バージョン。たとえば、使用している Communicator がバージョン 2.0.6362.111 の場合、MajorVersion は 2 です。メジャー バージョンは、ソフトウェアの主要リリースと同一です。 |
MinorVersion |
省略可能 |
System.UInt16 |
ソフトウェアのマイナー バージョン。たとえば、使用している Communicator がバージョン 2.0.6362.111 の場合、MinorVersion は 0 です。マイナー バージョンは、ソフトウェアの暫定リリースと同一です。 |
Priority |
省略可能 |
System.Int32 |
ルールの相対優先順位。ルールは優先順位に従って処理されます。優先順位 0 のルールが最初に処理され、優先順位 1 のルールが 2 番目に処理され、以下同様に処理されます。既に使用されている優先順位を割り当てると、新しいルールがその優先順位を使用するようになり、他のルールには相応の順位が再割り振りされます。 |
QfeNumber |
省略可能 |
System.UInt16 |
ソフトウェアの Quick Fix Engineering 番号。たとえば、使用している Communicator がバージョン 2.0.6362.111 の場合、QfeNumber は 111 です。QFE 番号は、ソフトウェアの公式リリース後に利用できるようになる、アプリケーションに対する計画された更新プログラムを表します。 |
Tenant |
省略可能 |
System.Guid |
変更するクライアント バージョン ポリシーの Office 365 テナント アカウントのグローバル一意識別子 (GUID) です。次に例を示します。 -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" 次のコマンドを実行することにより、テナントの各々についてテナント ID を返すことができます。 Get-CsTenant | Select-Object DisplayName, TenantID Windows PowerShell のリモート セッションを使用していて、Lync Online 15 のみに接続している場合、Tenant パラメーターを含める必要はありません。代わりに、接続情報に基づいてテナント ID が自動的に入力されます。Tenant パラメーターはハイブリッド展開で主に使用されます。 |
UserAgent |
省略可能 |
System.String |
ソフトウェア クライアントを識別するために使用する指定子。たとえば、OC は Communicator のユーザー エージェント指定子です。Get-CsClientVersionConfiguration コマンドレットを実行すると、各ユーザー エージェント指定子に対応するフレンドリ名を指定できます。 |
UserAgentFullName |
省略可能 |
System.String |
管理者が、ユーザー エージェントのフレンドリ名を指定できるようにします。たとえば、管理者は、エージェントを識別する目的で、ユーザー エージェント UCCP の代わりに、Microsoft Unified Communications Client という完全な名前を使えます。 |
WhatIf |
省略可能 |
System.Management.Automation.SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule オブジェクト。Set-CsClientVersionPolicyRule コマンドレットは、クライアント バージョン ルール オブジェクトのパイプ処理されたインスタンスを受け入れます。
戻り値の種類
なし。代わりに、Set-CsClientVersionPolicyRule コマンドレットは、Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule オブジェクトのインスタンスを変更します。