JP1 Version 9

JP1/IT Resource Management - Manager リファレンス

文法書

3020-3-S43-30

目　　次

前書き

変更内容

はじめに

1.　コマンド

コマンドの記述形式

コマンド一覧

コマンド共通の注意事項

jirmbackup

jirmcontrolservice

jirmdbreorg

jirmexport

jirmgetlogs

jirmimageimport

jirmimport

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmrestore

jirmsetportno

jirmsetup

jirmunsetup

jirmusermgr

jirmstatuschange

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

2.　定義ファイル

定義ファイルの記述形式

定義ファイル一覧

ユーザー設定プロパティファイル（jp1itrm.properties）

3.　JP1イベント

3.1　JP1イベントの属性

3.1.1　基本属性

3.1.2　拡張属性

3.2　JP1/ITRMが出力するJP1イベント一覧

3.3　JP1イベントの詳細

3.3.1　イベントID：00006600の詳細

3.3.2　イベントID：00006601の詳細

3.3.3　イベントID：00006610の詳細

3.3.4　イベントID：00006620の詳細

3.3.5　イベントID：00006630の詳細

3.3.6　イベントID：00006640の詳細

3.3.7　イベントID：00006641の詳細

3.3.8　イベントID：00006650の詳細

3.3.9　イベントID：00006651の詳細

3.3.10　イベントID：00006652の詳細

3.3.11　イベントID：00006660の詳細

3.3.12　イベントID：00006661の詳細

3.3.13　イベントID：00006662の詳細

3.3.14　イベントID：00006663の詳細

4.　API

APIの概要

API共通の仕様

APIの記述形式

API一覧

API情報の取得

業務グループの一覧の取得

仮想ホストの一覧の取得

システム情報の取得

ドライブ情報の取得

パフォーマンス情報の取得

仮想ホストの起動

仮想ホストの停止

仮想ホストの強制停止

仮想ホストのリブート

仮想ホストの強制リブート

索引

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2010, 2012, Hitachi, Ltd.

前書き

■ 対象製品

P-242C-CB94　 JP1/IT Resource Management - Manager　 09-51（適用OS：Windows Server 2008 R2）

■ 輸出時の注意

本製品を輸出される場合には，外国為替および外国貿易法ならびに米国の輸出管理関連法規などの規制をご確認の上，必要な手続きをお取りください。
なお，ご不明な場合は，弊社担当営業にお問い合わせください。

■ 商標類

AIXは，米国およびその他の国におけるInternational Business Machines Corporationの商標です。
BSAFEは，EMC Corporationの米国およびその他の国における登録商標または商標です。
HP-UXは，Hewlett-Packard Development Company, L.P.のオペレーティングシステムの名称です。
MicrosoftおよびHyper-Vは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
Pentiumは，アメリカ合衆国およびその他の国におけるIntel Corporationの商標です。
RSAは，EMC Corporationの米国およびその他の国における登録商標または商標です。
UNIXは，The Open Groupの米国ならびに他の国における登録商標です。
VMwareおよびESXは，VMware, Inc.の米国および各国での登録商標または商標です。
Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
その他記載の会社名、製品名は、それぞれの会社の商標もしくは登録商標です。
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.
This product includes software developed by IAIK of Graz University of Technology.
Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.
This product includes software developed by the University of California, Berkeley and its contributors.
This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).
Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/
This product includes cryptographic software written by Eric Young(eay@cryptsoft.com)
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)
This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

本製品は，EMC CorporationのRSA(R) BSAFETMソフトウェアを搭載しています。

■ マイクロソフト製品の表記について

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

表記 | 製品名
Hyper-V | Microsoft(R) Hyper-V(TM)
SCVMM | Microsoft(R) System Center Virtual Machine Manager 2008
Windows※ | Windows Server 2008 R2 | Microsoft(R) Windows Server(R) 2008 R2 Datacenter
Microsoft(R) Windows Server(R) 2008 R2 Datacenter without Hyper-V
Microsoft(R) Windows Server(R) 2008 R2 Enterprise
Microsoft(R) Windows Server(R) 2008 R2 Enterprise without Hyper-V
Microsoft(R) Windows Server(R) 2008 R2 Standard
Microsoft(R) Windows Server(R) 2008 R2 Standard without Hyper-V
Windows Server 2003 | Windows Server 2003 R2 | Microsoft(R) Windows Server(R) 2003 R2, Datacenter Edition
Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition
Microsoft(R) Windows Server(R) 2003 R2, Standard Edition
Windows Server 2003 R2(x64) | Microsoft(R) Windows Server(R) 2003 R2, Datacenter x64 Edition
Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition
Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition
Windows Server 2008 | Microsoft(R) Windows Server(R) 2008 Datacenter
Microsoft(R) Windows Server(R) 2008 Datacenter without Hyper-V
Microsoft(R) Windows Server(R) 2008 Enterprise
Microsoft(R) Windows Server(R) 2008 Enterprise without Hyper-V
Microsoft(R) Windows Server(R) 2008 Standard
Microsoft(R) Windows Server(R) 2008 Standard without Hyper-V
WSFC | Windows Server(R) Failover Cluster

注※

このマニュアルでは，Windows(R)をWindowsと表記します。

■ 発行

2012年2月 3020-3-S43-30

■ 著作権

All Rights Reserved. Copyright (C) 2010, 2012, Hitachi, Ltd.

変更内容

変更内容（3020-3-S43-30）JP1/IT Resource Management - Manager 09-51

追加・変更内容
変更個所

jirmimageimportコマンドの前提条件として，仮想ホストのドライブにnodefaultdriveletter属性が設定されていないことを追加した。
1. jirmimageimport

jirmimportコマンドを使ってデータをインポートした場合の注意事項を追加した。
1. jirmimport

jirmreportコマンドで，物理ホストの割り当て状況のレポートを出力するときに，対象となるOSにAIXを指定できるようにした。
1. jirmreport

性能履歴を1時間ごとに出力できるようにした（リソース使用量（時間推移）レポート）。
1. jirmreport

jirmrestoreコマンドを使ってバックアップデータをリストアする場合の注意事項を追加した。
1. jirmrestore

API機能を追加した。
1. jirmsetportno，1. jirmsetup，2. ユーザー設定プロパティファイル（jp1itrm.properties），4.

HVMのHVM拡張モードが有効の場合の注意事項を追加した。
1. jirmvmdeploy

ユーザー設定プロファイルに設定できる次の指定キーを追加した。

SE.reservation.rangeOfDailyCheck

SE.reservation.rangeOfHourlyCheck

AP.enableLoggingForNoAuthInfoRequest

2. ユーザー設定プロパティファイル（jp1itrm.properties）

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

このマニュアルは，JP1/IT Resource Management - Managerのコマンドや定義ファイルなどについて説明したものです。なお，このマニュアルでは，JP1/IT Resource Management - ManagerをJP1/ITRMと表記します。

＜はじめにの構成＞

対象読者

マニュアルの構成

コマンドの文法で使用する記号

対象読者

JP1/ITRMを使用して，データセンター内などで動作するITリソース（サーバ，ストレージ，ネットワークデバイスなどのIT機器）を管理，運用する方を対象としています。具体的には次の方を対象とします。

JP1/ITRMを使用してITリソースを管理するシステムの設計および運用をしたい方

JP1/ITRMを使用してITリソースを管理するシステムを構築したい方

また，このマニュアルは次の知識を持つ方にお読みいただくことを前提に説明しています。

Windows，サーバ，ストレージ，データベース，ネットワーク，仮想化の基礎知識

JP1/IM - Manager，およびJP1/NETM/Auditの基礎知識

さらに，使用する機能によって次の基礎知識を持っていることを前提とします。

HVM（Hitachi Virtualization Manager）を使用して仮想ホストを管理する場合

BladeSymphonyおよびJP1/SC/DPMの基礎知識

APIを使用する場合

HTTPおよびXMLの基礎知識

マニュアルの構成

このマニュアルは，次に示す章から構成されています。

第１章　コマンド

JP1/ITRMで使用できるコマンドの文法について説明しています。

第２章　定義ファイル

JP1/ITRMの定義ファイルの形式について説明しています。

第３章　JP1イベント

JP1/ITRMが出力するJP1イベントの属性，発行契機，および詳細内容について説明しています。

第４章　API

JP1/ITRMが提供するAPIの前提条件，機能，HTTPリクエスト形式などについて説明しています。

コマンドの文法で使用する記号

コマンドとパラメーターの説明で使用する記号を，次のように定義します。

記号
意味

｜
(ストローク)
複数の項目に対し，項目間の区切りを示し，「または」の意味を示す。
（例）
「A｜B｜C」は，「A，BまたはC」を示す。

｛　｝
この記号で囲まれている複数の項目の中から，必ず一組の項目を選択する。項目の区切りは|で示す。
（例）
｛A｜B｜C｝は「A，BまたはCのどれかを指定する」ことを示す。

[　]
この記号で囲まれている項目は任意に指定できる(省略してもよい)。
複数の項目が記述されている場合には，すべてを省略するか，どれか1つを選択する。
（例）
[A]は「何も指定しない」か「Aを指定する」ことを示す。
[B | C]は「何も指定しない」か「BまたはCを指定する」ことを示す。

…または...
この記号の直前に示された項目を繰り返して複数個，指定できる。
（例）
「A，B，…」は「AのあとにBを必要個数指定する」ことを示す。

このほかの参考情報については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」（3020-3-S41）の「はじめに」および「このマニュアルの参考情報」を参照してください。

1.　コマンド

この章では，JP1/ITRMで使用できるコマンドの文法について説明します。

＜この章の構成＞

コマンドの記述形式

コマンド一覧

コマンド共通の注意事項

jirmbackup

jirmcontrolservice

jirmdbreorg

jirmexport

jirmgetlogs

jirmimageimport

jirmimport

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmrestore

jirmsetportno

jirmsetup

jirmunsetup

jirmusermgr

jirmstatuschange

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

コマンドの記述形式

各コマンドで説明する項目を次に示します。ただし，コマンドによっては説明しない項目もあります。

機能

コマンドの機能について説明しています。

実行時の前提条件

コマンドの実行時の前提条件について説明しています。特に断り書きがない場合，コマンドの実行権限は，Administrators権限（Administratorsグループ）です。

形式

コマンドの形式について説明しています。

引数

コマンドの引数について説明しています。y/nをユーザーに確認する場合に入力する文字は，大文字と小文字が区別されません。それ以外の引数に入力する文字は，特に明記されていないかぎり大文字と小文字が区別されます。

注意事項

コマンドの注意事項を説明しています。

格納先フォルダ

コマンドの格納場所について説明しています。特に断り書きがない場合，コマンドは次のフォルダに格納されています。

ITRMパス¥JP1ITRM¥bin¥

戻り値

コマンドの戻り値について説明しています。なお，コマンド実行時に表示されるメッセージについては，マニュアル「JP1/IT Resource Management - Manager メッセージ」を参照してください。

使用例

コマンドの使用例について説明しています。

出力例

コマンドの使用例に対応した，出力例について説明しています。

コマンド一覧

JP1/ITRMで使用するコマンドを，構築時，運用時，メンテナンス時，およびトラブルシューティング時の4つに分けて次の表に示します。なお，次節以降のコマンドの説明では，コマンドをアルファベット順に記載しています。

構築に関するコマンド

コマンド名 | 機能概要
jirmimageimport | 仮想化ソフトウェアに構築した仮想ホストの情報に基づいて，JP1/ITRMのライブラリ格納フォルダへ仮想イメージテンプレートおよびデプロイに必要な情報を作成する。
jirmsetup | JP1/ITRMをセットアップする。
jirmunsetup | JP1/ITRMをアンセットアップする。

運用に関するコマンド

コマンド名 | 機能概要
jirminfocollect | JP1/ITRMが管理しているITリソースの構成情報を収集する。
jirminfolist | ITリソースの構成情報をCSV形式でファイルに出力する。
jirmnodeoperation | JP1/ITRMが管理しているホストを起動，停止，強制停止，リブート，および強制リブートする。
jirmreport | JP1/ITRMの各種レポートをCSV形式でファイルに出力する。
jirmstatuschange | ITリソースの管理状態を変更する。
jirmusermgr | ITリソース管理者のユーザーを登録する，ロールを設定する，アカウントのロックを解除する，またはユーザーの情報を一覧で表示する。
jirmvmconfig | 仮想ホストのリソースの割り当て量を確認または変更する。
jirmvmdel | デプロイ済みの仮想ホストを，仮想化ソフトウェア上から削除して，管理状態を削除待ちにする。
jirmvmdeploy | 仮想化ソフトウェア上に仮想ホストをデプロイする。
jirmvmmigrate | 仮想ホストをマイグレーションする。

メンテナンスに関するコマンド

コマンド名 | 機能概要
jirmbackup | JP1/ITRMのデータベースおよび定義ファイルのバックアップを取得する。
jirmcontrolservice | JP1/ITRMのサービスを起動，停止する，またはサービスの状態を確認する。
jirmdbreorg | データベースを再編成する。
jirmexport | JP1/ITRMのユーザー設定プロパティファイルやデータベースに格納されているデータをエクスポートする。
jirmimport | jirmexportコマンドでエクスポートしたデータをインポートする。
jirmrestore | jirmbackupコマンドで取得したバックアップデータをリストアする。
jirmsetportno | JP1/ITRMが使用するポート番号を変更する，または変更できるポート種別とポート番号を表示する。

トラブルシューティングに関するコマンド

コマンド名 | 機能概要
jirmgetlogs | JP1/ITRMの障害情報と，障害解析に必要な情報を採取する。

コマンド共通の注意事項

コマンドに共通する注意事項を次に示します。

［Ctrl］+［C］キーを押してコマンドを中止した場合

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，処理が失敗するおそれがあります。処理が失敗した場合は，しばらく時間を置いてからコマンドを再実行してください。

パスの指定方法

コマンドの引数にパスを指定する場合，特に断り書きがないときは次の点に注意して指定してください。

使用できる文字は，半角英数字，アンダーバー（_），ピリオド（.），ハイフン（-），コロン（:），シャープ（#），アットマーク（@），エンマーク（¥），丸括弧（()），半角スペースです。

コロン（:）が使用できるのは，ドライブ区切りだけです。

エンマーク（¥）が使用できるのは，フォルダ区切りだけです。

パスに半角スペースを含む場合は，パス全体を半角ダブルクォーテーション（"）で囲みます。

フォルダを指定する場合，先頭と末尾に，ピリオド（.）と半角スペースは指定できません。また，ピリオド（.）と半角スペースだけのフォルダも指定できません。

ハイフン（-）で始まるフォルダを指定する場合，オプション指定と区別するため，絶対パス形式で指定します。

相対パスで指定する場合，絶対パスに変換したあとの文字列が，指定されたバイト数以下になるようにしてください。

ネットワークドライブは指定できません。

コマンドの排他関係

JP1/ITRMで使用するコマンドには，ほかのコマンドの実行中に実行できないものがあります。コマンドの排他関係を次の表に示します。

表1-1　コマンドの排他関係

項番
実行中のコマンド
実行中のコマンドと同時に実行できるコマンド
実行中のコマンドと同時に実行できないコマンド

1

jirmbackup

jirmcontrolservice（-a stateオプション以外を指定した場合）

jirmdbreorg

jirmexport

jirmgetlogs（-dbまたは-mオプションを指定した場合）

jirmimport

jirmrestore

jirmsetportno（-cオプションを指定した場合）

jirmcontrolservice（-a stateオプションを指定した場合）

jirmimageimport

jirmsetportno（-rオプションを指定した場合）

排他関係をチェックしてエラーとなるコマンド

jirmbackup

jirmcontrolservice（-a stateオプション以外を指定した場合）

jirmdbreorg

jirmexport

jirmgetlogs

jirmimport

jirmrestore

jirmsetportno（-cオプションを指定した場合）

排他関係をチェックしないコマンド

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmsetup

jirmstatuschange

jirmunsetup

jirmusermgr

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

2

jirmcontrolservice（-a stateオプションを指定した場合）

jirmsetportno（-rオプションを指定した場合）

jirmbackup

jirmcontrolservice

jirmdbreorg

jirmexport

jirmgetlogs

jirmimageimport

jirmimport

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmrestore

jirmsetportno

jirmstatuschange

jirmusermgr

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

排他関係をチェックしないコマンド

jirmsetup

jirmunsetup

3
jirmgetlogs（-dbおよび-mオプションを指定しなかった場合）

jirmcontrolservice（-a stateオプションを指定した場合）

jirmimageimport

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmsetportno（-rオプションを指定した場合）

jirmstatuschange

jirmusermgr

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

排他関係をチェックしてエラーとなるコマンド

jirmbackup

jirmcontrolservice（-a stateオプション以外を指定した場合）

jirmdbreorg

jirmexport

jirmgetlogs

jirmimport

jirmrestore

jirmsetportno（-cオプションを指定した場合）

排他関係をチェックしないコマンド

jirmsetup

jirmunsetup

4
jirmimageimport

jirmbackup

jirmcontrolservice

jirmdbreorg

jirmexport

jirmgetlogs

jirmimport

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmrestore

jirmsetportno

jirmstatuschange

jirmusermgr

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

排他関係をチェックしてエラーとなるコマンド

jirmimageimport

排他関係をチェックしないコマンド

jirmsetup

jirmunsetup

5

jirminfocollect※

jirminfolist※

jirmnodeoperation※

jirmreport※

jirmstatuschange※

jirmusermgr※

jirmvmconfig※

jirmvmdel※

jirmvmdeploy※

jirmvmmigrate※

jirmcontrolservice（-a stateオプションを指定した場合）

jirmgetlogs（-dbおよび-mオプションを指定しなかった場合）

jirmimageimport

jirminfocollect※

jirminfolist※

jirmnodeoperation※

jirmreport※

jirmsetportno（-rオプションを指定した場合）

jirmstatuschange※

jirmusermgr※

jirmvmconfig※

jirmvmdel※

jirmvmdeploy※

jirmvmmigrate※

排他関係をチェックしないコマンド

jirmbackup

jirmcontrolservice（-a stateオプション以外を指定した場合）

jirmdbreorg

jirmexport

jirmgetlogs（-dbまたは-mオプションを指定した場合）

jirmimport

jirmrestore

jirmsetportno（-cオプションを指定した場合）

jirmsetup

jirmunsetup

6

jirmsetup（-rオプションを指定しなかった場合）

jirmunsetup

－

排他関係をチェックしないコマンド

すべてのコマンド

7
jirmsetup（-rオプションを指定した場合）
－

排他関係をチェックしてエラーとなるコマンド

jirmbackup

jirmcontrolservice（-a stateオプション以外を指定した場合）

jirmdbreorg

jirmexport

jirmgetlogs

jirmimageimport

jirmimport

jirmrestore

jirmsetportno（-cオプションを指定した場合）

jirmsetup（-rオプションを指定した場合）

排他関係をチェックしないコマンド

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmsetportno（-rオプションを指定した場合）

jirmsetup（-rオプションを指定しなかった場合）

jirmstatuschange

jirmunsetup

jirmusermgr

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

（凡例）

－：該当しない。

注※

同時に実行できるコマンド数は最大5つです。

jirmbackup

機能

JP1/ITRMのデータベースおよび設定情報のバックアップを取得するコマンドです。バックアップの取得は，Windowsのスケジュール実行機能またはJP1/AJS3に登録し，毎日自動で実行することをお勧めします。このコマンドは次のような場合に使用します。

ITリソース管理サーバの障害発生に備えて，定期的にバックアップを取得する。

データベースを再編成する場合など，データベースを操作する前にバックアップを取得する。

実行時の前提条件

JP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirmbackup -f 出力フォルダ名 [-q]

引数

-f 出力フォルダ名

バックアップフォルダ（JP1ITRM_backupまたはJP1ITRM_backup.old）を出力するフォルダの名称を指定します。バックアップフォルダには，バックアップしたデータが圧縮されて格納されています。出力フォルダ名を指定する際は次の点に注意してください。

156バイト以内の相対パスまたは絶対パス形式で指定します。

指定できるのは，ローカルディスク上にすでにあるフォルダだけです。ローカルディスク上にないフォルダを指定した場合や，存在しないフォルダ名を指定した場合は，エラーとなります。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

コマンド終了時のJP1/ITRMの各サービスの状態は，コマンド実行前と同じ状態になります。

戻り値

0 | 正常終了
1 | ほかのJP1/ITRMコマンドが実行中
2 | システム環境不正
3 | Administrators権限で実行していない
4 | 引数不正
5 | 指定したフォルダが存在しない，またはパスが不正
7 | ディスク容量不足
12 | 指定したフォルダ名が長過ぎる
16 | 内部コマンドの実行に失敗
17 | サービスの状態取得に失敗
18 | メモリの割り当てに失敗
60 | データベースのバックアップの実行に失敗
61 | データベースのバックアップ前処理に失敗
62 | データベースのバックアップ後処理に失敗
94 | サービスの状態が起動処理中または停止処理中
96 | JP1/ITRM DB Serviceが停止している
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
99 | その他のエラー（データベースのディスク容量不足を含む）

使用例

D:¥tmpフォルダにバックアップフォルダを出力する場合

jirmbackup -f D:¥tmp

jirmcontrolservice

機能

JP1/ITRMのサービスを起動，停止する，またはサービスの状態を確認するコマンドです。このコマンドは，Windowsのサービスコントロールマネージャーに複数登録されているJP1/ITRMのサービスの稼働状態を，一括で確認する場合などに使用します。また，このコマンドを使用すると，JP1/ITRMの各サービスを起動，停止する順序を統一できます。

このコマンドで操作対象となるサービスを次の表に示します。

表1-2　操作対象のサービス

サービス表示名※1 | サービス名※2 | サービスの内容
JP1/ITRM Web Service | JP1_ITRMWebService | Webサーバサービス
JP1/ITRM Service | JP1_ITRMService | JP1/ITRMの製品サービス
JP1/ITRM DB Service | HiRDBEmbeddedEdition_JR0 | データベースサービス

注※1

［コントロールパネル］－［管理ツール］－［サービス］で表示される名称です。

注※2

WSFCに登録する場合の名称です。

なお，データベースのクラスタ登録サービス（JP1/ITRM DB Cluster Service）は，操作対象ではありません。

実行時の前提条件

-aオプションでstartまたはstopを指定する場合，クラスタソフトにJP1/ITRMのサービスが登録されているときは，クラスタソフトでJP1/ITRMのサービスをオフラインにしてから実行してください。

形式

jirmcontrolservice -a {start | stop | state} [-q]

引数

-a {start | stop | state}

サービスに対する操作を指定します。

start：サービスの起動

stop：サービスの停止

state：サービスの状態の確認

JP1/ITRMのサービスを起動，停止する順序，またはサービスの状態を確認する順序を次の表に示します。

表1-3　サービスの起動，停止，状態の確認をする順序

サービス | 起動（start） | 停止（stop） | 状態の確認（state）
JP1/ITRM Web Service | 4 | 1 | 3
JP1/ITRM Service | 3 | 2 | 2
JP1/ITRM DB Service | サービス | 1 | 3 | －
ユニットサーバ（JP1/ITRM DB Serviceの子プロセス） | 2 | － | 1

（凡例）

－：操作しない。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

戻り値

0 | 正常終了
1 | ほかのJP1/ITRMコマンドが実行中
2 | システム環境不正
3 | Administrators権限で実行していない
4 | 引数不正
9 | ユーザーが処理を中止した
10 | サービスが停止できない
11 | サービスが起動できない
17 | サービスの状態取得に失敗
18 | メモリの割り当てに失敗
20 | 全サービスが起動状態（正常終了）
21 | JP1/ITRM DB Serviceが停止状態（正常終了）
22 | JP1/ITRM Serviceが停止状態（正常終了）
23 | JP1/ITRM Web Serviceが停止状態（正常終了）
24 | JP1/ITRM Web Serviceが起動状態（正常終了）
25 | JP1/ITRM Serviceが起動状態（正常終了）
26 | JP1/ITRM DB Serviceが起動状態（正常終了）
27 | JP1/ITRM DB Serviceの再起動を中断した
28 | 全サービスが停止状態（正常終了）
80 | サービスの状態が不正
91 | JP1/ITRM DB Serviceの起動に失敗
93 | サービスのスタートアップの種類が「無効」になっている
94 | サービスの状態が起動動作中または停止動作中
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
99 | その他のエラー

サービスの状態確認の結果

-aオプションにstateを指定した場合に出力される，サービスの状態確認の結果（戻り値）を次の表に示します。

表1-4　サービスの状態確認の結果（戻り値）

項番 | サービス | 状態確認の結果（戻り値）
JP1/ITRM Web Service | JP1/ITRM Service | JP1/ITRM DB Service
1 | 開始 | 開始 | 開始 | 全サービス開始（20）
2 | 開始 | 開始 | DBサービスの再起動が中断している状態 | DB再起動中断状態（27）
3 | 開始 | 開始 | JP1/ITRM DB Serviceは起動しているが，子プロセスは停止している状態 | DBサービス停止（21）
4 | 開始 | 開始 | 停止 | DBサービス停止（21）
5 | 開始 | 停止 | 開始 | 製品サービス停止（22）
6 | 開始 | 停止 | DBサービスの再起動が中断している状態 | DB再起動中断状態（27）
7 | 開始 | 停止 | JP1/ITRM DB Serviceは起動しているが，子プロセスは停止している状態 | Webサービス開始（24）
8 | 開始 | 停止 | 停止 | Webサービス開始（24）
9 | 停止 | 開始 | 開始 | Webサービス停止（23）
10 | 停止 | 開始 | DBサービスの再起動が中断している状態 | DB再起動中断状態（27）
11 | 停止 | 開始 | JP1/ITRM DB Serviceは起動しているが，子プロセスは停止している状態 | 製品サービス開始（25）
12 | 停止 | 開始 | 停止 | 製品サービス開始（25）
13 | 停止 | 停止 | 開始 | DBサービス開始（26）
14 | 停止 | 停止 | DBサービスの再起動が中断している状態 | DB再起動中断状態（27）
15 | 停止 | 停止 | JP1/ITRM DB Serviceは起動しているが，子プロセスは停止している状態 | 全サービス停止（28）
16 | 停止 | 停止 | 停止 | 全サービス停止（28）
17 | 任意の状態 | 任意の状態 | 開始または停止処理中 | 開始または停止処理中（94）
18 | 任意の状態 | 開始または停止処理中 | 任意の状態 | 開始または停止処理中（94）
19 | 開始または停止処理中 | 任意の状態 | 任意の状態 | 開始または停止処理中（94）

使用例1

サービスを起動する場合

jirmcontrolservice -a start

使用例2

サービスを停止する場合

jirmcontrolservice -a stop

使用例3

サービスの状態を確認する場合

jirmcontrolservice -a state

jirmdbreorg

機能

データベースを再編成するコマンドです。このコマンドは次のような場合に使用します。

データのアクセス効率および格納効率を改善したいときに，データベースの断片化された空き領域を再編成する。

データベースの領域不足を通知するイベントやメッセージが発行されたときに，データベースを再編成する。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM Web Serviceが停止している必要があります。

JP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

このコマンドではJP1/ITRMのデータベースを操作するため，実行前に必ずデータベースのバックアップを取得してください。

形式

jirmdbreorg -w 作業フォルダ名 [-q]

引数

-w 作業フォルダ名

コマンドの実行時に作成される，一時ファイルを格納するフォルダの名称を指定します。作業フォルダ名を指定する際は，次の点に注意してください。

161バイト以内の相対パスまたは絶対パス形式で指定します。

指定できるのは，ローカルディスク上にすでにあるフォルダだけです。ローカルディスク上にないフォルダを指定した場合や，存在しないフォルダ名を指定した場合は，エラーとなります。

指定した作業フォルダに十分な空き容量がないと，コマンドの実行に失敗するおそれがあります。次の表に示す空き容量があるフォルダを指定して，コマンドを再実行してください。

表1-5　データベースの規模と作業フォルダに必要な空き容量

データベースの規模 | -wで指定した作業フォルダに必要な空き容量（ギガバイト）
N30 | 22.0
N400 | 102.0
N700 | 170.0
N1000 | 236.0
N1500 | 350.0

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

JP1/ITRMのバージョンアップ後に，-rオプションを指定したjirmsetupコマンドを実行していない場合，データベースの再編成に失敗するおそれがあります。

コマンド終了後，JP1/ITRM ServiceおよびJP1/ITRM Web Serviceは停止したままの状態となります。

戻り値

0 | 正常終了
1 | ほかのJP1/ITRMコマンドが実行中
2 | システム環境不正
3 | Administrators権限で実行していない
4 | 引数不正
5 | 指定したフォルダが存在しない，またはパスが不正
7 | ディスク容量不足
9 | ユーザーが処理を中止した
12 | 作業フォルダ名が長過ぎる
13 | 削除できないフォルダまたはファイルが存在した
15 | 作業フォルダの削除に失敗
18 | メモリの割り当てに失敗
29 | システムファイルの読み込みに失敗
60 | データベースのバックアップに失敗
90 | JP1/ITRM DB Serviceの停止に失敗
91 | JP1/ITRM DB Serviceの起動に失敗
94 | サービスの状態が起動動作中または停止動作中
95 | JP1/ITRM ServiceまたはJP1/ITRM Web Serviceが起動中
96 | JP1/ITRM DB Serviceが停止中
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
99 | その他のエラー（JP1/ITRMのバージョンとデータベースのスキーマのバージョンが不一致またはデータベースのディスク容量不足を含む）

使用例

D:¥tmpを作業フォルダに指定して，データベースを再編成する場合

jirmdbreorg -w D:¥tmp

jirmexport

機能

JP1/ITRMの使用ポート番号の情報やユーザー設定プロパティファイルおよびデータベースに格納されているデータをエクスポートするコマンドです。このコマンドは次のような場合に使用します。

ITリソース管理サーバをリプレースする場合など，システム環境を移行するときに，データを退避する。

JP1/ITRMをバージョンアップするときに，データを退避する。

JP1/ITRMのデータベースの規模を変更するときに，データを退避する。

複数のJP1/ITRMをインストールしたシステムで，マシンの性能に問題がある場合など，一部のJP1/ITRMをほかのマシンに移行するときに，データを退避する。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM Web Serviceが停止している必要があります。

JP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境では，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirmexport -f 出力フォルダ名 [-q]

引数

-f 出力フォルダ名

JP1ITRM_exportdataフォルダを出力するフォルダの名称を指定します。JP1ITRM_exportdataフォルダには，エクスポートしたデータが格納されます。出力フォルダ名を指定する際は次の点に注意してください。

196バイト以内の相対パスまたは絶対パス形式で指定します。

指定できるのは，ローカルディスク上にすでにあるフォルダだけです。ローカルディスク上にないフォルダを指定した場合や，存在しないフォルダ名を指定した場合は，エラーとなります。

すでにJP1ITRM_exportdataフォルダが格納されているフォルダを指定した場合，上書きしてよいか確認するメッセージが出力されます。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

エクスポートの終了後，JP1/ITRM ServiceおよびJP1/ITRM Web Serviceは停止したままの状態となります。

エクスポートしたデータは，移行元と同じまたは上位のバージョンのJP1/ITRMにインポートできます。

JP1/ITRMのバージョンアップ後に，-rオプションを指定したjirmsetupコマンドを実行していない場合，エクスポートに失敗します。

戻り値

0
正常終了

1
ほかのJP1/ITRMコマンドが実行中

2
システム環境不正

3
Administrators権限で実行していない

4
引数不正

5
指定したフォルダが存在しない，またはパスが不正

7
ディスク容量不足

9
I/Oエラー

12
指定したフォルダ名が長過ぎる

13
削除できないフォルダまたはファイルが存在した

15
作業フォルダまたは作業ファイルの削除に失敗

18
メモリの割り当てに失敗

29
システムファイルの読み込みに失敗

30

テーブル定義ファイルの作成に失敗

JP1/ITRMのバージョンとデータベースのスキーマのバージョンが不一致

31
テーブルデータの抽出に失敗

90
JP1/ITRM DB Serviceの停止に失敗

91
JP1/ITRM DB Serviceの起動に失敗

94
サービスの状態が起動処理中または停止処理中

95
JP1/ITRM ServiceまたはJP1/ITRM Web Serviceが起動中

96
JP1/ITRM DB Serviceが停止中

97
コマンドを待機系サーバで実行している

98
［Ctrl］+［C］キーを押してコマンドを中止した

99
その他のエラー（データベースのディスク容量不足を含む）

使用例

D:¥tmpを出力フォルダに指定してエクスポートする場合

jirmexport -f D:¥tmp

jirmgetlogs

機能

JP1/ITRMの障害情報と，障害解析に必要な情報を採取するコマンドです。採取した情報は，JP1/ITRMに障害が発生した場合に，サポートセンターなどに問い合わせるときの資料として使用します。

実行時の前提条件

-dbオプションまたは-mオプションを指定する場合，次の点に注意してください。

JP1/ITRM ServiceおよびJP1/ITRM Web Serviceが停止している必要があります。

JP1/ITRM DB Serviceが起動している必要があります。

形式

jirmgetlogs -f 出力フォルダ名 [-q] [-db | -m]

引数

-f 出力フォルダ名

JP1ITRMRasInfoフォルダを出力するフォルダの名称を指定します。JP1ITRMRasInfoフォルダには，収集した障害情報が格納されます。出力フォルダ名を指定する際は次の点に注意してください。

141バイト以内の相対パスまたは絶対パス形式で指定します。

指定できるのは，ローカルディスク上にすでにあるフォルダだけです。ローカルディスク上にないフォルダを指定した場合や，存在しないフォルダを指定した場合は，エラーとなります。

すでにJP1ITRMRasInfoフォルダが格納されているフォルダを指定した場合，上書きしてよいか確認するメッセージが出力されます。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

-db

データベースのデータを収集する場合に指定します。

-m

データベースのインベントリ情報を格納したテーブルを収集する場合に指定します。

注意事項

コマンド終了後，JP1/ITRM ServiceおよびJP1/ITRM Web Serviceは停止したままの状態となります。

戻り値

0 | 正常終了
1 | ほかのJP1/ITRMコマンドが実行中
2 | システム環境不正
3 | Administrators権限で実行していない
4 | 引数不正
5 | 指定したフォルダが存在しない，またはパスが不正
7 | ディスク容量不足
9 | ユーザーが処理を中止した
12 | 指定したフォルダ名が長過ぎる
13 | 削除できないフォルダまたはファイルが存在した
14 | 一部を除いて終了
18 | メモリの割り当てに失敗
20 | サポートしていないOSバージョン
94 | サービスの状態が起動処理中または停止処理中
95 | JP1/ITRM ServiceまたはJP1/ITRM Web Serviceが起動中
96 | JP1/ITRM DB Serviceが停止中
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
99 | その他のエラー

使用例

D:¥tmpを出力フォルダに指定して，障害情報を収集する場合

jirmgetlogs -f D:¥tmp

jirmimageimport

機能

仮想化ソフトウェアに構築した仮想ホストの情報に基づいて，JP1/ITRMのライブラリ格納フォルダへ仮想イメージテンプレートおよびデプロイに必要な情報を作成するコマンドです。このコマンドは，JP1/ITRMのライブラリ管理機能を使用するための準備をする場合に使用します。ただし，HVMの場合は，仮想イメージテンプレートはJP1/SC/DPMで管理され，DPMシナリオ情報として格納されます。

実行時の前提条件

JP1/ITRMの前提条件に従って，SCVMM，vCenterまたはHVMの環境が構築できている必要があります。環境構築については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」を参照してください。

SCVMMから仮想イメージテンプレートを作成する場合，JP1/ITRMが使用するSCVMMの共有ライブラリ上に，仮想イメージテンプレートの基となる仮想ホストを格納しておいてください。また，JP1/ITRMが使用するSCVMMの共有ライブラリ上で，仮想ホスト名を重複させないでください。

VMware ESX 4.1以降で，仮想ホストがUSBデバイスを構成している場合は，設定を解除してください。

仮想イメージテンプレートの基となる仮想ホスト（HVMの場合はLPAR）の電源をOFFにしておいてください。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

デプロイ後，Hyper-V上の仮想ホストのダイナミックメモリを有効にする場合は，jirmimageimportコマンドを実行する前に，仮想イメージテンプレートの基となる仮想ホストのダイナミックメモリを有効にしておく必要があります。

仮想イメージテンプレートの基となる仮想ホストのOSがWindowsの場合，仮想ホストのドライブに，nodefaultdriveletter属性が設定されていないことを確認してください。nodefaultdriveletter属性は，diskpartコマンドで確認できます。nodefaultdriveletter属性の確認および解除手順を次に示します。

仮想イメージテンプレートの基となる仮想ホストのコマンドプロンプトで，diskpart.exeを実行する。

list volumeコマンドを実行し，コンピュータの各ボリュームの情報を表示する。

select volume nコマンドを実行し，指定したボリュームにフォーカスを設定する。
nには，手順2で表示されたボリュームの番号を指定します。

detail volumeコマンドを実行し，現在フォーカスが置かれているボリュームの詳細情報を確認する。
「既定のドライブ文字がありません」が「いいえ」の場合，nodefaultdriveletter属性は設定されていません。

nodefaultdriveletter属性が設定されている場合，attributes volume clear nodefaultdriveletterコマンドを実行し，設定を解除する。

形式

Hyper-Vの場合

jirmimageimport -t hyp
               [-d ライブラリ格納フォルダ名]
               -n 仮想イメージテンプレート名
               -v 仮想ホスト名
               -f SCVMMが動作するホストの完全修飾ドメイン名
               -u SCVMMが属するドメインへログインするためのドメイン名付きユーザー名
               -p SCVMMが属するドメインへログインするためのパスワード

VMwareの場合

jirmimageimport -t vmw
               [-d ライブラリ格納フォルダ名]
               -n 仮想イメージテンプレート名
               -h vCenterのデータセンター-仮想ホストの親ノード
               -v 仮想ホスト名
               -hip 仮想ホストが動作している仮想化ソフトウェアのIPアドレス
               -vip vCenterのIPアドレス
               -u vCenterへログインするためのユーザー名
               -p vCenterへログインするためのパスワード
               [-o vCenterのポート番号]

HVMの場合

jirmimageimport -t hvm
               [-d ライブラリ格納フォルダ名]
               -n 仮想イメージテンプレート名
               -hip 仮想ホストが動作している仮想化ソフトウェアのIPアドレス
               -lpar テンプレートLPAR番号
               -wip Webサーバ for DPMのIPアドレス
               [-wport Webサーバ for DPMで使用しているTomcatのポート番号]
               -dpmip 管理サーバ for DPMのIPアドレス
               -dpmpass 管理サーバ for DPMのパスワード
               -sn シナリオ名
               [-sharename 複製用情報ファイル格納フォルダの共有名]
               -mac 複製用情報ファイル作成時に入力した仮MACアドレス
               -shareuser 複製用情報ファイル格納フォルダのユーザー名
               -sharepass 複製用情報ファイル格納フォルダのパスワード
               -disk LPARに割り当てられたシステムディスクのLUのサイズ
               -os {RHEL | WIN2003 | WIN2008}

引数

-t {hyp | vmw | hvm}

仮想化ソフトウェアを指定します。指定した仮想化ソフトウェアが管理している，仮想ホストの仮想イメージテンプレートが，JP1/ITRMのライブラリに追加されます。

hyp：Hyper-V

vmw：VMware

hvm：HVM

-d ライブラリ格納フォルダ名

仮想イメージテンプレートを格納するJP1/ITRMのライブラリの格納フォルダ名を，絶対パス形式で指定します。ライブラリ格納フォルダ名は，仮想イメージテンプレート名と合わせて176バイト以内になるように指定します。省略した場合は，ユーザー設定プロパティファイル（jp1itrm.properties）の指定キーCO.templateFilePathの値が設定されます。プロパティの値が不正な場合，エラーで終了します。

-n 仮想イメージテンプレート名

仮想イメージテンプレートの名称を25バイト以内の半角文字列で指定します。指定できる文字を次に示します。

使用できる文字は，英数字，アンダーバー（_），ピリオド（.），シャープ（#），ハイフン（-），アットマーク（@），丸括弧（()），スペースです。

文字列にスペースを含む場合は，文字列全体をダブルクォーテーション（"）で囲みます。

文字列の先頭と末尾に，ピリオド（.）とスペースは指定できません。
また，ピリオド（.）とスペースだけの文字列も指定できません。

-v 仮想ホスト名

-tオプションにhypまたはvmwを指定した場合に，仮想ホストの名称を指定します。指定した仮想ホストの仮想イメージテンプレートが，JP1/ITRMのライブラリに追加されます。

-f SCVMMが動作するホストの完全修飾ドメイン名

-tオプションにhypを指定した場合に，SCVMMが動作するホストの完全修飾ドメイン名（例：scvmm.scvmmdomain.com）を指定します。

-u SCVMMが属するドメインへログインするためのドメイン名付きユーザー名，またはvCenterへログインするためのユーザー名

SCVMMが属するドメインまたはvCenterへログインするためのユーザー名を指定します。

-tオプションにhypを指定した場合は，SCVMMが属するドメインへログインするためのドメイン名付きユーザー名を指定します。SCVMMとライブラリサーバの両方にアクセスできるユーザー名をドメイン名¥ユーザー名の形式で指定します。

-tオプションにvmwを指定した場合は，vCenterへログインするためのユーザー名を指定します。

-p SCVMMが属するドメインまたはvCenterへログインするためのパスワード

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

-h vCenterのデータセンター-仮想ホストの親ノード

-tオプションにvmwを指定した場合に，次に示す書式で仮想ホストを特定するパスを指定します。

JP1/ITRMのリソース管理メニューの仮想構成，またはvCenterが管理する［ホストおよびクラスタ］の階層でパスを指定します。

パスはスラッシュ（/）で区切って指定します。

パスの先頭および末尾にスラッシュ（/）は指定できません。

パスの先頭はvCenter直後の階層にあるデータセンターまたはフォルダを指定します。

パスの末尾は仮想ホストの直前の階層にある親ノード（VMware ESXサーバ，クラスタ，プール，vAppのどれかが該当）を指定します。

-hip 仮想ホストが動作している仮想化ソフトウェアのIPアドレス

-tオプションにvmwまたはhvmを指定した場合に，仮想ホストが動作している仮想化ソフトウェアのIPアドレスを，0～255の半角数字とピリオド（.）で指定します。

-vip vCenterのIPアドレス

-tオプションにvmwを指定した場合に，vCenterのIPアドレスを，0～255の半角数字とピリオド（.）で指定します。

-o vCenterのポート番号

-tオプションにvmwを指定した場合に，vCenterへの接続先HTTPSポート番号を，0～65535の範囲で指定します。このオプションを省略した場合，ポート番号には443が設定されます。

-lpar テンプレートLPAR番号

-tオプションにhvmを指定した場合に，テンプレートLPARのLPAR番号を指定します。

-wip Webサーバ for DPMのIPアドレス

-tオプションにhvmを指定した場合に，Webサーバ for DPMのIPアドレスを，0～255の半角数字とピリオド（.）で指定します。

-wport Webサーバ for DPMで使用しているTomcatのポート番号

-tオプションにhvmを指定した場合に，Webサーバ for DPMで使用しているTomcatのポート番号を，0～65535の範囲で指定します。このオプションを省略した場合，ポート番号には8080が設定されます。

-dpmip 管理サーバ for DPMのIPアドレス

-tオプションにhvmを指定した場合に，管理サーバ for DPMのIPアドレスを，0～255の半角数字とピリオド（.）で指定します。

-dpmpass 管理サーバ for DPMのパスワード

-tオプションにhvmを指定した場合に，管理サーバ for DPMのパスワードを指定します。

-sn シナリオ名

-tオプションにhvmを指定した場合に，管理サーバfor DPMに登録されているDPMディスク複製OSインストール機能で使用するリストア用のシナリオ名を58文字以内で指定します。

-sharename 複製用情報ファイル格納フォルダの共有名

-tオプションにhvmを指定した場合に，複製用情報ファイル格納フォルダの共有名を80文字以内で指定します。このオプションを省略した場合，共有名にはDeployが設定されます。

-mac 複製用情報ファイル作成時に入力した仮MACアドレス

-tオプションにhvmを指定した場合に，複製用情報ファイル作成時に入力した仮MACアドレスを「xx-xx-xx-xx-xx-xx」の形式で指定します。

-shareuser 複製用情報ファイル格納フォルダのユーザー名

-tオプションにhvmを指定した場合に，複製用情報ファイル格納フォルダにアクセスするためのファイル共有のユーザー名を指定します。

-sharepass 複製用情報ファイル格納フォルダのパスワード

-tオプションにhvmを指定した場合に，複製用情報ファイル格納フォルダにアクセスするためのファイル共有のパスワードを指定します。

-disk LPARに割り当てられたシステムディスクのLUのサイズ

-tオプションにhvmを指定した場合に，テンプレートにするLPARに割り当てられたシステムディスクのLUのサイズを指定します。例えばLUのサイズが30ギガバイトの場合，次の形式で指定します。

バイトで指定する場合：-disk 32212254720

キロバイトで指定する場合：-disk 31457280KB

メガイトで指定する場合：-disk 30720MB

ギガバイトで指定する場合：-disk 30GB

-os {RHEL | WIN2003 | WIN2008}

-tオプションにhvmを指定した場合に，仮想ホストのOSを指定します。

RHEL：Red Hat Enterprise Linux 5

WIN2003：Windows Server 2003

WIN2008：Windows Server 2008，Windows Server 2008 R2

注意事項

このコマンドは，Hyper-VまたはVMwareの場合，容量の大きいファイルを転送するため，コマンドの実行に時間が掛かります。転送に掛かる時間は，ファイルのサイズやネットワーク帯域によって異なります。目安としては10ギガバイトのファイルの場合，30分程度です。ただし，HVMの場合，仮想イメージテンプレートファイルはJP1/SC/DPMで管理され，容量の大きいファイルは転送されないため，長い時間は掛りません。

Hyper-VまたはVMwareの場合，転送の経過時間が，目安となる時間と比較した上で，異常に長い場合は，障害が発生しているおそれがあります。-dオプションで指定したフォルダに格納されたファイルのサイズを監視し，転送中のファイルサイズが増えない場合は，障害が発生していると判断できます。

コマンドを実行すると，ファイル転送の開始時刻および終了時刻が次のように表示されます。

-tオプションにhypを指定した場合

KNAR83006-I 2010/08/18 13:30:25 仮想イメージテンプレートファイルの転送を開始します。
KNAR83007-I 2010/08/18 13:30:45 仮想イメージテンプレートファイルの転送が完了しました。

-tオプションにvmwを指定した場合

KNAR84006-I 2010/08/18 13:30:25 仮想イメージテンプレートファイルの転送を開始します。
KNAR84007-I 2010/08/18 13:30:45 仮想イメージテンプレートファイルの転送が完了しました。

また，VMwareの場合，コマンドで指定する仮想ホストは，VMware管理クライアントの［ホストおよびクラスタ］のツリーに存在している必要があります。vCenterで仮想イメージテンプレート化された仮想ホストは指定できません。

戻り値

0
正常終了

2
システム環境不正

3
Administrators権限で実行していない

4
引数不正

5
指定したフォルダが存在しない，またはパスが不正

12
指定したライブラリ格納フォルダ名と仮想イメージテンプレート名の合計が176バイトを超えている

16
Administrators権限で実行していない

97
コマンドを待機系サーバで実行している

98
［Ctrl］+［C］キーを押してコマンドを中止した

99
その他エラー（外部コマンド呼び出しの引数不正や，メモリ不足によるシステムエラーなど）

101
指定したテンプレート名が25バイトを超えている

102
指定したテンプレート名はすでに存在する

103
ユーザー名またはパスワードが不正

104
指定した仮想ホストの電源状態が不正

105
タイムアウトが発生

106
指定した仮想ホスト名が見つからない

107
vCenterのデータセンターから仮想ホストの親ノードまでのパスが不正

108
指定した仮想化環境管理ソフトウェアと通信できない

110
指定した仮想化ソフトウェアとの接続に失敗

111
仮想イメージテンプレートの作成に失敗

112
vCenterまたはSCVMMのAPIでエラーが発生

113
PowerShellがインストールされていない

115
すでにjirmimageimportコマンドが実行中

116
指定した仮想ホスト名と同一の仮想ホストが，共有ライブラリ上に重複して存在する

117
次の状態になっている

指定した仮想ホストが接続する仮想スイッチ，またはポートグループが存在しない

仮想ホストのネットワークアダプタの接続先に，VLANトランクポートが設定されている。

118
指定した仮想ホストにネットワークアダプタが存在しない

119
指定した仮想ホストにハードディスクが存在しない

120
ユーザー設定プロパティファイル（jp1itrm.properties）に指定したライブラリ共有名が存在しない

121
FTPによるファイル転送に失敗

122
SCVMMおよびHyper-Vで管理するゲストOSではない仮想ホストが指定された

123
チェックポイントまたはスナップショットを持つ仮想ホストが指定された

124
ユーザー設定プロパティファイル（jp1itrm.properties）に指定したライブラリ共有名と同名のライブラリ共有が複数存在する

125
指定したWebサーバfor DPMの設定に失敗

126
指定した管理サーバfor DPMの情報の取得に失敗

127
シナリオが存在しない

128
複製用情報ファイル格納フォルダにアクセスできない

129
指定したHVMからの情報の取得に失敗

130
指定したシナリオ名が58文字を超えている

131
指定した共有名が80文字を超えている

132
複製用情報ファイルが存在しない

134
共有ネットワークアダプタ，共有FCアダプタ以外が接続されている構成から除外されたテンプレートが作成された

135
引数で指定したOS種別と複製用情報ファイルのOS種別が異なっている

136
複製用情報ファイル格納フォルダへの接続に失敗

137
ファイルのコピーでエラーが発生

138
HvmShコマンドが見つからない

139
コマンドラインfor DPM が見つからない

140
管理サーバ for DPMのパスワードが間違っている

141
管理サーバ for DPMのパスワードをチェックするときに使用するグループ名がすでに存在している

142
管理サーバ for DPMのパスワードをチェックするときに使用するグループ名がすでに存在し，かつ端末情報の削除に失敗

143
指定したLPARが見つからない

144
DPMの更新モードの取得に失敗

145
指定したLPARに占有ネットワークアダプタが割り当てられている

146
指定したLPARに占有FCアダプタが割り当てられている

147
指定したLPARに共有ネットワークアダプタが存在しない

148
指定したLPARに共有FCアダプタが存在しない

149
指定したHVMからの情報の取得中に予期しないエラーが発生した

使用例1

vCenterが管理する仮想ホストの仮想イメージテンプレートを，JP1/ITRMのライブラリへ追加する場合

図1-1　vCenter上の構成イメージ

jirmimageimport -t vmw -d E:¥itrm¥template -n windows2003template
-h DataCenter/Folder/ESXServer -v vm01 -hip xxx.xxx.xxx.2 -vip xxx.xxx.xxx.1 -u user01 -p password

使用例2

vCenterが管理する仮想ホストの仮想イメージテンプレートを，JP1/ITRMのライブラリへ追加する場合（VMware ESXサーバがクラスタ構成のとき）

図1-2　vCenter上の構成イメージ（クラスタ構成の場合）

jirmimageimport -t vmw -d e:¥itrm¥template -n windows2003template
-h DataCenter/Cluster -v vm01 -hip xxx.xxx.xxx.2 -vip xxx.xxx.xxx.1
-u user01 -p password

使用例3

vCenterが管理する仮想ホストの仮想イメージテンプレートを，JP1/ITRMのライブラリへ追加する場合（VMware ESXサーバがクラスタ構成ではなく，VMware ESXサーバ配下にプールが存在する場合）

図1-3　vCenter上の構成イメージ（クラスタ構成ではなく，配下にプールが存在する場合）

jirmimageimport -t vmw -n windows2003template
-h DataCenter/Folder/ESXServer/Pool -v vm01
-hip xxx.xxx.xxx.2 -vip xxx.xxx.xxx.1 -u user01 -p password

使用例4

vCenterが管理する仮想ホストの仮想イメージテンプレートを，JP1/ITRMのライブラリへ追加する場合（VMware ESXサーバがクラスタ構成で，VMware ESXサーバクラスタ配下にプールが存在する場合）

図1-4　vCenter上の構成イメージ（クラスタ構成で，クラスタ配下にプールが存在する場合）

jirmimageimport -t vmw -n windows2003template
-h DataCenter/Cluster/Pool -v vm01 -hip xxx.xxx.xxx.2 -vip xxx.xxx.xxx.1
-u user01 -p password

使用例5

SCVMMが管理する仮想ホストの仮想イメージテンプレートを，JP1/ITRMのライブラリへ追加する場合

図1-5　SCVMM上の構成イメージ

jirmimageimport -t hyp -d e:¥itrm¥template -n windows2003template
-v vm01 -f scvmm.scvmmdomain.com -u scvmmdomain.com¥user03 -p password

使用例6

HVMが管理する仮想ホストの仮想イメージテンプレートを，JP1/ITRMのライブラリへ追加する場合

図1-6　HVM上の構成イメージ

jirmimageimport -t hvm -d e:¥itrm¥template -n ws2008template01 -hip 11.111.111.11 -lpar 1 -wip 11.111.111.33 -wport 8080 -dpmip 11.111.111.22 -dpmpass passwd01 -sn Scenario01 -sharename Deploy -mac ff-ff-ff-ff-ff-ff -shareuser admin02 -sharepass passwd02 -disk 30GB -os WIN2008

jirmimport

機能

jirmexportコマンドでエクスポートしたデータをインポートするコマンドです。このコマンドは次のような場合に使用します。

ITリソース管理サーバをリプレースするときなど，システム環境を移行するときに，データを復元する。

JP1/ITRMをバージョンアップするときに，データを復元する。

JP1/ITRMのデータベースの規模を変更するときに，データを復元する。

複数のJP1/ITRMをインストールしたシステムで，マシンの性能に問題がある場合など，一部のJP1/ITRMをほかのマシンに移行するときに，データを復元する。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM Web Serviceが停止している必要があります。

JP1/ITRM DB Serviceが起動している必要があります。

データの移行先では，移行元と同じまたは上位のバージョンのJP1/ITRMがインストールおよびセットアップされている必要があります。

クラスタ環境では，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirmimport -f JP1ITRM_exportdata格納フォルダ名 [-q]

引数

-f JP1ITRM_exportdata格納フォルダ名

JP1ITRM_exportdataフォルダが格納されているフォルダの名称を指定します。JP1ITRM_exportdataフォルダには，エクスポートしたデータが格納されています。JP1ITRM_exportdata格納フォルダ名を指定する際は次の点に注意してください。

196バイト以内の相対パスまたは絶対パス形式で指定します。

指定できるのは，ローカルディスク上にすでにあるフォルダだけです。ローカルディスク上にないフォルダを指定した場合や，存在しないフォルダ名を指定した場合は，エラーとなります。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

ユーザー設定プロパティファイル（jp1itrm.properties）は，インポート時に別名（jp1itrm.properties.export）で格納されます。このため，インポート後に，ユーザー設定プロパティファイルの内容を書き換える必要があります。

インポートの終了後，JP1/ITRM ServiceおよびJP1/ITRM Web Serviceは停止したままの状態となります。

過去のバージョンでエクスポートしたデータをインポートした場合は，次のどちらかの方法でITリソースの情報を再収集してください。

設定画面の［監視間隔設定］エリアで，［すべてを再収集］ボタンをクリックする。

-allオプションと-dオプションを指定したjirminfocollectコマンドを実行する。

JP1/ITRMで使用するポート番号は，エクスポート時に使用するポート番号に復元されます。使用するポート番号を変更したい場合は，インポート実行後にjirmsetportnoコマンドを実行してください。

JP1/ITRMのバージョンが09-51より前のエクスポートデータを使用した場合，API用のポートはoffになります。

戻り値

0 | 正常終了
1 | ほかのJP1/ITRMコマンドが実行中
2 | システム環境不正
3 | Administrators権限で実行していない
4 | 引数不正
5 | 指定したフォルダが存在しない，またはパスが不正
7 | ディスク容量不足
9 | ユーザーが処理を中止した
12 | 削除できないフォルダまたはファイルがある
18 | メモリの割り当てに失敗
29 | システムファイルの読み込みに失敗
40 | 指定したフォルダ下にエクスポートデータが存在しない
41 | インポートするデータが不正
42 | 指定したフォルダ下にあるエクスポートデータがインポート先に適合しない
43 | テーブル定義の再定義に失敗
44 | テーブルデータの注入に失敗
90 | JP1/ITRM DB Serviceの停止に失敗
91 | JP1/ITRM DB Serviceの起動に失敗
94 | サービスの状態が起動処理中または停止処理中
95 | JP1/ITRM ServiceまたはJP1/ITRM Web Serviceが起動中
96 | JP1/ITRM DB Serviceが停止中
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
99 | その他のエラー（データベースのスキーマの変更に失敗またはデータベースのディスク容量不足を含む）

使用例

D:¥tmpフォルダに格納されているJP1ITRM_exportdataフォルダをインポートする場合

jirmimport -f D:¥tmp

jirminfocollect

機能

JP1/ITRMが管理しているITリソースの構成情報を収集するコマンドです。次の情報を収集します。

リソース情報※1

ネットワーク情報

ドライブ情報

リソース状態※2

パフォーマンス情報※2

注※1

仮想ホストの場合，リソース情報のうち次の項目は，仮想ホストが動作している仮想化ソフトウェアに対して再収集したときに情報が更新されます。

・仮想化ソフトウェア

・仮想化ソフトウェアから収集した仮想ホストのCPU

・CPU占有種別

・仮想化ソフトウェアから収集した仮想ホストのメモリ

・NICポート数

また［リソースプール］は，仮想化環境管理ソフトウェアに対して再収集したときに情報が更新されます。

注※2

リソース状態とパフォーマンス情報を収集する場合は，オプション（-d）の指定が必要です。

このコマンドは，ITリソースを手動で追加して構成が変更された場合など，構成情報を収集するときに使用します。

なお，このコマンドで構成情報を収集できるのは，監視または監視停止の状態のITリソースです。ITリソースの状態が監視または監視停止以外の場合，構成情報を収集できません。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirminfocollect {-all | -res リソース名 | -rg リソースグループ名 |
               -bg 業務グループ名}
               [-retrycount リトライ回数 [-interval リトライ待ち時間]]
               [-d]

引数

-all

JP1/ITRMが管理しているすべてのITリソースに対して，構成情報を収集する場合に指定します。

-res リソース名

構成情報を収集するリソース名を指定します。

-rg リソースグループ名

構成情報を収集するリソースグループ名を指定します。

-bg 業務グループ名

構成情報を収集する業務グループ名を指定します。

-retrycount リトライ回数

構成情報の収集処理を実行している間は，収集対象のITリソースが異なる場合でも収集処理を並行して実行できません。そのような場合に，間隔を空けて収集処理要求を繰り返す回数を指定します。0～50の範囲で指定します。このオプションを省略した場合，再収集しません。

-interval リトライ待ち時間

-retrycountオプションで構成情報を再収集するように指定した場合の収集処理を要求する間隔（秒）を指定します。1～60の範囲で指定します。このオプションを省略した場合，5秒間隔になります。

-d

構成情報として「リソース情報」，「ネットワーク情報」，および「ドライブ情報」のほかに，「リソース状態」および「パフォーマンス情報」を取得する場合に指定します。このオプションを省略した場合，「リソース情報」，「ネットワーク情報」，および「ドライブ情報」が取得されます。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，処理が失敗するおそれがあります。正しく処理されているかどうかは，リソース管理画面の［システム］タブの情報を参照して確認してください。

グループがフォルダによって階層化されているリソースグループまたは業務グループを引数に指定する場合は，最上位のフォルダ名からスラッシュ（/）を区切り文字としてパス形式で指定してください。
例：フォルダA/フォルダB/リソースグループ1

戻り値

0 | 正常終了
1 | 引数不正
2 | JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない
8 | メモリ不足
12 | 通信エラー
16 | 実行権限がない
35 | 同時に実行できるコマンドの数を超えている
130 | ［Ctrl］+［C］キーを押してコマンドを中止した
137 | ITリソース，リソースグループ，業務グループが見つからない
145 | コマンド実行エラー（エラーの詳細はメッセージで確認）
165 | 操作対象のITリソースの一部について構成情報の収集に失敗
235 | 構成情報収集中にコマンドを実行した
255 | その他のエラー

使用例1

ITリソース「Resource1」の構成情報を収集する場合

jirminfocollect -res Resourse1

使用例2

リソースグループ「RG1」の構成情報を収集する場合

jirminfocollect -rg RG1

使用例3

業務グループ「Gyomu1」の構成情報を収集する場合

jirminfocollect -bg Gyomu1

使用例4

JP1/ITRMが管理しているすべてのITリソースに対して，「リソース情報」，「ネットワーク情報」，「ドライブ情報」，「リソース状態」，および「パフォーマンス情報」を取得する場合

jirminfocollect -all -d

jirminfolist

機能

ITリソースの構成情報をCSV形式でファイルに出力するコマンドです。このコマンドは次のような場合に使用します。

データセンター内にあるITリソースを把握する。

構築する業務システムの要件に応じて，ITリソースを絞り込む。

クラスタ環境の場合に，クラスタソフトを導入する物理ホストおよび仮想ホストを決定する。

移行するシステムの仮想ホストの一覧を作成する。

システムを構成している物理ホストと仮想ホストを一覧で確認する。

各ITリソースの最新の構成情報を確認する。

リソースの割り当て量を追加できる物理ホストがないか一覧で確認する。

管理台帳を参照し，リソースの割り当て量を追加できないか確認する。

現在の仮想化ソフトウェアに余裕がないか調査する。

ほかの仮想化ソフトウェアにマイグレーションできるか調査する。

各物理ホストの空きリソース量と，現在のリソースの使用状況を一覧で確認する。

パッチの適用対象となる仮想ホストの要件を確認する。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirminfolist {-all | -res リソース名 | -rg リソースグループ名 |
            -bg 業務グループ名}
            -f ファイル名 [-d] [-encoding {utf8 | utf8n}]

引数

-all

JP1/ITRMが管理しているすべてのITリソースの構成情報を出力する場合に指定します。

-res リソース名

構成情報を出力するリソース名を指定します。

-rg リソースグループ名

構成情報を出力するリソースグループ名を指定します。

-bg 業務グループ名

構成情報を出力する業務グループ名を指定します。

-f ファイル名

ITリソースの構成情報を出力するファイルの名称を，絶対パスまたは相対パス形式で指定します。ファイル名だけを指定した場合は，カレントディレクトリにCSVファイルを出力します。同名のファイルがすでに存在する場合は，ファイルを上書きします。

-d

CPU，メモリ，およびドライブの情報など，構成情報の詳細を出力する場合に指定します。このオプションを指定した場合に出力される項目については「表1-6　jirminfolistコマンドの出力項目」を参照してください。

-encoding {utf8 | utf8n}

ITリソースの構成情報を出力するファイルの文字コードを指定します。このオプションを省略した場合，OSのデフォルトエンコーディングで出力します。

utf8：BOM（Byte Order Mark）付きのUTF-8で出力する。

utf8n：BOMが付かないUTF-8で出力する。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，出力中のファイルが正しく出力さません。

ファイル出力処理中にエラーやユーザーによる中断などでコマンド実行が中断した場合は，出力中のファイルは削除されないで出力先に残ります。

グループがフォルダによって階層化されているリソースグループまたは業務グループを引数に指定する場合は，最上位のフォルダ名からスラッシュ（/）を区切り文字としてパス形式で指定してください。
例：フォルダA/フォルダB/リソースグループ1

構成情報が未収集または収集中の仮想ホストに対してはコマンドを実行できません。

-encodingオプションを省略して，OSのデフォルトエンコーディングでファイルを出力した場合，UTF-8から変換できない文字は「?」として出力されます。

戻り値

0 | 正常終了
1 | 引数不正
2 | JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない
8 | メモリ不足
12 | 通信エラー
16 | 実行権限がない
35 | 同時に実行できるコマンドの数を超えている
130 | ［Ctrl］+［C］キーを押してコマンドを中止した
131 | ファイルへの出力に失敗
137 | 指定したリソース名が存在しない
145 | コマンド実行エラー（エラーの詳細はメッセージで確認）
255 | その他のエラー

出力ファイルの形式

このコマンドを実行して出力されるCSVファイルの項目を次の表に示します。項目名はコンマ（,）区切りで出力されます。項目値にダブルクォーテーション（"）が存在する場合は，ダブルクォーテーション（"）2つに置き換え，さらに設定値全体をダブルクォーテーション（"）で囲みます。項目値にコンマ（,）が存在する場合は，その項目をダブルクォーテーション（"）で囲みます。

ファイルの1行目には，製品名，バージョン，ファイル名，および文字コードを，2行目には，ヘッダーとして各項目の項目名を出力します。3行目以降に，管理対象のデータを出力します。

表1-6　jirminfolistコマンドの出力項目

項番
項目名
ヘッダー名
出力属性
値

1
デバイス※1
DEVICE
○
出力対象のデバイスのカテゴリ。
次のどれかの文字列を出力する。

サーバ

仮想化ソフトウェア

ネットワークデバイス

ストレージ

プール

VMクラスタ

vApp

ドライブ情報（-dオプションを指定した場合，ITリソースに複数のドライブがあるときに出力する）

ネットワーク情報（-dオプションを指定した場合，アダプタのネットワーク情報があるときに出力する）

不明

2
タイプ
TYPE
○
出力対象のデバイスのタイプ。
値はデバイスごとに異なり，次のどれかの文字列を出力する。

サーバまたは仮想化ソフトウェアの場合

物理

仮想

不明

ネットワークデバイスの場合

FC

IP

FC/IP

ストレージの場合

FC

iSCSI

FC/iSCSI

ファイルサーバ

不明なインターフェース

FC/ファイルサーバ

iSCSI/ファイルサーバ

FC/iSCSI/ファイルサーバ

上記以外の場合

空文字

3
リソース名※1
RESOURCENAME
○
リソースの名称。

4
ホスト名
HOSTNAME
○
ホスト名。

5
管理状態
MANAGEMENTSTATUS
○
次のどれかの文字列を出力する。

発見

未処理

管理対象

管理対象外

削除待ち

6
状態
STATUS
○
管理状態が「管理対象」の場合，次のどれかの文字列を出力する。

正常

警告

異常

不明

応答なし

監視停止

7
管理IPアドレス※1，※2
MANAGEMENTIPADDRESS
○
管理IPアドレス。
複数の場合はコンマ（,）区切りで連結する。

8
業務IPアドレス※2
BUSINESSIPADDRESS
○
業務IPアドレス。
複数の場合はコンマ（,）区切りで連結する。

9
ネットワークアドレス
NETWORKADDRESS
○
ネットワークアドレス。
複数の場合はコンマ（,）区切りで連結する。

10
NIC枚数
NUMOFNIC
○
Network Interface Cardの枚数。

11
WWPN
WWPN
○
ファイバーチャネルのWWPN（World Wide Port Name）。
複数の場合はコンマ（,）区切りで連結する。

12
リソースグループ
RESOURCEGROUP
○
ITリソースが所属するリソースグループの名称。
階層をスラッシュ（/）区切りで連結する。

13
リソースグループ割り当て種別
RESOURCEGROUPTYPE
○
リソースグループの割り当て種別。
次のどれかの文字列を出力する。

共有

占有

割り当て不可

14
業務グループ
BUSINESSGROUP
○
ITリソースが所属する業務グループの名称。
階層をスラッシュ（/）区切りで連結する。複数の場合はコンマ（,）区切りで連結する。

15
導入予定日時
INTRODUCTIONDATE
○
導入予定日時。
yyyy/mm/dd hh:mm形式で出力する。

16
滅却予定日時
REMOVALDATE
○
滅却予定日時。
yyyy/mm/dd hh:mm形式で出力する。

17
コメント1
COMMENT1
○
コメント1。

18
コメント2
COMMENT2
○
コメント2。

