2.14. cn=tasks,cn=config 下のエントリーに対する一般的なタスク呼び出し属性
一部のコア Directory Server タスクは、LDAP ツールを使用してディレクトリーエントリーを編集することで開始できます。これらのタスクエントリーは、cn=tasks,cn=config に含まれています。各タスクは、以下のようなエントリーを更新して呼び出すことができます。
dn: cn=task_id,cn=task_type,cn=tasks,cn=config ...
本セクションでは、すべてのタスクタイプで共通の属性を紹介します。
タスクエントリーは、永続的な設定エントリーではありません。このエントリーは、タスク操作が実行中であるか、ttl の有効期限が切れるまで、設定ファイルにだけ存在します。その後、エントリーは自動的にサーバーにより削除されます。
2.14.1. cn
cn 属性は、開始する新しいタスク操作を特定します。cn 属性の値は、新しいタスクを定義する限りすべて使用できます。
| パラメーター | 説明 |
|---|---|
| エントリー DN | cn=task_name,cn=task_type,cn=tasks,cn=config |
| 有効な値 | 任意の文字列 |
| デフォルト値 | |
| 構文 | DirectoryString |
| 例 | cn: タスクエントリー名の例 |
2.14.2. nsTaskCancel
この属性を使用すると、進行中にタスクを中断できます。この属性は、ユーザーが変更できます。
| パラメーター | 説明 |
|---|---|
| エントリー DN | cn=task_name,cn=task_type,cn=tasks,cn=config |
| 有効な値 | true | false |
| デフォルト値 | |
| 構文 | 大文字と小文字を区別しない文字列 |
| 例 | nsTaskCancel: true |
2.14.3. nsTaskCurrentItem
この属性は、タスクがサブタスクに分割できると仮定して、タスク操作が完了したサブタスクの数を表示します。タスクが 1 つしかない場合は、タスクの実行中に nsTaskCurrentItem が 0、タスクの完了時には 1 になります。このように、属性は進捗バーに似ています。nsTaskCurrentItem 属性に nsTaskTotalItems と同じ値がある場合は、タスクが完了します。
この属性値はサーバーによって設定されるため、編集 しないでください。
| パラメーター | 説明 |
|---|---|
| エントリー DN | cn=task_name,cn=task_type,cn=tasks,cn=config |
| 有効な値 | 0 から最大 32 ビットの整数値 (2147483647) |
| デフォルト値 | |
| 構文 | 整数 |
| 例 | nsTaskCurrentItem: 148 |
2.14.4. nsTaskExitCode
この属性には、タスクの終了コードが含まれます。この属性は、タスクの完了後にのみ存在し、値はタスクが完了した場合にのみ有効になります。結果コードは、LDAP 終了コードに指定できますが、0 値のみが成功に相当します。他の結果コードはエラーです。
この属性値はサーバーによって設定されるため、編集 しないでください。
2.14.5. nsTaskLog
このエントリーには、警告メッセージおよび情報メッセージの両方など、タスクのすべてのログメッセージが含まれます。新しいメッセージはエントリー値の最後に追加されるため、この属性値は、デフォルトでは元の内容を消去しないので、数値が大きくなります。
nsTaskExitCode が 0 である正常なタスク操作は、nsTaskLog 属性にのみ記録されます。エラーを示すゼロ以外の応答は、エラーとしてエラーログに記録される場合がありますが、エラーメッセージは nsTaskLog 属性にのみ記録されます。このため、nsTaskLog 属性の情報を使用して、実際に発生したエラーが分かります。
この属性値はサーバーによって設定されるため、編集 しないでください。
2.14.6. nsTaskStatus
この属性には、累積の統計や現在の出力メッセージなどのタスクのステータスの変更情報が含まれます。属性の全内容は、プロセスが実行されている限り定期的に更新できます。
この属性値はサーバーによって設定されるため、編集 しないでください。
| パラメーター | 説明 |
|---|---|
| エントリー DN | cn=task_name,cn=task_type,cn=tasks,cn=config |
| 有効な値 | 任意の文字列 |
| デフォルト値 | |
| 構文 | 大文字と小文字を区別する文字列 |
| 例 | nsTaskStatus: エントリーの読み込みなど |
2.14.7. nsTaskTotalItems
この属性は、タスク操作で完了する必要のあるサブタスクの合計数を示します。nsTaskCurrentItem 属性に nsTaskTotalItems と同じ値がある場合は、タスクが完了します。
この属性値はサーバーによって設定されるため、編集 しないでください。
| パラメーター | 説明 |
|---|---|
| エントリー DN | cn=task_name,cn=task_type,cn=tasks,cn=config |
| 有効な値 | 0 から最大 32 ビットの整数値 (2147483647) |
| デフォルト値 | |
| 構文 | 整数 |
| 例 | nsTaskTotalItems: 152 |
2.14.8. ttl
この属性は、タスクが終了または中止した後に、タスクエントリーが DSE に留まる時間 (秒単位) を設定します。ttl 属性を設定すると、終了コードを失うことなく、タスクエントリーをポーリングして新しいステータス情報を取得できます。ttl 属性を 0 に設定すると、エントリーがキャッシュされません。
| パラメーター | 説明 |
|---|---|
| エントリー DN | cn=task_name,cn=task_type,cn=tasks,cn=config |
| 有効な値 | 0(キャッシュ不可) から最大 32 ビットの整数値 (2147483647) |
| デフォルト値 | |
| 構文 | DirectoryString |
| 例 | ttl: 120 |
