4.13.17 サーバのシャットダウン
機能
WindowsまたはLinux環境において，サーバのシャットダウンを実行します。
この部品では，次のサーバを前提とします。
・実行対象サーバ
この部品を実行する対象となるサーバです。
実行対象サーバのOS種別に応じたshutdownコマンドを使用して，シャットダウン(電源オフ)を実行します。
プロパティ設定の留意点を次に示します。
(1) シャットダウン理由(Windows.shutdownReasonプロパティ)には次のコードを指定します。これ以外の独自のコードを使用したい場合は，Microsoftサポートなどを参照してください。
コード 意味
0:0 その他 (計画済)
1:1 ハードウェア: メンテナンス (計画済)
1:2 ハードウェア: インストール (計画済)
2:2 オペレーティング システム: 回復 (計画済)
2:3 オペレーティング システム: アップグレード (計画済)
2:4 オペレーティング システム: 再構成 (計画済)
2:16 オペレーティング システム: Service pack (計画済)
2:17 オペレーティング システム: ホットフィックス (計画済)
2:18 オペレーティング システム: セキュリティ フィックス (計画済)
4:1 アプリケーション: メンテナンス (計画済)
4:2 アプリケーション: インストール (計画済)
5:19 セキュリティの問題 (計画済)
7:0 レガシ API シャットダウン (計画済)
利用場面
この部品は，計画停電時やプログラムの更新ファイル適用時において，サーバを停止する場合などに利用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) CentOS 6 (64-bit x86_64)
(9) CentOS 7 (64-bit x86_64)
(10) CentOS 8 (64-bit x86_64)
(11) Oracle Linux 8 (64-bit x86_64)
【実行対象サーバの使用条件】
なし。
注意事項
(1) 実行対象サーバの稼働OSとは関係なく，他のユーザーがログインしていても強制的にシャットダウンを実行します。他のユーザーの作業内容を保存できません。
(2) この部品は実行対象サーバでOSのshutdownコマンドが実行された時点で完了するため，この部品とシャットダウン処理は非同期に動作します。
(3) 実行対象サーバでOSのshutdownコマンドが実行されてからシャットダウン処理が始まるまでに，JP1/AOのシャットダウン事前処理のため，一定の待ち時間が発生します。所要時間は，実行対象サーバの稼働OSがWindowsの場合は180秒，Linuxの場合は1秒です。
(4) 実行対象サーバの稼働OSがWindowsの場合，プロパティには「"」(ダブルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。
(5) 実行対象サーバの稼働OSがWindowsの場合，シャットダウン理由(Windows.shutdownReasonプロパティ)およびシャットダウン理由コメント(Windows.shutdownReasonCommentプロパティ)は必ず指定してください。指定していない場合，この部品が異常終了します。
(6) 実行対象サーバの稼働OSがWindowsの場合，この部品で登録されるOSのイベントログの仕様はshutdownコマンドの仕様に従います。
(7) 実行対象サーバの稼働OSがWindowsの場合，この部品は環境変数"SystemRoot"を参照して"shutdown.exe"を呼び出すため，実行対象サーバにおいてこの環境変数がOSインストール時から変更された場合，この部品が異常終了することがあります。
(8) この部品でエラーが発生した場合は，タスクログのshutdownコマンドのメッセージに従って対処してください。
実行権限
Windowsの場合：Administrator権限
Linuxの場合：root権限
バージョン
02.01.00
部品のタグ
Control OS,Windows,Linux
タスクログに表示される部品の名称
osShutdownServer
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
0以外 |
異常(エラー内容はタスクログで確認) shutdownコマンド異常終了 |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
Windows.shutdownReason |
シャットダウン理由:Windows固有 |
実行対象サーバのOSがWindowsの場合に，シャットダウンの理由を「x:y」の形式で指定します。OSがWindowsの場合は必須です。Linuxの場合は指定しても無視されます。 |
0:0 |
入力 |
△ |
|
Windows.shutdownReasonComment |
シャットダウン理由コメント:Windows固有 |
実行対象サーバのOSがWindowsの場合に，シャットダウンの理由コメントを511文字以内で指定します。OSがWindowsの場合は必須です。Linuxの場合は指定しても無視されます。 |
Server shutdown was done by this product. |
入力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |