8.6.6 listservices(サービス・サービステンプレートの一覧出力)

機能

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形式で出力されます。

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

表8-5 サービス一覧およびサービステンプレート一覧の出力形式

出力情報の種類出力項目意味
サービス一覧Nameサービス名
Description説明
Categoryカテゴリ名
Resource Groupリソースグループ
Service Templateサービステンプレート名
Vendorベンダー名
Versionサービスバージョン
Configuration Type構成種別
サービステンプレート一覧Nameサービステンプレート名
Service IDサービステンプレートID
Description説明
Versionサービステンプレートバージョン
Categoryカテゴリ名
Vendorベンダー名
Vendor IDベンダーID
Configuration Type構成種別
注※
構成種別は,ユーザーが所属するユーザーグループから操作対象のリソースグループに対してAdminロールまたはDevelopロールが設定されている場合にだけ,出力されます。

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

格納先

JP1/AOのインストール先フォルダ¥bin

実行権限

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

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

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

戻り値

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

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

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

関連トピック