19
コメント3
COMMENT3
○
コメント3。

20
モデル
MODEL
○
デバイスのモデル。

21
OS
OS
○
OSの名前。

22
OSバージョン
OSVERSION
△
OSのバージョン。

23
ベンダー
VENDER
△
デバイスのベンダー。

24
CPU
CPU
△
CPUの名前。

25
CPUクロック数
CPUCLOCK(MHz)
△
CPUクロック数（メガヘルツ）。

26
CPUコア数
NUMOFCPUCORE
△
CPUコア数。

27
CPU同時マルチスレッディング
CPUSMT
△
CPUの同時マルチスレッディング（Simultaneous Multithreading）の有効・無効を表す。
次のどれかの文字列を出力する。

有効

無効

不明

28
CPU占有種別
CPUOCCUPATIONTYPE
△
仮想ホストのCPUが占有か共有かを表す。
次のどれかの文字列を出力する。

占有

共有

不明

29
メモリ
MEMORY(MB)
△
メモリ容量（メガバイト）

30
CPUクロック数
VMCPUCLOCK(MHz)
△
仮想化環境管理ソフトウェアまたは仮想化ソフトウェアから収集した仮想ホストのCPUクロック数（メガヘルツ）。
仮想ホストが仮想化環境管理ソフトウェアの管理対象の場合だけ出力する。

31
CPUコア数
VMNUMOFCPUCORE
△
仮想化環境管理ソフトウェアまたは仮想化ソフトウェアから収集した仮想ホストのCPUコア数。
仮想ホストが仮想化環境管理ソフトウェアの管理対象の場合だけ出力する。

32
メモリ
VMMEMORY(MB)
△
仮想化環境管理ソフトウェアまたは仮想化ソフトウェアから収集した仮想ホストのメモリ容量（メガバイト）。
仮想ホストが仮想化環境管理ソフトウェアの管理対象の場合だけ出力する。

33
ドライブ種別※1
DRIVECATEGORY
△
ドライブがファイルシステムかストレージプールかを表す。
次のどちらかの文字列を出力する。

ファイルシステム

プール

34
ドライブ名※1
DRIVENAME
△
ドライブの名前。

35
ドライブ状態※1
DRIVESTATUS
△
ドライブの状態。
次のどれかの文字列を出力する。

正常

警告

異常

不明

監視停止

収集しない

36
ドライブ使用量※1
DRIVEUSED(MB)
△
ドライブ使用量（メガバイト）。

37
ドライブ空き容量※1
DRIVEFREE(MB)
△
ドライブ空き容量（メガバイト）。

38
ドライブ総容量※1
DRIVETOTAL(MB)
△
ドライブ総容量（メガバイト）。

39
ファイルシステム※1
FILESYSTEM
△
ファイルシステムの種別。

40
ドライブタイプ※1
DRIVETYPE
△
ドライブがローカルかネットワークかを表す。
次のどちらかの文字列を出力する。

ローカル

ネットワーク

41
RAIDレベル※1
RAIDLEVEL
△
SMI-Sプロバイダから取得した情報。

例（3つのデータディスクと1つのパリティディスクを持つRAID5構成の場合）

RAID5（3D+1P）

42
IPネットワークアダプタ※3
IPNETWORKADAPTER
△
ITリソースが使用しているIPネットワークアダプタの名称。

43
アダプタ種別※3
IPNETWORKADAPTERTYPE
△
ITリソースが使用しているIPネットワークアダプタの種別。

44
IPアドレス※3
IPNETWORKADDRESS
△
ITリソースが使用しているIPネットワークアダプタのIPアドレス。

45
仮想スイッチ名※3
VIRTUALSWITCH
△
IPネットワークアダプタの仮想スイッチ名。

46
ネットワークセグメント※3
NETWORKSEGMENT
△
IPネットワークアダプタのネットワークセグメント。

47
FCネットワークアダプタ※3
FCNETWORKADAPTER
△
ITリソースが使用しているFCネットワークアダプタの名称。

48
WWPN※3
WWPNOFADAPTER
△
ファイバーチャネルのWWPN。

49
FC-HBA占有種別※3
FCHBAOCCUPATIONTYPE
△
ITリソースが使用しているネットワークアダプタが占有か共有かを示す。
次のどちらかの文字列を出力する。

占有の場合

占有

共有の場合

共有(共有数:共有数，最大共有数:最大共有数)

50
接続ストレージ
CONNECTEDSTORAGE
△
ITリソースが接続されているストレージの名称の一覧。
複数の場合はコンマ（,）区切りで連結する。

51
仮想化ソフトウェアのホスト名
HVHOSTNAME
△
仮想化ソフトウェアのホスト名。
出力対象のITリソースが仮想ホストの場合，その仮想ホストが動作する仮想化ソフトウェアのホスト名を出力する。

52
仮想化環境管理ソフトウェアのホスト名
VMMHOSTNAME
△
仮想化環境管理ソフトウェアのホスト名。
出力対象のITリソースが仮想化環境管理ソフトウェアに管理されている場合，その仮想化環境管理ソフトウェアが動作するホストの名前を出力する。

53
仮想化構成ツリーパス
VMMTREEPATH
△
ITリソースの仮想化環境管理ソフトウェアのツリー上でのパス。
出力対象のITリソースが仮想化環境管理ソフトウェアに管理されている場合，そのITリソースの仮想化構成ツリーのパスをスラッシュ（/）区切りのパス形式で出力する。

54
HAクラスタグループ名
HACLUSTERGROUP
△
HAクラスタグループの名前。
出力対象のITリソースがHAクラスタグループに所属する場合に出力する。

55
監視テンプレート
THRESHOLDTEMPLATE
△
ITリソースに指定されている監視テンプレートの名前。

（凡例）

○：常に出力する。

△：-ｄオプションを指定した場合だけ出力する。

注※1

ドライブが複数存在する場合は，「デバイス」，「リソース名」，「管理IPアドレス」および項番33～41のドライブ関連の項目をドライブごとに1行ずつ出力します。

注※2

仮想ホスト削除タスクによって削除待ちの状態にあるリソースの場合は，これらの情報を空文字で出力します。

注※3

アダプタが複数ある場合は，これらの情報をアダプタごとに1行ずつ出力します。

このコマンドを実行して出力されるファイルの出力例を次に示します。

出力例1

サーバが複数ドライブを持つ場合

JP1/IT Resource Management - Manager,0950,構成情報,MS932
DEVICE,TYPE,RESOURCENAME,HOSTNAME,MANAGEMENTSTATUS,STATUS,MANAGEMENTIPADDRESS,...,DRIVECATEGORY,DRIVENAME,...
サーバ,物理,"windows2008, R2",windows2008,管理対象,正常,"10.208.XX.XX,192.168.XX.XX",...,ファイルシステム,C:,
ドライブ情報,,"windows2008, R2",windows2008,,"10.208.XX.XX,192.168.XX.XX",...,ファイルシステム,D:,
ドライブ情報,,"windows2008, R2",windows2008,,"10.208.XX.XX,192.168.XX.XX",...,ファイルシステム,E:,
サーバ,仮想,windows VM,windows VM,管理対象,正常,10.208.XX.XX,...,ファイルシステム,C:,...
...

出力例2

ストレージおよびネットワークデバイスが存在する場合

JP1/IT Resource Management - Manager,0950,構成情報,MS932
DEVICE,TYPE,RESOURCENAME,HOSTNAME,MANAGEMENTSTATUS,STATUS,MANAGEMENTIPADDRESS,...,DRIVECATEGORY,DRIVENAME,...
ストレージ,FC,STG@10.208.XX.XX,,管理対象,正常,10.208.XX.XX,...,プール,RG,...
ドライブ情報,,STG@10.208.XX.XX,,管理対象,正常,10.208.XX.XX,...,プール,RG,..
ネットワークデバイス,FC,switch,,管理対象,正常,10.208.XX.XX,...,,,...
...

使用例1

JP1/ITRMが管理しているすべてのITリソースの構成情報を出力する場合

jirminfolist -all -f C:¥temp¥infolist_result.csv -d

使用例2

業務グループ「/業務グループA/システム1」の構成情報を出力する場合

jirminfolist -bg /業務グループA/システム1 -f C:¥temp¥infodata.csv -d

jirmnodeoperation

機能

JP1/ITRMが管理しているホストを起動，停止，強制停止，リブート，および強制リブートするコマンドです。操作対象が仮想ホストの場合は，起動，停止，強制停止，リブート，および強制リブートできます。操作対象が物理ホストの場合は，リブートできます。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

操作対象の仮想ホストは，探索で発見後，管理対象に設定し監視状態が「監視」または「監視停止」である必要があります。

操作対象が仮想ホストの場合，仮想ホストを管理している仮想化ソフトウェアおよび仮想化環境管理ソフトウェアが稼働している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirmnodeoperation -name リソース名
                 -op {start | stop | forcestop | reboot |
                 forcereboot}
                 [-wait] [-q]

引数

-name リソース名

操作対象とするホストのリソース名を指定します。

-op {start | stop | forcestop | reboot | forcereboot}

ホストに実行する操作を指定します。

start：起動

stop：停止

forcestop：強制停止

reboot：リブート

forcereboot：強制リブート

-wait

ホストに対する各操作が完了するのを待って，コマンドを終了する場合に指定します。このオプションを省略した場合，仮想ホストを操作する処理要求をしたあとすぐにコマンドが終了し，処理結果は表示されません。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

ホストに実行できる操作

各ホストに実行できる操作については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」の，ホストの起動・停止・リブートについての説明を参照してください。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，処理が失敗するおそれがあります。正しく処理されているかどうかは，タスク画面のタスク一覧エリアで確認してください。

戻り値

0 | 正常終了
1 | 引数不正
2 | JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない
8 | メモリ不足
12 | 通信エラー
16 | 実行権限がない
19 | ユーザー問い合わせで処理を中止した
35 | 同時に実行できるコマンドの数を超えている
106 | コマンドの前提条件を満たさないITリソースを指定した
130 | ［Ctrl］+［C］キーを押してコマンドを中止した
137 | 操作対象のITリソースが存在しない
145 | コマンド実行エラー（エラーの詳細はメッセージで確認）
254 | 重複しているリソース名を指定した
255 | その他のエラー

使用例

仮想ホスト「hostB」の停止を非対話形式で実行する場合（処理が完了するのを待ってコマンド終了する場合）

jirmnodeoperation -name hostB -op stop -wait -q

jirmreport

機能

JP1/ITRMの各種レポートをCSV形式でファイルに出力するコマンドです。次に示す7種類のレポートを出力します。

物理ホスト割り当て実績レポート
レポート画面のレポート表示エリアに表示される物理ホスト割り当て実績レポートのデータを，CSV形式でファイルに出力します。
指定した期間内で，総ホスト数，割り当て済みホスト数，CPU使用率，およびメモリ使用率の実績を，物理ホストの対象OSごとに出力します。

物理ホスト割り当て予定レポート
レポート画面のレポート表示エリアに表示される物理ホスト割り当て予定レポートのデータをCSV形式でファイルに出力します。
指定した期間内で，総ホスト数，および割り当て済みホスト数の予定を，物理ホストの対象OSごとに出力します。

仮想化ソフトウェア割り当て実績レポート
レポート画面のレポート表示エリアに表示される仮想化ソフトウェア割り当て実績レポートのデータをCSV形式でファイルに出力します。
指定した期間内で，仮想化ソフトウェアの総性能の量，割り当て済み性能の量，および使用率の実績を出力します。

仮想化ソフトウェア割り当て予定レポート
レポート画面のレポート表示エリアに表示される仮想化ソフトウェア割り当て予定レポートのデータをCSV形式でファイルに出力します。
指定した期間内で，仮想化ソフトウェアの総性能の量，および割り当て済み性能の量の予定を出力します。

予約状況・予約実績一覧レポート
指定した期間内の予約状況および予約実績情報をCSV形式でファイルに出力します。

リソース使用量レポート
指定した期間内のITリソースの使用量をCSV形式でファイルに出力します。

リソース使用量（時間推移）レポート
仮想化ソフトウェアおよび仮想ホストの性能履歴の時間推移を，指定した条件に一致するリソースごとにCSV形式でファイルに出力します。

このコマンドは次のような場合に使用します。

パフォーマンスが低下しているシステムでホストをスケールアウトする。

スペックが不足しているホストをスケールアップする。

データセンター内などで動作する物理ホストおよび仮想ホストのリソースの割り当て状況を確認する。

スケジュールの利用期間が終了した物理ホストおよび仮想ホストの一覧を作成する。

対象ホスト上で動作する仮想ホストの一時退避先となる仮想化ソフトウェアを，管理台帳を参照して決定する。

予約状況および予約履歴を確認する。

割り当てたホストの課金情報を作成する。

予約状況と実績にずれがある場合，仮想ホストの予約を見直すようにITリソース利用者に促す。

ある仮想化ソフトウェアに負荷が掛かってしまい，障害リスクが高まるおそれがある場合，負荷が平均的になるように仮想ホストの配置を見直す。

仮想化ソフトウェアを効率的に利用するために，1つの仮想化ソフトウェアに仮想ホストをまとめる。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

物理ホスト割り当て実績レポートを出力する場合

jirmreport -alloc phhis {-all {rg | bg} | -rg リソースグループ名 |
          -bg 業務グループ名}
          [-os {windows | linux | hp-ux | aix}] [-date 起点日時]
          [-range {month | 6month | year}]
          [-encoding {utf8 | utf8n}]
          -f ファイル名

物理ホスト割り当て予定レポートを出力する場合

jirmreport -alloc phplan {-all {rg | bg} | -rg リソースグループ名 |
          -bg 業務グループ名}
          [-os {windows | linux | hp-ux | aix}]
          [-range {month | 6month | year}]
          [-encoding {utf8 | utf8n}]
          -f ファイル名

仮想化ソフトウェア割り当て実績レポートを出力する場合

jirmreport -alloc hvhis {-all {rg | bg} | -rg リソースグループ名 |
          -bg 業務グループ名}
          [-metric {cpu | memory}] [-date 起点日時]
          [-range {month | 6month | year}]
          [-encoding {utf8 | utf8n}]
          -f ファイル名

仮想化ソフトウェア割り当て予定レポートを出力する場合

jirmreport -alloc hvplan {-all {rg | bg} | -rg リソースグループ名 |
          -bg 業務グループ名}
          [-metric {cpu | memory}]
          [-range {month | 6month | year}]
          [-encoding {utf8 | utf8n}]
          -f ファイル名

予約状況・予約実績一覧レポートを出力する場合

jirmreport -resv {-all {rg | bg} | -rg リソースグループ名 |
          -bg 業務グループ名 | -res リソース名 | -resvid 予約ID}
          [-date 起点日時]
          [-range {day | week | month | 6month | year}]
          [-encoding {utf8 | utf8n}]
          -f ファイル名

リソース使用量レポートを出力する場合

jirmreport -perf {-all {rg | bg} | -rg リソースグループ名 |
          -bg 業務グループ名 | -res リソース名}
          [-range {day | week | month | 2month}]
          [-encoding {utf8 | utf8n}]
          -f ファイル名

リソース使用量（時間推移）レポートを出力する場合

jirmreport -perfh {-all {rg | bg} | -rg リソースグループ名 |
          -bg 業務グループ名}
          [-encoding {utf8 | utf8n}]
          -f ファイル名

引数

-alloc {phhis | phplan | hvhis | hvplan}

物理ホストまたは仮想化ソフトウェアの割り当て状況のレポートを出力する場合，レポートの種類を指定します。

phhis：物理ホスト割り当て実績レポート

phplan：物理ホスト割り当て予定レポート

hvhis：仮想化ソフトウェア割り当て実績レポート

hvplan：仮想化ソフトウェア割り当て予定レポート

-os {windows | linux | hp-ux | aix}

物理ホストの割り当て状況のレポートを出力する場合，対象となるOSを指定します。このオプションを省略した場合，Windowsが対象になります。

windows：Windows

linux：Linux

hp-ux：HP-UX

aix：AIX

-metric {cpu | memory}

仮想化ソフトウェアの割り当て状況のレポートを出力する場合，対象となるメトリックを指定します。このオプションを省略した場合，CPUが対象になります。

cpu：CPU

memory：メモリ

-resv

予約状況・予約実績一覧レポートを出力する場合に指定します。

-perf

リソース使用量レポートを出力する場合に指定します。

-perfh

リソース使用量（時間推移）レポートを出力する場合に指定します。

-all {rg | bg}

レポートを出力する対象となるグループ種別を指定します。指定したグループ種別のすべてのグループが対象になります。

rg：全リソースグループ

bg：全業務グループ

-res リソース名

予約状況・予約実績一覧レポートまたはリソース使用量レポートを出力する場合，対象となるリソース名を指定します。該当するITリソースが複数存在する場合は，それらすべてが出力対象になります。

-resvid 予約ID

予約状況・予約実績一覧レポートを出力する場合，対象となる予約IDを1～9223372036854775807の範囲で指定します。このオプション指定した場合，-dateおよび-rangeオプションで出力対象として指定する集計期間に関係なく，指定した予約IDに該当する予約を出力します。

-rg リソースグループ名

レポートを出力する対象となるリソースグループ名を指定します。指定したリソースグループに所属するすべてのITリソースが出力対象になります。該当のリソースグループがフォルダによって階層化されている場合，フォルダ名を指定することもできます。

-bg 業務グループ名

レポートを出力する対象となる業務グループ名を指定します。指定した業務グループに所属するすべてのITリソースが出力対象になります。該当の業務グループがフォルダによって階層化されている場合，フォルダ名を指定することもできます。

-date 起点日時

物理ホスト割り当て実績レポート，仮想化ソフトウェア割り当て実績レポート，および予約状況・予約実績一覧レポートを出力する場合，対象の起点となる日時をyyyyMMddHHmm形式で指定します。なお，時刻（HHmm）の指定は，省略できます。時刻の指定を省略した場合，0：00が設定されます。このオプションを省略した場合，コマンド実行日の1か月前の0：00が起点日時になります。

-range {day | week | month | 2month | 6month | year}

レポートを出力する対象となる集計期間を指定します。-dateオプションで指定した起点日時から集計期間分が出力対象になります。

day：1日

week：1週間

month：1か月（31日）

2month：2か月（62日）

6month：6か月（186日）

year：1年（365日）

dayとweekは，予約状況・予約実績一覧レポートおよびリソース使用量レポートを出力する場合だけ指定できます。また，2monthはリソース使用量レポートを出力する場合だけ指定できます。このオプションを省略した場合，1か月が出力対象になります。

なお，集計期間に終了日時は含まれません。「起点日時≦集計期間＜集計期間の終了日時」となります。month，2month，6month，およびyearを指定する場合，それぞれの終了日時は，翌月（31日後），2か月後（62日後），6か月後（186日後），および1年後（365日後）になります。

-f ファイル名

レポートを出力するファイルの名称を，絶対パスまたは相対パス形式で指定します。ファイル名だけを指定した場合は，カレントディレクトリにファイルを出力します。同名のファイルがすでに存在する場合は，ファイルを上書きします。

-encoding {utf8 | utf8n}

レポートを出力するファイルの文字コードを指定します。このオプションを省略した場合，OSのデフォルトエンコーディングで出力します。

utf8：BOM（Byte Order Mark）付きのUTF-8で出力する。

utf8n：BOMが付かないUTF-8で出力する。

オプションごとの指定の可否を次の表に示します。

表1-7　オプションごとの指定の可否

オプション種別 | オプション種別に対応するオプション | レポート種別に対応するオプション
-alloc | -resv | -perf | -perfh
phhis | phplan | hvhis | hvplan
OS | -os | windows | △※1 | △※1 | × | × | × | × | ×
linux | △ | △ | × | × | × | × | ×
hp-ux | △ | △ | × | × | × | × | ×
aix | △ | △ | × | × | × | × | ×
メトリック | -metric | cpu | × | × | △※1 | △※1 | × | × | ×
memory | × | × | △ | △ | × | × | ×
出力対象 | -all | ○ | ○ | ○ | ○ | ○ | ○ | ○
-res | × | × | × | × | ○ | ○ | ×
-resvid | × | × | × | × | ○ | × | ×
-rg | ○ | ○ | ○ | ○ | ○ | ○ | ○
-bg | ○ | ○ | ○ | ○ | ○ | ○ | ○
起点日時 | -date | △ | × | △ | × | △ | × | ×
出力期間 | -range | day | × | × | × | × | △ | △ | ×
week | × | × | × | × | △ | △ | ×
month | △※1 | △※1 | △※1 | △※1 | △※1 | △※1 | ×
2month | × | × | × | × | × | △ | ×
6month | △ | △ | △ | △ | △ | × | ×
year | △ | △ | △ | △ | △ | × | ×
出力ファイル | -f | ◎ | ◎ | ◎ | ◎ | ◎ | ◎ | ◎
文字コード | -encoding※2 | utf8 | △ | △ | △ | △ | △ | △ | △
utf8n | △ | △ | △ | △ | △ | △ | △

（凡例）

◎：常に指定する。

○：同種別のオプションの中から必ず1つを指定する。

△：同種別のオプションの中から1つだけ指定できる。指定しない場合はデフォルトが設定される。

×：指定できない。

注※1

オプションを指定しない場合のデフォルトの設定になります。

注※2

指定しない場合は，OSのデフォルトエンコーディングでファイルを出力します。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，出力中のファイルが正しく出力さません。

ファイル出力処理中にエラーやユーザーによる中断などでコマンド実行が中断した場合は，出力中のファイルは削除されないで出力先に残ります。

グループがフォルダによって階層化されているリソースグループまたは業務グループを引数に指定する場合は，最上位のフォルダ名からスラッシュ（/）を区切り文字としてパス形式で指定してください。
例：フォルダA/フォルダB/リソースグループ1
また，引数にフォルダ名を指定する場合は，パスの最後の文字をスラッシュ（/）にしてください。
例：フォルダA/フォルダB/フォルダC/

-dateオプションで指定できる日時は，1970/01/02 00:00～2038/01/17 23:59です。

-encodingオプションを省略して，OSのデフォルトエンコーディングでファイルを出力した場合，UTF-8から変換できない文字は「?」として出力されます。

リソース使用量（時間推移）レポートを出力する場合，次の原因で性能情報を取得できなかったとき，該当する取得日時の性能情報は空白となります。

JP1/ITRMサービスが停止している

ITリソースを監視停止に設定している

VMware Distributed Resource SchedulerなどJP1/ITRM以外で仮想ホストをマイグレーションしたあとに，構成情報を更新していない

リソース使用量（時間推移）レポートを出力する場合，コマンド実行中に仮想ホストをマイグレーションしたときは，マイグレーションした仮想ホストの情報が出力されないことがあります。

リソース使用量（時間推移）レポートを出力する場合，レポート出力の対象期間中に，仮想化ソフトウェアのCPUまたはメモリの構成を変更したときは，仮想化ソフトウェアのCPU使用量またはメモリ使用量の正しい値が算出できません。仮想化ソフトウェアの構成を変更する場合は，必要に応じてjirmreportコマンドを利用してリソース使用量（時間推移）レポートの出力結果を保存してください。

リソース使用量（時間推移）レポートを出力する場合，一度に大量のリソースを出力対象にするとJP1/ITRMの負荷が高くなり，実行に1時間程度掛かることがあります。そのときは，-rgまたは-bgオプションで特定のリソースグループまたは業務グループを指定して，出力対象のリソースを限定した上でコマンドを実行してください。

戻り値

0 | 正常終了
1 | 引数不正
2 | JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない
8 | メモリ不足
12 | 通信エラー
16 | 実行権限がない
35 | 同時に実行できるコマンドの数を超えている
130 | ［Ctrl］+［C］キーを押してコマンドを中止した
131 | ファイルへの出力に失敗
137 | 指定したリソース名が存在しない
145 | コマンド実行エラー（エラーの詳細はメッセージで確認）
255 | その他のエラー

出力ファイルの形式

このコマンドを実行して出力されるCSVファイルの項目を，レポート種別ごとに次の表に示します。項目名はコンマ（,）区切りで出力されます。項目値にダブルクォーテーション（"）が存在する場合は，ダブルクォーテーション（"）2つに置き換え，さらに設定値全体をダブルクォーテーション（"）で囲みます。項目値にコンマ（,）が存在する場合は，その項目をダブルクォーテーション（"）で囲みます。

1行目には，製品名，バージョン，レポート名，文字コード，出力開始日時，および出力終了日時が出力されます。2行目には，それぞれのレポートの出力項目が，ヘッダーとして出力されます。

次に，2行目にヘッダーとして出力される項目を，レポートの種類ごとに説明します。

物理ホスト割り当て実績レポート

表1-8　物理ホスト割り当て実績レポートの出力項目

項番
項目名
ヘッダー名
値

1
日付
DATE
引数で指定した期間内の日付。
yyyy/mm/dd形式で出力する。

2
総ホスト数
TOTALHOSTS
項番1の日付時点でのリソースグループまたは業務グループの総物理ホスト数。

3
割り当て済みホスト数
ALLOCATEDHOSTS
項番1の日付時点でのリソースグループまたは業務グループの割り当て済み物理ホスト数。

4
CPU使用率
CPU(%)
項番1の日付時点でのリソースグループまたは業務グループ内の物理ホストのCPU使用率。

5
メモリ使用率
MEMORY(%)
項番1の日付時点でのリソースグループまたは業務グループ内の物理ホストのメモリ使用率。

注

日付ごとに古い順に出力します。

出力例

JP1/IT Resource Management - Manager,0911,物理ホスト割り当て実績,MS932,2010/12/31 00:00,2011/01/31 00:00
DATE,TOTALHOSTS,ALLOCATEDHOSTS,CPU(%),MEMORY(%)
2010/12/31,500,200,50.01,49.50
2011/01/01,500,200,40.10,30.50
2011/01/02,501,100,5.50,10.50

物理ホスト割り当て予定レポート

表1-9　物理ホスト割り当て予定レポートの出力項目

項番
項目名
ヘッダー名
値

1
日付
DATE
引数で指定した期間内の日付。
yyyy/mm/dd形式で出力する。

2
総ホスト数
TOTALHOSTS
項番1の日付時点でのリソースグループまたは業務グループの総物理ホスト数。

3
割り当て済みホスト数
ALLOCATEDHOSTS
項番1の日付時点でのリソースグループまたは業務グループの割り当て済み物理ホスト数。

注

日付ごとに古い順に出力します。

出力例

JP1/IT Resource Management - Manager,0911,物理ホスト割り当て予定,MS932,2010/12/31 00:00,2011/01/31 00:00
DATE,TOTALHOSTS,ALLOCATEDHOSTS
2011/12/31,500,200
2012/01/01,500,200
2013/01/02,501,100

仮想化ソフトウェア割り当て実績レポート

表1-10　仮想化ソフトウェア割り当て実績レポートの出力項目

項番
項目名
ヘッダー名
値

1
日付
DATE
引数で指定した期間内の日付。
yyyy/mm/dd形式で出力する。

2
総性能
TOTALPERF
項番1の日付時点でのリソースグループまたは業務グループの仮想化ソフトウェアの総性能（CPUまたはメモリ）。
対象がCPUの場合はギガヘルツ，メモリの場合はギガバイトを単位として出力する。

3
割り当て性能
ALLOCATEDPERF
項番1の日付時点でのリソースグループまたは業務グループの仮想化ソフトウェアに割り当てられた性能（CPUまたはメモリ）。
対象がCPUの場合はギガヘルツ，メモリの場合はギガバイトを単位として出力する。

4
使用率
UTIL(%)
項番1の日付時点でのリソースグループまたは業務グループに割り当てられた性能（CPUまたはメモリ）に対する使用率。

注

日付ごとに古い順に出力します。

出力例

JP1/IT Resource Management - Manager,0911,仮想化ソフトウェア割り当て実績,MS932,2010/12/31 00:00,2011/01/31 00:00
DATE,TOTALPERF,ALLOCATEDPERF,UTIL(%)
2010/12/31,400,100,50.01
2011/01/01,400,100,30.50

仮想化ソフトウェア割り当て予定レポート

表1-11　仮想化ソフトウェア割り当て予定レポートの出力項目

項番
項目名
ヘッダー名
値

1
日付
DATE
引数で指定した期間内の日付。
yyyy/mm/dd形式で出力する。

2
総性能
TOTALPERF
項番1の日付時点でのリソースグループまたは業務グループの仮想化ソフトウェアの総性能（CPUまたはメモリ）。
対象がCPUの場合はギガヘルツ，メモリの場合はギガバイトを単位として出力する。

3
割り当て性能
ALLOCATEDPERF
項番1の日付時点でのリソースグループまたは業務グループの仮想化ソフトウェアに割り当てられた性能（CPUまたはメモリ）。
対象がCPUの場合はギガヘルツ，メモリの場合はギガバイトを単位として出力する。

注

日付ごとに古い順に出力します。

出力例

JP1/IT Resource Management - Manager,0911,仮想化ソフトウェア割り当て予定,MS932,2010/12/31 00:00,2011/01/31 00:00
DATE,TOTALPERF,ALLOCATEDPERF
2010/12/31,400,100
2011/01/01,400,100

予約状況・予約実績一覧レポート

表1-12　予約状況・予約実績一覧レポートの出力項目

項番
項目名
ヘッダー名
値

1
予約ID
RESERVATIONID
予約時に自動で割り振られる予約ID。

2
予約名
RESERVATIONNAME
予約名。

3
予約開始日時
RESERVATIONSTART
予約開始日時。
yyyy/mm/dd hh:mm形式で出力する。

4
予約終了日時
RESERVATIONEND
予約終了日時。
yyyy/mm/dd hh:mm形式で出力する。
状態が「占有予約」の場合は出力しない。

5
状態
STATUS
予約の状態。
次のどれかの文字列を出力する。

未実行

実行中

完了

占有予約

6
コメント
COMMENT
コメント。

7
業務グループ名
BUSINESSGROUP
ITリソースが所属する業務グループ名。
階層をスラッシュ（/）区切りで連結する。

8
予約ユーザー名
USERNAME
予約者のユーザー名。

9
予約ユーザーID
USERID
予約者のユーザーID。

10
リソース名
RESOURCENAME
予約対象のリソース名。

11
管理IPアドレス
MANAGEMENTIPADDRESS
管理IPアドレス。

12
リソースグループ名
RESOURCEGROUP
ITリソースが所属するリソースグループ名。
階層をスラッシュ（/）区切りで連結する。

13
リソースグループ種別
RESOURCEGROUPTYPE
リソースグループ種別
次のどれかの文字列を出力する。

占有

共有

割り当て不可

14
OS
OS
OSの名前。

15
CPUクロック数
CPUCLOCK(MHz)
CPUクロック数（メガヘルツ）。
仮想ホストが仮想化環境管理ソフトウェアの管理対象の場合，仮想化環境管理ソフトウェアから収集した情報を出力する。

16
CPUコア数
NUMOFCPUCORE
CPUコア数。
仮想ホストが仮想化環境管理ソフトウェアの管理対象の場合，仮想化環境管理ソフトウェアから収集した情報を出力する。

17
メモリ
MEMORY(MB)
メモリ（メガバイト）。
仮想ホストが仮想化環境管理ソフトウェアの管理対象の場合，仮想化環境管理ソフトウェアから収集した情報を出力する。

18
NIC枚数
NUMOFNIC
NIC枚数。

19
仮想化ソフトウェア名
HVHOSTNAME
仮想化ソフトウェアのホスト名。
出力対象のITリソースが仮想ホストの場合，その仮想ホストが動作する仮想化ソフトウェアのホスト名を出力する。

20
リソースプール名
RESOURCEPOOLNAME
リソースプール名。
出力対象のITリソースが仮想ホストで，その仮想ホストがリソースプール上で動作する場合，そのリソースプール名を出力する。

21
HAクラスタグループ名
HACLUSTERGROUP
HAクラスタグループ名。
ITリソースがHAクラスタに所属している場合，その名称を出力する。

22
リソース予約開始日時
RESOURCESTART
個別予約開始日時のうち最も早い日時。
yyyy/mm/dd hh:mm形式で出力する。
1つの予約でそのITリソースが占有される期間の開始日時を表す。
予約の追加または編集で，予約スペックを前の期間の値から変更した場合，変更後の予約スペックの個別予約開始日時を表す。

23
リソース予約終了日時
RESOURCEEND
個別予約終了日時のうち最も遅い日時。
yyyy/mm/dd hh:mm形式で出力する。
1つの予約でそのITリソースが占有される期間の終了日時を表す。
予約の追加または編集で，予約スペックを前の期間の値から変更した場合，変更前の期間に対するリソース予約終了日時は，変更後の予約スペックの個別予約開始日時を表す。
状態が「占有予約」の場合は出力しない。

24
予約CPUクロック数
RESERVEDCPUCLOCK(MHz)
ユーザーが予約時に確保したITリソースのCPUクロック数（メガヘルツ）。

25
予約コア数
RESERVEDNUMOFCPUCORE
ユーザーが予約時に確保したITリソースのCPUコア数。

26
予約メモリ
RESERVEDMEMORY(MB)
ユーザーが予約時に確保したITリソースのメモリ容量（メガバイト）。

27
導入予定日時
INTRODUCTIONDATE
ITリソースの導入予定日時。
yyyy/mm/dd hh:mm形式で出力する。

28
滅却予定日時
REMOVALDATE
ITリソースの滅却予定日時。
yyyy/mm/dd hh:mm形式で出力する。

29
個別予約期間名
PERIODNAME
個別予約の期間名。

30
個別予約期間種別
PERIODTYPE
個別予約期間の種別。
次のどちらかの文字列を出力する。

利用

保守

31
個別予約開始日時
PERIODSTART
個別予約の開始日時。
yyyy/mm/dd hh:mm形式で出力する。

32
個別予約終了日時
PERIODEND
個別予約の終了日時。
yyyy/mm/dd hh:mm形式で出力する。
状態が「占有予約」の場合は出力しない。

注

予約開始日時の古い順に出力します。

1つの予約で複数のITリソースを予約している場合，項番10～項番32を予約対象のITリソースごとに複数行出力します。その際は，リソース予約開始日時の古い順に出力します。

