1.6.8　listservices（サービス・サービステンプレートの一覧出力） : JP1 Version 12 JP1/Automatic Operation コマンド・API リファレンス

機能

JP1/AOに登録されているサービスまたはサービステンプレートの一覧をCSV形式で出力します。

ベンダー名やバージョン情報を含んだサービスの一覧またはサービステンプレートの一覧を出力できます。なお，デバッグサービスについては出力されません。

形式

listservices
     /output {services | servicetemplates}
     /file 出力ファイルパス
     ［/encoding {UTF-8 | Shift_JIS}］
     /user ユーザーID
     {/password パスワード | /passwordfile パスワードファイルパス}

引数

/output {services | servicetemplates}

出力する一覧情報の種類として，次のどちらかを値に指定します。

services

サービス一覧を出力します。
servicetemplates

サービステンプレート一覧を出力します。

/file 出力ファイルパス

出力ファイルのパスを絶対パスまたは相対パスで指定します。指定したファイルが存在する場合はエラーとなります。

/encoding {UTF-8 | Shift_JIS}

出力ファイルのエンコーディングを指定します。このオプションを省略した場合は，OSのデフォルトエンコーディングとなります。

/user ユーザーID

JP1/AOのユーザーIDを指定します。

指定できる文字数は，1～256文字です。

使用できる文字の種類は，半角英数字，「!」，「#」，「$」，「%」，「&」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「\」，「^」，「_」，「|」です。

大文字と小文字は区別しません。

/password パスワード

userオプションで指定した，ユーザーのパスワードを指定します。

このオプションまたはpasswordfileオプションのどちらかを指定する必要があります。両方のオプションが指定されている場合，およびどちらのオプションも指定されていない場合はエラーとなります。

指定できる文字数は，1～256文字です。

使用できる文字の種類は，userオプションと同じです。

/passwordfile パスワードファイルパス

userオプションで指定したユーザーのパスワードファイルのパスを絶対パスまたは相対パスで指定します。パスワードファイルはencryptpasswordコマンドで作成します。

このオプションまたはpasswordオプションのどちらかを指定する必要があります。両方のオプションが指定されている場合，およびどちらのオプションも指定されていない場合はエラーとなります。

出力形式

サービスまたはサービステンプレートごとに1行ずつ，出力項目がCSV形式で出力されます。

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

表1‒7　サービス一覧およびサービステンプレート一覧の出力形式
出力情報の種類	出力項目	内容
サービス一覧	Name	サービス名
	Favorite	お気に入り設定の状態
	Description	説明
	Service Group	サービスグループ名
	Service Template	サービステンプレート名
	Vendor Name	ベンダー名
	Version	サービスバージョン
	Tags	サービスに設定されているタグ
	Status	状態
	Create Date	作成日時
	Modify Date	最終更新日時
	Submit Date	最終実行日時
	Reset Date	リセット日時
	Executed Count	タスク実行回数
	Completed Count	正常終了回数
	Last Failed Date	最終失敗日時
	Failed Count	失敗回数
	Submit Count	サービス実行回数
	ID	サービスID
	Latest	サービステンプレートが最新バージョンかどうか
	Supported Schedule Type	選択できるスケジュール
	Supported Action Type	タスクに対して実行できる操作
サービステンプレート一覧	Name	サービステンプレート名
	Vendor	ベンダー名
	Version	サービステンプレートバージョン
	Description	説明
	Service Template Key Name	サービステンプレートID
	Vendor ID	ベンダーID
	Tags	サービステンプレートに設定されているタグ
	Registered	作成時刻
	Updated	最終更新時刻
	Latest Version	サービステンプレートが最新バージョンかどうか
	Used Services	サービステンプレートを使用しているサービスの数
	Used Service Templates	このサービステンプレートをコンポーネントとして使用しているサービステンプレートの数
	Outdated Services	古いバージョンのサービステンプレートを使用しているサービスがあるかどうか
	Outdated Component	古いコンポーネントを使用しているかどうか
	Supported Schedule Type	選択できるスケジュール
	Supported Action Type	このサービステンプレートを使用しているタスクに対して実行できる操作
	Release State	リリース状態

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

サービス一覧の場合

"Name","Favorite","Description","Service Group","Service Template","Vendor Name","Version","Tags","Status","Create Date","Modify Date","Submit Date","Reset Date"
,"Executed Count","Completed Count","Last Failed Date","Failed Count","Submit Count","ID","Latest","Supported Schedule Type","Supported Action Type"
"リモートコマンド実行","false","リモートの実行対象サーバ上のコマンドを実行します。","DefaultServiceGroup","リモートコマンド実行","(株)日立製作所","01.12.00","Basic,OS_Operations"
,"リリース","2015-08-28 13:07:25","2015-08-28 13:07:25","2015-08-28 13:20:26","","3","1","2015-08-28 13:17:58","2","3","4005","はい","immediate,schedule,recurrence","forciblyStop,retry"

サービステンプレート一覧の場合

"Name","Vendor","Version","Description","Service Template Key Name","Vendor ID","Tags","Registered","Updated","Latest Version","Used Services","Used Service Templates","Outdated Services","Outdated Component","Supported Schedule Type","Release State","Supported Action Type"
"OSユーザーの一覧取得","(株)日立製作所","02.00.00","Windows/UNIXのOSユーザーの一覧を取得します。","osShowUsers","com.hitachi.software.dna.cts.jp1","AIX,Gather OS information,Linux,Windows","2016-11-17 15:04:12","2016-11-17 15:04:12","はい","0","0","いいえ","いいえ","immediate,schedule,recurrence","リリース",""

格納先

Windowsの場合: JP1/AOのインストール先フォルダ\bin
Linuxの場合: /opt/jp1ao/bin

実行権限

OSのAdministrators権限またはroot権限を持つユーザーで実行してください。

サービス一覧を出力する場合，コマンド実行ユーザーが所属するユーザーグループから，操作対象のサービスグループに対してAdminロール，Developロール，ModifyロールまたはSubmitロールが設定されている必要があります。ロールが設定されていないサービスグループのサービスについては出力されません。

サービステンプレート一覧を出力する場合，コマンド実行ユーザーが所属するユーザーグループから，操作対象のサービスグループに対してAdminロール，DevelopロールまたはModifyロールが設定されている必要があります。

戻り値

コマンドの戻り値を次の表に示します。

戻り値	説明
0	正常に終了しました。
1	引数が不正です。
2	コマンドの実行を中断しました。
3	サービスの状態が不正です。
4	ほかのコマンドを実行中です。
5	通信に失敗しました。
6	認証に失敗しました。
7	パスの指定が不正です。
8	すでに出力先パスに同名のファイルが存在します。
9	指定したパスが存在しません。
10	指定したパスにアクセスできません。
12	エンコーディングの指定が不正です。
13	ファイル出力に失敗しました。
14	コマンドの実行権限がありません。
160	サービス一覧の取得に失敗しました。
161	サービステンプレート一覧の取得に失敗しました。
255	そのほかのエラーでコマンドの実行が中断しました。

使用例

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

Windowsで，登録されているサービスの一覧をOSのデフォルトエンコーディングでファイルに出力する場合

listservices /output services /file list01 /user user01 /password pass01
Windowsで，登録されているサービステンプレートの一覧をUTF-8エンコーディングでファイルに出力する場合

listservices /output servicetemplates /file list02 /encoding UTF-8 /user user02 /password pass02

1.6.8 listservices（サービス・サービステンプレートの一覧出力）

1.6.8　listservices（サービス・サービステンプレートの一覧出力）