Hitachi

JP1 Version 12 JP1/Automatic Operation コマンド・API リファレンス 

1.6.9　listtasks（タスクの一覧出力，タスク詳細情報出力）

機能

listtasksコマンドの機能は次のとおりです。

タスクまたは履歴の一覧出力

listtasksコマンドのoutputオプションにtasksを指定して実行すると，［タスク］画面のタスク一覧に表示されるタスク情報をCSV形式で出力できます。またはoutputオプションにhistoriesを指定して実行すると，［タスク］画面の履歴一覧に表示されるタスク情報をCSV形式で出力できます。なお，デバッグタスクについてはどちらのCSVファイルにも出力されません。

期間を指定すると，出力するタスク情報を絞り込むこともできます。

タスク詳細情報の出力

listtasksコマンドのoutputオプションにtaskdetailsを指定して実行すると，タスク詳細情報格納フォルダに，入力プロパティおよび出力プロパティの値を含むタスク詳細情報が出力されます。なお，デバッグタスクの詳細情報については出力されません。

出力されたタスク詳細情報※を元に，submittaskコマンドを実行すると，指定日時実行タスクと定期実行タスクを，同一の設定で一括再登録できます。

注※

このタスク詳細情報には，定義情報（サービス, サービステンプレート, ユーザー，ユーザーグループ，サービスグループ, エージェントレス接続先定義, サービス共有プロパティ）および定義ファイルは含まれません。これらの情報をバックアップしたい場合は，backupsystemコマンドを使用してください。

図1‒1　タスク詳細情報の出力と入力

[図データ]

形式

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 タスク詳細情報格納フォルダのパス

    タスク詳細情報を出力するための，空のフォルダを絶対パスまたは相対パスで指定します。指定できるのはローカルディスクのフォルダだけです。指定できる文字数は，絶対パスの長さで180文字までです。相対パスの場合，絶対パスの長さに換算したときに180文字までとなるように指定します。

    指定したフォルダがない場合や，指定したフォルダ内にファイルまたはフォルダがすでにある場合はエラーになります。

    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オプションのどちらかを指定する必要があります。両方のオプションが指定されている場合，およびどちらのオプションも指定されていない場合はエラーとなります。

出力形式

listtasksコマンドの出力形式は次のとおりです。

タスクおよび履歴の一覧を出力する場合（outputオプションにtasksまたはhistoriesを指定した場合）

タスクごとに1行ずつ，出力項目がCSV形式で出力されます。

なお，出力項目の値は「"」で囲まれて出力されます。値に「"」が含まれる場合，直前に「"」を付加してエスケープされます。

表1‒8　タスク一覧の出力項目

出力項目

内容

Task Name

タスク名

To Do

To Do設定の状態

Status

タスクの状態

Scheduled Time

開始予定日時

Start Time

開始日時

Completion Time

終了日時

Schedule Type

タスク種別

Task ID

タスクID

Description

タスクの説明

Service

サービス名

Service Group

サービスグループ名

Tags

サービスに設定されているタグ

Submitted By

実行者

Submit Time

実行操作日時

Schedule Interval

定期実行周期

Recurrence Time

定期実行時刻

Schedule Start Date

定期実行適用開始日

Notes

メモ

Step Start Time

ステップ開始日時

Supported Action Type

タスクに対して実行できる操作

Service status

サービスの状態

ファイルの出力例を次に示します。

"Task Name","To Do","Status","Scheduled Time","Start Time","Completion Time","Schedule Type",
"Task ID","Description","Service","Service Group","Tags","Submitted By","Submit Time","Schedule Interval",
"Recurrence Time","Schedule Start Date","Notes","Step Start Time","Supported Action Type","Service Status"
"リモートコマンド実行_20150828130932","FALSE","失敗","","2015/8/28 13:09","2015/8/28 13:09","即時実行","4015",
"","リモートコマンド実行","DefaultServiceGroup","Basic,OS_Operations","System","2015/8/28 13:09","","","","","","forciblyStop,retry","リリース"

タスク詳細情報を出力する場合（outputオプションにtaskdetailsを指定した場合）

タスク詳細情報格納フォルダに出力されるデータを次に示します。

図1‒2　タスク詳細情報格納フォルダの構成

[図データ]

タスク詳細情報格納フォルダの内容を次に示します。

格納先

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

そのほかのエラーでコマンドの実行が中断しました。

使用例

次の場合のコマンドの使用例を示します。

関連項目

ページの先頭へ

All Rights Reserved. Copyright (C) 2019, 2022, Hitachi, Ltd.