項番1～項番9は同じ情報を繰り返し出力します。

1つの予約で1つのITリソースに複数の予約期間がある場合，項番29～項番32を個別予約の期間数分出力します。その際は，個別予約開始日時の古い順に，該当のITリソースと同じ行に出力します。

1つのITリソース内の個別予約期間で予約スペックを変更している場合，項番22～項番32を予約スペックの変更数分出力します。

項番1～項番21，項番27および項番28は，同じ情報を繰り返し出力します。

指定した期間内に予約がない場合は，予約状況・予約実績一覧レポートの出力項目は出力されません。

出力例

予約スペックを変更していない場合

JP1/IT Resource Management - Manager,0911,予約状況・予約実績一覧,MS932,2010/12/31 00:00,2011/01/31 00:00
RESERVATIONID,RESERVATIONNAME,...,RESOURCENAME,...,RESOURCESTART,...,PERIODNAME,...
10,予約1,...,HOST1,...,2010/12/31 00:00,...,期間1,...,期間2,...
10,予約1,...,HOST2,...,2010/12/31 00:00,...,期間1,...,期間2,...
10,予約1,...,HOST3,...,2011/01/01 00:00,...,期間1,...,期間2,...
20,予約2,...,HOST1,...,2011/01/10 00:00,...,期間1,...,期間2,...,期間3,...
20,予約2,...,HOST2,...,2011/01/10 00:00,...,期間1,...,期間2,...,期間3,...
30,予約3,...,HOST2,...,2011/01/20 00:00,...,期間1,...

HOST1の予約スペックを期間2で変更した場合

JP1/IT Resource Management - Manager,0951,予約状況・予約実績一覧,MS932,2011/11/01 00:00,2011/12/02 00:00
RESERVATIONID,RESERVATIONNAME,...,RESOURCENAME,...,CPUCLOCK(MHz),NUMOFCPUCORE,MEMORY(MB),...,RESOURCESTART,RESOURCEEND,RESERVEDCPUCLOCK(MHz),RESERVEDNUMOFCPUCORE,RESERVEDMEMORY(MB),...,PERIODNAME,PERIODSTART,PERIODEND
10,予約１,...,HOST1,...,3000.00,2,2048.00,...,2011/11/02 00:00,2011/11/04 00:00,1000,1,1024.00,...,期間1,2011/11/02 00:00,2011/11/03 00:00
10,予約１,...,HOST1,...,3000.00,2,2048.00,...,2011/11/04 00:00,2011/11/15 00:00,3000,2,2048.00,...,期間2,2011/11/04 00:00,2011/11/10 00:00,期間3 ,...

リソース使用量レポート

表1-13　リソース使用量レポートの出力項目

項番
項目名
ヘッダー名
値

1
デバイス
DEVICE
デバイスの種別。
次のどれかの文字列を出力する。

サーバ

仮想化ソフトウェア

プール

VMクラスタ

vApp

2
タイプ
TYPE
物理または仮想の種別を示す。
リソース種別が「サーバ」，「サーバ（仮想化ソフトウェア上）」，または「仮想化ソフトウェア」の場合，次のどれかの文字列を出力する。

物理

仮想

不明

3
リソース名
RESOURCENAME
リソース名。

4
管理状態
MANAGEMENTSTATUS
次のどれかの文字列を出力する。

発見

未処理

管理対象

管理対象外

削除待ち

5
状態
STATUS
管理状態が「管理対象」の場合，次のどれかの文字列を出力する。

正常

警告

異常

不明

応答なし

監視停止

6
管理IPアドレス
MANAGEMENTIPADDRESS
管理IPアドレス。

7
リソースグループ名
RESOURCEGROUP
ITリソースが所属するリソースグループ名。
階層をスラッシュ（/）区切りで連結する。

8
リソースグループ種別
RESOURCEGROUPTYPE
リソースグループ種別。
次のどれかの文字列を出力する。

占有

共有

割り当て不可

9
業務グループ名
BUSINESSGROUP
ITリソースが所属する業務グループ名。
階層をスラッシュ（/）区切りで連結する。複数の場合はコンマ（,）区切りで連結する。

10
OS
OS
OSの名前。

11
収集日時※1
COLLECTEDDATE
性能履歴の収集日時。
yyyy/mm/dd hh:mm形式で出力する。
出力期間にweekを指定した場合，分を表すmmは，30で固定される。
出力期間にmonthまたは2monthを指定した場合，hh:mmは，14:00で固定される。

12
測定項目
METRIC
CPU使用率（%）やメモリ使用率（%）など，JP1/ITRMが収集する性能情報の種別と単位を出力する。JP1/ITRMが収集する性能情報については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」を参照。

13
測定対象
INSTANCE
測定対象の名前。
リソース管理画面の［パフォーマンス］タブに表示される［測定対象］と同じ項目を出力する。

14
測定対象状態
INSTANCESTATUS
次のどれかの文字列を出力する。

正常

警告

異常

不明

監視停止

収集しない

15
性能値※2
PERFVALUE
性能値。
値は測定項目ごとに異なる。

注

リソース使用量レポートでは，すべての管理状態のITリソースを出力対象とします。プール，VMクラスタ，およびvAppの管理状態は，これらを管理する仮想化環境管理ソフトが稼働するホストの管理状態に依存します。

また，ITリソースごとに項番10～項番15を指定期間数分，収集日時の古い順に複数行出力します。その際，項番1～項番9は同じ情報を繰り返し出力します。

出力するITリソースがない場合は，リソース使用量レポートの出力項目は出力されません。

注※1

出力期間と出力するデータの対応を次に示します。なお，性能履歴のデータの集約前に実行した場合，その測定項目の行は出力しません。

出力期間 | 出力するデータ
day | 性能監視の間隔に設定した間隔で取得したデータ。
week | dayを指定した場合に出力するデータを集計し，1時間の平均に集約したデータ。
month | dayを指定した場合に出力するデータを集計し，1日の平均に集約したデータ。
2month

注※2

性能値がない場合，その測定項目の行は出力しません。

出力例

JP1/IT Resource Management - Manager,0911,リソース使用量,MS932,2010/12/31 00:00,2011/01/31 00:00
DEVICE,TYPE,RESOURCENAME,...,COLLECTEDDATE,METRIC,INSTANCE,INSTNCESTATUS,PERFVALUE
サーバ,物理,HOST1,...,2010/12/31 00:00,CPU使用率(%),CPU,正常,40.55
サーバ,物理,HOST1,...,2011/01/01 00:00,CPU使用率(%),CPU,正常,30.00
：
サーバ,物理,HOST1,...,2011/01/31 00:00,CPU使用率(%),CPU,正常,10.22
仮想化ソフトウェア,物理,HOST2,...,2010/12/31 00:00,CPU使用率(%),CPU,正常,20.11
仮想化ソフトウェア,物理,HOST2,...,2011/01/01 00:00,20.00,...

リソース使用量（時間推移）レポート

表1-14　リソース使用量（時間推移）レポートの出力項目

項番
項目名
ヘッダー名
値

仮想ホストの場合
仮想化ソフトウェアの場合

1
デバイス種別
DEVICETYPE
デバイスの種別。
文字列「VM」を出力する。
デバイスの種別。
文字列「HV」を出力する。

2
詳細種別
DETAILTYPE
仮想ホストのOS種別。
次の文字列を出力する。

Windows

Linux

仮想化ソフトウェアの種別。
次の文字列を出力する。

VMware

Hyper-V

HVM

3
リソース名
RESOURCENAME
リソース名。

4
仮想化ソフトウェアのリソース名
HVRESOURCENAME
仮想ホストが動作する仮想化ソフトウェアのリソース名。
仮想化ソフトウェアのリソース名。

5
測定項目
METRIC
JP1/ITRMが収集する性能情報の種別と単位を次の順で出力する。

CPU使用量(GHz)

メモリ使用量(GB)
HVM上の仮想ホストの場合，行を出力しない。

ディスク読み込み転送速度(MB/sec)
デバイス種別が「HV」かつ詳細種別が「HVM」の場合，行を出力しない。

ディスク書き込み転送速度(MB/sec)
デバイス種別が「HV」かつ詳細種別が「HVM」の場合，行を出力しない。

ネットワーク平均パケット送信量(packets/sec)

ネットワーク平均パケット受信量(packets/sec)

6
測定対象
INSTANCE
測定対象の名前。
リソース管理画面の［パフォーマンス］タブに表示される［測定対象］と同じ項目を出力する。
ただし，CPU使用量(GHz)およびメモリ使用量(GB)は，次に示す固定の文字列を出力する。

CPU使用量(GHz)
「CPU」と出力する。

メモリ使用量(GB)
「メモリ」と出力する。

測定対象の名前。
リソース管理画面の［パフォーマンス］タブに表示される［測定対象］と同じ項目を出力する。
ただし，CPU使用量(GHz)およびメモリ使用量(GB)は，次に示す文字列を出力する。

CPU使用量(GHz)
［測定対象］のCPU使用率に該当する文字列を出力する。

メモリ使用量(GB)
［測定対象］のメモリ使用率に該当する文字列を出力する。

7
しきい値（警告）
WARNINGTHRESHOLD
空文字。
レポートコマンドを実行したときの監視テンプレートに設定されている警告を通知するしきい値。
JP1/ITRMの画面に表示される監視テンプレートのしきい値（警告）に，仮想化ソフトウェアの現在のスペックを積算した絶対量を小数点第3位で四捨五入し，小数点第2位まで出力する。

8
しきい値（異常）
ERRORTHRESHOLD
空文字。
レポートコマンドを実行したときの監視テンプレートに設定されている異常を通知するしきい値。
JP1/ITRMの画面に表示される監視テンプレートのしきい値（異常）に，仮想化ソフトウェアの現在のスペックを積算した絶対量を小数点第3位で四捨五入し，小数点第2位まで出力する。

9
使用可能値
USABLEVALUE
jirmreportコマンドを実行したときに，仮想ホストの予約されている次の項目のスペックを出力する。

CPU使用量(GHz)

メモリ使用量(GB)

これらの項目以外の場合，空文字を出力する。
jirmreportコマンドを実行したときの，仮想化ソフトウェアの次の項目のスペックを出力する。

CPU使用量(GHz)

メモリ使用量(GB)

これらの項目以外の場合，空文字を出力する。

10
性能値※1
PERFVALUE
空文字。

11
データ取得日時（yyyy/mm/dd hh:mm形式）※2
性能値。
値は測定項目ごとに異なる。
コマンド実行時点から過去31日分のデータを1時間ごとに集約した値を，古い順に数値で出力する。数値が小数の場合は，小数点第3位で四捨五入し，小数点第2位まで出力する。データ取得日時のデータがない場合，空文字を出力する。
ヘッダーは，yyyy/mm/dd hh:mm形式でデータ取得日時を出力する。
仮想ホストのCPU使用量およびメモリ使用量は，仮想化ソフトウェアから取得した仮想ホストの性能値を出力する。

注

リソース使用量（時間推移）レポートでは，管理状態が「管理対象」であるすべての仮想化ソフトウェアおよび仮想ホストを出力対象とします。

注※1

仮想化ソフトウェアまたは仮想ホストの，ある測定項目の性能値が存在しない場合，その測定項目の行は出力しません。

また，仮想化ソフトウェアまたは仮想ホストの性能値がすべて存在しない場合，その仮想化ソフトウェアまたは仮想ホストの情報を出力しません。

仮想化ソフトウェアの状態が「監視状態」ではない期間に，仮想化ソフトウェア上の仮想ホストが「監視状態」でも，その期間の仮想ホストのCPU使用量およびメモリ使用量は出力しません。

注※2

データ取得日時の分を表すmmは，30で固定されます。

出力例

JP1/IT Resource Management - Manager,,,,,0951,リソース使用量（時間推移）,MS932,2010/12/31 00:00,2011/01/31 00:00
DEVICETYPE,...,RESOURCENAME,HVRESOURCENAME,METRIC,...,USABLEVALUE,PERFVALUE,2011/01/01 01:30,...,2011/01/01 07:30,...
HV,...,HV1,HV1,CPU使用量(GHz),...,10.00,　,7.10,...,9.50,...
VM,...,VM1,HV1,CPU使用量(GHz),...,3.00,　,2.93,...,3.00,...
VM,...,VM2,HV1,CPU使用量(GHz),...,3.00,　,1.50,...,2.00,...
VM,...,VM3,HV1,CPU使用量(GHz),...,3.70,　,2.80,...,3.50,...

使用例

業務グループ「/業務A/業務システム1」のリソース使用量を出力する場合

jirmreport -perf -bg /業務A/業務システム1 -f C:¥temp¥reportdata.csv

jirmrestore

機能

jirmbackupコマンドで取得したバックアップデータをリストアするコマンドです。このコマンドは，ITリソース管理サーバに障害が発生した場合など，バックアップ取得時の運用環境の状態に回復させるときに使用します。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM Web Serviceが停止している必要があります。

JP1/ITRM DB Serviceが起動している必要があります。

バックアップを取得したサーバとリストアするサーバで，次の項目が同じである必要があります。

JP1/ITRMのバージョン，リビジョン，および限定コード

JP1/ITRMのインストール先フォルダ

データベース格納フォルダ

ローカルディスクのデータベース格納フォルダ（クラスタ環境の場合）

共有ディスクのデータベース格納フォルダ（クラスタ環境の場合）

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirmrestore -j バックアップフォルダ名 [-w 作業フォルダ名] [-q]

引数

-j バックアップフォルダ名

バックアップフォルダの名称（JP1ITRM_backupまたはJP1ITRM_backup.old）を指定します。バックアップフォルダ名を指定する際は次の点に注意してください。

156バイト以内の相対パスまたは絶対パス形式で指定します。

指定できるのは，ローカルディスク上のフォルダだけです。

-w 作業フォルダ名

コマンドの実行時に，一時フォルダを作成するフォルダの名称を指定します。-jオプションで指定したフォルダに，書き込み権限が存在しない場合，または10メガバイトの空き容量が存在しない場合は，このオプションで作業フォルダを指定します。作業フォルダ名を指定する際は，次の点に注意してください。

156バイト以内の相対パスまたは絶対パス形式で指定します。

10メガバイト以上の空き容量があるフォルダを指定します。

書き込み権限が存在するフォルダを指定します。

指定できるのは，ローカルディスク上にすでにあるフォルダだけです。ローカルディスク上にないフォルダを指定した場合や，存在しないフォルダ名を指定した場合は，エラーとなります。

このオプションを省略した場合，-jオプションで指定したバックアップデータが格納されているフォルダを作業フォルダとします。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

コマンド終了後，JP1/ITRM ServiceおよびJP1/ITRM Web Serviceは停止したままの状態となります。

ユーザー設定プロパティファイル（jp1itrm.properties）は，リストア時に別名（jp1itrm.properties.backup）で格納されます。このため，リストア後に，ユーザー設定プロパティファイルの内容を書き換える必要があります。

JP1/ITRMの使用ポート番号は，バックアップ時の使用ポート番号に復元されます。使用ポート番号を変更したい場合は，リストア実行後にjirmsetportnoコマンドを実行してください。

戻り値

0
正常終了

1
ほかのJP1/ITRMコマンドが実行中

2
システム環境不正

3
Administrators権限で実行していない

4
引数不正

5
指定したフォルダが存在しない，またはパスが不正

7
ディスク容量不足

9
ユーザーが処理を中止した

12
削除できないフォルダまたはファイルが存在した

16
他プロセスの実行に失敗

18
メモリの割り当てに失敗

70
データベースのリストアに失敗

71
バックアップデータが不正

72

バックアップデータのバージョンが現在のシステムのバージョンと一致しない

バックアップ取得時と現在のシステムで，JP1/ITRMインストール先フォルダまたはデータベースの格納フォルダが一致しない

90
JP1/ITRM DB Serviceの停止に失敗

91
JP1/ITRM DB Serviceの起動に失敗

92
JP1/ITRM DB Serviceの初期化処理に失敗

94
サービスの状態が起動処理中または停止処理中

95
JP1/ITRM ServiceまたはJP1/ITRM Web Serviceが起動中

96
JP1/ITRM DB Serviceが停止中

97
コマンドを待機系サーバで実行している

98
［Ctrl］+［C］キーを押してコマンドを中止した

99
その他のエラー（データベースのディスク容量不足を含む）

使用例

D:¥tmp¥JP1ITRM_backupフォルダに格納されているバックアップデータをリストアする場合

jirmrestore -j D:¥tmp¥JP1ITRM_backup

jirmsetportno

機能

JP1/ITRMが使用するポート番号を変更する，または変更できるポート種別とポート番号を表示するコマンドです。このコマンドでポート番号を変更できるサービスとポート種別を次の表に示します。

表1-15　変更対象のサービス

サービス | ポート種別 | 説明
Hitachi Webサーバ（GUI） | HTTP | Hitachi Web Serverが使用するポート番号。SSL有効には対応していない。WebブラウザからJP1/ITRMにアクセスする際のURLにも使用する。
Hitachi Webサーバ（API） | API | Hitachi Web Serverが使用するポート番号。APIクライアントからJP1/ITRMにアクセスする際のURLにも使用する。
Webサーバ連携（Webサーバとの通信） | Connector | WebサーバとWebコンテナ間の通信に使用するポート番号。
Webサーバ連携（終了メッセージの受信） | Shutdown | WebサーバとWebコンテナ間で，終了メッセージの通信に使用するポート番号。
データベース | DB | データベースのポート番号。
JP1/ITRM RMIレジストリ | RMI | Javaプロセス間通信に使用するRMIレジストリのポート番号。

実行時の前提条件

-cオプションを指定する場合は，JP1/ITRMの全サービスが停止している必要があります。

クラスタ環境の場合は，次の点に注意してください。

実行系サーバと待機系サーバの両方で，コマンドを実行する必要があります。

実行時に指定するポート番号は，現用系と予備系で同じ値を指定する必要があります。現用系と予備系で値が異なる場合，正常に通信できないおそれがあります。

形式

jirmsetportno {-r | -c ポート種別 ポート番号 [ポート種別 ポート番号]... [-q]}

引数

-r

変更できるポート種別とポート番号を表示します。ポート番号の設定値は，レジストリから取得します。ポート番号の表示については，出力例1を参照してください。

-c ポート種別 ポート番号

指定したポート種別ごとに，ポート番号を変更します。ポート種別は複数指定でき，必ずポート番号と一緒に指定します。サービスに対応するポート種別とポート番号を次の表に示します。

表1-16　サービスに対応するポート種別とポート番号

サービス
ポート種別
インストール時のポート番号のデフォルト値
ポート番号に指定できる値の範囲

Hitachi Webサーバ（GUI）
HTTP
23500
1～65535

Hitachi Webサーバ（API）
API

APIが無効の場合
off

APIが有効の場合
23505

Webサーバ連携（Webサーバとの通信）
Connector
23501
5001～65535

Webサーバ連携（終了メッセージの受信）
Shutdown
23502

データベース
DB
23503

JP1/ITRM RMIレジストリ
RMI
23504

このオプションを指定すると，JP1/ITRMのファイルや，ポート番号設定レジストリの設定値を変更します。また，Servicesファイルにポート番号を設定します。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

ポート番号の変更を有効にするためには，コマンド実行後にJP1/ITRMの全サービスを再起動する必要があります。

ポート番号は，JP1/ITRMにログインする際のURLに使用されています。JP1/ITRMからユーザーへ送信されているメールに，JP1/ITRMのURLが含まれている場合，ポート番号が変更されると，そのページへアクセスできなくなります。

指定したポート番号が，すでにほかのアプリケーションで使用されている場合，コマンドを実行するとエラーになります。

指定したポート番号が，servicesファイルに設定されている場合，コマンドを実行するとエラーになります。

ポート種別を複数指定した場合，重複しているポートがあるときに，コマンドを実行するとエラーになります。

戻り値

0 | 正常終了
1 | ほかのJP1/ITRMコマンドが実行中
2 | システム環境不正
3 | Administrators権限で実行していない
4 | 引数不正
9 | ユーザーが処理を中止した
18 | メモリの割り当てに失敗
50 | 指定したポート番号がすでに使用されている
51 | ポート番号を変更できなかった
94 | サービスの状態が起動動作中または停止動作中
95 | JP1/ITRMのサービスが起動している
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
99 | その他のエラー

使用例1

ポート種別ごとにポート番号を表示する場合

jirmsetportno -r

出力例1

正常終了の場合

DB = 23503, HTTP = 23500, Connector = 23501, Shutdown = 23502, RMI = 23504, API = off

使用例2

ポート番号を変更する場合

jirmsetportno -c Shutdown 23020 API 23505

出力例2

正常終了の場合

KNAR80613-I ポート番号を変更しました。
DB = 23503, HTTP = 23500, Connector = 23501, Shutdown = 23020, RMI = 23504, API = 23505

jirmsetup

機能

JP1/ITRMをセットアップするコマンドです。JP1/ITRMのインストールなどしたあとに，データベース，Webサーバ，Webコンテナサーバを設定して，JP1/ITRMを運用できる状態にします。このコマンドは次のような場合に使用します。

JP1/ITRMをインストール，バージョンアップまたは上書きインストールしたあと使用できる状態にする。

JP1/ITRMの運用中，Web画面が正常に起動しないときなどに，Webアプリケーションの環境を再構築する。

実行時の前提条件

JP1/ITRMのインストールプログラムが実行され，インストーラーで展開するファイルがインストール先フォルダにすべて格納されている必要があります。

-rオプションを指定する場合は，JP1/ITRMの全サービスが停止している必要があります。

クラスタ環境でセットアップする場合，-c以外のオプションには，現用系と予備系で同じ値を指定する必要があります。

セットアップの実行時に，Windowsファイアウォールのサービスが起動している必要があります。

形式

jirmsetup {-dbscale {N30 | N400 | N700 | N1000 | N1500}
         -db RDエリア名 [-h 論理ホスト名 -sharedir 共有ディスク名
         -c {online | standby}] [-httpport HTTP通信ポート番号]
         [-conport Webコンテナ通信ポート番号]
         [-shutdownport 終了メッセージ受信ポート番号]
         [-dbport データベースのポート番号]
         [-rmiport RMIレジストリポート番号]
         [-apiport {API通信ポート番号 | off}]
         [-templatedir 仮想イメージテンプレート格納フォルダ名]
         [-storeddir 退避イメージ格納フォルダ名] | -r} [-q]

引数

-dbscale {N30 | N400 | N700 | N1000 | N1500}

作成するデータベースの規模を指定します。それぞれの値を指定した場合のデータベースの容量や，管理対象とするサーバ数については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」を参照してください。

-db RDエリア名

RDエリアを格納するローカルディスクの名称を指定します。117バイト以内の相対パスまたは絶対パス形式で指定します。RDエリア名に指定できる文字は半角英数字，丸括弧（()）ピリオド（.），アンダーバー（_），半角スペースです。

-h 論理ホスト名

クラスタ環境の場合に，論理ホスト名を32バイト以内で指定します。論理ホスト名に指定できる文字は半角英数字，ハイフン（-），ピリオド（.），アンダーバー（_）です。

-sharedir 共有ディスク名

クラスタ環境の場合に，RDエリアを作成する共有ディスクの名称を指定します。109バイト以内の相対パスまたは絶対パス形式で指定します。共有ディスク名に指定できる文字は半角英数字，丸括弧（()）ピリオド（.），アンダーバー（_），半角スペースです。

-c {online | standby}

クラスタ環境の場合に，セットアップするホスト種別を指定します。

online：現用系のホストとしてセットアップします。現用系のセットアップではデータベースのRDエリアを作成します。

standby：予備系のホストとしてセットアップします。予備系のセットアップではデータベースのRDエリアは作成しません。

-httpport HTTP通信ポート番号

WebサーバとWebブラウザ間の通信用のポート番号（GUI）を指定します。ポート番号に指定できる範囲は，1～65535です。

-conport Webコンテナ通信ポート番号

WebサーバとWebコンテナ間の通信用のポート番号を指定します。ポート番号に指定できる範囲は，5001～65535です。

-shutdownport 終了メッセージ受信ポート番号

WebサーバとWebコンテナ間の終了メッセージ受信用のポート番号を指定します。ポート番号に指定できる範囲は，5001～65535です。

-dbport データベースのポート番号

データベースが使用するポート番号を指定します。ポート番号に指定できる範囲は，5001～65535です。

-rmiport RMIレジストリポート番号

Javaプロセス間の通信に使用するRMIレジストリのポート番号を指定します。ポート番号に指定できる範囲は，5001～65535です。

-apiport {API通信ポート番号 | off}

APIクライアントとWebブラウザ間のAPI通信ポート番号またはoffを指定します。API通信ポート番号に指定できる範囲は，1～65535です。

APIを使用しない場合は，offを指定します。

-templatedir 仮想イメージテンプレート格納フォルダ名

仮想イメージテンプレートを格納するフォルダ名を，150バイト以内の絶対パスまたは相対パス形式で指定します。このとき指定したフォルダは，ユーザー設定プロパティファイル（jp1itrm.properties）の指定キーCO.templateFilePathに設定されます。クラスタ環境の場合は，共有ディスク上のフォルダを指定してください。

-storeddir 退避イメージ格納フォルダ名

退避イメージを格納するフォルダ名を，150バイト以内の絶対パスまたは相対パス形式で指定します。このとき指定したフォルダは，ユーザー設定プロパティファイル（jp1itrm.properties）の指定キーCO.storedImagePathに設定されます。クラスタ環境の場合は，共有ディスク上のフォルダを指定してください。

-r

データベースをセットアップしないで，WebサーバおよびWebコンテナを設定する場合に指定します。JP1/ITRMをバージョンアップしたときや上書きインストールしたときは，このオプションを指定してjirmsetupコマンドを実行します。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

［Ctrl］＋［C］キーを押してコマンドを中止した場合，jirmunsetupコマンドを実行したあと，再度jirmsetupコマンドを実行してください。

引数にポート番号を指定する場合，ほかのアプリケーションによって使用されていないポート番号を指定してください。

仮想イメージテンプレート格納フォルダ名と退避イメージ格納フォルダ名には異なるパスを指定してください。また，クラスタ環境のセットアップ時には，共有ディスク上のパスを指定する必要があります。

JP1/ITRMをバージョンアップする前に，バージョンアップ時の障害に備えて，エクスポートデータとバックアップデータを取得しておく必要があります。

-rオプションを指定したjirmsetupコマンドでセットアップを実行中に，データベースのマイグレーションに失敗した場合は，次のどちらかの対処をしてください。

JP1/ITRMをバージョンアップする前に取得したエクスポートデータをインポートする。

バージョンアップ後に取得したバックアップデータをリストアして，再度コマンドを実行する。

-rオプションを指定したjirmsetupコマンドでセットアップを実行し，データベースをマイグレーションした場合は，次のどちらかの方法でITリソースの情報を再収集してください。

設定画面の［監視間隔設定］エリアで，［すべてを再収集］ボタンをクリックする。

-allオプションと-dオプションを指定したjirminfocollectコマンドを実行する。

戻り値

0 | 正常終了
1 | ほかのJP1/ITRMコマンドが実行中
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
208 | その他エラー（外部コマンド呼び出しの引数不正や，メモリ不足によるシステムエラーなど）
209 | 引数不正
210 | Administrators権限で実行していない
212 | RDエリア格納ドライブの容量が不足している
215 | データベースのセットアップ時に発生したその他のエラー
216 | データベースの接続時のエラー
217 | データベースの構築時に発生したメモリエラー
223 | ポート番号が重複している
224 | データベースのセットアップ時に発生したメモリ不足
225 | データベースのマイグレーションエラー
226 | サービスの起動に失敗
227 | サービスの停止に失敗
228 | JP1/ITRMサービス起動中エラー
229 | すでにセットアップされている
231 | ユーザーが処理を中止した
232 | 指定したパスが存在しない
233 | 指定したフォルダ名はすでに使用されている
234 | ファイルのオープンに失敗

使用例1

管理対象のサーバを400台として，セットアップする場合

jirmsetup -dbscale N400 -db "C:¥Program Files (x86)¥Hitachi¥ITRM¥database"

使用例2

Webアプリケーション環境を再構築する場合

jirmsetup -r

jirmunsetup

機能

JP1/ITRMをアンセットアップするコマンドです。JP1/ITRMのセットアップ時のデータベース，Webサーバ，Webコンテナサーバの設定を解除し，JP1/ITRMをアンインストールできる状態にします。このコマンドは次のような場合に使用します。

JP1/ITRMをアンインストールする。

データベースの規模を変更する前に，エクスポートおよびアンセットアップする。

データベースの構成をクラスタ環境に変更する前に，エクスポートおよびアンセットアップする。

実行時の前提条件

JP1/ITRMのインストールプログラムが実行され，インストーラーで展開するファイルがすべてインストール先フォルダに格納されている必要があります。

JP1/ITRMの全サービスが停止している必要があります。

セットアップの実行時に，Windowsファイアウォールのサービスが起動している必要があります。

形式

jirmunsetup -uninstall [-q]

引数

-uninstall

JP1/ITRMをアンセットアップするときに指定します。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

戻り値

0 | 正常終了
97 | コマンドを待機系サーバで実行している
98 | ［Ctrl］+［C］キーを押してコマンドを中止した
208 | その他エラー（外部コマンド呼び出しの引数不正や，メモリ不足によるシステムエラーなど）
209 | 引数不正
210 | Administrators権限で実行していない
224 | データベースのセットアップ時に発生したメモリ不足
226 | サービスの起動に失敗
227 | サービスの停止に失敗
228 | JP1/ITRMサービス起動中エラー
230 | JP1/ITRMがセットアップされていない
231 | ユーザーが処理を中止した

使用例

JP1/ITRMをアンセットアップする場合

jirmunsetup -uninstall

jirmusermgr

機能

ITリソース管理者のユーザーを登録する，ロールを設定する，アカウントのロックを解除する，またはユーザーの情報を一覧で表示するコマンドです。このコマンドは次のような場合に使用します。

システムを初期構築するとき，または業務グループを新規に割り当てるときに，初期登録ユーザーを作成する。

ユーザーにロールを設定する。

ユーザーのアカウントがロックされた場合に，ロックされたユーザーを確認して，ロックを解除する。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

ユーザーを登録する場合

jirmusermgr -adduser {{-u ユーザーID [-password パスワード]
           [-name ユーザー名] [-address メールアドレス]
           [-comment コメント] [-role ロール名]} |
           {-i ユーザー登録ファイル名}}

ロールを設定する場合

jirmusermgr -addrole -u ユーザーID -role ロール名

ユーザーの情報を一覧で表示する場合

jirmusermgr -list

アカウントのロックを解除する場合

jirmusermgr -unlock -u ユーザーID

引数

-adduser

ユーザーを新規に登録する場合に指定します。

-addrole

ユーザーにロールを新規に設定する場合に指定します。

-list

ユーザーの情報を一覧で表示する場合に指定します。表示項目を次の表に示します。

表1-17　ユーザー一覧の表示項目

項目
内容

ユーザーID
ユーザーIDを出力する。

ロック状態
アカウントのロックの状態を出力する。

Enable：ロックされていない

Disable：ロックされている

名称
登録ユーザーのユーザー名を出力する。名称は常にダブルクォーテーション（"）で囲んで出力される。

メールアドレス
登録ユーザーのメールアドレスを出力する。

コメント
登録ユーザーの補足情報を出力する。コメントは常にダブルクォーテーション（"）で囲んで出力される。

ロール名
ユーザーIDに設定されているロールを出力する。複数のロールが割り当てられている場合，コンマ（,）区切りでダブルクォーテーション（"）で囲んで出力される。
例："_jp1admin, _jp1resource"

-unlock

ユーザーのアカウントのロックを解除する場合に指定します。

-u ユーザーID

登録するユーザー，ロールを設定するユーザー，またはアカウントのロックを解除するユーザーのIDを指定します。

-password パスワード

JP1/ITRMにログインするためのパスワードを指定します。このオプションを省略した場合，パスワードはjp1itrmで登録されます。

-name ユーザー名

-adduserを指定した場合に，ユーザーの名前を半角ダブルクォーテーション（"）で囲んで指定します。

-address メールアドレス

-adduserを指定した場合に，イベントの発行や探索結果などを通知するためのメールアドレスを指定します。

-comment コメント

-adduserを指定した場合に，ユーザーの補足情報を半角ダブルクォーテーション（"）で囲んで指定します。

-role ロール名

-adduserまたは-addroleを指定した場合に，ロールを指定します。すでにシステムに登録されているロール名を指定してください。

-i ユーザー登録ファイル名

-adduserを指定した場合に，複数のユーザーを一度に登録するとき，ユーザー登録ファイル名を相対パスまたは絶対パス形式で指定します。ユーザー登録ファイルについては，「ユーザー登録ファイルの形式」を参照してください。

引数の排他関係

引数には，ほかの引数の指定時に指定できないものがあります。引数の排他関係を次の表に示します。

表1-18　引数の排他関係

オプション | オプション
ユーザー登録（-adduser） | ロール割り当て（-addrole） | ユーザー一覧表示（-list） | アカウントロック解除（-unlock）
-iなし | -iあり
-u | ◎ | × | ◎ | × | ◎
-password | ○ | × | × | × | ×
-name | ○ | × | × | × | ×
-address | ○ | × | × | × | ×
-comment | ○ | × | × | × | ×
-role | ○ | × | ○ | × | ×
-i | × | ◎ | × | × | ×

（凡例）

◎：必ず指定。

○：任意に指定。

×：指定できない。

ユーザー登録ファイルの形式

ユーザー登録ファイルはCSV形式で，複数のユーザーの登録情報を記述できます。ユーザー登録ファイルに設定できる項目を，次の表に示します。

表1-19　ユーザー登録ファイルの設定項目

項目
内容

ユーザーID
登録するユーザーのユーザーID。ユーザーIDは必ず指定する。

名称
登録するユーザーの名称。

パスワード
登録するユーザーのパスワード。値を省略した場合，パスワードはjp1itrmで登録される。

メールアドレス
登録するユーザーのメールアドレス。

コメント
登録するユーザーのコメント。

