スクリプトは以下の形式で作成します。
【Windowsマネージャー】
インストールフォルダー\SVROR\Manager\etc\user_scripts
【Linuxマネージャー】
/etc/opt/FJSVrcvmr/user_scripts
実行順_リソース名_実行するタイミング-任意の文字列.拡張子
以下のように指定します。
項目 | 記載する内容 |
|---|---|
実行順 | スクリプトの実行順序を記述します。2桁の整数を指定します。 同じ実行順を複数のスクリプトに指定した場合、実行順序は保証されません。 |
リソース名 | リソース名については、「操作前後のスクリプト起動の対象になるリソース名と操作名」を参照してください。 |
実行するタイミング | 操作を契機にスクリプトを実行する場合、以下のように指定します。
操作名については、「操作前後のスクリプト起動の対象になるリソース名と操作名」を参照してください。 |
任意の文字列(省略可) | 空白を除いた任意の文字列を指定します。 ファイル名として利用可能な文字のうち、空白を除く任意の文字で構成されたOSがサポートしている文字数を指定できます。 同じ操作に対して複数のスクリプトを配置する場合、スクリプトの用途を区別するためにユーザーが自由に文字列を指定できます。 |
拡張子 | 【Windowsマネージャー】 【Linuxマネージャー】 |
例
L-Platformの解約前に動作するスクリプト名
00_lplatform_pre_delete.bat
L-Platformの申請後に動作するスクリプト名
00_lplatform_post_create.bat
L-Serverの作成後に動作するスクリプト名
01_lserver_post_create-sample.bat
L-Serverの停止前に動作するスクリプト名
00_lserver_pre_stop.sh
操作前後のスクリプト起動の対象になるリソース名と操作名
操作前後のスクリプト起動の対象になるリソース名と操作名は以下のとおりです。
リソース名 | 操作名 | 備考 | |
|---|---|---|---|
lplatform | 利用申請 | create | 操作後のスクリプト実行時、作成されたL-Serverの状態は以下となります。
|
構成変更(L-Serverの追加時) | create | 1回の操作で複数台追加した場合、追加した台数回スクリプトが起動します。 | |
構成変更(L-Serverの削除時) | delete | 1回の操作で複数台削除した場合、削除した台数回スクリプトが起動します。 | |
解約 | delete | - | |
一括電源ON | start | 利用申請時に作成されたL-Serverに電源OFF状態のものが含まれる場合にも、本操作が実行されます。 | |
一括電源OFF | stop | - | |
lserver (物理L-Server/仮想L-Server共通) | 作成 | create | rcxadm lserver create実行時、または[リソース]タブからの操作でL-Serverを作成した場合 |
削除 | delete | rcxadm lserver delete実行時、または[リソース]タブからの操作でL-Serverを削除した場合 | |
起動 | start | 一括電源ONの操作時には実行されません。 | |
停止 | stop | 一括電源OFFの操作時には実行されません。 | |
tenant | 作成 | create | 1回の操作で複数作成した場合、作成したテナント数回スクリプトが起動します。 |
削除 | delete | - | |
テナント配下のL-Serverをすべて起動 | start | すべてのテナントを選択した場合、テナントの数だけスクリプトが起動します。 | |
テナント配下のL-Serverをすべて停止 | stop | すべてのテナントを選択した場合、テナントの数だけスクリプトが起動します。 | |
変更 | modify | - | |
終了ステータス
以下のステータスが返されます。
正常終了
エラーが発生しました。
標準出力とエラー
以下のフォルダーに出力されます。
【Windowsマネージャー】
インストールフォルダー\SVROR\Manager\var\script_log
【Linuxマネージャー】
/opt/FJSVrcvmr/var/script_log
以下のファイル名で出力されます。
標準出力
出力日時_スクリプト名_stdout.txt
標準エラー
出力日時_スクリプト名_stderr.txt
出力日時は以下の形式です。
YYYY-MM-DD HH-MM-SS
同じスクリプトが同時刻に実行された場合、ファイル名の末尾に-Xがつきます。
Xは1から始まる連番です。
一時ファイル
スクリプトは、イベント発生などの情報を一時ファイルとして出力します。
出力される情報については、「表B.3 変数の意味と値」を参照してください。
【Windowsマネージャー】
インストールフォルダー\SVROR\Manager\var\tmp\rcxtempfile
【Linuxマネージャー】
/opt/FJSVrcvmr/var/tmp/rcxtempfile
実行するタイミング.xx.xx
実行するタイミングは、「表B.1 指定項目」で指定した値です。
xx.xxは以下の書式です。
マネージャーのプロセスID.重複しないようにランダムに生成した数字
スクリプトには、第一引数として上記のファイル名がフルパスで渡されます。
このため、渡された引数をそのまま使用して読み込むことで、スクリプト内ではファイル名の考慮は必要ありません。
ユーザースクリプトが受け取る情報は以下のとおりです。
一時ファイルは、以下の形式で出力されます。
変数名 = 値 |
改行コードは以下のとおりです。
【Windowsマネージャー】
CR+LF
【Linuxマネージャー】
LF
変数の意味と値は以下のとおりです。
変数 | 意味 | 値 |
|---|---|---|
EVENT | イベント発生時に、RORコンソールの[イベント]欄に表示される文字列 | ""で囲まれた文字列 |
PROGRESS | イベントが発生したタイミング |
|
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 | 操作を実行したユーザーが所属する ユーザーグループ名 | ""で囲まれた文字列
|
OWNER | 操作対象のリソースを所有するユーザー名 | ""で囲まれた文字列
|
FULL_NAME | 操作対象になったリソースを一意に特定できる名前 | ""で囲まれた文字列
|
FOLDER_TYPE | 操作対象のリソースのフォルダーのタイプ | ""で囲まれた文字列
|
