Set-CsDeviceUpdateConfiguration
トピックの最終更新日: 2012-03-26
デバイス更新 Web サービス構成設定のコレクションを変更します。これらの設定を使用して、Microsoft Lync Server 2010 のコンポーネントである デバイス更新 Web サービス を管理します。管理者は、このコンポーネントを使用して、Microsoft Lync 2010 Phone Edition を実行している電話などのデバイスにファームウェア更新プログラムを配布できます。
構文
Set-CsDeviceUpdateConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-LogCleanUpInterval <TimeSpan>] [-LogCleanUpTimeOfDay <Nullable>] [-LogFlushInterval <TimeSpan>] [-MaxLogCacheLimit <UInt32>] [-MaxLogFileSize <UInt32>] [-ValidLogFileExtensions <PSListModifier>] [-ValidLogFileTypes <PSListModifier>] [-WhatIf [<SwitchParameter>]]
Set-CsDeviceUpdateConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-LogCleanUpInterval <TimeSpan>] [-LogCleanUpTimeOfDay <Nullable>] [-LogFlushInterval <TimeSpan>] [-MaxLogCacheLimit <UInt32>] [-MaxLogFileSize <UInt32>] [-ValidLogFileExtensions <PSListModifier>] [-ValidLogFileTypes <PSListModifier>] [-WhatIf [<SwitchParameter>]]
解説
デバイス更新 Web サービスを使用することにより、管理者は、Microsoft Lync 2010 Phone Editionが実行されているデバイスにファームウェアの更新を配布できます。管理者は、定期的にデバイス更新ルールのセットを Microsoft Lync Server 2010 にアップロードします。テストされて承認されたルールは、該当するデバイスがシステムに接続するとき、それらのデバイスに適用することができます。デバイスは、電源がオンになったときに最初に更新があるかどうかを確認し、その後ユーザーがログオンするときに再び確認します。その後デバイスは、24 時間ごとに更新があるかどうかを確認します。
デバイス更新の構成設定は、グローバル スコープまたはサイト スコープのいずれかで適用できます。Set-CsDeviceUpdateConfiguration コマンドレットを使用することにより、設定のコレクションに変更を加えることができます。たとえば、このコマンドレットを使用して、ログ ファイルがシステムによって自動的に削除されるまでの保持時間の長さを変更できます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Set-CsDeviceUpdateConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsDeviceUpdateConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
Xds Identity |
変更するデバイス更新の構成設定の一意の識別子です。グローバル設定を参照するには、次の構文を使用します。-Identity global。サイト設定を参照するには、次のような構文を使用します。-Identity "site:Redmond"。Identity 指定時はワイルドカードを使用できないことに注意してください。 |
Instance |
省略可能 |
DeviceUpdateSettings オブジェクト |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
LogCleanUpInterval |
省略可能 |
Timespan |
システムによって削除されるまでの間、デバイス更新のログ ファイルを保持する時間を指定します。 値は dd.hh:mm:ss の形式で入力する必要があります。dd は日、hh は時間、mm は分、ss は秒を表します。日数のみを入力する場合は、数値の後に続けてピリオド (.) を入力する必要があります。 最小値: 1.00:00:00 (1 日) 最大値: 365.00:00:00 (1 年) 既定値は次のとおりです。10.00:00:00 (10 日間) |
LogCleanUpTimeOfDay |
省略可能 |
DateTime |
削除する期限切れのログ ファイルがあるかどうかをシステムがチェックする時刻を示します (期限切れのログ ファイルは LogCleanupInterval プロパティによって指定された値よりも古いファイルです)。 LogCleanupTimeOfDay パラメーターに渡される値は、24 時間形式の hh:mm にする必要があります。hh は時を表し、mm は分を表します。この形式では、午前 0 時を 00:00、午前 8:30 を 08:30、および午後 11:52 を 23:52 として表記します。 |
LogFlushInterval |
省略可能 |
TimeSpan |
ログ ファイルのキャッシュに格納されている情報が、実際のログ ファイルに書き込まれる頻度を示します。既定では、デバイス更新情報はすぐにはログ ファイルに書き込まれません。代わりにこの情報は、次の状態になるまでキャッシュに格納されます。1) ログのフラッシュ時間間隔が経過するか、2) キャッシュが最大サイズに達した場合。この値が 10 分 (00:10:00) に設定されている場合、キャッシュの情報は 10 分ごとにログ ファイルに書き込まれます。データがログに書き込まれた後、キャッシュはクリアされます。 値は hh:mm:ss の形式で入力する必要があります。hh は時間、mm は分、ss は秒を表します。 最小値: 00:01:00 (1 分) 最大値: 01:00:00 (1 時間) 既定値は次のとおりです。00:05:00 |
MaxLogCacheLimit |
省略可能 |
整数 |
キャッシュのクリアが必要となりデータがログ ファイルに書き込まれるまでに、ログ ファイルのキャッシュに保持できる情報の最大サイズ (バイト) を示します。既定では、5 分ごとにログ ファイルが "フラッシュ" されます (詳細については、LogFlushInterval パラメーターの説明を参照してください)。ただし、キャッシュが最大サイズに達した場合、ログのフラッシュ間隔が経過していなくても、キャッシュ内の情報は自動的にログ ファイルに書き込まれ、キャッシュはクリアされます。 既定値は次のとおりです。512000 |
MaxLogFileSize |
省略可能 |
整数 |
各ログ ファイルの最大サイズをバイト単位で示します。ファイルが最大サイズに達すると、次のデータの集合が自動的に新しいログ ファイルに書き込まれます。ログのクリーンアップ間隔が経過するまで、古いログ ファイルは保持されます。 既定値は次のとおりです。1024000 |
ValidLogFileExtensions |
省略可能 |
PSListModifier |
デバイス更新 Web サービスで使用できる有効なログ ファイルの拡張子を示します。このリストは変更可能ですが、ファイル拡張子が異なるログ ファイルを作成する Lync 2010 Phone Edition 互換デバイスを使用していない限り、変更する必要はありません。 既定値は次のとおりです。.dmp, .clg, .clg2, .bak, .kdmp, .dat, .bin, .cat, .xml, .txt, .hex |
ValidLogFileTypes |
省略可能 |
PSListModifier |
デバイス更新システムによって保持されるログ ファイルの種類を示します。既定のファイルの種類には、次のものがあります。 Watson。システム クラッシュ イベント時にデバイスによって自動的に生成されるログ ファイル。 Config。RoundTable デバイス を構成するときに毎回作成される Microsoft RoundTable 会議デバイス デバイスのプロファイル。 DiagLog。RoundTable デバイスの自己診断データ。 CELog。動作テストの結果と一緒に重要なシステム イベントのレコードが記録される Lync 2010 Phone のログ。 異なる種類のログ ファイルを作成する Lync 2010 Phone Edition 互換デバイスを使用する場合は、それ以外のファイルの種類を追加できます。また、ファイルを削除することもできます。たとえば、CELog ファイルを保存しない場合は、CELog ファイルを削除できます。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration オブジェクト。Set-CsDeviceUpdateConfiguration は、デバイス更新構成オブジェクトのパイプライン処理されたインスタンスを受け入れます。
戻り値の種類
Set-CsDeviceUpdateConfiguration は、値またはオブジェクトを戻しません。代わりに、このコマンドレットは、Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration オブジェクトのインスタンスを構成します。
例
-------------------------- 例 1 --------------------------
Set-CsDeviceUpdateConfiguration -Identity global -MaxLogFileSize 2048000 -MaxLogCacheLimit 1024000
例 1 は、Set-CsDeviceUpdateConfiguration を使用してグローバル構成設定を変更する方法を示しています。この場合は、2 つのプロパティの値を変更しています。MaxLogFileSize プロパティを 2048000 バイトに、MaxLogCacheLimit プロパティを 1024000 バイトに設定しています。
-------------------------- 例 2 --------------------------
Set-CsDeviceUpdateConfiguration -Identity site:Redmond -LogFlushInterval 00:02:00
上記のコマンドでは、site:Redmond という Identity を持つデバイス更新の構成設定の LogFlushInterval プロパティを変更しています。これを実行するため、Identity パラメーターを使用して Redmond サイトでの設定を指定し、LogFlushInterval パラメーターを使用して変更するプロパティの値を示します。この例では、LogFlushInterval を 2 分に設定しています (00 時間: 02 分: 00 秒)。
-------------------------- 例 3 --------------------------
Get-CsDeviceUpdateConfiguration | Set-CsDeviceUpdateConfiguration -LogCleanUpInterval 14.00:00:00
例 3 では、組織内のすべてのデバイス更新の構成設定を変更して、LogCleanUpInterval を 14 日に設定しています。これを実行するため、まず Get-CsDeviceUpdateConfiguration を使用して、現在使用中のデバイス更新の構成設定すべてのコレクションを取得します。次に、このコレクションを Set-CsDeviceUpdateConfiguration にパイプ処理します。このコマンドレットでは、LogCleanUpInterval パラメーターを使用して、コレクション内の項目ごとにログのクリーンアップ間隔時間を 14 日に設定します (14 日。00 時間: 00 分: 00 秒)。
-------------------------- 例 4 --------------------------
Get-CsDeviceUpdateConfiguration -Filter "site:*" | Set-CsDeviceUpdateConfiguration -LogCleanUpInterval 20.00:00:00
例 4 は、サイト スコープで構成されているすべてのデバイス更新の構成設定のプロパティの値を変更する方法を示しています。この場合、コマンドは LogCleanUpInterval を 20 日に設定しています (20 日。00 時間: 00 分: 00 秒)。これを実行するため、Get-CsDeviceUpdateConfiguration コマンドレットを Filter パラメーターと共に使用します。フィルター値 "site:*" により、返りデータを Identity が文字列値 "site:" で始まる設定に制限します。次に、このフィルターされたコレクションを Set-CsDeviceUpdateConfiguration にパイプ処理して、コレクション内の各項目のログ クリーンアップ間隔の値を変更します。
-------------------------- 例 5 --------------------------
Get-CsDeviceUpdateConfiguration | Set-CsDeviceUpdateConfiguration -ValidLogFileTypes @{Remove="CELog"}
上記のコマンドでは、デバイス更新の構成設定によって使用されている有効なログ ファイルのタイプのリストから CELog を削除しています。このコマンドでは、まず Get-CsDeviceUpdateConfiguration を使用して、組織で現在使用中のデバイス更新の構成設定すべてのコレクションを取得します。次に、このコレクションを Set-CsDeviceUpdateConfiguration にパイプ処理します。このコマンドレットでは、ValidLogFileTypes パラメーターを使用して有効なログ ファイルのタイプのリストから CELog を削除します。ValidLogFileTypes に渡されるパラメーターの値 (@{Remove="CELog"}) により、有効なファイル タイプのセットから CELog を削除するよう Set-CsDeviceUpdateConfiguration に指示します。1 つのコマンドで複数のファイル タイプを削除するには、追加のファイル タイプをコンマ区切りリストの一部として含めるだけです。次に例を示します。
@{Remove="CELog","Watson"}