ロール名
登録するユーザーの所属するロール。
複数の所属ロール名を指定する場合，所属ロール名をコンマ（,）区切りで記述し，複数の所属ロール名をダブルクォーテーション（"）で囲む。
例："_jp1admin, _jp1resource"

ユーザー登録ファイルを記述する際は，次の点に注意してください。

各項目をコンマ（,）で区切ります。

設定値にコンマ（,）を含む場合は，設定値をダブルクォーテーション（"）で囲みます。

設定値にダブルクォーテーション（"）を含む場合は，ダブルクォーテーション（"）で囲み，さらに設定値全体をダブルクォーテーション（"）で囲みます。
例：user1,username,,,"comment(""DeptA"")",role1

シャープ（#）で始まる行は，コメント行として扱います。

空行は無視されます。

設定値を省略する場合でも，各項目をコンマ（,）で区切ります。コンマ（,）の数が不足している場合，エラーになります。

ユーザー登録ファイルの記述例を次に示します。

#JP1/IT Resource Management - Manager

#ユーザーID, 名称, パスワード, メールアドレス, コメント, 所属ロール名

User1,UserName1,Password1,user1@address.com,Commnet1,_jp1admin

User2,UserName2,Password2,user2@address.com,Commnet2,"_jp1admin,_ jp1resource"

User3,UserName3,Password3,user3@address.com,Commnet3,_testrole

戻り値

0
正常終了

1
引数不正

2
JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない

4
すでに登録されているユーザーIDが指定された

6
存在しないロールが指定された

7
存在しないユーザーIDが指定された

8
メモリ不足

9
アカウントのロックの解除に失敗

10

ユーザーの登録処理に失敗

ロールの設定の処理に失敗

アカウントがロックされているユーザーの一覧取得処理に失敗

アカウントがロックされているユーザーの解除に失敗

11

一部，またはすべてのユーザーの登録に失敗

CSVファイルにユーザーが登録されていない

CSVファイルのフォーマットが不正

12
通信エラー

16
実行権限がない

35
コマンドの同時実行できる数を超えている

130
［Ctrl］+［C］キーを押してコマンドを中止した

255
その他のエラー

使用例1

ユーザーの情報を一覧で表示する場合

jirmusermgr -list

出力例1

正常終了の場合

KNAR82402-I ユーザー一覧の表示を開始します。
ユーザーID,状態,名称,メールアドレス,コメント,所属ロールID
User1,Enable,"UserA",UserA@xxxx.co.jp,"Comment1","Role1,Role2,Role3"
User2,Disable,"UserB",UserB@xxxx.co.jp,"Comment2",Role1
User3,Disable,"UserC",UserC@xxxx.co.jp,"Comment3","Role2,Role3"
KNAR82412-I ユーザー一覧の表示を終了しました。

使用例2

user1を次の設定で登録する場合

パスワード：なし

メールアドレス：user1@xxxx.com

コメント：ResourceGroup1 operation user

ロール名：OPGROUP1

jirmusermgr -adduser -u user1 -address user1@xxxx.com -comment "ResourceGroup1 operation user" -role OPGROUP1

使用例3

user1にロール名「TestRole」を設定する場合

jirmusermgr -addrole -u user1 -role TestRole

使用例4

user1のアカウントのロックを解除する場合

jirmusermgr -unlock -u user1

使用例5

ユーザー登録ファイルを使用してユーザーを新規に登録する場合

jirmusermgr -adduser -i C:¥itrmdata¥userfile.csv

jirmstatuschange

機能

ITリソースの管理状態を変更するコマンドです。JP1/ITRMの探索機能によって発見されたITリソース，手動で追加されたITリソース，およびデプロイの予約がされたITリソースが変更対象になります。このコマンドは次のような場合に使用します。

業務システムの変更に伴うマシン入れ替え時に，一括で管理状態を変更する。

仮想化ソフトウェアの入れ替えに伴い，仮想化ソフトウェア上の仮想ホストの管理状態を変更する。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirmstatuschange {-res リソース名 | -rg リソースグループ名 |
                -bg 業務グループ名}
                -state {monitored |unmonitored |unmanaged |
                trashed | deleted}
                [-q]

引数

-res リソース名

管理状態を変更するリソース名を指定します。

-rg リソースグループ名

管理状態を変更するリソースグループ名を指定します。

-bg 業務グループ名

管理状態を変更する業務グループ名を指定します。

-state {monitored | unmonitored | unmanaged | trashed | deleted}

変更後のITリソースの管理状態を指定します。

monitored：ITリソースの状態を管理対象の監視に変更する。

unmonitored：ITリソースの状態を管理対象の監視停止に変更する。

unmanaged：ITリソースの状態を管理対象外に変更する。

trashed：ITリソースの状態を削除待ちに変更する。

deleted：ITリソースをJP1/ITRMから削除する。

なお，-rgオプションまたは-bgオプションを指定した場合，-stateオプションでunmanaged，trashed，およびdeletedは指定できません。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します

管理状態を変更できるITリソースを次の表に示します。

表1-20　変更対象機器

項番 | 機器 | 変更可否
1 | 物理ホスト | ○
2 | 仮想ホスト | ○
3 | 仮想化ソフトウェア | ○
4 | 仮想化環境管理ソフトウェア | ○
5 | ネットワークデバイス | ○
6 | ストレージ | ○
7 | リソースプール | ×
8 | VMクラスタ | ×
9 | vApp | ×
10 | 不明なITリソース | △

（凡例）

○：変更できる。

×：変更できない。

△：一部変更できる。

変更できる管理状態の遷移を次の表に示します。

表1-21　管理状態の遷移

項番 | 変更前の状態 | 変更後の状態
発見 | 未処理 | 管理対象 | 管理対象外 | 削除待ち | 削除/初期状態
監視 | 監視停止
1 | 発見 | － | × | ○※1，※2 | × | ○ | × | ×
2 | 未処理 | × | － | ○※1，※2 | × | ○ | × | ×
3 | 管理対象 | 監視 | × | × | － | ○ | × | ○ | ×
4 | 監視停止 | × | × | ○※3 | － | × | ○ | ×
5 | 管理対象外 | × | × | ○※1 | × | － | × | ○
6 | 削除待ち | × | × | ○※3，※4 | ○※5 | × | － | ○※6
7 | 削除/初期状態 | × | × | × | × | × | × | －

（凡例）

○：遷移できる。

×：遷移できない。

－：変更前後の状態が同じ。

注※1

探索時に情報が取得できなかった不明なITリソースは，遷移できません。

注※2

操作対象のITリソースのホスト名が重複している場合は，遷移できません。

注※3

操作対象のITリソースが手動追加またはデプロイ予定の場合は，遷移できません。

注※4

操作対象のITリソースが仮想ホスト削除タスクによって削除されたITリソースの場合は，遷移できません。

注※5

操作対象のITリソースが手動追加またはデプロイ予定の場合は，遷移できます。

注※6

予約のあるITリソースの場合は削除できません。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，処理が失敗するおそれがあります。正しく処理されているかどうかは，画面で確認してください。

グループがフォルダによって階層化されているリソースグループまたは業務グループを引数に指定する場合は，最上位のフォルダ名からスラッシュ（/）を区切り文字としてパス形式で指定してください。
例：フォルダA/フォルダB/リソースグループ1

戻り値

0
正常終了

1
引数不正

2
JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない

8
メモリ不足

12
通信エラー

16
実行権限がない

19
ユーザー問い合わせで処理を中止した

35
同時に実行できるコマンドの数を超えている

130
［Ctrl］+［C］キーを押してコマンドを中止した

137

指定したITリソース，リソースグループ，または業務グループが存在しない

指定したITリソースが操作対象外のITリソースである

145
操作対象のITリソースの変更に失敗

165
操作対象の一部のITリソースが処理に失敗

254
重複しているリソース名を指定した

255
その他のエラー

使用例1

ITリソース「hostA」の管理状態を監視停止にする場合

jirmstatuschange -res hostA -state unmonitored

使用例2

リソースグループ「RG1」の配下のITリソースの管理状態を監視にする場合

jirmstatuschange -rg RG1 -state monitored

jirmvmconfig

機能

仮想ホストのリソースの割り当て量を確認または変更するコマンドです。このコマンドは次のような場合に使用します。

リソース割り当て量を確認する。

リソースが不足した場合に，仮想ホストに割り当てるリソース割り当て量を追加する（スケールアップ）。

リソースが過剰になった場合に，仮想ホストに割り当てるリソース割り当て量を削減する（スケールダウン）。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

操作対象の仮想ホストは，探索で発見後，管理対象に設定し監視状態が「監視」または「監視停止」である必要があります。

操作対象の仮想ホストを管理している仮想化ソフトウェアおよび仮想化環境管理ソフトウェアが稼働している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

形式

jirmvmconfig [-cpu CPU周波数] [-cpucore CPUコア数]
            [-cpumode {share | occupy}] [-mem メモリ]
            [-wait] [-q] -vmhost リソース名

引数

-cpu CPU周波数

変更するCPU周波数（ギガヘルツ）を半角数字とピリオド（.）で指定します。指定できる値の範囲は0.01～999.99の小数点第2位までの数値です。ただし，実際に設定変更できる最大値はCPU占有種別によって異なります。

CPU占有の場合

仮想化ソフトウェアの未使用CPU周波数と現在設定されているCPU周波数の合計値

CPU共有の場合

仮想化ソフトウェアの未使用CPU周波数と構築先の仮想化ソフトウェアでCPU占有種別が共有で設定されているCPU周波数の合計値

-cpucore CPUコア数

変更するCPUコア数を半角数字で指定します。指定できる値の範囲は1～4,096の整数値です。ただし，実際に設定できる最大値はCPU占有種別によって異なります。

CPU占有の場合

仮想化ソフトウェア未使用CPUコア数と現在設定されているCPUコア数の合計値

CPU共有の場合

仮想化ソフトウェアの未使用CPUコア数と構築先の仮想化ソフトウェアでCPU占有種別が共有で設定されているCPUコア数の合計値

-cpumode {share | occupy}

CPU占有種別を変更する場合に指定します。

share：CPU占有種別を共有に指定

occupy：CPU占有種別を占有に指定

-mem メモリ

変更するメモリサイズ（ギガバイト）を半角数字とピリオド（.）で指定します。指定できる値の範囲は0.01～999.99の小数点第2位までの数値です。ただし，実際に設定できる最大値は仮想化ソフトウェアの空きメモリサイズと現在設定されているメモリサイズの合計値となります。HVM上にデプロイされた仮想ホストの場合は，0.25ギガバイト単位で指定してください。

-wait

割り当て量を変更する処理が完了するのを待って，コマンドを終了する場合に指定します。このオプションを省略した場合，割り当て量変更の処理要求をしたあとすぐにコマンドが終了し，処理結果は表示されません。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

-vmhost リソース名

割り当て量を変更する仮想ホストのリソース名を指定します。リソースの割り当てを変更するオプション（-cpu，-cpucore，-cpumode，-mem）を指定しないで，このオプションを指定した場合，指定した仮想ホストの現在のリソース割り当て状況が表示されます。割り当て状況の表示については，出力例1を参照してください。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，処理が失敗するおそれがあります。正しく処理されているかどうかは，［サーバの設定変更］画面で確認するか，現在のリソース割り当て状況を表示して確認してください。

VMware上の稼働中の仮想ホストに対しては，CPUコア数とメモリサイズの変更はできません。

Hyper-V上の稼働中の仮想ホストに対しては，CPU周波数，CPUコア数，CPU占有種別，およびメモリサイズの変更はできません。

HVM上の稼働中の仮想ホストに対しては，CPUコア数，CPU占有種別，およびメモリサイズの変更はできません。

構成情報が未収集または収集中の仮想ホストに対してはコマンドを実行できません。

HVMに仮想ホストをデプロイする場合，-cpumodeオプションでCPUの占有種別を占有にすると，CPUはコア単位で占有され，1コア当たりの物理CPUの周波数が割り当てられます。そのため，-cpumodeオプションで占有を指定した場合，-cpuオプションでCPUの周波数を設定するとエラーになります。

戻り値

0 | 正常終了
1 | 引数不正
2 | JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない
8 | メモリ不足
12 | 通信エラー
16 | 実行権限がない
19 | ユーザー問い合わせで処理を中止した
35 | 同時に実行できるコマンドの数を超えている
106 | コマンドの前提条件を満たさない仮想ホストを指定した
130 | ［Ctrl］+［C］キーを押してコマンドを中止した
145 | コマンド実行エラー（エラーの詳細はメッセージで確認）
180 | データベースからの情報取得に失敗
254 | 重複しているリソース名を指定した
255 | その他のエラー

使用例1

ITリソース「hostA」のリソース割り当て状況を表示する場合

jirmvmconfig -vmhost hostA

出力例1

KNAR82508-I 仮想ホスト(hostA)のリソース割り当ての表示を開始します。
仮想ホスト名 : hostA
リソースプール : vmwareesxA
OS : Windows
CPU周波数 : 1.5 GHz
CPUコア数 : 1 個
CPU占有種別 : 共有
メモリ : 1 GB
KNAR82509-I 仮想ホスト(hostA)のリソース割り当ての表示が完了しました。

使用例2

ITリソース「hostA」のCPUコア数を2個に変更する場合（処理が完了するのを待ってコマンド終了する場合）

jirmvmconfig -cpucore 2 -wait -q -vmhost hostA

jirmvmdel

機能

デプロイ済みの仮想ホストを，仮想化ソフトウェア上から削除して，管理状態を削除待ちにするコマンドです。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

仮想ホストは，探索で発見後，管理対象に設定し監視状態が「監視」または「監視停止」である必要があります。

操作対象が仮想ホストの場合，仮想ホストを管理している仮想化ソフトウェアおよび仮想化環境管理ソフトウェアが稼働している必要があります。

クラスタ環境の場合は，実行系サーバでコマンドを実行する必要があります。待機系サーバで実行した場合は，エラーとなります。

HVMの仮想ホストを削除する場合の前提条件については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」の，仮想ホストの構成変更についての説明を参照してください。

形式

jirmvmdel {-res リソース名 | 仮想ホスト名} [-wait] [-q]

引数

-res リソース名

削除する仮想ホストのリソース名を指定します。

仮想ホスト名

削除する仮想ホスト名を指定します。なお，仮想ホスト名がオプション（-res，-wait，または-q）と同じ文字列の場合は，-resオプションでリソース名を指定してください。

-wait

処理が完了するのを待って，コマンドを終了する場合に指定します。このオプションを省略した場合，削除の処理要求をしたあとすぐにコマンドが終了し，処理結果は表示されません。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，処理が失敗するおそれがあります。正しく処理されているかどうかは，タスク画面のタスク一覧エリアで確認してください。

仮想ホストを削除するときは，.vmdkなどの仮想ホストの関連データを含めて削除します。仮想ホストの関連データを残す場合は，仮想ホストの退避を実行してください。

jirmvmdelコマンドで仮想ホストを削除した場合，仮想ホストの実体は削除されますが，JP1/ITRMの管理対象としては，［削除待ちリソース一覧］エリアに残った状態になります。JP1/ITRMからITリソースを削除する場合は，-state deletedオプションを指定したjirmstatuschangeコマンドを実行してください。または，［削除待ちリソース一覧］エリアから削除してください。

jirmvmdelコマンドで削除したITリソースを，［削除待ちリソース一覧］エリアから管理対象に移動することはできません。

jirmvmdelコマンドで削除したITリソースが利用しているIPアドレスを除いて，［削除待ちリソース一覧］エリアで利用しているIPアドレスは，デプロイ時に使用することはできません。

操作対象の仮想ホストは停止している必要があります。

戻り値

0 | 正常終了
1 | 引数不正
2 | JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない
8 | メモリ不足
12 | 通信エラー
16 | 実行権限がない
19 | ユーザー問い合わせで処理を中止した
35 | 同時に実行できるコマンドの数を超えている
106 | コマンドの前提条件を満たさない仮想ホストを指定した
130 | ［Ctrl］+［C］キーを押してコマンドを中止した
145 | コマンド実行エラー（エラーの詳細はメッセージで確認）
254 | 重複しているリソース名を指定した
255 | その他のエラー

使用例1

ITリソース「vmhost1」を削除する場合（処理が完了するのを待ってコマンド終了する場合）

jirmvmdel -res vmhost1 -wait -q

使用例2

ITリソース「vmhost1」を削除する場合

jirmvmdel -res vmhost1 -q

jirmvmdeploy

機能

仮想化ソフトウェア上に仮想ホストをデプロイするコマンドです。デプロイした仮想ホストは自動的に起動します。このコマンドは，仮想ホストの環境構築を自動で実行する場合などに使用します。

実行時の前提条件

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

操作対象は管理対象の仮想ホストである必要があります。

クラスタ環境では，実行系のマシン上でコマンドを実行する必要があります。

形式

jirmvmdeploy -vmhost 仮想ホスト名
            -desthv デプロイ先仮想化ソフトウェア名
            [-pool デプロイ先リソースプール名]
            -tmpl 仮想イメージテンプレート名
            [-date 滅却予定日時] [-cpu CPU周波数]
            [-cpucore CPUコア数] [-cpumode {share | occupy}]
            [-mem メモリ] [-lcode ライセンスコード] [-p OSパスワード]
            [-domain ドメイン名 | -workgroup ワークグループ名]
            [-dnssuffix DNSサフィックス] [-dnsip DNSサーバIPアドレス]
            [-datastore データストア名]※1
            [-storage ストレージのリソース名]※2
            [-storagepool ストレージプール名]※2
            [-storageport ストレージ接続ポート]※2
            -i ネットワーク設定情報ファイル名
            [-fchba FC-HBA設定情報ファイル名]※2
            [-script ユーザースクリプト] [-sshport SSHポート番号]
            [-wait] [-q]

注※1　デプロイ先の仮想化ソフトウェアがVMwareの場合は，必ず指定してください。

注※2　デプロイ先の仮想化ソフトウェアがHVMの場合は，必ず指定してください。

引数

-vmhost 仮想ホスト名

仮想化ソフトウェア上に作成する仮想ホスト名を1～15バイトの半角文字列で指定します。使用できる文字は，英数字およびハイフン（-）です。文字列の先頭と末尾にハイフン（-）は使用できません。また，数字だけの文字列も指定できません。

-desthv デプロイ先仮想化ソフトウェア名※

デプロイ先の仮想化ソフトウェア名を指定します。

-pool デプロイ先リソースプール名※

デプロイ先のリソースプール名を指定します。リソースプール名にはデプロイ先の仮想化ソフトウェアに関連する次の名称を指定できます。

仮想化ソフトウェア名

VMクラスタ名

リソースプール名（デプロイ先の仮想化ソフトウェアがVMwareの場合だけ）

vApp名（デプロイ先の仮想化ソフトウェアがVMwareの場合だけ）

-tmpl 仮想イメージテンプレート名

仮想イメージテンプレート名を指定します。指定した仮想イメージテンプレートの設定に基づいて仮想ホストが作成されます。

-date 滅却予定日時

作成する仮想ホストの滅却予定日時をyyyyMMddHHmm形式で，1970/01/02/ 00:00～2038/01/17/ 23:59の範囲で指定します。指定できる文字は半角数字です。

-cpu CPU周波数

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストのCPU周波数（ギガヘルツ）を0.01～999.99の範囲で指定します。使用できる文字は半角数字とピリオド（.）で，小数点第2位まで有効です。

-cpucore CPUコア数

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストのCPUコア数を1～4,096の範囲で指定します。使用できる文字は半角数字です。

-cpumode {share | occupy}

-tmplオプションで指定した仮想イメージテンプレートの設定値を使用しない場合に，作成する仮想ホストのCPU占有種別を指定します。

share：CPU占有種別を共有に指定

occupy：CPU占有種別を占有に指定

-mem メモリ

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストが使用するメモリサイズ（ギガバイト）を0.01～999.99の範囲で指定します。ただし，HVMに仮想ホストをデプロイする場合は，0.25ギガバイト単位で指定してください。使用できる文字は半角数字とピリオド（.）で，小数点第2位まで有効です。

-lcode ライセンスコード

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストが使用するライセンスコードを指定します。

-p OSパスワード

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストのOSユーザー名のOSパスワードを1～127バイトの半角文字列で指定します。ただし，HVMにWindowsの仮想ホストをデプロイする場合は，1～14バイトの半角文字列で指定してください。使用できる文字は，英数字およびハイフン（-）です。

-domain ドメイン名

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストのドメイン名を1～63バイトの半角文字列で指定します。使用できる文字は，英数字，アンダーバー（_），ピリオド（.），ハイフン（-）です。文字列の先頭にピリオド（.）は使用できません。

-workgroup ワークグループ名

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストのワークグループ名を1～15バイトの半角文字列で指定します。指定できる文字は，英数字です。

-dnssuffix DNSサフィックス

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，作成する仮想ホストのDNSサフィックスを1～63バイトの半角文字列で指定します。指定できる文字は，英数字，ピリオド（.），ハイフン（-）です。文字列の先頭にピリオド（.）とハイフン（-）は使用できません。

-dnsip DNSサーバIPアドレス

作成する仮想ホストのプライマリDNSサーバのIPアドレスを指定します。

-datastore データストア名

デプロイ先のデータストア名を指定します。仮想化ソフトウェア配下のデータストア名を指定できます。

-storage ストレージのリソース名

デプロイ先のストレージのリソース名を指定します。

-storagepool ストレージプール名

デプロイ先のストレージのストレージプール名を指定します。

-storageport ストレージ接続ポート

ストレージへの接続に使用するポートを指定します。

-i ネットワーク設定情報ファイル名

ネットワーク設定を記載したファイルの名称を絶対パス形式で指定します。ネットワーク設定情報ファイルは，CSV形式とし，複数のネットワーク設定を記述できます。ファイル名は任意です。なお，このファイルには-tmplオプションで指定した仮想イメージテンプレートが備える仮想NIC数と同数の定義が必要となります。ネットワーク設定情報ファイルの形式については，「ネットワーク設定情報ファイルの形式」を参照してください。

-fchba FC-HBA設定情報ファイル名

LPARが使用するFC-HBA設定を記載したファイルの名称を絶対パス形式で指定します。FC-HBA設定情報ファイルの形式については，「FC-HBA設定情報ファイルの形式」を参照してください。

-script ユーザースクリプト

-tmplオプションで指定した仮想イメージテンプレートの値を使用しない場合に，デプロイ時に仮想ホスト上で実行するユーザースクリプトを1～255バイトの絶対パスで指定します。

例1：C:¥temp¥xxxx.exe△jp1user（△は半角スペースを示します。）

例2：/home/tasks/job01.sh

-sshport SSHポート番号

仮想イメージテンプレートのOSがLinuxの場合，ユーザースクリプトを実行する際に使用するSSH通信のポート番号を0～65535の範囲で指定します。使用できる文字は，半角数字です。このオプションを省略した場合，SSH通信のポート番号に22が設定されます。仮想イメージテンプレートのOSがLinux以外の場合，このオプションの指定は無効になります。

-wait

デプロイ処理が完了するのを待って，コマンドを終了する場合に指定します。このオプションを省略した場合，デプロイの処理要求をしたあとすぐにコマンドが終了し，処理結果は表示されません。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します。

注※

VMwareまたはHyper-Vの場合は，仮想化ソフトウェア名，VMクラスタ名，リソースプール名，およびvApp名は，次の規則に従って指定してください。

jirminfolistコマンドの出力結果の仮想化構成ツリーパス（VMMTREEPATH）に出力される形式で指定してください。

セパレータには「/（スラッシュ）」を使用してください。

パス表記の先頭および末尾にはセパレータ「/（スラッシュ）」を使用しないでください。

例：「vCenter管理/VMC-1/POOL-1」，「vCenter管理/ESX-5/POOL3」

HVMの場合は，jirminfolistコマンドのリソース名（RESOURCENAME）に出力される形式で指定してください。

ネットワーク設定情報ファイルの形式

ネットワーク設定情報ファイルを作成する前に，次の作業を実施してください。

ネットワーク名の確認

次の手順で，ネットワーク名を確認してください。

リソース管理画面の［アクション］メニューから［デプロイ］を選択する。
［デプロイ設定］画面が表示されます。

仮想イメージテンプレートを指定して，ネットワーク定義の［設定］ボタンをクリックする。
［ネットワーク設定］画面が表示されます。

利用するネットワーク名を［ネットワーク設定］画面で確認する。

仮想ネットワークデバイス名の確認

次の手順で，デプロイ先の仮想化ソフトウェアが保持する仮想ネットワークデバイス名を確認してください。

リソース管理画面の［アクション］メニューから［デプロイ］を選択する。
［デプロイ設定］画面が表示されます。

仮想イメージテンプレートを指定して，ネットワーク定義の［設定］ボタンをクリックする。
［ネットワーク設定］画面が表示されます。

［ネットワーク名］を選択し，IPアドレスの種別を選択後，仮想ネットワークデバイス名の［選択］ボタンをクリックする。
［仮想ネットワークデバイス選択］画面が表示されます。

仮想ネットワークデバイス名を［仮想ネットワークデバイス選択］画面で確認する。

IPアドレスの種別やIPアドレスの決定

ネットワークごとにIPアドレスの種別やIPアドレスを決定してください。

仮想ネットワークデバイスの決定

ネットワークごとに設定する仮想ネットワークデバイスを決定してください。

ネットワーク設定情報ファイルに設定する項目を，次の表に示します。

なお，各項目は仮想イメージテンプレートが保持するすべてのネットワークについて設定する必要があります。

表1-22　ネットワーク設定情報ファイルの設定項目

項目
内容
VMware
Hyper-V
HVM

Windows
Linux
Windows
Windows
Linux

IPアドレス種別
仮想ホストに設定するIPアドレスの種別として次のどれかを指定します。

M：管理IPアドレスとして設定

B：業務IPアドレスとして設定

N：未使用IPアドレスとして設定

必ず管理IPアドレス（M）は1つ指定してください。未使用IPアドレス（N）を指定する場合，ネットワーク名以外の項目は無視されます。
○
○
○
○
○

ネットワーク名

VMware，Hyper-Vの場合

仮想イメージテンプレートが保持するネットワーク名を指定します。

HVMの場合

仮想イメージテンプレートが保持する仮想NIC番号を指定します。

○
○
○
○
○

IPアドレス
作成する仮想ホストに設定するIPアドレスを指定します。
なお，IPアドレス種別が業務IPアドレス（B）の場合，IPアドレスの指定を省略するとDHCPで自動的にIPアドレスを取得します。
○※1
○※1
○※1
○※1
○※1

ネットマスク
作成する仮想ホストに設定するネットマスクを指定します。
なお，IPアドレス種別が業務IPアドレス（B）で，IPアドレスの指定を省略した場合，この項目の設定は無視されます。
○※1
○※1
○※1
○※1
○※1

ゲートウェイ
作成する仮想ホストに設定するゲートウェイを指定します。この項目を省略した場合，ゲートウェイを設定しません。
なお，IPアドレス種別が業務IPアドレス（B）で，IPアドレスの指定を省略した場合，この項目の設定は無視されます。
△※1
△※1
△※1
△※1
△※1

DNSサーバ
作成する仮想ホストに設定するDNSサーバを指定します。この項目は仮想イメージテンプレートのOSが，Windowsの場合だけ有効です。この項目を省略した場合，DNSサーバを設定しません。
△※1
－
△※1
△※1
－

DNSサフィックス
作成する仮想ホストに設定するDNSサフィックスを指定します。この項目は仮想イメージテンプレートのOSが，Windowsの場合だけ有効です。この項目を省略した場合，DNSサフィックスを設定しません。
△※1
－
△※1
－
－

仮想ネットワークデバイス名

VMware，Hyper-Vの場合

デプロイ先の仮想化ソフトウェアに設定されている仮想スイッチ名を指定します。

HVMの場合

仮想NICに割り当てられている共有NICのネットーワークセグメント名を指定します。※2

○※1
○※1
○※1
○※1
○※1

VLAN ID
ネットワークに割り当てるデプロイ先の仮想化ソフトウェアのVLAN IDを指定します。
この項目を省略した場合，0（VLAN未使用）が仮定されます。また，IPアドレス種別が未使用IPの場合はこの項目は無視されます。
○※1
○※1
○※1
○※1
○※1

（凡例）

○：必ず指定する。

△：任意で指定する。

－：無効になる。

注※1

IPアドレス種別に「N」を指定した場合は無効になります。

注※2

HVMでHVM拡張モードが無効，またはHVM拡張モードをサポートしていない場合，次に示す注意が必要です。

ネットワークセグメントを指定する際の組み合わせとして，「Na」と「Nb」（Nは数字）を選択するときは，必ずNが同じ数字になるように指定してください。また，「Na」と「Nb」を管理と業務で対になるようにLPARに割り当てる必要があります。

HVM拡張モードが有効の場合は，次のようにネットワークセグメントを指定できます。

・仮想ホストにネットワークセグメントをポート単位で指定する。

・複数の仮想ネットワークに同じネットワークセグメントを指定する。

ネットワーク設定情報ファイルを記述する際は，次の点に注意してください。

各項目をコンマ（,）で区切ります。

設定値にコンマ（,）またはスペースが存在する場合は，設定値をダブルクォーテーション（"）で囲みます。

シャープ（#）で始まる行は，コメント行として扱います。

ネットワーク設定情報ファイルの記述例を次に示します。

#JP1/IT Resource Management - Manager
#IPアドレス種別,ネットワーク名,IPアドレス,ネットマスク,ゲートウェイ,DNSサーバ,DNSサフィックス,仮想ネットワークデバイス名,VLAN ID
M,"Network adapter 1",1.1.1.1,255.0.0.0,1.1.1.6,1.1.1.4,abc.com,vsw1,10
B,"Network adapter 2",2.2.2.2,255.0.0.0,2.2.2.6,2.2.2.4,xyz.com,vsw2,100

FC-HBA設定情報ファイルの形式

FC-HBA設定情報ファイルはCSV形式で作成します。

FC-HBA設定情報ファイルに設定する項目を，次の表に示します。各項目は仮想イメージテンプレートが保持するすべてのFC-HBAについて設定する必要があります。また，1つのFC-HBA設定情報ファイルに複数のFC-HBAを設定できます。

表1-23　FC-HBA設定情報ファイルの設定項目

項目
内容
VMware
Hyper-V
HVM

FC-HBA種別
仮想ホストに設定するFC-HBA種別として次のどれかを指定します。

B：ブート用のFC-HBAとして設定

Y：ブート用以外で有効なFC-HBAとして設定

N：無効なFC-HBAとして設定

ブート用のFC-HBA（B）は1つだけ設定してください。
－
－
○

PCIデバイス識別情報
仮想イメージテンプレートが保持するPCIデバイス識別情報を指定します。［FC-HBA設定］画面の［PCIデバイス識別情報］に表示される情報を指定してください。
－
－
○

（凡例）

○：必ず指定する。

－：無効になる。

FC-HBA設定情報ファイルの記述例を次に示します

#JP1/IT Resource Management - Manager
#FC-HBA種別,PCIデバイス識別情報
B,[5:4:0]
Y,[5:4:1]
N,[6:5:0]

このコマンドで操作する仮想化ソフトウェア種別および仮想ホストのOS種別ごとに，指定できるオプションを次の表に示します。

なお，表中の「－」（無効）のオプションを指定した場合，指定値を無視して処理が続行されます。エラーにはなりません。

表1-24　仮想化ソフトウェア種別および仮想ホストのOS種別ごとに，指定できるオプション

オプション | VMware | Hyper-V | HVM
Windows | Linux | Windows | Windows | Linux
-vmhost | ○ | ○ | ○ | ○ | ○
-desthv | ○ | ○ | ○ | ○ | ○
-pool | △ | △ | △ | △ | △
-tmpl | ○ | ○ | ○ | ○ | ○
-date | △ | △ | △ | △ | △
-cpu | △ | △ | △ | △※1 | △※1
-cpucore | △ | △ | △ | △ | △
-cpumode | △ | △ | △ | △ | △
-mem | △ | △ | △ | △ | △
-lcode | △ | － | △ | △ | －
-p | △ | △ | △ | △ | △
-domain | △ | － | △ | △ | －
-workgroup | △ | － | △ | △※2 | －
-dnssuffix | － | △ | － | － | －
-dnsip | － | △ | － | － | △
-datastore | ○ | ○ | － | － | －
-storage | － | － | － | ○ | ○
-storagepool | － | － | － | ○ | ○
-storageport | － | － | － | ○ | ○
-i※3 | ○ | ○ | ○ | ○ | ○
-fchba※4 | － | － | － | ○ | ○
-script | △ | △ | △ | △ | △
-sshport | － | △ | － | － | △
-wait | △ | △ | △ | △ | △
-q | △ | △ | △ | △ | △

（凡例）

○：必ず指定する。

△：任意で指定する。

－：無効になる。

注※1

HVMに仮想ホストをデプロイする場合，-cpumodeオプションでCPUの占有種別を占有にすると，-cpuオプションに指定した値は無視されます。

注※2

仮想化ソフトウェアがHVMで，仮想ホストのOSがWindows Server 2008またはWindows Server 2008 R2の場合には，ワークグループ名の指定は無効となるため，-workgroupオプションの指定値は無視されます。

注※3

ネットワーク設定情報ファイルに設定する項目の指定の要否については，「表1-22　ネットワーク設定情報ファイルの設定項目」を参照してください。

注※4

FC-HBA設定情報ファイルに設定する項目の指定の要否については，「表1-23　FC-HBA設定情報ファイルの設定項目」を参照してください。

注意事項

コマンドの実行中に［Ctrl］+［C］を押して処理を中止すると，処理が失敗するおそれがあります。正しく処理されているかどうかは，［タスク一覧］画面または［デプロイ設定］画面で確認してください。

コマンドで誤った値を指定したことでデプロイに失敗した場合，JP1/ITRMの管理対象から仮想ホストを削除してください。また，仮想化環境管理ソフトウェア側からも該当する仮想ホストが残っていないかを確認し，残っている場合には仮想化環境管理ソフトウェア側からも削除してください。

