7.6.1 Spool Service制御コマンドを使用した起動管理
Spool Service制御コマンド(eurpmlsctrlコマンド)のファイル名と格納先を次に示します。
なお,Spool Service制御コマンドは,管理者権限を持つユーザが実行してください。
(1) Spool Service制御コマンドのオプション
Spool Service制御コマンド(eurpmlsctrlコマンド)が提供するオプションの一覧を次の表に示します。
オプション |
指定値 |
内容 |
---|---|---|
-m |
start |
EUR Server - Spool Serviceを起動します。 |
stop |
EUR Server - Spool Serviceを停止します。 |
|
stat |
EUR Server - Spool Serviceの稼働状態を確認します。 |
|
chg |
EUR Server - Spool Serviceの起動管理定義を変更します。 |
|
disp |
EUR Server - Spool Serviceの起動管理定義の登録内容を出力します。 |
|
-message | -nomessage |
− |
標準エラー出力にメッセージを出力するかどうかを指定します。 |
-ini |
環境設定ファイルパス |
操作対象となるEUR Server - Spool Serviceが使用する環境設定ファイルのパスを指定します。 環境設定ファイルパスには,EUR Server - Spool Serviceの環境設定ファイルの格納先のディレクトリパス,またはファイルパスを指定できます。ディレクトリパスを指定する場合はEUR Server - Spool Serviceの環境設定ファイルのデフォルトのファイル名(EURPMLS.ini)が仮定されます。ファイルパスを指定する場合は任意のファイル名を指定できます。 |
- ■注意
-
-
オプションおよびオプションの指定値は,大文字と小文字を区別します。例えば,-mオプションを「-M」と指定したり,-mオプションの指定値を「-m STOP」と指定したりすると,エラーになります。
-
一つのコマンド構文に,同じオプションが複数指定されている場合は,コマンド構文の後方に指定されたオプションが有効となります。
-
無効なオプションが指定されている場合は,そのオプションを無視して処理を実行します。
-
ファイルパスを指定するときの規則,および注意については,マニュアル「EUR 帳票出力 リファレンス EUR Server編」を参照してください。また,パスに日本語を使用する場合の注意については,「付録B.2 EUR Server Service,およびEUR Server - Spool Serviceを使用する場合の注意」を参照してください。
-
(2) 形式と指定例
EUR Server - Spool Serviceの起動管理をするときのコマンドの形式と指定例について説明します。
(a) 起動管理定義の登録内容を確認する
起動管理定義の登録内容を確認するときのコマンドの形式と指定例を次に示します。
eurpmlsctrl /m disp 〔/message | /nomessage〕
- /m disp
-
EUR Server - Spool Serviceの制御種別を指定します。
-
disp:EUR Server - Spool Serviceの起動管理定義の登録内容を確認します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- ■指定例
-
起動管理定義に登録されているEUR Server - Spool Serviceの登録内容を確認します。
eurpmlsctrl /m disp /message
- ■出力例
-
EUR Server - Spool Serviceの起動管理定義の登録内容は,標準出力(stdout)に出力されます。出力例を次に示します。
+-------------+-----------+----------------------------------- |<EURPMRSID> |<AutoFlag> |<DefinitionFile> +-------------+-----------+----------------------------------- |EURPMRS |MANUAL |/var/opt/eur/spool/ …デフォルト +-------------+-----------+-----------------------------------
- <EURPMRSID>
-
EUR Server - Spool Serviceの識別名(EURPMRS)を示します。
- <AutoFlag>
-
EUR Server - Spool Serviceを手動(MANUAL)で起動することを示します。
- <DefinitionFile>
-
EUR Server - Spool Serviceの環境設定ファイルパスを示します。
(b) 起動管理定義を変更する
起動管理定義を変更するときのコマンドの形式と指定例を次に示します。
eurpmlsctrl /m chg 〔/message | /nomessage〕 〔/ini 環境設定ファイルパス〕
- /m chg
-
EUR Server - Spool Serviceの制御種別を指定します。
-
chg:EUR Server - Spool Serviceの起動管理定義を変更します。
-
- 〔/message | /nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
/message:メッセージを出力します。
-
/nomessage:メッセージを出力しません。
指定を省略した場合は,/messageが仮定されます。/nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- 〔/ini 環境設定ファイルパス〕
-
EUR Server - Spool Serviceが使用する環境設定ファイルのパスを指定します。指定を省略した場合は,環境設定ファイルのパスの定義は変更されません。
環境設定ファイルパスには,EUR Server - Spool Serviceの環境設定ファイルの格納先のディレクトリパス,またはファイルパスを指定できます。ディレクトリパスを指定する場合はEUR Server - Spool Serviceの環境設定ファイルのデフォルトのファイル名(EURPMLS.ini)が仮定されます。ファイルパスを指定する場合は任意のファイル名を指定できます。
- ■指定例
-
EUR Server - Spool Serviceの環境設定ファイルパスを変更します。
eurpmctrl /m chg /message /ini "/var/opt/eur/spool/EURPMRS_MAIN/"
(c) EUR Server - Spool Serviceを起動する
eurpmlsctrl -m start 〔-message | -nomessage〕
- -m start
-
EUR Server - Spool Serviceの制御種別を指定します。
-
start:EUR Server - Spool Serviceを起動します。
-
- 〔-message | -nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
-message:メッセージを出力します。
-
-nomessage:メッセージを出力しません。
指定を省略した場合は,-messageが仮定されます。-nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- ■指定例
-
EUR Server - Spool Serviceを起動します。
eurpmlsctrl -m start -message
(d) EUR Server - Spool Serviceを停止する
eurpmlsctrl -m stop 〔-message | -nomessage〕
- -m stop
-
EUR Server - Spool Serviceの制御種別を指定します。
-
stop:EUR Server - Spool Serviceを停止します。
-
- 〔-message | -nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
-message:メッセージを出力します。
-
-nomessage:メッセージを出力しません。
指定を省略した場合は,-messageが仮定されます。-nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- ■指定例
-
EUR Server - Spool Serviceを停止します。
eurpmlsctrl -m stop -message
(e) EUR Server - Spool Serviceの稼働状態を確認する
eurpmlsctrl -m stat 〔-message | -nomessage〕
- -m stat
-
EUR Server - Spool Serviceの制御種別を指定します。
-
stat:EUR Server - Spool Serviceの稼働状態を確認します。
-
- 〔-message | -nomessage〕
-
標準エラー出力にメッセージを出力するかどうかを指定します。
-
-message:メッセージを出力します。
-
-nomessage:メッセージを出力しません。
指定を省略した場合は,-messageが仮定されます。-nomessageを指定した場合も,コマンドの終了コードは出力されます。
-
- ■指定例
-
EUR Server - Spool Serviceの稼働状態を確認します。
eurpmlsctrl -m stat -message
- ■出力例
-
EUR Server - Spool Serviceの稼働状態は,標準出力(stdout)に出力されます。出力例を次に示します。
+--------------+--------------+--------------+ |<EURPMRSID> |<Status> |<PID> | +--------------+--------------+--------------+ |EURPMRS |Running |4237 | +--------------+--------------+--------------+
- <EURPMRSID>
-
固定値「EURPMRS」を示します。
- <Status>
-
EUR Server - Spool Serviceの稼働状態を示します。
Running:稼働
Starting:起動処理中
Stopping:停止処理中
Stopped:停止
ErrorStopped:異常停止
Unknown:不明
- <PID>
-
プロセスIDを示します。
プロセスIDは,StatusがRunning(稼働)またはStopping(停止処理中)の場合に表示されます。
(3) Spool Service制御コマンドのエラー情報
Spool Service制御コマンド(eurpmlsctrlコマンド)では,エラーを検知すると,メッセージオプション(-message)によって次に示す標準エラーを出力します。
エラー種別 |
発生条件 |
メッセージID |
---|---|---|
コマンドシンタックスエラー |
不明なオプションを指定したとき |
KEEY001-E |
オプションに値の指定がないとき |
KEEY002-E |
|
オプションの指定値が不正なとき |
KEEY003-E |
|
必須オプションの指定がないとき |
KEEY004-E |
|
コマンド実行時エラー |
すでに起動しているEUR Server - Spool Serviceを起動しようとしたとき |
KEEY020-E |
起動処理中または停止処理中のEUR Server - Spool Serviceを起動しようとしたとき |
KEEY021-E |
|
すでに停止しているEUR Server - Spool Serviceを停止しようとしたとき |
KEEY022-E |
|
起動処理中または停止処理中のEUR Server - Spool Serviceを停止しようとしたとき |
KEEY023-E |
|
プロセス管理ファイルの読み込みでエラーが発生したとき |
KEEY024-E |
|
起動管理定義の書き込みでエラーが発生したとき |
KEEY027-E |
|
起動管理定義の読み込みでエラーが発生したとき |
KEEY028-E |
|
メモリが不足したとき |
KEEY030-E |
|
環境設定ファイル読み込み中にエラーが発生したとき |
KEEY031-S |
|
ログファイル処理時にエラーが発生したとき |
KEEY032-S |
|
EUR Serverr - Spool Serviceの起動時にエラーが発生したとき |
KEEY053-E |
|
EUR Server - Spool Serviceの停止時にエラーが発生したとき |
KEEY054-E |
|
EUR Server - Spool Serviceの呼び出しでエラーが発生したとき |
KEEY055-E |
|
コマンド実行ワーニング |
ログファイルのオープンエラーが発生したとき |
KEEY035-W |
コマンド実行タイムアウト |
コマンド実行時にタイムアウトが発生したとき |
KEEY050-E |
(a) Spool Service制御コマンドの終了コード
Spool Service制御コマンド(eurpmlsctrlコマンド)を実行すると,終了コードが返されます。終了コード一覧を次に示します。
終了コード |
意味 |
---|---|
0 |
Spool Service制御コマンドが正常に終了しました。 |
4 |
Spool Service制御コマンドの実行中,警告が発生しました。 |
8 |
Spool Service制御コマンドの実行中,エラーが発生しました。 |
Spool Service制御コマンド(eurpmlsctrlコマンド)を呼び出しているプログラムでは,Spool Service制御コマンドの終了コードを参照して,エラーチェックしてください。
(b) エラーメッセージのフォーマット
Spool Service制御コマンド(eurpmlsctrlコマンド)を実行したとき,標準エラーに出力されるメッセージのフォーマットを次に示します。
eurpmlsctrl:△KEEY0XX-E△エラーメッセージ▼
- (凡例)
-
△:半角空白を示します。
▼:改行(0x0d+0x0a)を示します。