8.6.7 listtasks(タスクの一覧出力,タスク詳細情報出力)
機能
タスクまたは履歴の一覧出力
listtasksコマンドのoutputオプションにtasksを指定して実行すると,[タスク一覧]ビューに表示されるタスク情報をCSV形式で出力できます。またはoutputオプションにhistoriesを指定して実行すると,[履歴]ビューに表示されるタスク情報をCSV形式で出力できます。なお,デバッグタスクについてはどちらのCSVファイルにも出力されません。
期間を指定すると,出力するタスク情報を絞り込むこともできます。
タスク詳細情報の出力
listtasksコマンドのoutputオプションにtaskdetailsを指定して実行すると,タスク詳細情報格納フォルダに,入力プロパティおよび出力プロパティの値を含むタスク詳細情報が出力されます。なお,デバッグタスクの詳細情報については出力されません。
出力されたタスク詳細情報※を元に,submittaskコマンドを実行すると,指定日時実行タスクと定期実行タスクを,同一の設定で一括再登録できます。
- 注※
-
このタスク詳細情報には,定義情報(サービス, サービステンプレート, ユーザー,ユーザーグループ,リソースグループ, エージェントレス接続先定義, サービス共有プロパティ)および定義ファイルは含まれません。これらの情報をバックアップしたい場合は,backupsystemコマンドを使用してください。
形式
listtasks [/startrange {yyyy-mm-dd|,yyyy-mm-dd|yyyy-mm-dd,yyyy-mm-dd}] /output {tasks | histories | taskdetails} {/file出力ファイルパス |/taskdetaildir タスク詳細情報格納フォルダのパス} [/encoding {UTF-8 | Shift_JIS}] /user ユーザーID {/password パスワード | /passwordfile パスワードファイルパス}
引数
- /startrange {yyyy-mm-dd|,yyyy-mm-dd|yyyy-mm-dd,yyyy-mm-dd}
-
タスクの開始日または開始予定日を指定することで,出力するタスクを絞り込みます。
「yyyy」には西暦を4桁の半角数字で指定します。「mm」には月を1(または01)から12の半角数字で指定します。「dd」には日を1(または01)から31の半角数字で指定します。
-
yyyy-mm-dd
指定した日付以後に開始したタスクまたは開始予定のタスクを出力します。
-
,yyyy-mm-dd
指定した日付以前に開始したタスクまたは開始予定のタスクを出力します。
-
yyyy-mm-dd,yyyy-mm-dd
指定した期間内に開始したタスクまたは開始予定のタスクを出力します。「,」の右側には,左側に指定した日付以降の日付だけを指定できます。
定期実行タスクの場合,次に開始予定のタスクまで出力されます。その次以降に開始予定のタスクは出力されません。
待機中のタスクを出力したい場合,定期実行タスクおよび指定日時実行タスクのときは開始日時ではなく開始予定日時を指定してください。即時実行タスクのときは実行操作日時を指定してください。実行操作日時は[タスク詳細]ダイアログボックスで確認できます。
このオプションを省略した場合は,ユーザーが参照できるすべてのタスクが出力されます。
なお,outputオプションにtaskdetailsを指定した場合に,startrangeオプションを指定するとエラーになります。
-
- /output {tasks | histories | taskdetails}
-
出力する一覧情報の種類として,次のどれかを値に指定します。
-
tasks
[タスク一覧]ビューのタスク一覧を出力します。
-
histories
[履歴]ビューの履歴一覧を出力します。
-
taskdetails
入力プロパティおよび出力プロパティの値を含むタスク詳細情報を出力します。
-
- {/file 出力ファイルパス |/taskdetaildir タスク詳細情報格納フォルダのパス}
-
-
/file 出力ファイルパス
一覧として出力するファイルのパスを絶対パスまたは相対パスで指定します。指定したファイルがすでにある場合はエラーとなります。
outputオプションにtasksまたはhistoriesを指定した場合は,必須で指定します。outputオプションにtaskdetailsを指定した場合に,このオプションを指定するとエラーになります。
-
/taskdetaildir タスク詳細情報格納フォルダのパス
タスク詳細情報を出力するための,空のフォルダを絶対パスまたは相対パスで指定します。指定できるのはローカルディスクのフォルダだけです。指定できる文字数は,絶対パスの長さで190文字までです。相対パスの場合,絶対パスの長さに換算したときに190文字までとなるように指定します。
指定したフォルダがない場合や,指定したフォルダ内にファイルまたはフォルダがすでにある場合はエラーになります。
outputオプションにtaskdetailsを指定した場合は,必須で指定します。outputオプションにtasksまたはhistoriesを指定した場合に,このオプションを指定するとエラーになります。
-
- /encoding {UTF-8 | Shift_JIS}
-
出力ファイルのエンコーディングを指定します。このオプションを省略した場合は,OSのデフォルトエンコーディングとなります。
outputオプションにtaskdetailsを指定した場合は,タスク詳細情報格納フォルダの直下にある,タスク一覧ファイル(listtasks.csv)だけに適用されます。タスク詳細情報およびプロパティファイルは,常にUTF-8で出力されます。
- /user ユーザーID
-
JP1/AOのユーザーIDを指定します。
指定できる文字数は,1〜256文字です。
使用できる文字の種類は,半角英数字,「!」,「#」,「$」,「%」,「&」,「'」,「(」,「)」,「*」,「+」,「-」,「.」,「=」,「@」,「¥」,「^」,「_」,「|」です。
大文字と小文字は区別しません。
- /password パスワード
-
userオプションで指定した,ユーザーのパスワードを指定します。
このオプションまたはpasswordfileオプションのどちらかを指定する必要があります。両方のオプションが指定されている場合,およびどちらのオプションも指定されていない場合はエラーとなります。
指定できる文字数は,1〜256文字です。
使用できる文字の種類は,userオプションと同じです。
- /passwordfile パスワードファイルパス
-
userオプションで指定したユーザーのパスワードファイルのパスを絶対パスまたは相対パスで指定します。パスワードファイルはencryptpasswordコマンドで作成します。
このオプションまたはpasswordオプションのどちらかを指定する必要があります。両方のオプションが指定されている場合,およびどちらのオプションも指定されていない場合はエラーとなります。
出力形式
[タスク一覧]ビューおよび[履歴]ビューの一覧を出力する場合(outputオプションにtasksまたはhistoriesを指定した場合)
タスクごとに1行ずつ,出力項目がCSV形式で出力されます。
なお,出力項目の値は「"」で囲まれて出力されます。値に「"」が含まれる場合,直前に「"」を付加してエスケープされます。
出力項目 |
意味 |
---|---|
Task |
タスク名 |
Status |
状態 |
Scheduled Time |
開始予定日時 |
Start Time |
開始日時 |
End Time |
終了日時 |
Type |
タスク種別 |
ID |
タスクID |
Description |
タスクの説明 |
Service |
サービス名 |
Resource Group |
リソースグループ |
Category |
サービスカテゴリ |
Submitted By |
実行者 |
Submitted At |
実行操作日時 |
Recurrence Pattern |
定期実行周期 |
Recurrence Time |
定期実行時刻 |
Recurrence Start |
定期実行適用開始日 |
Configuration Type※ |
構成種別 |
- 注※
-
構成種別は,ユーザーが所属するユーザーグループから,操作対象のリソースグループに対してAdminロールまたはDevelopロールが設定されている場合にだけ,出力されます。
ファイルの出力例を次に示します。
"Task","Status","Scheduled Time","Start Time","End Time","Type","ID","Description","Service","Resource Group","Category","Submitted By","Submitted At","Recurrence Pattern","Recurrence Time","Recurrence Start","Configuration Type" "リモートコマンド実行_20131031190605","待機中","2013-11-01 00:00:00","","","定期実行タスク","3327","","リモートコマンド実行","All Resources","OS_Operations/Basic","user","2013-10-31 19:06:37","毎週 月,水,金","00:00:00","2013-10-31","リリース" "リモートコマンド実行_20131031194429","待機中","2013-11-01 09:00:00","","","指定日時実行タスク","3355","","リモートコマンド実行","All Resources","OS_Operations/Basic","user","2013-10-31 19:44:52","","","","リリース" "OSユーザーの一覧取得_20131031194524","待機中","2013-11-01 20:00:00","","","定期実行タスク","3385","","OSユーザーの一覧取得","All Resources","OS_Operations/Management","user","2013-10-31 19:45:44","毎日","20:00:00","2013-10-31","リリース" "リモートコマンド実行_20131031194500","待機中","2013-11-30 00:00:00","","","指定日時実行タスク","3361","","リモートコマンド実行","All Resources","OS_Operations/Basic","user","2013-10-31 19:45:17","","","","リリース" "OSユーザーの一覧取得_20131031194524","正常終了","2013-10-31 20:00:00","2013-10-31 20:00:00","2013-10-31 20:00:19","定期実行タスク","3375","","OSユーザーの一覧取得","All Resources","OS_Operations/Management","user","2013-10-31 19:45:44","毎日","20:00:00","2013-10-31","リリース"
タスク詳細情報を出力する場合(outputオプションにtaskdetailsを指定した場合)
タスク詳細情報格納フォルダに出力されるデータを次に示します。
タスク詳細情報格納フォルダの内容を次に示します。
-
タスク詳細情報格納フォルダ
フォルダ名:任意
taskdetaildirオプションに指定するフォルダです。
-
タスク一覧ファイル
ファイル名:listtasks.csv
タスク詳細情報に含まれるタスクの一覧と,その一覧のうちsubmittaskコマンドで一括再登録する対象となるタスクを確認するためのファイルです。
outputオプションに,tasksを指定して出力されるタスク一覧の各行の末尾に,submittaskコマンドで一括再登録するタスクかどうかのフラグが付加されています。
タスク一覧の出力例を次に示します。
図8‒3 タスク一覧の出力例 ヘッダー部とデータ部の内容は次のとおりです。
- ヘッダー部(1行目)
-
Unexecuted Schedule
- データ部(2行目以降)
-
true:一括再登録されるタスクです。
false:一括再登録されないタスクです。
データ部(2行目以降)のフラグがtrueになるのは,予定されたタスク(指定日時実行タスクまたは定期実行タスク)のうち未実行のタスクです。
-
listtasksコマンドを実行する時点で,実行が開始されていない指定日時実行タスク
-
listtasksコマンドを実行する時点で,キャンセルされていない定期実行タスク
-
listtasksコマンドを実行する時点で,保留中の指定日時実行タスクと定期実行タスク
なお,このファイルは,submittaskコマンドで一括再登録するタスクを確認するためのものです。このファイルは編集しないでください。
-
個別タスク詳細情報格納フォルダ
フォルダ名:タスクID
個々のタスクの定義情報と,プロパティファイルを格納するフォルダです。タスクIDがフォルダ名となり,出力するタスクの数だけフォルダが生成されます。
-
タスク定義情報ファイル
ファイル名:taskdef.xml
タスクの定義情報をXMLで出力したファイルです。このファイルは編集しないでください。
-
入力プロパティファイル
ファイル名:input.properties
タスクに設定された入力プロパティの情報が出力されます。データの形式は,submittaskコマンドのpropertyfileオプションに指定するプロパティファイルと同じです。ファイルの形式については,「8.6.9 submittask(サービスの実行,タスクの一括再登録)」のpropertyfileオプションの説明を参照してください。なお,出力されるのは,可視性が「exec」の入力プロパティだけです。該当する入力プロパティが1つもない場合は,空のファイルが作成されます。
submittaskコマンドでタスクの一括再登録を行う場合,このファイルを編集して実行しないでください。編集した場合のコマンドの実行結果は製品サポートの対象外です。ただし,元の設定と異なる設定で登録する場合は,このファイルをコピーして使用します。ファイルのコピー後に,指定日時やタスク名など,サービスの実行時に指定できる項目を指定してから,個別にサービスを実行してください入力プロパティの値を変更したい場合については,コピーしたファイルを必要に応じて編集し,submittaskコマンドのpropertyfileオプションに指定して実行してください。
なお,例えば,ホスト名,IPアドレス,ユーザー名,パスワードなどの情報が入力プロパティの値に含まれている場合も,そのまま出力されます。
-
出力プロパティファイル
ファイル名:output.properties
タスクに設定された出力プロパティの内容が出力されます。データの形式は,入力プロパティファイルと同じです。ファイルの形式については,「8.6.9 submittask(サービスの実行,タスクの一括再登録)」のpropertyfileオプションの説明を参照してください。該当する入力プロパティが1つもない場合は,空のファイルが作成されます。
なお,例えば,ホスト名,IPアドレス,ユーザー名,パスワードなどの情報が出力プロパティの値に含まれている場合も,そのまま出力されます。
格納先
- Windowsの場合
-
JP1/AOのインストール先フォルダ¥bin
- Linuxの場合
-
/opt/jp1ao/bin
実行権限
OSのAdministrators権限またはroot権限を持つユーザーで実行してください。Administrators権限またはroot権限がない場合は,権限昇格を求めるメッセージが表示されます。
userオプションに指定するユーザーに必要な権限は,outputオプションに指定する引数によって異なります。
- outputオプションにtasksまたはhistoriesを指定する場合(タスクまたは履歴の一覧出力)
-
/userオプションに指定するユーザーが所属するユーザーグループから,操作対象のリソースグループに対してAdminロール,Developロール,ModifyロールまたはSubmitロールが設定されている必要があります。ロールが設定されていないリソースグループのタスクについては出力されません。
- outputオプションにtaskdetailsを指定する場合(タスク詳細情報の出力)
-
userオプションには,Adminロールを持つユーザーを指定してください。JP1/AOに登録されているすべてのタスクの情報が一括で出力されるほか,入力プロパティや出力プロパティの値に,ホスト名,IPアドレス,ユーザー名,パスワードなどの情報が含まれている場合も,そのまま出力されるため,すべてのリソースにアクセスできるAdminロールを指定する必要があります。出力されたタスク詳細情報は,適切にアクセス制御された場所に保管してください。
戻り値
コマンドの戻り値を次の表に示します。
戻り値 |
説明 |
---|---|
0 |
正常に終了しました。 |
1 |
引数が不正です。 |
2 |
コマンドの実行を中断しました。 |
3 |
サービスの状態が不正です。 |
4 |
ほかのコマンドを実行中です。 |
5 |
通信に失敗しました。 |
6 |
認証に失敗しました。 |
7 |
パスの指定が不正です。 |
8 |
すでに出力先パスに同名のファイルが存在します。 |
9 |
指定したパスが存在しません。 |
10 |
指定したパスにアクセスできません。 |
11 |
指定したフォルダが空ではありません。 |
12 |
エンコーディングの指定が不正です。 |
13 |
ファイル出力に失敗しました。 |
14 |
コマンドの実行権限がありません。 |
150 |
タスク一覧の取得に失敗しました。 |
151 |
履歴一覧の取得に失敗しました。 |
152 |
タスク詳細情報の取得に失敗しました。 |
255 |
そのほかのエラーでコマンドの実行が中断しました。 |
使用例
次の場合のコマンドの使用例を示します。
-
Windowsで,登録されているタスクの一覧をOSのデフォルトエンコーディングでファイルに出力する場合
listtasks /output tasks /file list01.csv /user user01 /password pass01
-
Windowsで,2012年1月1日から2012年3月31日までの間に開始または開始予定の[履歴]ビューのタスクをUTF-8エンコーディングでファイルに出力する場合
listtasks /startrange 2012-01-01,2012-03-31 /output histories /file list02.csv /encoding UTF-8 /user user02 /password pass02
-
Windowsで,タスク詳細情報を出力する場合
listtasks /output taskdetails /taskdetaildir "C:\data\taskdetail" /user user03 /password pass03
関連トピック