-waitオプションを指定した場合，コマンドの実行処理が完了するまでに数十分掛かることがあります。-waitオプションを指定してコマンドを実行する場合，同時に実行できるコマンド数の制限に達しないように注意してください。

コマンドを実行する前に，指定するIPアドレスがほかに使用されていないことを確認してください。すでに使用されているIPアドレスを使用すると，データベースの操作に失敗したり，タイムアウトで失敗する場合があります。

コマンドの実行時，JP1/ITRMとデプロイ先のネットワークセグメントが異なる場合は，ゲートウェイを必ず設定してください。ゲートウェイを設定していないと，仮想ホストの構成情報の取得に失敗します。

デプロイする仮想ホストOSに対してICMPをファイアウォールなどで許可しない場合，仮想ホストの構成情報の取得に失敗します。この場合は，［探索範囲の編集］画面で［pingによる探索］を無効にして，再度探索を実行してください。

デプロイする仮想ホストOSに対してWMIをファイアウォールなどで許可しない場合，仮想ホストの構成情報の取得に失敗します。必ずWMIを許可してください。

HVMに仮想ホストをデプロイする場合，-cpumodeオプションでCPUの占有種別を占有にすると，CPUはコア単位で占有され，1コア当たりの物理CPUの周波数が割り当てられるため，-cpuオプションに指定した値は無視されます。

戻り値

0
正常終了

1
引数不正

2
JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない

8
メモリ不足

12
通信エラー

16
実行権限がない

19
ユーザー問い合わせで処理を中止した

35
同時に実行できるコマンドの数を超えている

130
［Ctrl］+［C］キーを押してコマンドを中止した

136
デプロイ先に指定したリソースプールが存在しない

139
テンプレートが存在しない

140

デプロイ先に指定した仮想化ソフトウェアが存在しない

デプロイ先リソースプールに関連した仮想化ソフトウェアではない

145
コマンド実行エラー（エラーの詳細はメッセージで確認）

170
使用できないIPアドレスを指定した

254
重複しているテンプレート名を指定した

255
その他のエラー

使用例1

仮想イメージテンプレート「templateT」を基に，仮想ホスト「hostA」を仮想化構成ツリーが「VMMX/DATACENTERX/VMC1/vmX」の仮想化ソフトウェア「vmX」にデプロイする場合（処理が完了するのを待ってコマンド終了する場合）

jirmvmdeploy -vmhost hostA -desthv VMMX/DATACENTERX/VMC1/vmX -tmpl templateT -datastore data_storeS -i C:¥deploy_network1.csv -wait -q

使用例2

仮想イメージテンプレート「templateU」を基に，CPU周波数とメモリサイズを指定して，仮想ホスト「hostB」を仮想化構成ツリーが「VMMX/DATACENTERX/VMC1/vmY」の仮想化ソフトウェア「vmY」にデプロイする場合

jirmvmdeploy -vmhost hostB -desthv VMMX/DATACENTERX/VMC1/vmY -tmpl templateU -cpu 2 -mem 2 -datastore data_storeS -i C:¥deploy_network2.csv -q

jirmvmmigrate

機能

仮想ホストをマイグレーションするコマンドです。ホットマイグレーションとコールドマイグレーションを選択して実行できます。

実行時の前提条件

対象となる仮想化ソフトウェアが仮想化環境管理ソフトウェアで管理されている必要があります。JP1/ITRMでサポートしている仮想化ソフトウェアおよび仮想化環境管理ソフトウェアについては，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」の管理対象のITリソースについての説明を参照してください。

移動元と移動先の仮想化ソフトウェアは同一製品である必要があります。

移動元と移動先の仮想化ソフトウェア，および移動する仮想ホストがJP1/ITRMの管理対象である必要があります。

仮想ホストが動作する仮想化ソフトウェアが起動している必要があります。

ホットマイグレーションの場合，移動対象となる仮想ホストが起動している必要があります。

コールドマイグレーションの場合，移動対象となる仮想ホストが停止している必要があります。

JP1/ITRM ServiceおよびJP1/ITRM DB Serviceが起動している必要があります。

クラスタ環境の場合，実行系のマシン上でコマンドを実行する必要があります。待機系で実行した場合は，エラー終了します。

形式

jirmvmmigrate -type {hot | cold}
             -res 仮想ホストのリソース名
             -desthv 移動先仮想化ソフトウェア名
             [-pool 移動先リソースプール名] [-datastore データストア名]
             [-i 仮想ネットワークデバイス設定情報ファイル名]※
             [-wait] [-q]

注※　コールドマイグレーションの場合は，省略できません。

引数

-type {hot | cold}

マイグレーション種別を指定します。

hot：ホットマイグレーション

cold：コールドマイグレーション

-res 仮想ホストのリソース名

移動する仮想ホストのリソース名を指定します。

-desthv 移動先仮想化ソフトウェア名※

移動先の仮想化ソフトウェア名を指定します。

-pool 移動先リソースプール名※

-desthvオプションに指定した仮想化ソフトウェアから構成されているリソースプール名を指定します。移動対象の仮想ホストと移動先に指定できるリソースプールの対応については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のマイグレーションについての説明を参照してください。

このオプションを省略した場合，-desthvオプションに指定した仮想化ソフトウェア名がリソースプール名として指定されます。そのため，リソースプールに仮想化ソフトウェアを指定する場合は，このオプションを省略してください。ただし，このオプションに明示的に仮想化ソフトウェアを指定したい場合は，-desthvオプションと同じ仮想化ソフトウェア名を指定してください。

-datastore データストア名

移動先のデータストア名を指定します。-desthvオプションに指定した仮想化ソフトウェア配下のデータストア名を指定してください。VMware上の仮想ホストをコールドマイグレーションする場合は必ず指定してください。ホットマイグレーションの場合，およびVMware以外の仮想ホストをコールドマイグレーションする場合，このオプションに指定した値は無視されます。

-i 仮想ネットワークデバイス設定情報ファイル名

移動先の仮想ネットワークデバイスの設定を定義する仮想ネットワークデバイス設定情報ファイルを絶対パス形式で指定します。このオプションは，コールドマイグレーションの場合，必ず指定します。ホットマイグレーションの場合，このオプションに指定した値は無視されます。

仮想ネットワークデバイス設定情報ファイルについては，「仮想ネットワークデバイス設定情報ファイルの形式」を参照してください。

-wait

仮想ホストのマイグレーション処理の完了を待って，コマンドを終了する場合に指定します。このオプションを省略した場合は，マイグレーションの処理要求をしたあとすぐにコマンドが終了し，処理結果は表示されません。

-q

非対話形式でコマンドを実行するときに指定します。コマンドを自動実行する場合など，ユーザーの確認を省略したいときに使用します

注※

仮想化ソフトウェア名，およびリソースプール名は，次の規則に従って指定してください。

jirminfolistコマンドの出力結果の仮想化構成ツリーパス（VMMTREEPATH）に出力される形式で指定してください。

セパレータには「/（スラッシュ）」を使用してください。

パス表記の先頭および末尾にはセパレータ「/（スラッシュ）」を使用しないでください。

例：「vCenter管理/VMC-1/POOL-1」，「vCenter管理/ESX-5/POOL3」

仮想ネットワークデバイス設定情報ファイルの形式

仮想ネットワークデバイス設定情報ファイルは，複数の仮想ネットワークデバイスの設定をCSV形式で記述します。ファイル名は任意です。仮想ネットワークデバイス設定情報ファイルに設定できる項目を，次の表に示します。

表1-25　仮想ネットワークデバイス設定情報項目一覧

項目 | 説明
ネットワーク名 | 移動対象の仮想ホストが保持するネットワーク名。
移動先仮想ネットワークデバイス名 | ネットワーク名に指定したネットワークが接続する，移動先の仮想化ソフトウェアに設定されている仮想スイッチ名。

それぞれの項目は，この表の順番で，仮想ホストが保持するネットワークの数分定義してください。

仮想ネットワークデバイス設定情報ファイルの記述例を次に示します。

#JP1/IT Resource Management - Manager
#ネットワーク名,移動先仮想ネットワークデバイス名
"Network Adapter 1",vsw01
"Network Adapter 2",vsw02

このコマンドに指定するマイグレーション種別および仮想化ソフトウェア種別ごとに，指定できるオプションを次の表に示します。

なお，表中の「－」（無効）のオプションを指定した場合，指定値を無視して処理が続行されます。エラーにはなりません。

表1-26　マイグレーション種別および仮想化ソフトウェア種別ごとに，指定できるオプション

オプション | ホットマイグレーション | コールドマイグレーション
VMware | Hyper-V | VMware | Hyper-V
-type | ○ | ○ | ○ | ○
-res | ○ | ○ | ○ | ○
-desthv | ○ | ○ | ○ | ○
-pool | △ | △ | △ | △
-datastore | － | － | ○ | －
-i | － | － | ○ | ○
-wait | △ | △ | △ | △
-q | △ | △ | △ | △

（凡例）

○：必ず指定する。

△：任意で指定する。

－：無効になる。

注意事項

コマンドの実行中に［Ctrl］+［C］キーを押して処理を中止すると，処理が失敗するおそれがあります。正しく処理されているかどうかは，タスク画面のタスク一覧エリアで確認してください。

移動する仮想ホストとマイグレーション先に予約が設定されているときは，マイグレーション実行後に予約を実行できるかどうか確認してください。

戻り値

0 | 正常終了
1 | 引数不正
2 | JP1/ITRM ServiceまたはJP1/ITRM DB Serviceが起動していない
8 | メモリ不足
12 | 通信エラー
16 | 実行権限がない
19 | ユーザー問い合わせで処理を中止した
35 | 同時に実行できるコマンドの数を超えている
130 | ［Ctrl］+［C］キーを押してコマンドを中止した
106 | 指定した仮想ホストが存在しない
136 | 指定した移動先のリソースプールが存在しない
140 | 指定した移動先の仮想化ソフトウェアが存在しない
141 | 指定した移動先のデータストアが存在しない
145 | コマンド実行エラー（エラーの詳細はメッセージで確認）
254 | 重複しているリソース名を指定した
255 | その他のエラー

使用例1

稼働している仮想ホスト「hostA」を仮想化ソフトウェア「VMMX/DATACENTERX/VMC1/vmX」にホットマイグレーションする場合（処理が完了するのを待ってコマンド終了する場合）

jirmvmmigrate -type hot -res hostA -desthv VMMX/DATACENTERX/VMC1/vmX -wait -q

使用例2

停止している仮想ホスト「hostB」を仮想化ソフトウェア「VMMX/DATACENTERX/VMC1/vmY」にコールドマイグレーションする場合

jirmvmmigrate -type cold -res hostB -desthv VMMX/DATACENTERX/VMC1/vmY -datastore data_storeS -i C:¥migrate_network1.csv -q

2.　定義ファイル

この章では，JP1/ITRMの定義ファイルの形式について説明します。

＜この章の構成＞

定義ファイルの記述形式

定義ファイル一覧

ユーザー設定プロパティファイル（jp1itrm.properties）

定義ファイルの記述形式

定義ファイルで説明する項目を次に示します。

説明

定義ファイルの用途について説明しています。

形式

定義ファイルの入力形式について説明しています。

ファイル

定義ファイルのファイル名について説明しています。

格納先フォルダ

定義ファイルの格納場所について説明しています。

定義の反映時期

定義ファイルが反映されるタイミングについて説明しています。

記述内容

定義ファイルの記述内容について説明しています。

定義例

定義ファイルの定義例について説明しています。

定義ファイル一覧

JP1/ITRMの定義ファイルの一覧を次に示します。

表2-1　定義ファイル一覧

定義ファイル名 | 説明
ユーザー設定プロパティファイル（jp1itrm.properties） | ユーザーが必要に応じてJP1/ITRMの各種設定を定義する。

ユーザー設定プロパティファイル（jp1itrm.properties）

説明

ユーザーが必要に応じてJP1/ITRMの各種設定を定義するプロパティファイルです。

形式

指定キー名 = 設定値

ファイル

jp1itrm.properties

格納先フォルダ

ITRMパス¥JP1ITRM¥conf¥

クラスタ運用の場合

共有フォルダ¥JP1ITRM¥conf¥

定義の反映時期

JP1/ITRM Serviceを再起動したあと反映されます。

記述内容

ユーザー設定プロパティファイルを記述する場合，次の点に注意してください。

指定キーと設定値はイコール（=）でつなぎます。なお，半角スペースは省略できます。記述形式を次に示します。
指定キー名△=△設定値
（凡例）　△：半角スペース

指定キーと設定値は1行に1つずつ指定します。

プロパティを設定する行の終わりは，改行する必要があります。

ユーザー設定プロパティファイルの最終行は，改行する必要があります。

指定キーと設定値の途中で改行しないでください。

指定キーに設定した値が，指定できる値の範囲を超えている場合，また有効な設定値でない場合は，デフォルト値が仮定されます。

同一の指定キーを複数設定した場合は，あとに指定した指定キーの値で実行します。

シャープ（#）で始まる行は，コメント行として扱います。

使用できるのはASCII文字だけです。また，大文字と小文字は区別されます。

指定する文字列内にエンマーク（¥）が含まれる場合は，「¥¥」と記述する必要があります。

スペースだけの行は無視されます。

指定キーは，行の最初のスペース以外の文字から，最初のスペースの直前までとします。

設定値は，指定キーのあとのイコール（=）の直後にある，スペース以外の文字から，行末までとします。

空白を含むパスを指定する場合，ダブルクォーテーションで囲まないでください。

ユーザー設定プロパティファイルで設定できる指定キーを次に示します。

表2-2　ユーザー設定プロパティファイルで設定できる指定キー一覧

指定キー名
説明
デフォルト値
指定できる値

AD.SnmpController.receiveTrapPort
トラップ受信の際に設定するポート番号。
162
0～65,535

CO.IDName
JP1/ITRMの識別名（メール送信元識別名）。
localhost
64バイト以内

CO.storedImagePath
退避イメージの格納フォルダ名。
インストールおよびセットアップの完了後に，退避イメージの格納フォルダを変更した場合は，CO.storedImagePathの値も変更する。
ITRMパス¥JP1ITRM¥imageStore
150バイト以内
半角英数字，アンダーバー（_），ピリオド（.），ハイフン（-），コロン（:），シャープ（#），アットマーク（@），エンマーク（¥），丸括弧（()），半角スペース

CO.templateFilePath
テンプレートの格納フォルダ名。
インストールおよびセットアップの完了後に，テンプレートの格納フォルダを変更した場合は，CO.templateFilePathの値も変更する。
ITRMパス¥JP1ITRM¥template
150バイト以内
半角英数字，アンダーバー（_），ピリオド（.），ハイフン（-），コロン（:），シャープ（#），アットマーク（@），エンマーク（¥），丸括弧（()），半角スペース

SE.event.regulerUserNotificationTaskPeriod
未通知イベントレポートをメールで通知する間隔（単位：分）。
5
1～1,440

SE.event.maxCurrentEventResult
イベントの通知によってメール本文に記載するイベントの上限件数。上限件数を超えた場合は省略する。
50
1～65,535

SE.event.maxNotAckEventResult
未受諾レポートによってメール本文に記載するイベントの上限件数。上限件数を超えた場合は省略する。
50
1～65,535

SE.Inventory.renewProcessingInterval
全ノードインベントリ更新処理の最小実行間隔（単位：秒）。
前回の全ノード更新処理完了からの経過時間がこの値よりも小さい場合，全ノードの更新処理は実行されない。
60
10～72,000

SE.library.MaxBackupCount
ライブラリに保持できる退避イメージの上限数。
500
0～500

SE.library.MaxTemplateCount
ライブラリに保持できる仮想イメージテンプレートの上限数。
500
0～500

SE.perf.aggregateBaseHour
日単位集約の基点となる時刻（単位：時）。
デフォルトタイムゾーンを適用する。
0
0～23

SE.resource.MaxBusinessGroupAddCount
1つの業務グループの配下に設定できる業務グループ数。
1,000
0～1,000

SE.resource.MaxBusinessGroupCount
システムに登録できる業務グループ数。
2,000
0～2,000

SE.resource.MaxBusinessGroupFolderCount
システムに登録できる業務グループフォルダ数。
2,000
0～2,000

SE.resource.MaxBusinessGroupHierarchyCount
業務グループの階層の上限数。
10
1～10

SE.resource.MaxFolderCount
システムに登録できるリソースグループフォルダの数。
1,000
0～1,000

SE.resource.MaxFolderDepth
リソースグループフォルダの階層の上限数。
10
1～10

SE.resource.MaxFolderResourceGroupInFolder
1つのリソースグループフォルダの配下に追加できるリソースグループ数。
1,000
0～1,000

SE.resource.MaxHAClusterGroupAddCount
1つのHAクラスタグループに登録できるホスト数。
5
0～5

SE.resource.MaxHAClusterGroupCount
システムに登録できるHAクラスタグループ数。
1,000
0～1,000

SE.resource.MaxResourceGroupCount
システムに登録できるリソースグループ数。
1,000
0～1,000

SE.status.renewProcessingInterval
状態管理に対する全ノード状態更新処理の最小実行間隔（単位：秒）。
前回の全ノード更新処理完了からの経過時間がこの値よりも小さい場合，全ノードの更新処理は実行されない。
60
30～900

SE.user.MaxComment
コメントとして設定できる文字数の上限値（単位：バイト）。
80
0～80

SE.user.MaxRoleIdCount
ロールIDとして設定できる文字数の上限値（単位：バイト）。
256
1～256

SE.user.MaxRollCount
システムに登録できるロール数。
1,000
1～1,000

SE.user.MaxUserCount
システムに登録できるユーザー数。
1,000
1～1,000

SE.user.MaxUserInRoll
1つのロールに追加できるユーザー数。
1,000
0～1,000

SE.UserManage.loginFailCount
ログインに連続して失敗できる回数。
3
1～10

SE.UserManage.SessionTimeout
ログイン時のセッションの有効期間（単位：分）。
20
1～60

AD.customize.polling.timeoutSec
デプロイ処理内でのOSカスタマイズ処理のタイムアウト時間（単位：秒）。
2,100
1～2,147,483,647

AD.changePowerStatus.RebootTimeout.WMI
WMI用
マシンの電源状態を変更（リブート）する機能のタイムアウト時間（単位：秒）。
目安は「シャットダウン時間＋起動時間＋α」。
3,600
0～2,147,483,647

AD.changePowerStatus.RebootTimeout.SSH
UNIX用
マシンの電源状態を変更（リブート）する機能のタイムアウト時間（単位：秒）。
目安は「停止時間＋起動時間＋α」。
3,600
0～2,147,483,647

AD.changePowerStatus.ShutdownTimeout.Vcenter
vCenter用
マシンの電源状態を変更（停止）する機能のタイムアウト時間（単位：秒）。
1,500
0～2,147,483,647

AD.changePowerStatus.ShutdownTimeout.Scvmm
SCVMM用
マシンの電源状態を変更（停止）する機能のタイムアウト時間（単位：秒）。
1,500
0～2,147,483,647

AD.changePowerStatus.PowerOnServerTimeout.Vcenter
vCenter用
マシンの電源状態を変更（起動）する機能のタイムアウト時間（単位：秒）。
目安は「AD.timeout.BootOS＋α」。
2,100
0～2,147,483,647

AD.changePowerStatus.PowerOnServerTimeout.Scvmm
SCVMM用
マシンの電源状態を変更（起動）する機能のタイムアウト時間（単位：秒）。
目安は「AD.timeout.BootOS＋α」。
2,100
0～2,147,483,647

AD.backUpVmTimeout.Vcenter
vCenter用
仮想ホスト退避機能のタイムアウト時間（単位：秒）。
実測値から容量240ギガバイトを想定したデフォルト。ネットワーク性能に依存する。
目安は「データ転送時間×2＋α」。
2,100
0～2,147,483,647

AD.backUpVmTimeout.Scvmm
SCVMM用
仮想ホスト退避機能のタイムアウト時間（単位：秒）。
実測値から容量240ギガバイトを想定したデフォルト。ネットワーク性能に依存する。
目安は「データ転送時間×2＋α」。
86,400
0～2,147,483,647

AD.restoreVmTimeout.Vcenter
vCenter用
仮想ホストをリストアする機能のタイムアウト時間（単位：秒）。
実測値から容量240ギガバイトを想定したデフォルト。ネットワーク性能に依存する。
目安は「データ転送時間×2＋α」。
86,400
0～2,147,483,647

AD.restoreVmTimeout.Scvmm
SCVMM用
仮想ホストをリストアする機能のタイムアウト時間（単位：秒）。
実測値から容量240ギガバイトを想定したデフォルト。ネットワーク性能に依存する。
目安は「データ転送時間×2＋α」。
86,400
0～2,147,483,647

AD.importOvfTimeout.Vcenter
vCenter用
OVFインポート機能のタイムアウト時間（単位：秒）。
実測値から容量240ギガバイトを想定したデフォルト。ネットワーク性能に依存する。
目安は「データ転送時間×2＋α」。
86,400
0～2,147,483,647

AD.createVmFromVhdTimeout.Scvmm
SCVMM用
既存VHD利用の仮想ホスト作成機能のタイムアウト時間（単位：秒）。
実測値から容量240ギガバイトを想定したデフォルト。ネットワーク性能に依存する。
目安は「データ転送時間×2＋α」。
86,400
0～2,147,483,647

AD.customizeOsSpecTimeout.Vcenter
vCenter用
ゲストOSカスタマイズ機能のタイムアウト時間（単位：秒）。
目安は「AD.customize.polling.timeoutSec＋α」。
2,400
0～2,147,483,647

AD.customizeOsSpecTimeout.Scvmm
SCVMM用
ゲストOSカスタマイズ機能のタイムアウト時間（単位：秒）。
目安は「AD.customize.polling.timeoutSec＋α」。
2,400
0～2,147,483,647

AD.timeout.BootOS
全OS共通
OSの起動監視のタイムアウト時間（単位：分）。
OSの起動時間を実測して算定。
30
1～1,440

AD.ovf.timeoutSec
全仮想化機能共通
OVFディスク転送処理のタイムアウト時間（単位：秒）。
86,400
0～2,147,483,647

CO.logger.auditEnable
監査ログを出力するかどうか。
0：出力しない
1：出力する
0
0または1

CO.logger.auditFilePath
監査ログの出力先フォルダ名。
ITRMパス¥JP1ITRM¥logs
241バイト以内
監査ログの出力先パスに指定できる文字列については，マニュアル「JP1/NETM/Audit 構築・運用ガイド」を参照してください。

CO.logger.auditFileCount
監査ログの面数（単位：面）。
10
2～16

CO.logger.auditMaxFileSize
監査ログファイルの最大サイズ（単位：バイト）。
10,485,760
1,048,576～2,147,483,647

AD.timeout.rate
アダプタで監視している時間に，指定した割合を掛けて，VMwareドライバでのタイマ監視時間とする。（単位：%）
70
1～100

AD.changePowerStatus.PowerOffServerTimeout.Vcenter
vCenter用
マシン電源状態変更機能のタイムアウト時間（単位：秒）。
300
0～2,147,483,647

AD.changePowerStatus.PowerOffServerTimeout.Scvmm
SCVMM用
マシン電源状態変更機能のタイムアウト時間（単位：秒）。
300
0～2,147,483,647

AD.libraryShareName.Scvmm
SCVMM用
JP1/ITRMが使用するSCVMMライブラリサーバの共有フォルダ名。
jp1itrm
32バイト以内

AD.FtpVirtualDirectoryName.Scvmm
SCVMM用
JP1/ITRMが使用するFTPサーバの仮想フォルダ名。
jp1itrm
32バイト以内

CO.ITRMServerURL
JP1/ITRMサーバのURL。
ITリソース管理サーバに複数のIPアドレスが設定されている場合，セットアップ時に設定される指定キーCO.ITRMServerURLのIPアドレスが，JP1/ITRMに接続するためのIPアドレスではないときがある。この場合，JP1/ITRMが通知するメール内のURLおよびAPI機能のレスポンス中のURLが不正になるため，指定キーCO.ITRMServerURLに設定されているIPアドレスを，JP1/ITRMに接続するためのIPアドレスに変更すること。
http://localhost:
（該当なし）

SE.JP1Event
JP1イベント発行を有効にするかどうか。
0：無効
1：有効
0
0または1

VI.vmmtreevmhost.display
リソース管理画面の［リソース管理メニュー］で，仮想構成のグループに仮想ホストを表示するかどうか。
仮想ホストを表示する場合は，［リソース管理メニュー］で一度に表示するツリーノードの表示制限値（200個以内）を超えないことを確認してから表示すること。
0：仮想ホストを表示しない
1：仮想ホストを表示する
0
0または1

ML.networkTrafficControl
JP1/ITRMで管理対象機器との通信転送量制限機能を有効にするかどうか。
0：無効
1：有効
1
0または1

AD.MaxConnection.Scvmm
SCVMMアダプタが発行するコマンドの最大並列実行数。
10
-1～2,147,483,647

AD.DBWait.Scvmm
SCVMMアダプタがDB更新コマンドを発行した場合の待ち時間（単位：ミリ秒）。
60,000
0～2,147,483,647

AD.smis.timeout.pollingJob.createLU
SMI-S（Storage）連携でLU作成時のジョブをポーリングする際のタイムアウト時間（単位：分）。
720
1～1,440

AD.smis.timeout.pollingJob.deleteLU
SMI-S（Storage）連携でLU削除時のジョブをポーリングする際のタイムアウト時間（単位：分）。
720
1～1,440

SE.commandWorkPath
コマンドの作業フォルダ。
ITRMパス¥JP1ITRM¥user
256バイト以内

AD.smis.createLUTimeout
SMISストレージ用。
LUの作成およびホストグループ設定が完了するまでのタイムアウト時間（単位：秒）。
131,400
0～2,147,483,647

AD.smis.deleteLUTimeout
SMISストレージ用。
LUの削除およびホストグループ設定が完了するまでのタイムアウト時間（単位：秒）。
131,400
0～2,147,483,647

AD.changePowerStatus.ShutdownTimeout.WMI
WMI用。
マシン電源状態変更機能（停止）のタイムアウト時間（単位：秒）。
1,500
0～2,147,483,647

AD.changePowerStatus.ShutdownTimeout.SSH
SSH用。
マシン電源状態変更機能（停止）のタイムアウト時間（単位：秒）。
1,500
0～2,147,483,647

AD.hvm.createLPARTimeout
HVM用。
LPARの作成が完了するまでのタイムアウト時間（単位：秒）。
2,700
0～2,147,483,647

AD.hvm.deleteLPARTimeout
HVM用。
LPARの削除が完了するまでのタイムアウト時間（単位：秒）。
135
0～2,147,483,647

AD.hvm.waitLPARDeactivatedTimeout
HVM用。
LPARがDeactivated状態になるのを監視する時間（単位：秒）。
OSによるシャットダウン実行後にLPARの状態を監視する。
900
0～2,147,483,647

AD.changeVmSettingTimeout.HVM
HVM用。
仮想ホスト構成変更機能のタイムアウト時間（単位：秒）。
495
0～2,147,483,647

AD.changePowerStatus.PowerOnServerTimeout.HVM
HVM用。
マシンの電源をONにするときのタイムアウト時間（単位：秒）。
45
0～2,147,483,647

AD.changePowerStatus.PowerOffServerTimeout.HVM
HVM用。
マシンの電源をOFFにするときのタイムアウト時間（単位：秒）。
45
0～2,147,483,647

AD.dpm.installOSbyDPMTimeout
JP1/SC/DPM用。
イメージディスクを利用して仮想ホストへOSをインストールときのタイムアウト時間（単位：秒）。
129,600
0～2,147,483,647

AD.dpm.command.defaultGroup
デプロイ実行時にJP1/SC/DPMに登録するグループ名。
jp1itrm
64バイト以内

AD.dpm.MaxConnection
管理サーバ for DPMごとのDPMドライバが発行するコマンドの最大並列実行数。
-1，または0を指定したときは無制限になる。
5
-1～1,000

AD.dpm.command.passwordCheckGroup
jirmimageimportコマンドで管理サーバ for DPMのパスワードチェック時に使用するグループ名。JP1/SC/DPMに登録されていないグループ名を指定する。
jp1itrm_group
64バイト以内

AD.hvm.maxExecution
HVM用。
HVMおよびHVM上のLPARに対する操作でのHvmShコマンド最大同時実行数。
30
1～262,144

AD.hvm.executionEntryTimeout
HVM用。
HVMおよびHVM上のLPARに対する操作の実行待ちタイムアウト時間（単位：秒）。
300
1～86,400

SE.reservation.rangeOfDailyCheck
1日1回実施する定期チェックのチェック対象期間（単位：日）。
1
1～366

SE.reservation.rangeOfHourlyCheck
1時間1回実施する定期チェックのチェック対象期間（単位：時間）。
1
1～72

AP.enableLoggingForNoAuthInfoRequest
APIが認証情報（HTTPリクエストのAuthorizationヘッダーフィールド）を伴わないリクエストを受け付けた場合に，公開ログおよび監査ログを出力するかどうかを指定する。
APIクライアントのHTTP通信の実装次第で，認証情報なしでのリクエストが発生することがあるため，その場合の「認証情報なし」のリクエストに対してエラーログを記録するかどうかを指定する。
0：出力しない（記録しない）
1：出力する（記録する）
0
0または1

注

計算式中の「＋α」は余剰を意味します。

定義例

#All Rights Reserved. Copyright (C) 2010, 2012, Hitachi, Ltd.↓
#Licensed Material of Hitachi, Ltd.↓
↓
#------------------------------------------------------------------------------↓
# 下記のプロパティは，設定値にディレクトリパスを指定する必要があります。↓
# パスを指定する場合は，パスの区切り文字を「¥¥」で指定してください。↓
# 指定例：↓
# CO.templateFilePath = C:¥¥Program Files (x86)¥¥HITACHI¥¥JP1ITRM¥¥template↓
# CO.storedImagePath = C:¥¥Program Files (x86)¥¥HITACHI¥¥JP1ITRM¥¥imageStore↓
# CO.logger.auditFilePath = C:¥¥Program Files (x86)¥¥HITACHI¥¥JP1ITRM¥¥logs↓
# SE.commandWorkPath = C:¥¥Program Files (x86)¥¥HITACHI¥¥JP1ITRM¥¥user↓
#------------------------------------------------------------------------------↓
↓
CO.templateFilePath = C:¥¥Program files (x86)¥¥Hitachi¥¥JP1ITRM¥¥template↓
CO.storedImagePath = C:¥¥Program files (x86)¥¥Hitachi¥¥JP1ITRM¥¥imageStore↓
CO.ITRMServerURL = http://xxx.xxx.xxx.xxx:↓
SE.commandWorkPath = C:¥¥Program files (x86)¥¥Hitachi¥¥JP1ITRM¥¥user↓
↓

（凡例）

↓：改行

3.　JP1イベント

この章では，JP1/ITRMが出力するJP1イベントの属性，発行契機，および詳細内容について説明します。

＜この章の構成＞

3.1　JP1イベントの属性

3.2　JP1/ITRMが出力するJP1イベント一覧

3.3　JP1イベントの詳細

3.1　JP1イベントの属性

JP1イベントの属性には基本属性と拡張属性があります。

＜この節の構成＞

3.1.1　基本属性

3.1.2　拡張属性

3.1.1　基本属性

基本属性は，すべてのJP1イベントが持っている属性です。

表3-1　JP1イベントの基本属性

項目 | 属性名 | 説明 | 内容（属性値）
イベントID | （該当なし） | 事象の内容を表す8バイトの値。 | 00006600～000067FF
メッセージ | （該当なし） | JP1イベントの内容を表した文字列。 | メッセージテキスト

3.1.2　拡張属性

拡張属性は，JP1イベントを発行するプログラムが独自に割り当てる属性です。

拡張属性には共通情報と固有情報があります。共通情報はJP1プログラムで統一されている情報を示します。固有情報は共通情報以外の拡張属性を示します。

表3-2　共通情報の一覧

項目
属性名
説明
内容（属性値）

重要度
SEVERITY
JP1イベントの緊急性を表す項目。

Error（エラー）

Warning（警告）

Notice（通知）

Information（情報）

ユーザー名
USER_NAME
業務を実行しているユーザー名。
空文字

プロダクト名
PRODUCT_NAME
プロダクト名。
/HITACHI/JP1/ITRM

オブジェクトタイプ
OBJECT_TYPE
JP1イベント発行の契機となったオブジェクトの種類を表す名称。
ただし，名称はオブジェクトタイプ定義ファイル※1に記載されている必要がある。

SERVICE

DISCOVERY

RESOURCE

SCHEDULE

オブジェクト名
OBJECT_NAME
JP1イベント発行の契機となったオブジェクトの名称。
ただし，名称はオブジェクトタイプ定義ファイル※1に記載されている必要がある。

JP1/ITRMのサービス名※2

JP1/ITRMのノード名※2

JP1/ITRMのスケジュール名※2

登録名タイプ
ROOT_OBJECT_TYPE
オブジェクトの種別。通常はオブジェクトタイプと同じ。

SERVICE

DISCOVERY

RESOURCE

SCHEDULE

登録名
ROOT_OBJECT_NAME
ユーザーの操作時に実行を指示する単位になる名称。

JP1/ITRMのサービス名※2

JP1/ITRMのノード名※2

JP1/ITRMのスケジュール名※2

オブジェクトID
OBJECT_ID
プロダクト名との組み合わせでオブジェクトのインスタンスを統合システム内で一意に意識できる文字列。
このIDはJP1/IM - Viewの［統合機能メニュー］画面から各製品のモニターを呼び出すときに使用する。
JP1/ITRMのスケジュールID※2

事象種別
OCCURRENCE
オブジェクト名に示したオブジェクトに対して起こった事象。

START

END

NOSTART

ERROR

NOTICE

開始時刻
START_TIME
実行開始または再実行開始の時刻。
UTC 1970-01-01 00:00:00からの秒数

終了時刻
END_TIME
実行終了の時刻。
UTC 1970-01-01 00:00:00からの秒数

終了コード
RESULT_CODE
10進数文字列の終了コード。
10進数文字列の終了コード

注※1

