7.5.2 Server Service制御コマンドを使用した起動管理
Server Service制御コマンド(eurpmctrlコマンド)のファイル名と格納先を次に示します。
-
Windows環境の場合
EUR Serverのインストール先ディレクトリ\Server\Program下にあります。
-
UNIX/Linux環境の場合
/opt/eur/server/binディレクトリにあります。
Server Service制御コマンドは,管理者権限を持つユーザが実行してください。例えば,コマンドプロンプトからServer Service制御コマンドを実行するときには,コマンドプロンプトは管理者権限を持つユーザが起動してください。
(1) Server Service制御コマンドのオプション
Server Service制御コマンド(eurpmctrlコマンド)が提供するオプションの一覧を次の表に示します。なお,オプション名のセパレータは「/」で示しています。UNIX/Linux環境の場合は,「/」を「-」に置き換えてお読みください。
オプション |
指定値 |
内容 |
---|---|---|
/id |
識別名※ |
操作対象となるEUR Server Serviceの識別名を指定します。 |
/ini |
環境設定ファイルパス |
操作対象となるEUR Server Serviceが使用する環境設定ファイルのパスを指定します。 環境設定ファイルパスには,EUR Server Serviceの環境設定ファイルの格納先のディレクトリパス,またはファイルパスを指定できます。ディレクトリパスを指定する場合はEUR Server Serviceの環境設定ファイルのデフォルトのファイル名(EURPM.ini)が仮定されます。ファイルパスを指定する場合は任意のファイル名を指定できます。 |
/kind |
ALL |
起動管理定義に登録されているすべてのEUR Server Serviceを操作対象とします。 |
AUTOONLY |
起動管理定義に登録されているEUR Server Serviceのうち,自動起動の設定がされているEUR Server Serviceを操作対象とします。 |
|
/m |
add |
EUR Server Serviceの起動管理定義を登録します。 |
disp |
EUR Server Serviceの起動管理定義の登録内容を出力します。 |
|
chg |
EUR Server Serviceの起動管理定義を変更します。 |
|
del |
EUR Server Serviceの起動管理定義を削除します。 |
|
start |
EUR Server Serviceを起動します。 |
|
stop |
EUR Server Serviceを停止します。 |
|
stat |
EUR Server Serviceの稼働状態を確認します。 |
|
auto |
EUR Server Serviceの自動起動の設定をします。 |
|
/message | /nomessage |
− |
標準エラー出力にメッセージを出力するかどうかを指定します。 |
/mode |
AUTO |
自動で起動します。 |
MANUAL |
手動で起動します。 |
- 注※
-
1〜16バイトで指定します。半角英数字および「_」(アンダースコア)が使用できます。値の先頭と末尾に半角空白を指定した場合は削除されます。また,半角空白だけを指定した場合は,値を指定していないと見なされます。
- ■注意
-
-
オプション,オプションの指定値,およびオプションに指定する文字列は,大文字と小文字を区別します。ただし,識別名については大文字と小文字を区別しません。例えば,/mオプションを「/M」と指定したり,/mオプションの指定値を「/m STOP」と指定したりすると,エラーになります。
-
一つのコマンド構文に,同じオプションが複数指定されている場合は,コマンド構文の後方に指定されたオプションが有効となります。
-
無効なオプションが指定されている場合は,そのオプションを無視して処理を実行します。
-
ファイルパスを指定するときの規則,および注意については,マニュアル「EUR 帳票出力 リファレンス EUR Server編」を参照してください。また,パスに日本語を使用する場合の注意については,「付録B.2 EUR Server Service,およびEUR Server - Spool Serviceを使用する場合の注意」を参照してください。
-
(2) 形式と指定例
EUR Server Serviceの起動管理をするときのコマンドの形式と指定例について説明します。
(a) 起動管理定義を登録する
起動管理定義を登録するときのコマンドの形式と指定例を次に示します。
eurpmctrl /m add /id 識別名 〔/message | /nomessage〕 〔/mode {AUTO | MANUAL}〕 〔/ini 環境設定ファイルパス〕
- /m add
-
EUR Server Serviceの制御種別を指定します。
-
add:EUR Server Serviceの起動管理定義を登録します。
ただし,起動管理定義の登録数が上限を超えた場合は,登録できません。最大5件の起動管理定義を登録できます。
-
- /id 識別名
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/mode {AUTO | MANUAL}〕
-
EUR Server Serviceを自動で起動するかどうかを指定します。
-
AUTO:自動で起動します。
-
MANUAL:手動で起動します。
指定を省略した場合は,/mode MANUALが仮定されます。
-
- 〔/ini 環境設定ファイルパス〕
-
EUR Server Serviceが使用する環境設定ファイルのパスを指定します。指定を省略した場合は,デフォルトのパス(Windows環境の場合:EUR Serverのインストール先ディレクトリ\Server,UNIX/Linux環境の場合:/var/opt/eur/server)が仮定されます。
環境設定ファイルパスには,EUR Server Serviceの環境設定ファイルの格納先のディレクトリパス,またはファイルパスを指定できます。ディレクトリパスを指定する場合はEUR Server Serviceの環境設定ファイルのデフォルトのファイル名(EURPM.ini)が仮定されます。ファイルパスを指定する場合は任意のファイル名を指定できます。
- ■指定例
-
識別名が「EURSV_TEST」のEUR Server Serviceの起動管理定義を登録します。
eurpmctrl /m add /id EURSV_TEST /message /ini C:\Program Files\EURSV_TEST
(b) 起動管理定義の登録内容を確認する
起動管理定義の登録内容を確認するときのコマンドの形式と指定例を次に示します。
eurpmctrl /m disp 〔/message | /nomessage〕 〔/kind ALL | /id 識別名〕
- /m disp
-
EUR Server Serviceの制御種別を指定します。
-
disp:EUR Server Serviceの起動管理定義の登録内容を確認します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/kind ALL〕
-
操作対象のEUR Server Serviceを指定します。このオプションは/idオプションと同時に指定できません。
-
ALL:起動管理定義に登録されているすべてのEUR Server Serviceを操作対象とします。
-
- 〔/id 識別名〕
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。このオプションは/kindオプションと同時に指定できません。
- ■指定例
-
起動管理定義に登録されているEUR Server Serviceの登録内容を確認します。
eurpmctrl /m disp /message
- ■出力例
-
EUR Server Serviceの起動管理定義の登録内容は,標準出力(stdout)に出力されます。出力例を次に示します。
+-----------+-----------+-------------------------------------- |<EURPMID> |<AutoFlag> |<DefinitionFile> +-----------+-----------+-------------------------------------- |EURSV |AUTO |/var/opt/eur/server/ …デフォルト |EURSV_MAIN |AUTO |/var/opt/eur/server/EURSV_MAIN/ |EURSV_SUB |MANUAL |/var/opt/eur/server/EURSV_SUB/ | . | . | . | . | . | . | . | . | . |EURSV_TEST |MANUAL |/var/opt/eur/server/EURSV_TEST/ +-----------+-----------+--------------------------------------
- <EURPMID>
-
EUR Server Serviceの識別名を示します。
- <AutoFlag>
-
EUR Server Serviceを自動で起動するかどうかを示します。
AUTO:自動で起動します。
MANUAL:手動で起動します。
- <DefinitionFile>
-
EUR Server Serviceの環境設定ファイルパスを示します。
(c) 起動管理定義を変更する
起動管理定義を変更するときのコマンドの形式と指定例を次に示します。
eurpmctrl /m chg /id 識別名 〔/message | /nomessage〕 〔/mode {AUTO | MANUAL}〕 〔/ini 環境設定ファイルパス〕
- /m chg
-
EUR Server Serviceの制御種別を指定します。
-
chg:EUR Server Serviceの起動管理定義を変更します。
-
- /id 識別名
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/mode {AUTO | MANUAL}〕
-
EUR Server Serviceを自動で起動するかどうかを指定します。
-
AUTO:自動で起動します。
-
MANUAL:手動で起動します。
指定を省略した場合は,自動起動の定義は変更されません。
-
- 〔/ini 環境設定ファイルパス〕
-
EUR Server Serviceが使用する環境設定ファイルのパスを指定します。指定を省略した場合は,環境設定ファイルのパスの定義は変更されません。
環境設定ファイルパスには,EUR Server Serviceの環境設定ファイルの格納先のディレクトリパス,またはファイルパスを指定できます。ディレクトリパスを指定する場合はEUR Server Serviceの環境設定ファイルのデフォルトのファイル名(EURPM.ini)が仮定されます。ファイルパスを指定する場合は任意のファイル名を指定できます。
- ■指定例
-
識別名が「EURSV_SUB」のEUR Server Serviceが自動で起動するように,起動管理定義を変更します。
eurpmctrl /m chg /id EURSV_SUB /message /mode AUTO
(d) 起動管理定義を削除する
起動管理定義を削除するときのコマンドの形式と指定例を次に示します。
eurpmctrl /m del 〔/message | /nomessage〕 〔/kind ALL | /id 識別名〕
- /m del
-
EUR Server Serviceの制御種別を指定します。
-
del:EUR Server Serviceの起動管理定義を削除します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/kind ALL〕
-
操作対象のEUR Server Serviceを指定します。このオプションは/idオプションと同時に指定できません。
-
ALL:起動管理定義に登録されているすべてのEUR Server Serviceを操作対象とします。
-
- 〔/id 識別名〕
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。このオプションは/kindオプションと同時に指定できません。
- ■指定例
-
識別名が「EURSV_TEMP」の起動管理定義を削除します。
eurpmctrl /m del /message /id EURSV_TEMP
(e) EUR Server Serviceを起動する
eurpmctrl /m start 〔/message | /nomessage〕 〔/kind {ALL | AUTOONLY}| /id 識別名〕
- /m start
-
EUR Server Serviceの制御種別を指定します。
-
start:EUR Server Serviceを起動します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/kind {ALL | AUTOONLY}〕
-
操作対象のEUR Server Serviceを指定します。このオプションは/idオプションと同時に指定できません。
-
ALL:起動管理定義に登録されているすべてのEUR Server Serviceを操作対象とします。
-
AUTOONLY:起動管理定義に登録されているEUR Server Serviceのうち,自動起動の設定がされたEUR Server Serviceを操作対象とします。
-
- 〔/id 識別名〕
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。このオプションは/kindオプションと同時に指定できません。
- ■指定例
-
起動管理定義に登録されているEUR Server Serviceのうち,自動起動が設定されたEUR Server Serviceを起動します。
eurpmctrl /m start /message /kind AUTOONLY
(f) EUR Server Serviceを停止する
eurpmctrl /m stop 〔/message | /nomessage〕 〔/kind {ALL | AUTOONLY}| /id 識別名〕
- /m stop
-
EUR Server Serviceの制御種別を指定します。
-
stop:EUR Server Serviceを停止します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/kind {ALL | AUTOONLY}〕
-
操作対象のEUR Server Serviceを指定します。このオプションは/idオプションと同時に指定できません。
-
ALL:起動管理定義に登録されているすべてのEUR Server Serviceを操作対象とします。
-
AUTOONLY:起動管理定義に登録されているEUR Server Serviceのうち,自動起動が設定されたEUR Server Serviceを操作対象とします。
-
- 〔/id 識別名〕
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。このオプションは/kindオプションと同時に指定できません。
- ■指定例
-
識別名が「EURSV_MAIN」のEUR Server Serviceを停止します。
eurpmctrl /m stop /message /id EURSV_MAIN
(g) EUR Server Serviceの稼働状態を確認する
eurpmctrl /m stat 〔/message | /nomessage〕 〔/kind {ALL | AUTOONLY}| /id 識別名〕
- /m stat
-
EUR Server Serviceの制御種別を指定します。
-
stat:EUR Server Serviceの稼働状態を確認します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/kind {ALL | AUTOONLY}〕
-
操作対象のEUR Server Serviceを指定します。このオプションは/idオプションと同時に指定できません。
-
ALL:起動管理定義に登録されているすべてのEUR Server Serviceを操作対象とします。
-
AUTOONLY:起動管理定義に登録されているEUR Server Serviceのうち,自動起動が設定されたEUR Server Serviceを操作対象とします。
-
- 〔/id 識別名〕
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。このオプションは/kindオプションと同時に指定できません。
- ■指定例
-
起動管理定義に登録されているEUR Server Serviceの稼働状態を確認します。
eurpmctrl /m stat /message
- ■出力例
-
EUR Server Serviceの稼働状態は,標準出力(stdout)に出力されます。出力例を次に示します。
+--------------+--------------+-----------+ |<EURPMID> |<Status> |<PID> | +--------------+--------------+-----------+ |EURSV |Running |4236 | …デフォルトエントリ |EURSV_MAIN |Starting | | |EURSV_SUB |Stopping |4242 | | . | . | . | | . | . | . | | . | . | . | |EURSV_TEST |Stopped | | +--------------+--------------+-----------+
- <EURPMID>
-
EUR Server Serviceの識別名を示します。
- <Status>
-
EUR Server Serviceの稼働状態を示します。
Running:稼働
Starting:起動処理中
Stopping:停止処理中
Stopped:停止
ErrorStopped:異常停止
Unknown:不明
- <PID>
-
プロセスIDを示します。
プロセスIDは,StatusがRunning(稼働)またはStopping(停止処理中)の場合に表示されます。
(h) EUR Server Serviceの自動起動の設定をする
eurpmctrl /m auto /mode {AUTO | MANUAL} 〔/message | /nomessage〕 〔/kind ALL | /id 識別名〕
- /m auto
-
EUR Server Serviceの制御種別を指定します。
-
auto:EUR Server Serviceの自動起動の設定をします。
-
- /mode {AUTO | MANUAL}
-
EUR Server Serviceを自動で起動するかどうかを指定します。
-
AUTO:自動で起動します。
-
MANUAL:手動で起動します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/kind ALL〕
-
操作対象のEUR Server Serviceを指定します。このオプションは/idオプションと同時に指定できません。
-
ALL:起動管理定義に登録されているすべてのEUR Server Serviceを操作対象とします。
-
- 〔/id 識別名〕
-
操作対象のEUR Server Serviceの識別名を1〜16バイトの範囲で指定します。半角英数字および「_」(アンダースコア)を使用できます。このオプションは/kindオプションと同時に指定できません。
- ■指定例
-
識別名が「EURSV_TEST」のEUR Server Serviceが自動で起動するように設定します。
eurpmctrl /m auto /mode AUTO /message /id EURSV_TEST
EUR Server Serviceの自動起動の設定方法については,「7.5.3 EUR Server Serviceの自動起動の設定」を参照してください。
(3) Server Service制御コマンドのエラー情報
Server Service制御コマンド(eurpmctrlコマンド)では,エラーを検知すると,メッセージオプション(/message)によって次に示す標準エラーを出力します。
エラー種別 |
発生条件 |
メッセージID |
---|---|---|
コマンドシンタックスエラー |
不明なオプションを指定したとき |
KEEY001-E |
オプションに値の指定がないとき |
KEEY002-E |
|
オプションの指定値が不正なとき |
KEEY003-E |
|
必須オプションの指定がないとき |
KEEY004-E |
|
同時に指定できないオプションを指定したとき |
KEEY005-E |
|
指定した識別名の起動管理定義が存在しないとき |
KEEY006-E |
|
追加しようとした識別名の起動管理定義が存在するとき |
KEEY008-E |
|
コマンドシンタックスワーニング |
起動管理定義が一つも存在しないとき |
KEEY007-W |
自動起動の対象が一つも存在しないとき |
KEEY009-W |
|
環境設定ファイルパスの追加または変更で指定したディレクトリパスまたはファイルパスが,ほかのエントリの環境設定ファイルパスと重複したとき |
KEEY010-W |
|
コマンド実行時エラー |
すでに起動している識別名のEUR Server Serviceを起動しようとしたとき |
KEEY020-E |
起動処理中または停止処理中の識別名のEUR Server Serviceを起動しようとしたとき |
KEEY021-E |
|
すでに停止している識別名のEUR Server Serviceを停止しようとしたとき |
KEEY022-E |
|
起動処理中または停止処理中の識別名のEUR Server Serviceを停止しようとしたとき |
KEEY023-E |
|
プロセス管理ファイルの読み込みでエラーが発生したとき |
KEEY024-E |
|
EUR Server Serviceの起動時にエラーが発生したとき |
KEEY025-E |
|
EUR Server Serviceの停止時にエラーが発生したとき |
KEEY026-E |
|
指定した識別名の起動管理定義の書き込みでエラーが発生したとき |
KEEY027-E |
|
指定した識別名の起動管理定義の読み込みでエラーが発生したとき |
KEEY028-E |
|
メモリが不足したとき |
KEEY030-E |
|
環境設定ファイル読み込み中にエラーが発生したとき |
KEEY031-S |
|
ログファイル処理時にエラーが発生したとき |
KEEY032-S |
|
起動している識別名のEUR Server Serviceの起動管理定義を,変更または削除しようとしたとき |
KEEY038-E |
|
登録できる件数を超えて起動管理定義を追加しようとしたとき |
KEEY039-E |
|
Windows環境でEUR Server Serviceの呼び出しでエラーが発生したとき |
KEEY040-E |
|
サービスのオープンまたは情報取得でエラーが発生したとき |
KEEY041-E |
|
コマンド実行ワーニング |
ログファイルのオープンエラーが発生したとき |
KEEY035-W |
コマンド実行タイムアウト |
コマンド実行時にタイムアウトが発生したとき |
KEEY050-E |
(a) Server Service制御コマンドの終了コード
Server Service制御コマンド(eurpmctrlコマンド)を実行すると,終了コードが返されます。終了コード一覧を次に示します。
終了コード |
意味 |
---|---|
0 |
Server Service制御コマンドが正常に終了しました。 |
4 |
Server Service制御コマンドの実行中,警告が発生しました。 |
8 |
Server Service制御コマンドの実行中,エラーが発生しました。 |
Server Service制御コマンドを呼び出しているプログラムでは,Server Service制御コマンドの終了コードを参照して,エラーチェックしてください。
(b) エラーメッセージのフォーマット
Server Service制御コマンド(eurpmctrlコマンド)を実行したとき,標準エラーに出力されるメッセージのフォーマットを次に示します。
eurpmctrl:△KEEY0XX-E△エラーメッセージ▼
- (凡例)
-
△:半角空白を示します。
▼:改行(0x0d+0x0a)を示します。