New-CsClientVersionPolicyRule
トピックの最終更新日: 2012-03-23
新しいクライアント バージョン ポリシー ルールを作成します。クライアント バージョン ポリシー ルールを使用すると、ユーザーが特定のクライアント アプリケーションを使用して Lync Server にログオンできるかどうかを決定できます。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
New-CsClientVersionPolicyRule -Identity <XdsIdentity> <COMMON PARAMETERS>
New-CsClientVersionPolicyRule -Parent <String> -RuleId <String> <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>] [-InMemory <SwitchParameter>] [-MajorVersion <UInt16>] [-MinorVersion <UInt16>] [-Priority <Int32>] [-QfeNumber <UInt16>] [-Tenant <Guid>] [-UserAgent <String>] [-UserAgentFullName <String>] [-WhatIf [<SwitchParameter>]]
例
例 1
例 1 は、新しいクライアント バージョン ポリシー ルールの作成方法を示しています。ポリシー ルールには、2 つの部分で構成された ID があります。アナウンスの割り当て先であるスコープと、36 文字の GUID です。新しいクライアント バージョン ポリシー ルールの ID を作成する場合、まず, .NET Framework メソッド NewGuid を使用して新しい GUID を作成する必要があります。例の最初のコマンドでこの手順を実行すると、作成された GUID は変数 $x に格納されます。
GUID を作成したら、次に New-CsClientVersionPolicyRule コマンドレットを使用して新しいルールを作成できます。このコマンドレットで、Parent (新しいルールのスコープ (site:Redmond) を表すパラメーター値を指定)、RuleId (パラメーター値 $x (新しく作成した GUID を表す) を指定)、MajorVersion (4)、および UserAgent (InHouse) の 4 つのパラメーターを使用します。この場合、UserAgent パラメーターは社内クライアント アプリケーションを表します。
$x = [guid]::NewGuid()
New-CsClientVersionPolicyRule -Parent "site:Redmond" -RuleId $x -MajorVersion 4 -UserAgent InHouse
例 2
例 2 のコマンドは、例 1 のコマンドの変化形です。ただし、この場合、最初は新しいルールがメモリ内にのみ作成され、後で Lync Server に追加されます。このタスクを実行するために、この例の最初のコマンドは ID の GUID 部分を作成します。2 つ目のコマンドでは、メモリ内専用の新しいクライアント バージョン ポリシー ルールが作成されます。InMemory パラメーターにより、このルールはメモリ内にのみ存在し、すぐには Lync Server インフラストラクチャに追加されません。例 1 と同様に、Parent パラメーターと RuleId パラメーターを使用して、新しいルールのスコープと GUID を指定しています。これらは、ルール ID を構成する 2 つの要素です。
仮のルールを作成したら、次の 2 つのコマンドを使用して MajorVersion プロパティと UserAgent プロパティにそれぞれ値を割り当てます。それらのタスクが完了したら、例の最後のコマンド (および Set-CsClientVersionPolicyRule コマンドレット) を使用して、実際のクライアント バージョン ポリシー ルールを作成し、そのルールを Redmond サイトに割り当てます。
$x = [guid]::NewGuid()
$z = New-CsClientVersionPolicyRule -Parent "site:Redmond" -RuleId $x -InMemory
$z.MajorVersion = 4
$z.UserAgent = "Inhouse"
Set-CsClientVersionPolicyRule -Instance $z
解説
クライアント バージョン ルールは、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 のインストール時に、そのようなサイトは自動作成されません。
クライアント バージョン ポリシー ルールはクライアント バージョン ポリシー内に集められています。これは、グローバル スコープ、サイト スコープ、サービス スコープ (レジストラー サービス)、またはユーザーごとのスコープで構成可能なポリシーです。新しいクライアント バージョン ルールを作成するには、New-CsClientVersionPolicyRule コマンドレットを使用します。新しいルールを作成する際に、そのルールの ID も指定する必要があります。この ID は、スコープ (site:Redmond など) とグローバル一意識別子 (GUID) で構成されます。ID を独自に組み合わせることも、スコープ (Parent パラメーター) と GUID (RuleId パラメーター) を指定し、New-CsClientVerisonPolicyRule コマンドレットを実行して ID を作成することもできます。
クライアント バージョン ポリシーがフェデレーション ユーザーに適用されないことに注意してください。代わりに、フェデレーション ユーザーは、自分自身の組織で使用されているクライアント バージョン ポリシーに拘束されます。たとえば、フェデレーション ユーザーが、フェデレーション組織で許可されてるクライアントであるクライアント A を使用しているとします。フェデレーション組織がクライアント A の使用を許可している限り、このユーザーはそのクライアントを使用して、自組織と通信することができます。このことは、自組織のクライアント バージョン ポリシーでクライアント A の使用を禁止している場合でも同じです。自組織に適用されているクライアント バージョン ポリシーは、フェデレーション組織で使用されているクライアント バージョン ポリシーを上書きしません。
このコマンドレットを実行できるメンバー。既定では、次のグループのメンバーは New-CsClientVersionPolicyRule コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets -match "New-CsClientVersionPolicyRule"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Identity |
必須 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
作成するクライアント バージョン ポリシー ルールの一意の識別子。クライアント バージョン ポリシー ルールの ID は、ルールが構成されたスコープと、グローバル一意識別子 (GUID) で構成されています。これは、ルールの Identity が次のようになることを意味します。site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83。 Identity パラメーターを使用する代わりに、New-CsClientVerisonPolicyRule コマンドレットで ID を作成するときに Parent と RuleId の各パラメーターを使用することもできます。 |
Parent |
必須 |
System.String |
新しいルールのスコープ情報。Parent パラメーターを使用してグローバル ポリシーの新しいルールを作成するには、次の構文を使用します。-Parent global。サイト ポリシーの新しいルールを作成するには、次のような構文を使用します。-Parent "site:Redmond"。サービス ポリシーの新しいルールを作成するには、次のような構文を使用します。-parent "Registrar:atl-cs-001.litwareinc.com"。ユーザーごとのポリシーの新しいルールを作成するには、次のような構文を使用します。-Parent "RedmondClientVersionPolicy"。 新しいルールを作成する際には、Identity パラメーターを使用するか、または Parent パラメーターと RuleId パラメーターの両方を使用する必要があります。 |
RuleId |
必須 |
System.String |
ルールのグローバル一意識別子 (GUID)。Windows PowerShell では、次のコマンドを使用して GUID を作成できます。 $x = [guid]::NewGuid() |
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 |
管理者は、クライアント バージョン ルールに関する追加情報を指定できます。たとえば、ルールを変更する必要があると思われる場合に、説明に連絡先に関する情報を含めることができます。 |
Enabled |
省略可能 |
System.Boolean |
クライアント バージョン ルールを使用するかどうかを指定します。Enabled プロパティを False ($False) に設定している場合、ユーザーが指定のソフトウェアでログオンしようとすると常にルールは無視されます。既定値は True です。 |
Force |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
InMemory |
省略可能 |
System.Management.Automation.SwitchParameter |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
MajorVersion |
省略可能 |
System.UInt16 |
ソフトウェアのメジャー バージョン。たとえば、使用している Communicator がバージョン 2.0.6362.111 の場合、MajorVersion は 2 です。メジャー バージョンは、ソフトウェアの主要リリースと同一です。新しいルールを作成するときは必ず、MajorVersion プロパティに値を割り当てる必要があります。 |
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 のユーザー エージェント指定子です。 |
UserAgentFullName |
省略可能 |
System.String |
管理者が、ユーザー エージェントのフレンドリ名を指定できるようにします。たとえば、管理者は、エージェントを識別する目的で、ユーザー エージェント UCCP の代わりに、Microsoft Unified Communications Client という完全な名前を使えます。 |
WhatIf |
省略可能 |
System.Management.Automation.SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
入力の種類
なし。New-CsClientVersionPolicyRule コマンドレットはパイプライン入力を受け付けません。
戻り値の種類
New-CsClientVersionPolicyRule コマンドレットを実行すると、Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule オブジェクトの新しいインスタンスが作成されます。