オブジェクトタイプ定義ファイルについては，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のJP1/IM - Managerとの連携に必要な設定についての説明を参照してください。

注※2

内容（属性値）に設定される情報を次の表に示します。

内容（属性値） | 設定される情報 | 説明
JP1/ITRMのサービス名 | ITRM | JP1/ITRMのサービス名。
JP1/ITRMのノード名 | ノード名 | JP1/ITRMで管理しているノード名。
JP1/ITRMのスケジュール名，JP1/ITRMのスケジュールID | AutoDiscovery | 探索。
UpdateInventory | ITリソースの構成情報の更新。
CollectMachineState | ITリソースの状態収集。
DailyExceptionReport | 未受諾イベント通知（毎日）。
WeeklyExceptionReport | 未受諾イベント通知（毎週）。
DailyStatisticalReport | レポートに関するイベント通知（毎日）。
WeeklyStatisticalReport | レポートに関するイベント通知（毎週）。
MonthlyStatisticalReport | レポートに関するイベント通知（毎月）。
DeleteEventData | イベント削除。
CompressMeasurementResult | 性能情報の収集。
EventLogSendMail | イベント通知。
DBReclaim | データベースの空きページ解放。
Backup | バックアップ。
DatabaseStatusCheck | データベースの状態チェック。
EventTableCheck | イベントの容量チェック。
DatabaseHoldCheck | データベースの閉塞チェック。
DatabaseFreeSpaceCheck | データベースの空き容量チェック。
TaskAutoRun | タスク実行。
TaskAutoDelete | タスク実行の履歴削除。
ReservationAutoDelete | 割り当て予約の履歴削除。
ReservationAutoCheck | 割り当て予約チェック（設定時間分）。
ReservationAutoCheckForUse | 割り当て予約チェック（毎時）。

表3-3　固有情報の一覧

項目
属性名
説明
内容（属性値）

JP1/ITRMのホスト名
E.ITRM_TARGET_HOST
JP1/ITRMのホスト名。
対象ホスト名

JP1/ITRMのホストのポート番号
E.ITRM_PORT
JP1/ITRMのホストのポート番号。
対象ホストのポート番号

モジュールID
E.MODULE_ID
モジュールIDを表す文字列。

event

task

イベント発行番号※
E.EVENT_ID
JP1/ITRMのイベント発行番号。
イベントが発行されるたびに付与される一意のID

タスクID※
E.TASK_ID
タスクIDを表す文字列。
タスクID

注※

発行するイベントのモジュールIDがeventの場合はイベント発行番号を追加し，モジュールIDがtaskの場合はタスクIDを追加します。

3.2　JP1/ITRMが出力するJP1イベント一覧

JP1/ITRMが出力するJP1イベントのイベントID，発行契機，およびメッセージを次の表に示します。

表3-4　JP1/ITRMが出力するJP1イベント一覧

イベントID | 発行契機 | メッセージ
00006600 | データベース状態の警告を通知した場合 | JP1/ITRM - Managerのデータベースの空き容量が少なくなっています。
00006601 | データベース状態の異常を通知した場合 | JP1/ITRM - Managerのデータベースの空き容量が不足しています。
00006610 | スケジュールの実行に異常（予約不正，滅却予定日時の超過）を検知した場合 | スケジュールの実行に伴い異常が発生しました。
00006620 | タスクの実行に異常（タスクの異常終了，タスクの実行期限の超過）を検知した場合 | タスクの実行に伴い異常が発生しました。
00006630 | タスク遅延（保守期間内に未完了，遅延実行）を検知した場合 | タスクに遅延が発生しました。
00006640 | 管理対象の変更（管理対象のノード追加やノード削除，構成情報の変更）を検知した場合 | JP1/ITRM - Managerの管理対象に変更がありました。
00006641 | 新規にノードを発見した場合 | 探索した結果，新規にノードが発見されました。
00006650 | JP1/ITRMのサービスを起動した場合 | JP1/ITRM - Managerのサービスが起動しました。
00006651 | JP1/ITRMのサービスを停止した場合 | JP1/ITRM - Managerのサービスが停止しました。
00006652 | JP1/ITRMのサービスの異常（起動失敗や異常終了）を検知した場合 | JP1/ITRM - Managerのサービスが異常により起動していません。
00006660 | 探索での情報取得が失敗した場合 | 探索処理中に情報を取得できなかったリソースがあります。
00006661 | ユーザーアカウントがロックされた場合 | ユーザアカウントがロックされました。
00006662 | 管理対象ノードへの認証または接続に失敗した場合 | 管理対象ノードへの認証もしくは接続に失敗しました。
00006663 | 導入予定日時が超過した場合 | 導入予定日時を超過しているリソースがあります。

3.3　JP1イベントの詳細

JP1/ITRMから発行されるJP1イベントの詳細を，イベントID別に示します。

＜この節の構成＞

3.3.1　イベントID：00006600の詳細

3.3.2　イベントID：00006601の詳細

3.3.3　イベントID：00006610の詳細

3.3.4　イベントID：00006620の詳細

3.3.5　イベントID：00006630の詳細

3.3.6　イベントID：00006640の詳細

3.3.7　イベントID：00006641の詳細

3.3.8　イベントID：00006650の詳細

3.3.9　イベントID：00006651の詳細

3.3.10　イベントID：00006652の詳細

3.3.11　イベントID：00006660の詳細

3.3.12　イベントID：00006661の詳細

3.3.13　イベントID：00006662の詳細

3.3.14　イベントID：00006663の詳細

3.3.1　イベントID：00006600の詳細

属性種別 | 項目 | 属性名 | 内容（属性値）
基本属性 | イベントID | （該当なし） | 00006600
メッセージ | （該当なし） | JP1/ITRM - Managerのデータベースの空き容量が少なくなっています。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Warning（警告）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | SERVICE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのサービス名
登録名タイプ | ROOT_OBJECT_TYPE | SERVICE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのサービス名
事象種別 | OCCURRENCE | NOTICE
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | イベントが発行されるたびに付与される一意のID
タスクID | E.TASK_ID | （該当なし）

3.3.2　イベントID：00006601の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006601
メッセージ | （該当なし） | JP1/ITRM - Managerのデータベースの空き容量が不足しています。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Error（エラー）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | SERVICE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのサービス名
登録名タイプ | ROOT_OBJECT_TYPE | SERVICE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのサービス名
事象種別 | OCCURRENCE | Error
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | イベントが発行されるたびに付与される一意のID
タスクID | E.TASK_ID | （該当なし）

3.3.3　イベントID：00006610の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006610
メッセージ | （該当なし） | スケジュールの実行に伴い異常が発生しました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Error（エラー）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | SCHEDULE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのスケジュール名
登録名タイプ | ROOT_OBJECT_TYPE | SCHEDULE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのスケジュール名
オブジェクトID | OBJECT_ID | JP1/ITRMのスケジュールID
事象種別 | OCCURRENCE | Error
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | イベントが発行されるたびに付与される一意のID
タスクID | E.TASK_ID | （該当なし）

3.3.4　イベントID：00006620の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006620
メッセージ | （該当なし） | タスクの実行に伴い異常が発生しました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Error（エラー）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | RESOURCE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのノード名
登録名タイプ | ROOT_OBJECT_TYPE | RESOURCE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのノード名
事象種別 | OCCURRENCE | Error
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | task
イベント発行番号 | E.EVENT_ID | （該当なし）
タスクID | E.TASK_ID | タスクID

3.3.5　イベントID：00006630の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006630
メッセージ | （該当なし） | タスクに遅延が発生しました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Error（エラー）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | SCHEDULE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのスケジュール名
登録名タイプ | ROOT_OBJECT_TYPE | SCHEDULE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのスケジュール名
オブジェクトID | OBJECT_ID | JP1/ITRMのスケジュールID
事象種別 | OCCURRENCE | Error
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | task
イベント発行番号 | E.EVENT_ID | （該当なし）
タスクID | E.TASK_ID | タスクID

3.3.6　イベントID：00006640の詳細

属性種別
項目
属性名
内容

基本属性
イベントID
（該当なし）
00006640

メッセージ
（該当なし）
JP1/ITRM - Managerの管理対象に変更がありました。

拡張属性
共通情報
重要度
SEVERITY
Notice（通知）

ユーザー名
USER_NAME
空文字

プロダクト名
PRODUCT_NAME
/HITACHI/JP1/ITRM

オブジェクトタイプ
OBJECT_TYPE

DISCOVERY

RESOURCE

オブジェクト名
OBJECT_NAME
JP1/ITRMのノード名

登録名タイプ
ROOT_OBJECT_TYPE

DISCOVERY

RESOURCE

登録名
ROOT_OBJECT_NAME
JP1/ITRMのノード名

事象種別
OCCURRENCE
Notice

開始時刻
START_TIME
実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数

終了時刻
END_TIME
（該当なし）

終了コード
RESULT_CODE
（該当なし）

固有情報
JP1/ITRMのホスト名
E.ITRM_TARGET_HOST
対象ホスト名

JP1/ITRMのホストのポート番号
E.ITRM_PORT
対象ホストのポート番号

モジュールID
E.MODULE_ID
event

イベント発行番号
E.EVENT_ID
イベントが発行されるたびに付与される一意のID

タスクID
E.TASK_ID
（該当なし）

3.3.7　イベントID：00006641の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006641
メッセージ | （該当なし） | 探索した結果，新規にノードが発見されました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Notice（通知）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | DISCOVERY
オブジェクト名 | OBJECT_NAME | JP1/ITRMのサービス名
登録名タイプ | ROOT_OBJECT_TYPE | DISCOVERY
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのサービス名
事象種別 | OCCURRENCE | Notice
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | イベントが発行されるたびに付与される一意のID
タスクID | E.TASK_ID | （該当なし）

3.3.8　イベントID：00006650の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006650
メッセージ | （該当なし） | JP1/ITRM - Managerのサービスが起動しました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Information（情報）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | SERVICE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのサービス名
登録名タイプ | ROOT_OBJECT_TYPE | SERVICE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのサービス名
事象種別 | OCCURRENCE | START
開始時刻 | START_TIME | （該当なし）
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | （該当なし）
タスクID | E.TASK_ID | （該当なし）

3.3.9　イベントID：00006651の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006651
メッセージ | （該当なし） | JP1/ITRM - Managerのサービスが停止しました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Information（情報）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | SERVICE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのサービス名
登録名タイプ | ROOT_OBJECT_TYPE | SERVICE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのサービス名
事象種別 | OCCURRENCE | END
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | （該当なし）
タスクID | E.TASK_ID | （該当なし）

3.3.10　イベントID：00006652の詳細

属性種別
項目
属性名
内容

基本属性
イベントID
（該当なし）
00006652

メッセージ
（該当なし）
JP1/ITRM - Managerのサービスが異常により起動していません。

拡張属性
共通情報
重要度
SEVERITY
Error（エラー）

ユーザー名
USER_NAME
空文字

プロダクト名
PRODUCT_NAME
/HITACHI/JP1/ITRM

オブジェクトタイプ
OBJECT_TYPE
SERVICE

オブジェクト名
OBJECT_NAME
JP1/ITRMのサービス名

登録名タイプ
ROOT_OBJECT_TYPE
SERVICE

登録名
ROOT_OBJECT_NAME
JP1/ITRMのサービス名

事象種別
OCCURRENCE

END

NOSTART

開始時刻
START_TIME
実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数

終了時刻
END_TIME
（該当なし）

終了コード
RESULT_CODE
（該当なし）

固有情報
JP1/ITRMのホスト名
E.ITRM_TARGET_HOST
対象ホスト名

JP1/ITRMのホストのポート番号
E.ITRM_PORT
対象ホストのポート番号

モジュールID
E.MODULE_ID
event

イベント発行番号
E.EVENT_ID
（該当なし）

タスクID
E.TASK_ID
（該当なし）

3.3.11　イベントID：00006660の詳細

属性種別
項目
属性名
内容

基本属性
イベントID
（該当なし）
00006660

メッセージ
（該当なし）
探索処理中に情報を取得できなかったリソースがあります。

拡張属性
共通情報
重要度
SEVERITY
Warning（警告）

ユーザー名
USER_NAME
空文字

プロダクト名
PRODUCT_NAME
/HITACHI/JP1/ITRM

オブジェクトタイプ
OBJECT_TYPE
DISCOVERY

オブジェクト名
OBJECT_NAME
JP1/ITRMのサービス名

登録名タイプ
ROOT_OBJECT_TYPE
DISCOVERY

登録名
ROOT_OBJECT_NAME
JP1/ITRMのサービス名

事象種別
OCCURRENCE

ERROR

NOTICE

開始時刻
START_TIME
実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数

終了時刻
END_TIME
（該当なし）

終了コード
RESULT_CODE
（該当なし）

固有情報
JP1/ITRMのホスト名
E.ITRM_TARGET_HOST
対象ホスト名

JP1/ITRMのホストのポート番号
E.ITRM_PORT
対象ホストのポート番号

モジュールID
E.MODULE_ID
event

イベント発行番号
E.EVENT_ID
イベントが発行されるたびに付与される一意のID

タスクID
E.TASK_ID
（該当なし）

3.3.12　イベントID：00006661の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006661
メッセージ | （該当なし） | ユーザアカウントがロックされました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Warning（警告）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | SERVICE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのサービス名
登録名タイプ | ROOT_OBJECT_TYPE | SERVICE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのサービス名
事象種別 | OCCURRENCE | NOTICE
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | イベントが発行されるたびに付与される一意のID
タスクID | E.TASK_ID | （該当なし）

3.3.13　イベントID：00006662の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006662
メッセージ | （該当なし） | 管理対象ノードへの認証もしくは接続に失敗しました。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Error（エラー）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | RESOURCE
オブジェクト名 | OBJECT_NAME | JP1/ITRMのノード名
登録名タイプ | ROOT_OBJECT_TYPE | RESOURCE
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのノード名
事象種別 | OCCURRENCE | Error
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | イベントが発行されるたびに付与される一意のID
タスクID | E.TASK_ID | （該当なし）

3.3.14　イベントID：00006663の詳細

属性種別 | 項目 | 属性名 | 内容
基本属性 | イベントID | （該当なし） | 00006663
メッセージ | （該当なし） | 導入予定日時を超過しているリソースがあります。
拡張属性 | 共通情報 | 重要度 | SEVERITY | Error（エラー）
ユーザー名 | USER_NAME | 空文字
プロダクト名 | PRODUCT_NAME | /HITACHI/JP1/ITRM
オブジェクトタイプ | OBJECT_TYPE | DISCOVERY
オブジェクト名 | OBJECT_NAME | JP1/ITRMのサービス名
登録名タイプ | ROOT_OBJECT_TYPE | DISCOVERY
登録名 | ROOT_OBJECT_NAME | JP1/ITRMのサービス名
事象種別 | OCCURRENCE | Error
開始時刻 | START_TIME | 実行開始または再実行開始の時刻。UTC 1970-01-01 00:00:00からの秒数
終了時刻 | END_TIME | （該当なし）
終了コード | RESULT_CODE | （該当なし）
固有情報 | JP1/ITRMのホスト名 | E.ITRM_TARGET_HOST | 対象ホスト名
JP1/ITRMのホストのポート番号 | E.ITRM_PORT | 対象ホストのポート番号
モジュールID | E.MODULE_ID | event
イベント発行番号 | E.EVENT_ID | イベントが発行されるたびに付与される一意のID
タスクID | E.TASK_ID | （該当なし）

4.　API

JP1/ITRMが提供するAPIの前提条件，機能，HTTPリクエスト形式などについて説明します。

＜この章の構成＞

APIの概要

API共通の仕様

APIの記述形式

API一覧

API情報の取得

業務グループの一覧の取得

仮想ホストの一覧の取得

システム情報の取得

ドライブ情報の取得

パフォーマンス情報の取得

仮想ホストの起動

仮想ホストの停止

仮想ホストの強制停止

仮想ホストのリブート

仮想ホストの強制リブート

APIの概要

JP1/ITRMでは，JP1/ITRMが提供している機能をセルフサービスポータルなどのユーザープログラムから利用するために，HTTPプロトコルを利用したAPI（Application Programming Interface）を提供します。

なお，この章での「API」は，「JP1/ITRMが提供するAPI」を指しています。また，APIを使用するセルフサービスポータルなどのユーザープログラムを総称して「APIクライアント」と表記します。

JP1/ITRMとAPIクライアントの関係については，「JP1/ITRMサーバおよびAPIクライアントのネットワーク接続構成の検討」を参照してください。

APIを使用するには

JP1/ITRMが提供するAPIを使用するには，次の準備が必要です。

JP1/ITRMサーバおよびAPIクライアントのネットワーク接続構成の検討

APIの有効化，およびAPI用待ち受けポートの設定

APIクライアントからアクセスするためのJP1/ITRMのIPアドレスの確認

APIを使用するときに用いる専用のJP1/ITRMユーザーの作成

ここでは，それぞれの準備について説明します。

JP1/ITRMサーバおよびAPIクライアントのネットワーク接続構成の検討

「APIクライアント」は，ITリソースを提供する側の管理者が作成するプログラムです。APIクライアントとJP1/ITRM間は，HTTP通信を使用します。また，APIクライアントは，BASIC認証で認証します。そのため，次の図に示すとおり，APIクライアントとJP1/ITRM間の通信が，仮想ホスト利用者の属する管理用LAN以外に流れないような構成を推奨します。

図4-1　APIを使用するときの前提のシステム構成

APIの有効化，およびAPI用待ち受けポートの設定

APIを使用するには，APIを有効にする必要があります。

APIを有効にするには，インストーラーの指示に従って画面上で有効にする方法と，コマンドを使用して有効にする方法があります。

画面上で有効にする方法

新規にJP1/ITRMをインストールする場合に，画面上でAPIを有効にできます。

手順については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のインストールについて説明している章を参照してください。

コマンドで有効にする方法

次の場合に，jirmsetupコマンドまたはjirmsetportnoコマンドを使用してAPIを有効にできます。

JP1/ITRMがインストール済みの場合

JP1/ITRMのバージョンが09-51未満からバージョンアップした場合
バージョンアップ後は，API機能が無効になっています。

JP1/ITRMのバージョンが09-51未満の状態でエクスポートしたデータを，JP1/ITRMのバージョンが09-51以降の環境にインポートした場合
インポート後は，API機能が無効になっています。

jirmsetupコマンドの詳細については，「jirmsetup」（1.　コマンド）を参照してください。

jirmsetportnoコマンドの詳細については，「jirmsetportno」（1.　コマンド）を参照してください。

APIクライアントからアクセスするためのJP1/ITRMのIPアドレスの確認

APIのレスポンスで得られる情報の中に，JP1/ITRMのIPアドレスが含まれます。

このIPアドレスは，APIクライアントからアクセスできるIPアドレスである必要があります。JP1/ITRMのサーバに複数のIPアドレスが設定されている場合，ユーザー設定プロパティファイル（jp1itrm.properties）の指定キー（CO.ITRMServerURL）に設定されているIPアドレスを，APIクライアントからJP1/ITRMに接続するためのIPアドレスに変更してください。

ユーザー設定プロパティファイル（jp1itrm.properties）の詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

APIを使用するときに用いる専用のJP1/ITRMユーザーの作成

APIを使用するには，JP1/ITRMのリソース管理ロールに属するユーザー（ロールID：_jp1resourceに割り当てられているユーザー）をAPIを使用する専用のJP1/ITRMユーザーとしてあらかじめ作成しておく必要があります。

APIを経由した参照や操作の際には，ここで作成したユーザーのIDおよびパスワードを使用します。

ユーザーの追加およびロールの割り当てについては，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のユーザー管理の検討についての説明，およびマニュアル「JP1/IT Resource Management - Manager 運用ガイド」のユーザーとロールの管理についての説明を参照してください。

APIを使用するときの前提条件

APIを使用して参照および操作できるITリソースの種類は，リソース管理画面のリソース一覧エリアに次の状態で表示される仮想ホストです。

［デバイス］：サーバ

［タイプ］：仮想

APIを使用してITリソースを参照および操作するためには，ITリソースを業務グループと関連づける必要があります。そのため，次の作業を必ず実施してください。

業務グループの作成

リソースグループの作成

リソースグループの業務グループへの関連づけ

割り当て種別が共有であるリソースグループに属する仮想ホストの場合，仮想ホストの利用期間の割り当て

業務グループとの関連づけについては，マニュアル「JP1/IT Resource Management - Manager 運用ガイド」のITリソースの構成を把握する，およびITリソースをITリソース利用者に提供することについての説明を参照してください。

APIクライアントで実装すること

JP1/ITRMでは，APIクライアントの利用者（ITリソース利用者）を管理できません。そのため，APIクライアントでは，次の関係を管理する必要があります。

APIを使用するときに用いる専用のJP1/ITRMユーザー

APIクライアントの利用者（ITリソース利用者）

業務グループ

また，APIクライアントでは，APIクライアントの利用者の認証およびAPIクライアントの利用者がどのITリソースを参照・操作できるのかというアクセス権制御をする必要があります。

API共通の仕様

API共通の仕様を次に示します。

通信プロトコル

APIとの通信プロトコルの詳細を次に示します。

通信プロトコル
HTTPを使用します。HTTPのバージョンは，1.0以降です。
HTTPリクエストや，HTTPレスポンスなどのHTTPプロトコルの詳細な仕様については，RFC1945およびRFC2068で規定されている仕様に従ってください。

文字コード
UTF-8を使用します。

ポート番号
デフォルトは，23505です。ポート番号は，新規にJP1/ITRMをインストールまたはセットアップする場合に指定できます。詳細については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のインストールに関する手順またはセットアップ手順を参照してください。また，ポート番号を変更する場合は，jirmsetportnoコマンドを使用してください。jirmsetportnoコマンドの詳細については，「jirmsetportno」（1.　コマンド）を参照してください。

認証方式
BASIC認証にだけ対応しています。

HTTPリクエスト形式

APIに対するHTTPリクエスト形式には，Method，URI，Query String，ヘッダーフィールドを指定します。Method，URI，およびQuery Stringは，各機能のHTTPリクエスト形式を参照してください。ヘッダーフィールドは，次のとおり指定してください。

Authorization:△Basic△BASE64でエンコードしたJP1/ITRMのユーザー名およびパスワード

（凡例）　△：半角スペース

なお，ヘッダーフィールド（Authorization）に指定する形式の詳細な仕様については，RFC2617で規定されている仕様に従ってください。

APIの発行元の認証

APIは，APIの発行元（APIの利用者）を認証します。APIクライアントからHTTPリクエストとして受信した認証情報が，次の2つの条件を満たしているかを検証します。

API実行時にヘッダーフィールド（Authorization）で指定された認証情報を使用して，JP1/ITRMにログインできる。

API実行時にヘッダーフィールド（Authorization）で指定されたJP1/ITRMのユーザーに，ロールID：_jp1resourceが割り当たっている。

参考

APIクライアントごとに，API専用のユーザーを追加し，そのユーザーにロールID：_jp1resourceを割り当てることをお勧めします。ユーザーの追加およびロールの割り当てについては，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のユーザーとロールの管理についての説明を参照してください。

HTTPレスポンス形式

HTTPリクエストに対するレスポンスは，XMLを使用します。

HTTPレスポンスの項目を次の表に示します。

項目
値

Status Code
HTTPステータスコード。
HTTPステータスコードについては，「HTTPステータスコード」を参照してください。

ヘッダーフィールド
Content-Type: application/xml

Content-Length: Bodyのサイズ

Body
なし，またはXML。
XMLについては，各機能の「XMLのスキーマ」を参照してください。

HTTPステータスコード

APIから返却するHTTPステータスコードを次の表に示します。

HTTPステータスコード
説明

200 OK
正常。
HTTPリクエストは成功し，要求に応じた情報が返却される。

202 Accepted
受理。
リクエストは受理されたが，処理は完了していない。

400 Bad Request
指定したリクエストが誤っている。

401 Unauthorized
認証情報が未設定または誤っている。

405 Method Not Allowed
指定したHTTPメソッドが未サポートである。

500 Internal Server Error
サーバ側でリクエストした内容を完了できなかった。

なお，JP1/ITRMのWebサーバでエラーが発生した，通信障害が発生したなど，このHTTPステータスコード以外のステータスコードが返却されることがあります。この場合，HTTPレスポンス形式のBodyの形式が，XML形式になりません。

エラー情報

APIの処理が異常終了した場合に返却するエラー情報について説明します。

なお，エラー情報として返却するメッセージは，APIクライアントの開発者向けのメッセージです。ITリソース利用者向けのメッセージではありません。そのため，APIが返却したメッセージをAPIクライアントの利用者に表示することは想定していません。

APIクライアントの開発者は，HTTPレスポンス形式のHTTPステータスコードを使って，エラーの要因が，リクエスト内容の誤りなのかJP1/ITRMのエラーなのかを切り分けてください。

注意

HTTPレスポンス形式のBodyに含まれるエラーメッセージID，メッセージテキスト，要因および対処は，JP1/ITRMのバージョンアップに伴い変更されることがあります。そのため，APIクライアントを実装するときのプログラミングの条件にしないでください。また，メッセージの文字列を解析しないでください。

XMLのネームスペース

http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/errorを使用します。

XMLのスキーマ

APIからのエラー情報を格納するスキーマを次の表に示します。

エレメント
説明
データ型
出現回数

階層1
階層2
階層3
最小
最大

error
－
－
エラー情報。
－
1
1

@product_version
－
VV-RR-SS（バージョン-リビジョン-限定コード）形式のJP1/ITRMの製品バージョン。
xs:string
1
1

@api_version
－
2桁の半角数字.2桁の半角数字形式のAPIのバージョン。
xs:string
1
1

@datetime
－
エラー発生日時。
ISO8601形式かつUTCで出力する。
xs:dateTime
1
1

@method
－
リクエストされたHTTPメソッド。
xs:string
1
1

@url
－
リクエストされたURL。
xs:string
1
1

message
－
メッセージ。
xs:string
1
1

@message_id
メッセージID。
xs:string
1
1

text_msg
メッセージ（本文）。
4,095文字以内の文字列で表す。
xs:string
1
1

cause_msg
メッセージ（原因）。
4,095文字以内の文字列で表す。
xs:string
0
1

action_msg
メッセージ（対処）。
4,095文字以内の文字列で表す。
xs:string
0
1

（凡例）

－：なし。

出力例

認証情報が指定されていなかった場合の出力例を示します。

HTTP/1.1 401 Unauthorized
Content-Length: 500
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<error product_version="09-51-01" api_version="01.00"
datetime="2011-08-26T05:11:11.250Z" method="POST"
url="http://localhost:23505/jp1itrm/api/instances/1/start?realm=1"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/error">
<message message_id="KNAR96111-E">
<text_msg>認証情報が指定されていません。(指定されたURI=/jp1itrm/api/instances/1/start?realm=1) </text_msg>
<cause_msg>HTTPリクエストに認証情報が指定されていません。</cause_msg>
<action_msg>HTTPリクエストには正しい認証情報を指定してください。</action_msg>
</message>
</error>

APIの記述形式

各APIで説明する項目を次に示します。ただし，APIによっては説明しない項目もあります。

機能

APIの機能について説明しています。

APIのサポートバージョン

APIのサポートバージョンについて説明しています。

HTTPリクエスト形式

APIを使用する際のHTTPリクエスト形式について説明しています。

HTTPステータスコード

APIが返却するHTTPステータスコードについて説明しています。

XMLのネームスペース

APIが正常終了したときに返却するXMLのネームスペースについて説明しています。

XMLのスキーマ

APIが正常終了したときに返却するXMLのスキーマについて説明しています。

使用例

APIを使用するためのHTTPリクエスト例について説明しています。

出力例

APIの使用例に対応した，HTTPレスポンス例について説明しています。

API一覧

提供するAPIの一覧をAPI情報の取得，仮想ホストの構成，および仮想ホストに対する操作に分けて次の表に示します。

API情報の取得に関するAPI

機能 | 説明
API情報の取得 | 提供するAPI情報を取得する。

仮想ホストの構成に関するAPI

機能 | 説明
業務グループの一覧の取得 | JP1/ITRMに登録されている業務グループの一覧を取得する。
仮想ホストの一覧の取得 | 仮想ホストの一覧を取得する。
システム情報の取得 | 仮想ホストのシステム情報を取得する。
ドライブ情報の取得 | 仮想ホストのドライブ情報を取得する。
パフォーマンス情報の取得 | 仮想ホストのパフォーマンス情報を取得する。

仮想ホストの操作に関するAPI

機能 | 説明
仮想ホストの起動 | 仮想ホストを起動する。
仮想ホストの停止 | 仮想ホストを停止する。
仮想ホストの強制停止 | 仮想ホストを強制停止する。
仮想ホストのリブート | 仮想ホストをリブートする。
仮想ホストの強制リブート | 仮想ホストを強制リブートする。

API情報の取得

機能

JP1/ITRMの製品のバージョン，APIのバージョンなどのAPI情報を取得します。

取得する項目を次の表に示します。

項目
説明

JP1/ITRMの製品のバージョン
JP1/ITRMの製品のバージョン。
VV-RR-SS（バージョン-リビジョン-限定コード）形式で取得する。

APIのバージョン
APIのバージョン。
2桁の半角数字.2桁の半角数字形式で取得する。
APIのサポート状況を判断する。

業務グループの一覧へのリンク※
業務グループの一覧を取得するAPIへのリンクアドレス。

注※

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

API情報を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | GET
URI | /jp1itrm/api
Query String | －

（凡例）

－：なし。

HTTPステータスコード

200 OK，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，200 OKの場合，http://www.hitachi.co.jp/soft/xml/jp1/itrm/apiを使用します。

XMLのスキーマ

API情報を格納するスキーマを次の表に示します。

エレメント
説明
データ型
出現回数

階層1
階層2
階層3
最小
最大

api
－
－
オブジェクトの一覧。
－
1
1

@product_version
－
VV-RR-SS（バージョン-リビジョン-限定コード）形式のJP1/ITRMの製品バージョン。
xs:string
1
1

@api_version
－
2桁の半角数字.2桁の半角数字形式のAPIのバージョン。
xs:string
1
1

link
－
オブジェクト。
－
0
0以上の任意の数字

@rel
オブジェクトの種別。
次の値を表す。

realms
業務グループの一覧の取得へのリンク。

xs:string
1
1

@href※
オブジェクトへのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string
1
1

（凡例）

－：なし。

注※

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，API情報を取得する場合の使用例を示します。

GET△/jp1itrm/api△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

API情報を取得した場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 188
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<api product_version="09-51-01" api_version="01.00"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api">
<link rel="realms" href="http://localhost:23505/jp1itrm/api/realms" />
</api>

業務グループの一覧の取得

機能

JP1/ITRMに登録されているすべての業務グループの一覧を取得します。一部の業務グループだけを取得するといった指定はできません。

業務グループが登録されていない場合は，0件となります。

取得する項目を次の表に示します。

項目 | 説明
業務グループID | システムで自動的に割り振られた業務グループID。業務グループを一意に表す。
業務グループ名 | 業務グループのフルパス。
仮想ホストの一覧へのリンク※ | 仮想ホストの一覧を取得するAPIへのリンクアドレス。

注※

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

業務グループの一覧を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | GET
URI※ | /jp1itrm/api/realms
Query String※ | －

（凡例）

－：なし。

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，API情報の取得で返却される「業務グループの一覧へのリンク」を使用してリクエストしてください。

HTTPステータスコード

200 OK，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，200 OKの場合，http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/realmsを使用します。

XMLのスキーマ

業務グループの一覧を格納するスキーマを次の表に示します。

エレメント
説明
type
出現回数

階層1
階層2
階層3
階層4
最小
最大

realms
－
－
－
業務グループの一覧。
－
1
1

realm
－
－
業務グループ。
業務グループがJP1/ITRM上に１つも登録されていない場合，このエレメントの個数は0となる。
－
0
0以上の任意の数字

@id
－
業務グループID。
0以上の整数で表す。
xs:long
1
1

name
－
業務グループ名。
業務グループフォルダ名と業務グループ名を"/"で連結した，2,048文字以内の文字列で表す。
xs:string
1
1

instances
－
仮想ホストの一覧。
－
0
1

@href※
仮想ホストの一覧へのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string
1
1

（凡例）

－：なし。

注※

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，業務グループの一覧を取得する場合の使用例を示します。

GET△/jp1itrm/api/realms△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

業務グループの一覧を取得する場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 361
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<realms xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/realms">
<realm id="1">
<name>第一開発/1課/グループA</name>
<instances href="http://localhost:23505/jp1itrm/api/instances?realm=1" />
</realm>
<realm id="2">
<name>第一開発/1課/グループB</name>
<instances href="http://localhost:23505/jp1itrm/api/instances?realm=2" />
</realm>
:
</realms>

仮想ホストの一覧の取得

機能

次の条件をすべて満たす仮想ホストの一覧を取得します。仮想ホスト以外のITリソースは取得しません。

指定した業務グループに割り当てられている。

個別予約期間が現在の日時を含む，または個別予約開始日時が現在の日時よりも未来である。

条件に一致した仮想ホストがJP1/ITRM上に登録されていない場合は，0件となります。

取得する項目を次の表に示します。

項目
説明

リソースID
システムで自動的に割り振られたリソースID。仮想ホストを一意に表す。

リソース名
仮想ホストのリソース名。
リソース管理画面のリソース一覧エリアに表示される［リソース名］と同じリソース名を出力する。

ホスト名
仮想ホストのホスト名。
［リソース編集］画面の［ホスト名］と同じホスト名を出力する。

電源状態※1
仮想ホストの電源状態。
仮想ホストの状態によって，次の文字列を出力する。

ON
・仮想ホストの電源が入っていて，電源を操作中ではない。
・仮想ホストが仮想化ソフトウェアのCPUまたはメモリを使用している。
・仮想ホストの停止，または強制停止が完了していない。

OFF
・仮想ホストの電源が切れている。
・仮想ホストが起動する途中である。

ERROR
・仮想ホストに障害が発生している。

UNKNOWN
・ON，OFF，ERRORに当てはまらない。
・電源状態が不明である。
・電源状態を取得できなかった。

