ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.0.0 リファレンスガイド インフラ管理者編 (リソース管理)

5.2 スクリプトの形式

スクリプトは以下の形式で作成します。

スクリプトの格納場所

【Windows】
インストールフォルダー\Manager\etc\user_scripts

【Linux】
/etc/opt/FJSVrcvmr/user_scripts

スクリプトの名前

実行順_リソース名_実行するタイミング-任意の文字列.拡張子

スクリプトの書式

以下のように指定します。

表5.1 指定項目

項目

記載する内容

実行順

スクリプトの実行順序を記述します。2桁の整数を指定します。

同じ実行順を複数のスクリプトに指定した場合、実行順序は保証されません。

リソース名

リソース名については、「操作前後のスクリプト起動の対象になるリソース名と操作名」を参照してください。

実行するタイミング

操作を契機にスクリプトを実行する場合、以下のように指定します。

  • 操作前

    pre_操作名

  • 操作後

    post_操作名

操作名については、「操作前後のスクリプト起動の対象になるリソース名と操作名」を参照してください。

任意の文字列(省略可)

空白を除いた任意の文字列を指定します。

ファイル名として利用可能な文字のうち、空白を除く任意の文字で構成されたOSがサポートしている文字数を指定できます。

同じ操作に対して複数のスクリプトを配置する場合、スクリプトの用途を区別するためにユーザーが自由に文字列を指定できます。

拡張子

【Windows】
コマンドラインから直接実行できる形式です。

【Linux】
実行権が付与されている必要があります。

  • L-Serverの作成後に動作するスクリプト名

    01_lserver_post_create-sample.bat

  • L-Serverの停止前に動作するスクリプト名

    00_lserver_pre_start.sh


操作前後のスクリプト起動の対象になるリソース名と操作名

操作前後のスクリプト起動の対象になるリソース名と操作名は以下のとおりです。

表5.2 操作前後のスクリプト起動の対象になるリソース名と操作名

リソース名

操作名

lserver

(物理L-Server/仮想L-Server共通)

作成

create

削除

delete

起動

start

停止

stop


終了ステータス

以下のステータスが返されます。

0

正常終了

0以外

エラーが発生しました。


標準出力エラー

以下のフォルダーに出力されます。

【Windows】
インストールフォルダー\Manager\var\script_log

【Linux】
/opt/FJSVrcvmr/var/script_log

以下のファイル名で出力されます。

一時ファイル

スクリプトは、イベント発生などの情報を一時ファイルとして出力します。
出力される情報については、「表5.3 変数の意味と値」を参照してください。

一時ファイルの格納場所

【Windows】
インストールフォルダー\Manager\var\tmp\rcxtempfile

【Linux】
/opt/FJSVrcvmr/var/tmp/rcxtempfile

一時ファイルのファイル名

実行するタイミング.tmp.xx.xx

スクリプトには、第一引数として上記のファイル名がフルパスで渡されます。

ファイル名に記述したタイミングで、ユーザーが作成したスクリプトが実行されます。

一時ファイルのフォーマット

ユーザースクリプトが受け取る情報は以下のとおりです。

形式

一時ファイルは、以下の形式で出力されます。

変数名 =

改行コードは以下のとおりです。

【Windows】
CR+LF

【Linux】
LF

変数の意味と値は以下のとおりです。

表5.3 変数の意味と値

変数

意味

EVENT

イベント発生時にRORコンソールのイベント欄に表示される文字列

""で囲まれた文字列

PROGRESS

イベントが発生したタイミング

  • 操作前

    "Started"

  • 操作後

    "Compleated"

  • タスクエラー時

    "Error"

TASK_ID

操作の対象になったタスクのID

""で囲まれた文字列

タスクではない場合: ""

RESOURCE_NAME

操作の対象になったリソースの名前

""で囲まれた文字列

RESOURCE_TYPE

操作の対象になったリソースの種別

""で囲まれた文字列

RESOURCE_ID

操作の対象になったリソースのID

""で囲まれた文字列

TENANT_NAME

操作の対象になったリソースが所属するテナント名

""で囲まれた文字列

テナントに所属していない場合: ""

TENANT_ID

操作の対象になったリソースが所属するテナントID

""で囲まれた文字列

テナントに所属していない場合: "-"

TIME

イベントが発生した時刻

YYYY-MM-DD HH:MM:SS

CLIENT_IP

操作を実行したクライアントのIPアドレス

XX.XX.XX.XX

USER_ID

操作を実行したユーザーID

""で囲まれた文字列

コマンドの特権管理者で実行された場合: ""

USER_NAME

操作を実行したユーザーの名前

""で囲まれた文字列

コマンドの特権管理者で実行された場合: ""

USER_GROUP_ID

操作を実行したユーザーが所属する

ユーザーグループID

""で囲まれた文字列

タスクでなはい場合: ""
ユーザーがグループに所属していない場合: ""

USER_GROUP_NAME

操作を実行したユーザーが所属する

ユーザーグループ名

""で囲まれた文字列

  • タスクではない場合: ""

  • ユーザーがグループに所属していない場合

    ""