Set-CsAddressBookConfiguration
トピックの最終更新日: 2012-03-25
既存のアドレス帳構成設定のコレクションを変更します。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
Set-CsAddressBookConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Set-CsAddressBookConfiguration [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-EnableFileGeneration <$true | $false>] [-EnableSearchByDialPad <$true | $false>] [-Force <SwitchParameter>] [-IgnoreGenericRules <$true | $false>] [-KeepDuration <UInt32>] [-MaxDeltaFileSizePercentage <UInt32>] [-MaxFileShareThreadCount <Int32>] [-RunTimeOfDay <DateTime>] [-SynchronizePollingInterval <TimeSpan>] [-UseNormalizationRules <$true | $false>] [-WhatIf [<SwitchParameter>]]
例
例 1
この例では、アドレス帳の同期を行う時刻を指定する RunTimeOfDay プロパティを 23:00 (午後 11 時の 24 時間形式表記) に設定します。Identity パラメーターを使用して、Identity が site:Redmond のアドレス帳構成設定のみが変更されるようにしています。
Set-CsAddressBookConfiguration -identity site:Redmond -RunTimeOfDay 23:00
例 2
例 2 では、サイト スコープで構成されているすべてのアドレス帳設定のコレクションの RunTimeOfDay プロパティを、午後 11 時 (23:00) に設定します。これを実行するため、コマンドはまず Get-CsAddressBookConfiguration コマンドレットと Filter パラメーターを使用して、すべてのサイト固有の設定のコレクションを戻します。フィルター値 "site:*" は、戻されるデータをサイト スコープで構成されているコレクションに制限します。次に、この情報を Set-CsAddressBookConfiguration コマンドレットにパイプ処理し、コレクションの各項目の RunTimeOfDay プロパティの値を変更します。
Get-CsAddressBookConfiguration -Filter site:* | Set-CsAddressBookConfiguration -RunTimeOfDay 23:00
例 3
例 3 では、KeepDuration プロパティが 30 日未満であるすべてのアドレス帳の設定のコレクションに含まれる KeepDuration プロパティを変更しています。このタスクを実行するため、パラメーターなしで Get-CsAddressBookConfiguration コマンドレットを使用し、組織内で使用するように構成されているすべてのアドレス帳の設定のコレクションを戻します。次に、このコレクションを Where-Object コマンドレットへパイプ処理し、KeepDuration プロパティが 30 日未満の設定のみを選択します。さらに、このフィルターされたコレクションを Set-CsAddressBookConfiguration コマンドレットにパイプ処理し、コレクションの各項目の KeepDuration プロパティの値を 30 日に変更します。
Get-CsAddressBookConfiguration | Where-Object {$_.KeepDuration -lt 30} | Set-CsAddressBookConfiguration -KeepDuration 30
解説
アドレス帳サーバーは、AD DS と Lync Server の間の仲介役です。アドレス帳サーバーは、Lync Server に保存されているユーザー情報と AD DS に保存されているユーザー情報の同期が保たれるようにします。このために、アドレス帳ファイルと ユーザー データベース に保存されている情報を定期的に同期します。
また、アドレス帳サーバーは、Lync を実行しているコンピューターにダウンロードされるインデックス ファイルを定期的に生成します。ユーザーが連絡先を検索する際は、このインデックス ファイルまたは 中央管理ストア に保存されているアドレス帳インデックス ファイルのどちらかを使って検索します。
アドレス帳サーバーの管理は、アドレス帳構成設定を使って行います。この設定では、アドレス帳ファイルとユーザー データベースの同期頻度や、アドレス帳インデックス ファイルの生成頻度などを指定します。Lync Server をインストールするときに、一連のグローバル アドレス帳設定が作成されます。個別のサイトに適用できるカスタム構成設定を作成することもできます。カスタム構成設定が存在する場合は、その設定がサイト内で稼働しているすべてのアドレス帳サーバーに対して適用され、グローバル設定よりも優先されます。
Set-CsAddressBookConfiguration コマンドレットでは、組織で現在使用されている任意のアドレス帳構成設定のコレクションを変更することができます。
このコマンドレットを実行できるユーザー: 既定では、Set-CsAddressBookConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalServerAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsAddressBookConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Confirm |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
EnableFileGeneration |
省略可能 |
System.Boolean |
True (既定値) に設定すると、クライアントでダウンロード可能なアドレス帳インデックス ファイルが、アドレス帳サーバーにより生成されます。False に設定すると、このインデックス ファイルは生成されません。この場合、クライアント アプリケーションで連絡先を検索する際には、アドレス帳 Web クエリ サービス を使用する必要があります。 |
EnableSearchByDialPad |
省略可能 |
System.Boolean |
True に設定されている場合、モバイル ユーザーは電話のキーパッドを使用して連絡先を検索できます。 |
Force |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
Identity |
省略可能 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
アドレス帳設定のコレクションに割り当てられた一意の識別子です。グローバル設定を参照するには、次の構文を使用します。-Identity global。サイト スコープで構成されるコレクションを参照するには、次のような構文を使用します。-Identity site:Redmond。Identity を指定する場合、ワイルドカード文字を使用することはできません。 このパラメーターが省略されている場合、Set-CsAddressBookConfiguration コマンドレットはグローバル設定を変更します。 |
IgnoreGenericRules |
省略可能 |
System.Boolean |
アドレス帳サーバーで電話番号を解析する際に、汎用正規化ルールを無視するかどうかを示します。汎用規則とは、Lync Server に組み込まれているルールです。このルールを変更することはできませんが、このプロパティの値を True に設定することで、アドレス帳サーバーがこのルールを無視し、独自に作成したカスタム ルールを使用するように指定できます。既定値は False です。 |
Instance |
省略可能 |
AddressBookSettings オブジェクト |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
KeepDuration |
省略可能 |
System.UInt32 |
アドレス帳サーバーが変更ファイルを保持する時間 (日数) を指定します。KeepDuration プロパティの値よりも古い変更ファイルは削除されます。KeepDuration には 1 ～ 90 の範囲の任意の整数値を設定できます。既定値は 30 日です。 |
MaxDeltaFileSizePercentage |
省略可能 |
System.UInt32 |
Active Directory に変更 (Lync Server に対して新しいユーザーを有効にするなど) が行われると、通常、アドレス帳サーバーはこれらの変更を "差分ファイル" に記録します。差分ファイルは、更新された情報のみを含むファイルです。Lync は、完全なアドレス帳ファイルではなく、差分ファイルをダウンロードできます。MaxDeltaFileSizePercentage プロパティにより、差分ファイルが完全なアドレス帳ファイルに組み込まれるまでの、差分ファイルのサイズを決定できます。既定では、新しいアドレス帳ファイルが生成されるまでに、完全なアドレス帳ファイルの 20 パーセントまで差分ファイルのサイズを増加させることができます。そのサイズに達すると、Lync クライアントは、差分ファイルではなく、完全なファイルをダウンロードします。 MaxDeltaFileSizePercentage には、1 ～ 100 の範囲のパーセント値を入力する必要があります。 |
MaxFileShareThreadCount |
省略可能 |
System.Int32 |
ファイル共有に割り当てられたスレッドの最大数です。スレッドを増やすとパフォーマンスが向上しますが、同時に他のプロセスで利用できるリソースが少なくなります。 |
RunTimeOfDay |
省略可能 |
System.DateTime |
サーバーが新しいアドレス帳ファイルを生成する時刻を指定します。RunTimeOfDay プロパティでは 24 時間形式 (時 : 分 : 秒) を使用します。00:00:00 は深夜 0 時を表し、23:59:00 は午後 11 時 59 分を表します。 既定値は 01:30:00 (午前 1 時 30 分) です。 |
SynchronizePollingInterval |
省略可能 |
System.TimeSpan |
アドレス帳サーバーが ユーザー データベース に格納されている情報との同期を行う頻度を示します。SynchronizePollingInterval には、5 秒間 (00:00:05) から 3 時間 (03:00:00) の間の任意の値を設定できます。既定値は 5 分 (00:05:00) です。 |
UseNormalizationRules |
省略可能 |
System.Boolean |
電話番号の取得時に、アドレス帳サーバーが電話正規化ルールを使用する必要があるかどうかを示します。False に設定した場合、電話番号はそのままの状態で取得され、これらの番号を表示するときに正規化ルールを適用するかどうかはクライアント アプリケーションに依存します。 既定値は True です。 |
WhatIf |
省略可能 |
System.Management.Automation.SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings オブジェクトです。Set-CsAddressBookConfiguration コマンドレットは、アドレス帳構成オブジェクトのパイプ処理による入力を受け入れます。
戻り値の種類
Set-CsAddressBookConfiguration コマンドレットは、値またはオブジェクトを戻しません。代わりに、Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings オブジェクトのインスタンスを構成します。