OS
仮想ホスト上のOSの名称（ゲストOSが認識しているOSの名称）。
リソース管理画面のリソース一覧エリアに表示される［OS］と同じOS名を出力する。

予約ID
システムで自動的に割り振られた予約を示す値。
スケジュール画面の予約一覧エリアに表示される［予約ID］と同じ予約IDを出力する。

予約名
予約名称。
スケジュール画面の予約一覧エリアに表示される［予約名］と同じ予約名を出力する。

業務グループID
システムで自動的に割り振られた業務グループID。予約に対応する業務グループを一意に表す。

業務グループ名
予約に対応する業務グループの名称。
スケジュール画面の予約一覧エリアに表示される［業務グループ］と同じ業務グループ名を出力する。

予約コメント
予約に対応するコメント。
スケジュール画面の予約一覧エリアに表示される［コメント］と同じコメントを出力する。

個別予約期間名
個別予約の期間名。
スケジュール画面の［すべて］タブに表示される［予約名］と同じ予約名を出力する。

個別予約開始日時
個別予約の開始日時。
スケジュール画面の［すべて］タブに表示される［開始日時］と同じ日時を出力する。

個別予約終了日時
個別予約の終了日時。
スケジュール画面の［すべて］タブに表示される［終了日時］と同じ日時を出力する。

システム情報へのリンク※2
システム情報を取得するAPIへのリンクアドレス。

パフォーマンス情報へのリンク※2
パフォーマンス情報を取得するAPIへのリンクアドレス。

ドライブ情報へのリンク※2
ドライブ情報を取得するAPIへのリンクアドレス。

仮想ホスト操作へのリンク※2
起動・停止・リブートするAPIへのリンクアドレス。

注※1

仮想ホストの電源状態は，次の契機で更新されます。

・設定画面の［監視間隔設定］エリアで［状態監視］を指定して仮想ホストを管理する仮想化ソフトウェアから稼働情報を収集したとき。

・設定画面の［管理リソース一覧］エリアで仮想ホストを管理する仮想化ソフトウェアから構成情報を再収集したとき。

・仮想ホストを操作するタスクが完了したとき。

なお，仮想ホストを管理する仮想化ソフトウェアが，監視停止の状態である場合，およびJP1/ITRMから仮想化ソフトウェアに通信できない状態である場合は，電源状態は更新されません。

注※2

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

参考

APIクライアントで個別予約開始日時を利用することで，利用期間が現在なのか未来なのかを確認できます。APIクライアントの利用者に，開始日時を連絡するかどうかの判断材料に利用してください。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

仮想ホストの一覧を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | GET
URI※ | /jp1itrm/api/instances
Query String※ | realm=業務グループID

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，業務グループ情報の一覧の取得で返却される「仮想ホストの一覧へのリンク」を使用してリクエストしてください。

HTTPステータスコード

200 OK，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，200 OKの場合，http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/instancesを使用します。

XMLのスキーマ

仮想ホストの一覧を格納するスキーマを次の表に示します。

エレメント
説明
type
出現回数

階層1
階層2
最小
最大

instances
－
仮想ホストの一覧。
－
1
1

instance
仮想ホストの情報。
条件に一致する仮想ホストがJP1/ITRM上に１つも登録されていない場合，このエレメントの個数は0となる。
この配下の情報については，「システム情報の取得」（4.　API）の「XMLのスキーマ」を参照。
－
0
0以上の任意の数字

（凡例）

－：なし。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，業務グループID「1」の仮想ホストの一覧を取得する場合の使用例を示します。

GET△/jp1itrm/api/instances?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

業務グループID「1」の仮想ホストの一覧を取得する場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 1639
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<instances xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/instances">
<instance href="http://localhost:23505/jp1itrm/api/instances/1" id="1">
<name>VM001</name>
<hostname>HOST_01</hostname>
<state>ON</state>
<os>Microsoft Windows Server 2008 R2 Enterprise</os>
<reservations>
<reservation id="123" name="aaa" realm_id="456" realm_name="第一開発/1課/グループA" comment="ccc"
period_name="yoyaku"
start_time="2011-09-10T23:59:48.812Z" end_time="2011-09-10T23:59:48.812Z" />
<reservation id="777" name="bbb" realm_id="888" realm_name="第一開発/1課/グループB" comment="dd"
period_name="yoyaku2"
start_time="2011-09-10T23:59:48.812Z" end_time="2011-09-10T23:59:48.812Z" />
</reservations>
<performance href="http://localhost:23505/jp1itrm/api/instances/1/performances" />
<storage_volume href="http://localhost:23505/jp1itrm/api/instances/1/storage_volumes" />
<actions>
<link rel="start" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/start?realm=1" />
<link rel="stop" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/stop?realm=1" />
<link rel="powerOff" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/powerOff?realm=1" />
<link rel="reboot" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/reboot?realm=1" />
<link rel="reset" method="post"
href="http://localhost:23505/jp1itrm/api/instances/1/reset?realm=1" />
</actions>
</instance>
<instance href="http://localhost:23505/jp1itrm/api/instances/2" id="2">
<name>VM002</name>
:
</instance>
:
</instances>

システム情報の取得

機能

指定した仮想ホストのシステム情報を取得します。

取得する項目を次の表に示します。

項目
説明

リソースID
システムで自動的に割り振られたリソースID。仮想ホストを一意に表す。

リソース名
仮想ホストのリソース名。
リソース管理画面のリソース一覧エリアに表示される［リソース名］と同じリソース名を出力する。

ホスト名
仮想ホストのホスト名。
［リソース編集］画面の［ホスト名］と同じホスト名を出力する。

電源状態※1
仮想ホストの電源状態。
仮想ホストの状態によって，次の文字列を出力する。

ON
・仮想ホストの電源が入っていて，電源を操作中ではない。
・仮想ホストが仮想化ソフトウェアのCPUまたはメモリを使用している。
・仮想ホストの停止，または強制停止が完了していない。

OFF
・仮想ホストの電源が切れている。
・仮想ホストが起動する途中である。

ERROR
・仮想ホストに障害が発生している。

UNKNOWN
・ON，OFF，ERRORに当てはまらない。
・電源状態が不明である。
・電源状態を取得できなかった。

OS
仮想ホスト上のOSの名称（ゲストOSが認識しているOSの名称）。
リソース管理画面のリソース一覧エリアに表示される［OS］と同じOS名を出力する。

プロセッサ名
ゲストOSが認識している仮想ホストのプロセッサ名。
リソース管理画面の［システム］タブにある［プロセッサ］に表示されるプロセッサ名と同じプロセッサ名を出力する。

CPUコア数
ゲストOSが認識している仮想ホストのCPUコア数。
リソース管理画面の［システム］タブにある［プロセッサ］に表示されるCPUコア数と同じCPUコア数を出力する。

CPUクロック数
ゲストOSが認識している仮想ホストのCPUクロック数（単位：メガヘルツ）。
リソース管理画面の［システム］タブにある［プロセッサ］に表示されるCPUクロック数と同じCPUクロック数を出力する。

メモリ容量
ゲストOSが認識している仮想ホストのメモリ容量（単位：キロバイト）。
リソース管理画面の［システム］タブに表示される［メモリ］と同じメモリ容量を出力する。

割り当てられているCPUコア数※2
仮想化環境管理ソフトウェアまたは仮想化ソフトウェアから収集した仮想ホストのCPUコア数。
［サーバの設定変更］画面にある［CPU］に表示されるCPUコア数と同じCPUコア数を出力する。

割り当てられているCPUクロック数※2
仮想化環境管理ソフトウェアまたは仮想化ソフトウェアから収集した仮想ホストのCPUクロック数（単位：メガヘルツ）。
［サーバの設定変更］画面にある［CPU］に表示されるCPUのクロック数と同じCPUクロック数を出力する。

割り当てられているCPUの占有種別※2
仮想化環境管理ソフトウェアまたは仮想化ソフトウェアから収集した仮想ホストのCPUの占有種別。
［サーバの設定変更］画面にある［CPU占有種別］に表示されるCPUの占有種別に相当する次の文字列を出力する。

SHARED
CPU占有種別が共有である。

OCCUPIED
CPU占有種別が占有である。

割り当てられているメモリ容量※2
仮想化環境管理ソフトウェアまたは仮想化ソフトウェアから収集した仮想ホストのメモリ容量（単位：キロバイト）。
［サーバの設定変更］画面にある［CPU］に表示されるメモリと同じメモリ容量を出力する。

IPアドレス
仮想ホストのIPアドレス。
リソース管理画面の［システム］タブに表示される［IPネットワーク］の［IPアドレス］と同じIPアドレスを出力する。

注※1

仮想ホストの電源状態は，次の契機で更新されます。

・設定画面の［監視間隔設定］エリアで［状態監視］を指定して仮想ホストを管理する仮想化ソフトウェアから稼働情報を収集したとき。

・設定画面の［管理リソース一覧］エリアで仮想ホストを管理する仮想化ソフトウェアから構成情報を再収集したとき。

・仮想ホストを操作するタスクが完了したとき。

なお，仮想ホストを管理する仮想化ソフトウェアが，監視停止の状態となっている場合，およびJP1/ITRMから仮想化ソフトウェアに通信できない状態となっている場合は，電源状態は更新されません。

注※2

デプロイやサーバの設定変更機能でリソース割り当てを変更した場合，変更した結果を確認するには，割り当てられているCPUコア数，割り当てられているCPUクロック数，割り当てられているCPUの占有種別，および割り当てられているメモリ容量を確認してください。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

システム情報を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | GET
URI※ | /jp1itrm/api/instances/リソースID
Query String※ | －

（凡例）

－：なし。

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「システム情報へのリンク」を使用してリクエストしてください。

HTTPステータスコード

200 OK，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，200 OKの場合，http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/instanceを使用します。

XMLのスキーマ

システム情報を格納するスキーマを次の表に示します。

エレメント
説明
type
出現回数

階層1
階層2
階層3
階層4
最小
最大

instance
－
－
－
仮想ホスト。
－
1
1

@href※
－
－
システム情報を取得するAPIへのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string
1
1

@id
－
－
仮想ホストID。
0以上の整数で表す。
xs:long
1
1

name
－
－
リソース名。
128文字以内の文字列で表す。
xs:string
1
1

hostname
－
－
仮想ホストのホスト名。
1,024文字以内の文字列で表す。
xs:string
1
1

state
－
－
仮想ホストの電源状態。
次の種別を表す。

ON
電源ON状態。

OFF
電源OFF状態。

ERROR
エラー状態。

UNKNOWN
状態不明。

xs:string
1
1

os
－
－
仮想ホスト上のOSの名称。
255文字以内の文字列で表す。
xs:string
1
1

cpu
－
－
CPU情報。
仮想ホストの一覧の取得では，このエレメントは出力しない。
－
0
1

@name
－
プロセッサ名。
64文字以内の文字列で表す。
xs:string
1
1

@num_of_cores
－
CPUコア数。
1～4,096の数値で表す。
xs:long
1
1

@unit
－
CPUクロック数の単位を表すMHZという文字列。
xs:string
1
1

@value
－
CPUクロック数。
0以上の数値で表す。
xs:long
1
1

memory
－
－
メモリ情報。
仮想ホストの一覧の取得では，このエレメントは出力しない。
－
0
1

@unit
－
メモリ容量の単位を表すKBという文字列。
xs:string
1
1

@value
－
メモリ容量。
0以上の数値で表す。
xs:long
1
1

allocated_cpu
－
－
割り当てられているCPUの情報。
仮想ホストの一覧の取得では，このエレメントは出力しない。
－
0
1

@num_of_cores
－
割り当てられているCPUコア数。
値が取得できなかった場合，-1となる。
xs:long
1
1

@unit
－
割り当てられているCPUクロック数の単位を表すMHZという文字列。
xs:string
1
1

@value
－
割り当てられているCPUクロック数。
0以上の数値で表す。
xs:long
1
1

@occupationType
－
割り当てられているCPU占有種別。
次の種別を表す。

SHARED
CPU占有種別が共有。

OCCUPIED
CPU占有種別が占有。

UNKNOWN
CPU占有種別が不明。

xs:string
1
1

allocated_memory
－
－
割り当てられているメモリの情報。
仮想ホストの一覧の取得では，このエレメントは出力しない。
－
0
1

@unit
－
割り当てられているメモリ容量の単位を表すKBという文字列。
xs:string
1
1

@value
－
仮想化ソフトウェアから割り当てられているメモリ容量。
値が取得できなかった場合，-1となる。
xs:long
1
1

ethernet_adapter
－
－
ネットワークアダプタ。
IPアドレスが複数割り当てられている場合は，ethernet_adapterがIPアドレスの個数分，返却される。
仮想ホストの一覧の取得では，このエレメントは出力しない。
－
0
0以上の任意の数字

@ip_address
－
仮想ホストのIPアドレス。
IPアドレスが割り振られていない，または取得できないネットワークアダプタの場合，「0.0.0.0」を返却する。
xs:string
1
1

reservations
－
－
予約情報の一覧。
システム情報の取得では，このエレメントおよび配下のエレメントを出力しない。
－
0
1

reservation
－
予約情報。
個別予約期間の個数分，reservationを返却する。
－
0
0以上の任意の数字

@id
予約ID。
同じ予約内に，同じITリソースで複数の個別予約期間がある場合，reservationごとに重複するIDとなる。
xs:long
1
1

@name
予約名。
設定されていない場合，空文字を出力する。
1,020文字以内の文字列で表す。
xs:string
1
1

@realm_id
業務グループID。
xs:long
1
1

@realm_name
業務グループ名。
仮想ホストの一覧の取得の「Query String」で指定された業務グループIDに対応する業務グループ名を，フォルダ名を付けて出力する。
2,048文字以内の文字列で表す。
xs:string
1
1

@comment
コメント。
設定されていない場合，空文字を出力する。
1,024文字以内の文字列で表す。
xs:string
1
1

@period_name
個別予約期間名。
設定されていない場合，空文字を出力する。
1,024文字以内の文字列で表す。
xs:string
1
1

@start_time
個別予約開始日時。
ISO8601形式かつUTCで出力する。
xs:dateTime
1
1

@end_time
個別予約終了日時。
ISO8601形式かつUTCで出力する。
xs:dateTime
1
1

performance
－
－
パフォーマンス情報。
仮想ホストの一覧の取得の場合に，出力する。
－
0
1

@href※
－
パフォーマンス情報へのリンク。
1,024文字以内の文字列で表す。
xs:string
1
1

storage_volume
－
－
ドライブ情報。
仮想ホストの一覧の取得の場合に，出力する。
－
0
1

@href※
－
ドライブ情報へのリンク。
1,024文字以内の文字列で表す。
xs:string
1
1

actions
－
－
仮想ホストの操作。
仮想ホストの一覧の取得の場合に，出力する。
－
0
1

link
－
仮想ホスト操作へのリンク。
－
0
0以上の任意の数字

@rel
仮想ホストの操作種別。
次の種別を表す。

start
仮想ホスト起動。

stop
仮想ホスト停止。

powerOff
仮想ホスト強制停止。

reboot
仮想ホストリブート。

reset
仮想ホスト強制リブート。

xs:string
1
1

@method
操作を実行するときに指定するHTTPメソッドの種別。
次の種別を表す。

post
HTTPのPOSTメソッド。

xs:string
1
1

@href※
仮想ホストの操作へのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string
1
1

（凡例）

－：なし。

注※

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，リソースID「1」のシステム情報を取得する場合の使用例を示します。

GET△/jp1itrm/api/instances/1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

リソースID「1」のシステム情報を取得する場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 509
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<instance href="http://localhost:23505/jp1itrm/api/instances/1" id="1"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/instance">
<name>VM001</name>
<hostname>HOST_01</hostname>
<state>ON</state>
<os>Microsoft Windows Server 2008 R2 Enterprise</os>
<cpu name="Intel(R) Pentium(R)" num_of_cores="2" unit="MHZ" value="2048" />
<memory unit="KB" value="1048576" />
<allocated_cpu num_of_cores="2" unit="MHZ" value="1024" occupationType="SHARED" />
<allocated_memory unit="KB" value="1048576" />
<ethernet_adapter ip_address="192.111.222.120" />
<ethernet_adapter ip_address="192.111.222.130" />
</instance>

ドライブ情報の取得

機能

指定した仮想ホストのドライブ情報を取得します。

取得する項目を次の表に示します。

項目
説明

種別
ドライブ種別。
リソース管理画面の［ドライブ］タブに表示される［種別］と同じドライブ種別を出力する。

名前
ドライブ名。
リソース管理画面の［ドライブ］タブに表示される［名前］と同じドライブ名を出力する。

状態
ドライブの空き容量などの状態。
リソース管理画面の［ドライブ］タブに表示されるアイコンを次の文字列で出力する。

NORMAL
正常。

WARNING
警告。

ERROR
異常。

UNKNOWN
不明。

NOT_MONITORED
監視停止。

NOT_COLLECTED
収集しない。

アイコンの意味については，マニュアル「JP1/IT Resource Management - Manager 設計・構築ガイド」のドライブ情報の表示について説明している個所を参照してください。

使用量
ドライブ使用量（単位：バイト）。
リソース管理画面の［ドライブ］タブに表示される［使用量］と同じドライブ使用量を出力する。

空き容量
ドライブ空き容量（単位：バイト）。
リソース管理画面の［ドライブ］タブに表示される［空き容量］と同じドライブ空き容量を出力する。

総容量
ドライブ総容量（単位：バイト）。
リソース管理画面の［ドライブ］タブに表示される［総容量］と同じドライブ総容量を出力する。

ファイルシステム
ドライブのファイルシステム。
リソース管理画面の［ドライブ］タブに表示される［ファイルシステム］と同じドライブのファイルシステムを出力する。

ドライブタイプ
ドライブのタイプ。
リソース管理画面の［ドライブ］タブに表示される［ドライブタイプ］と同じドライブのタイプを出力する。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

ドライブ情報を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | GET
URI※ | /jp1itrm/api/instances/リソースID/storage_volumes
Query String※ | －

（凡例）

－：なし。

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「ドライブ情報へのリンク」を使用してリクエストしてください。

HTTPステータスコード

200 OK，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，200 OKの場合，http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/storage_volumesを使用します。

XMLのスキーマ

ドライブ情報を格納するスキーマを次の表に示します。

エレメント
説明
type
出現回数

階層1
階層2
階層3
階層4
最小
最大

storage_volumes
－
－
－
ドライブ情報の一覧。
－
1
1

@href※
－
－
ドライブ情報へのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string
1
1

storage_volume
－
－
ドライブ情報。
ドライブがない場合，このエレメントの個数は0となる。
－
0
0以上の任意の数字

drive_category
－
ドライブ種別（FILESYSTEM）。
xs:string
1
1

drive_name
－
ドライブ名。
255文字以内の文字列で表す。
xs:string
1
1

drive_state
－
ドライブの状態。
次の状態を表す。

NORMAL
正常。

WARNING
警告。

ERROR
異常。

UNKNOWN
状態不明。

NOT_MONITORED
監視停止。

NOT_COLLECTED
収集しない。

xs:string
1
1

drive_used
－
ドライブ使用量。
整数で表す。
xs:long
1
1

－
@unit
ドライブ使用量の単位を表すBYTEという文字列。
xs:string
1
1

drive_free
－
ドライブ空き容量。
0以上の数値で表す。
xs:long
1
1

－
@unit
ドライブ空き容量の単位を表すBYTEという文字列。
xs:string
1
1

drive_total
－
ドライブの総容量。
0以上の数値で表す。
xs:long
1
1

－
@unit
ドライブの総容量の単位を表すBYTEという文字列。
xs:string
1
1

file_system
－
ファイルシステム。
16文字以内の文字列で表す。
xs:string
1
1

drive_type
－
ドライブタイプ。
255文字以内の文字列で表す。
xs:string
1
1

（凡例）

－：なし。

注※

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，リソースID「1」の仮想ホストのドライブ情報を取得する場合の使用例を示します。

GET△/jp1itrm/api/instances/1/storage_volumes△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

リソースID「1」の仮想ホストのドライブ情報を取得する場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 568
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<storage_volumes href="http://localhost:23505/jp1itrm/api/instances/1/storage_volumes"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/storage_volumes">
<storage_volume>
<drive_category>FILESYSTEM</drive_category>
<drive_name>C:</drive_name>
<drive_state>NORMAL</drive_state>
<drive_used unit="BYTE">12345678</drive_used>
<drive_free unit="BYTE">87654321</drive_free>
<drive_total unit="BYTE">99999999</drive_total>
<file_system>NTFS</file_system>
<drive_type>Local</drive_type>
</storage_volume>
<storage_volume>
:
</storage_volume>
:
</storage_volumes>

パフォーマンス情報の取得

機能

指定した仮想ホストのパフォーマンス情報を取得します。取得するデータが複数ある場合，最新の1件を取得します。

なお，次の場合，パフォーマンス情報は更新されません。

性能監視が無効となっている。

仮想ホストに対応する監視テンプレートで，該当する測定項目の収集を無効としている。

仮想ホストが監視停止の状態である。

JP1/ITRMから仮想化ソフトウェアに通信できない状態である。

パフォーマンス情報を履歴として確認したい場合は，ITリソース管理者に依頼してください。ITリソース管理者は，レポート機能で履歴を取得してください。

取得する項目を次の表に示します。

項目
説明

測定項目
測定する項目名。
リソース管理画面の［パフォーマンス］タブに表示される［測定項目］のうち，次の項目を出力する。

CPU
ゲストOSが認識しているCPU使用率。

MEMORY
ゲストOSが認識しているメモリ使用率。

測定対象
測定する対象。
リソース管理画面の［パフォーマンス］タブに表示される［測定対象］と同じ項目を出力する。

単位
測定値の単位（単位：パーセント）。
リソース管理画面の［パフォーマンス］タブに表示される［測定対象］に対応した単位を出力する。

測定日時
測定した日時。

測定値
測定した値。
リソース管理画面の［パフォーマンス］タブに表示される［測定対象］の測定した値を出力する。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

パフォーマンス情報を取得するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | GET
URI※ | /jp1itrm/api/instances/リソースID/performances
Query String※ | －

（凡例）

－：なし。

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「パフォーマンス情報へのリンク」を使用してリクエストしてください。

HTTPステータスコード

200 OK，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，200 OKの場合，http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/performancesを使用します。

XMLのスキーマ

パフォーマンス情報を格納するスキーマを次の表に示します。

エレメント
説明
type
出現回数

階層1
階層2
階層3
階層4
最小
最大

performances
－
－
－
パフォーマンス情報の一覧。
－
1
1

@href※
－
－
パフォーマンス情報へのリンクアドレス。
1,024文字以内の文字列で表す。
xs:string
1
1

performance
－
－
パフォーマンス情報。
測定項目および測定対象の組み合わせに対して，1つのエレメントとなる。
－
0
0以上の任意の数字

@metric
－
測定項目。
次の項目を表す。

CPU
CPU使用率。

MEMORY
メモリ使用率。

xs:string
1
1

@instance_name
－
測定対象。
255文字以内の文字列で表す。
xs:string
1
1

@unit
－
測定項目の単位を表す%という文字列。
xs:string
1
1

perf_data
－
パフォーマンスデータ。
データがない場合，このエレメントの個数は0となる。
－
0
0以上の任意の数字

@time
測定日時。
ISO8601形式かつUTCで出力する。
xs:dateTime
1
1

@value
測定対象の測定値。
0以上の数値で表す。
xs:float
1
1

（凡例）

－：なし。

注※

リンクアドレス中のサーバを示す部分には，ユーザー設定プロパティファイル（jp1itrm.properties）のCO.ITRMServerURLキーで設定されたものが使用されます。詳細については，「ユーザー設定プロパティファイル（jp1itrm.properties）」（2.　定義ファイル）を参照してください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，リソースID「1」の仮想ホストのパフォーマンス情報を取得する場合の使用例を示します。

GET△/jp1itrm/api/instances/1/performances△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

リソースID「1」の仮想ホストのパフォーマンス情報を取得する場合の出力例を示します。

HTTP/1.1 200 OK
Content-Length: 459
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<performances href="http://localhost:23505/jp1itrm/api/instances/1/performances"
xmlns="http://www.hitachi.co.jp/soft/xml/jp1/itrm/api/performances">
<performance metric="CPU" instance_name="CPU" unit="%">
<perf_data time="2011-08-26T02:34:46.765Z" value="11.0" />
</performance>
<performance metric="MEMORY" instance_name="メモリ : 4.00 GB" unit="%">
<perf_data time="2011-08-26T02:34:46.765Z" value="40.0" />
</performance>
:
</performances>

仮想ホストの起動

機能

指定した仮想ホストを起動します。このAPIを実行すると，起動のタスクが登録されます。

利用期間ではない仮想ホストは起動できません。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

仮想ホストを起動するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | POST
URI※ | /jp1itrm/api/instances/リソースID/start
Query String※ | realm=業務グループID

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「仮想ホスト操作へのリンク」を使用してリクエストしてください。

HTTPステータスコード

202 Accepted，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，202 Acceptedの場合，XMLデータは返却されません。

タスクの実行結果に関する注意事項

タスクの実行結果は待たないでHTTPステータスコードが出力されます。仮想ホストを起動できたかどうかは，仮想ホストの一覧の取得，またはシステム情報の取得の項目にある電源状態で確認してください。

起動が完了するまでに掛かる時間は，仮想ホストの構成などによります。運用や構成に合わせて調整してください。

電源状態のポーリングは，1分以上間隔を空けてください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，業務グループID「1」に属する，リソースID「1」の仮想ホストを起動する場合の使用例を示します。

POST△/jp1itrm/api/instances/1/start?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

業務グループID「1」に属する，リソースID「1」の仮想ホストを起動する場合の出力例を示します。

HTTP/1.1 202 Accepted
Content-Length: 0
Content-Type: application/xml

仮想ホストの停止

機能

指定した仮想ホストを停止します。このAPIを実行すると，停止のタスクが登録されます。

利用期間ではない仮想ホストは停止できません。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

仮想ホストを停止するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | POST
URI※ | /jp1itrm/api/instances/リソースID/stop
Query String※ | realm=業務グループID

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「仮想ホスト操作へのリンク」を使用してリクエストしてください。

HTTPステータスコード

202 Accepted，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，202 Acceptedの場合，XMLデータは返却されません。

タスクの実行結果に関する注意事項

タスクの実行結果は待たないでHTTPステータスコードが出力されます。仮想ホストを停止できたかどうかは，仮想ホストの一覧の取得，またはシステム情報の取得の項目にある電源状態で確認してください。

停止が完了するまでに掛かる時間は，仮想ホストの構成などによります。運用や構成に合わせて調整してください。

電源状態のポーリングは，1分以上間隔を空けてください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，業務グループID「1」に属する，リソースID「1」の仮想ホストを停止する場合の使用例を示します。

POST△/jp1itrm/api/instances/1/stop?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

業務グループID「1」に属する，リソースID「1」の仮想ホストを停止する場合の出力例を示します。

HTTP/1.1 202 Accepted
Content-Length: 0
Content-Type: application/xml

仮想ホストの強制停止

機能

指定した仮想ホストを強制停止します。このAPIを実行すると，強制停止のタスクが登録されます。

利用期間ではない仮想ホストは強制停止できません。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

仮想ホストを強制停止するAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | POST
URI※ | /jp1itrm/api/instances/リソースID/powerOff
Query String※ | realm=業務グループID

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「仮想ホスト操作へのリンク」を使用してリクエストしてください。

HTTPステータスコード

202 Accepted，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，202 Acceptedの場合，XMLデータは返却されません。

タスクの実行結果に関する注意事項

タスクの実行結果は待たないでHTTPステータスコードが出力されます。仮想ホストを強制停止できたかどうかは，仮想ホストの一覧の取得，またはシステム情報の取得の項目にある電源状態で確認してください。

強制停止が完了するまでに掛かる時間は，仮想ホストの構成などによります。運用や構成に合わせて調整してください。

電源状態のポーリングは，1分以上間隔を空けてください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，業務グループID「1」に属する，リソースID「1」の仮想ホストを強制停止する場合の使用例を示します。

POST△/jp1itrm/api/instances/1/powerOff?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

業務グループID「1」に属する，リソースID「1」の仮想ホストを強制停止する場合の出力例を示します。

HTTP/1.1 202 Accepted
Content-Length: 0
Content-Type: application/xml

仮想ホストのリブート

機能

指定した仮想ホストをリブートします。このAPIを実行すると，リブートのタスクが登録されます。

利用期間ではない仮想ホストはリブートできません。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

仮想ホストをリブートするAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | POST
URI※ | /jp1itrm/api/instances/リソースID/reboot
Query String※ | realm=業務グループID

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「仮想ホスト操作へのリンク」を使用してリクエストしてください。

HTTPステータスコード

202 Accepted，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，202 Acceptedの場合，XMLデータは返却されません。

タスクの実行結果に関する注意事項

タスクの実行結果は待たないでHTTPステータスコードが出力されます。仮想ホストをリブートできたかどうかは，仮想ホストにアクセスして確認してください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，業務グループID「1」に属する，リソースID「1」の仮想ホストをリブートする場合の使用例を示します。

POST△/jp1itrm/api/instances/1/reboot?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

業務グループID「1」に属する，リソースID「1」の仮想ホストをリブートする場合の出力例を示します。

HTTP/1.1 202 Accepted
Content-Length: 0
Content-Type: application/xml

仮想ホストの強制リブート

機能

指定した仮想ホストを強制リブートします。このAPIを実行すると，強制リブートのタスクが登録されます。

利用期間ではない仮想ホストは強制リブートできません。

APIのサポートバージョン

このAPIは，01.00以降で提供します。

HTTPリクエスト形式

仮想ホストを強制リブートするAPIのHTTPリクエスト形式を次の表に示します。

項目 | 値
Method | POST
URI※ | /jp1itrm/api/instances/リソースID/reset
Query String※ | realm=業務グループID

注※

リクエストに使用するURIおよびQuery Stringは，APIクライアントで生成するのではなく，仮想ホストの一覧の取得で返却される「仮想ホスト操作へのリンク」を使用してリクエストしてください。

HTTPステータスコード

202 Accepted，またはエラーを示すステータスコードが出力されます。

詳細については，「API共通の仕様」の「HTTPステータスコード」を参照してください。

XMLのネームスペース

HTTPステータスコードが，202 Acceptedの場合，XMLデータは返却されません。

タスクの実行結果に関する注意事項

タスクの実行結果は待たないでHTTPステータスコードが出力されます。仮想ホストを強制リブートできたかどうかは，仮想ホストにアクセスして確認してください。

使用例

認証情報にユーザー名「portal01」，パスワード「password」を指定して，業務グループID「1」に属する，リソースID「1」の仮想ホストを強制リブートする場合の使用例を示します。

POST△/jp1itrm/api/instances/1/reset?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==

（凡例）　△：半角スペース

出力例

業務グループID「1」に属する，リソースID「1」の仮想ホストを強制リブートする場合の出力例を示します。

HTTP/1.1 202 Accepted
Content-Length: 0
Content-Type: application/xml

索引

[Ａ][Ｊ]
[ア行][カ行][サ行][タ行][ハ行][ヤ行]

(英字)

(Ａ)

API

API一覧

API共通の仕様

API情報の取得

APIの概要

APIの記述形式

(Ｊ)

jirmbackup

jirmcontrolservice

jirmdbreorg

jirmexport

jirmgetlogs

jirmimageimport

jirmimport

jirminfocollect

jirminfolist

jirmnodeoperation

jirmreport

jirmrestore

jirmsetportno

jirmsetup

jirmstatuschange

jirmunsetup

jirmusermgr

jirmvmconfig

jirmvmdel

jirmvmdeploy

jirmvmmigrate

JP1/ITRMが出力するJP1イベント一覧

jp1itrm.properties

JP1イベント

JP1イベントの詳細

JP1イベントの属性

(ア行)

(い)

イベントID：00006600の詳細

イベントID：00006601の詳細

イベントID：00006610の詳細

イベントID：00006620の詳細

イベントID：00006630の詳細

イベントID：00006640の詳細

イベントID：00006641の詳細

イベントID：00006650の詳細

イベントID：00006651の詳細

イベントID：00006652の詳細

イベントID：00006660の詳細

イベントID：00006661の詳細

イベントID：00006662の詳細

イベントID：00006663の詳細

(カ行)

(か)

拡張属性

仮想ホストの一覧の取得

仮想ホストの起動

仮想ホストの強制停止

仮想ホストの強制リブート

仮想ホストの停止

仮想ホストのリブート

(き)

基本属性

業務グループの一覧の取得

(こ)

コマンド

コマンド一覧

コマンド共通の注意事項

コマンドの記述形式

コマンドの排他関係

(サ行)

(し)

システム情報の取得

(タ行)

(て)

定義ファイル

定義ファイル一覧

定義ファイルの記述形式

(と)

ドライブ情報の取得

(ハ行)

(は)

パスの指定方法

パフォーマンス情報の取得

(ヤ行)

(ゆ)

ユーザー設定プロパティファイル（jp1itrm.properties）

ユーザー登録ファイルの形式

■ 商標類

AIXは，米国およびその他の国におけるInternational Business Machines Corporationの商標です。
BSAFEは，EMC Corporationの米国およびその他の国における登録商標または商標です。
HP-UXは，Hewlett-Packard Development Company, L.P.のオペレーティングシステムの名称です。
MicrosoftおよびHyper-Vは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
Pentiumは，アメリカ合衆国およびその他の国におけるIntel Corporationの商標です。
RSAは，EMC Corporationの米国およびその他の国における登録商標または商標です。
UNIXは，The Open Groupの米国ならびに他の国における登録商標です。
VMwareおよびESXは，VMware, Inc.の米国および各国での登録商標または商標です。
Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
その他記載の会社名、製品名は、それぞれの会社の商標もしくは登録商標です。
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.
This product includes software developed by IAIK of Graz University of Technology.
Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.
This product includes software developed by the University of California, Berkeley and its contributors.
This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).
Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/
This product includes cryptographic software written by Eric Young(eay@cryptsoft.com)
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)
This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

本製品は，EMC CorporationのRSA(R) BSAFETMソフトウェアを搭載しています。