5.2.2 OracleDBインスタンスの停止
機能
OracleDBサーバ上のOracleDBインスタンスを停止します。
プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼ぶ)上で，SQL*PlusのSHUTDOWNコマンドをIMMEDIATEオプションで実行します。
同コマンドは同期的に実行します。
このドキュメント内で使用しているOracleに関する用語を次に示します。
・OracleDBインスタンス
DBサーバにインストールされているDBのインスタンスです。
同一のDBサーバ上に複数のインスタンスが存在することができ，各々のインスタンスはDBサーバ内でユニークな識別名(後述の「Oracleシステム識別子(SID)」)と固有のインストール先フォルダを持っています。
また，インスタンスはDBのテーブル領域やDBユーザーのアカウント情報や権限設定情報らを束ねる存在でもあります。
・SQL*Plus
OracleDBに同梱されているユーティリティツールです。
コマンドラインインタフェイス(CLI)でOracleDBを操作・保守する為の独自なコマンドを有しているほか，SQL文を実行するDBクライアント機能を備えています。
・Oracleシステム識別子名(SID)
OracleDBインスタンスの識別名です。
Oracleのマニュアルサイトではシステム識別子またはSIDと記載されています。
この部品が前提とするサーバを次に示します。
・OracleDBサーバ(実行対象サーバ)
OracleDBがインストールされているサーバです。
利用場面
この部品は，起動中のOracleDBインスタンスを停止する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 10-52以降
【実行対象システム内前提製品】
(1)OracleDBサーバ
・Oracle 11g Standard/Enterprise
【実行対象システム内前提製品の稼働OS】
(1)OracleDBサーバ
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Enterprise/Datacenter
・Red Hat Enterprise Linux 5 Advanced Platform (x86)，Red Hat Enterprise Linux 5 (x86)，Red Hat Enterprise Linux 5 Advanced Platform (AMD/Intel 64)，Red Hat Enterprise Linux 5 (AMD/Intel 64)
・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
ただし，OracleDBの要求を満たすもの。
【実行対象システム内前提製品の使用条件】
(1)OracleDBサーバに関する条件
・OracleDBが正常にインストール済みであること。
・SQL*Plusがインストール済みであること。
・指定したOracleシステム識別子(SID)に対応するOracleDBインスタンスが停止または起動していること。
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) プロパティ「Oracleシステム識別子(SID)」(database.oracleSid)に指定したOracleシステム識別子(以降，「OracleSID」と呼びます)については，英大文字と小文字を区別します。次に示す禁止文字をOracleSIDに含める事はできません。またこれら以外にもOracle側で制限を設けている場合があります。これら以外の制限についてはOracleDBの仕様をご参照下さい。
禁止文字:
・改行文字(¥n)
・半角スペース( )
・セミコロン(;)
(3) OracleSIDに対応するOracleDBインスタンス(以降，「対象のインスタンス」と呼びます)が既に停止している場合は，この部品が戻り値0で正常終了します。インスタンスの状態によっては，部品が戻り値27で異常終了しても，実際のインスタンスが正常に停止するケースがあります。
(4) プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼びます)の稼働OSがWindowsの場合，この部品はレジストリーを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によってレジストリーがインストール直後の状態から更新されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，対象のインスタンスが存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。
(5) DBサーバの稼働OSがUNIXの場合，この部品はOracleDBのインストーラーが作成した"oratab"ファイルを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によって"oratab"ファイルがインストール直後の状態から更新，移動，或いは削除されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，対象のインスタンスが存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。
(6) 対象のインスタンスに設定しているエンコード種別はDBサーバの稼働OSで選択しているエンコード種別と一致している必要があります。一致していない場合は，エラーや誤動作が発生する事があります。
(7) DBインスタンス停止時は，コールの完了またはユーザーによるデータベース接続の切断を待ちません。コミットしていないデータは破棄されます。
(8) この部品が異常終了する時，「ORA-」で始まるエラーコードとメッセージがタスクログに表示されることがあります。そのような場合は，OracleDBのマニュアルサイトなどでこのエラーコードを検索して下さい。
実行権限
・Windowsの場合は，ora_dbaグループに属するユーザーであること。
・UNIXの場合は，OSDBAグループに属するユーザーであること。
バージョン
01.52.00
カテゴリ
Database/Oracle
タスクログに表示される部品の名称
dbStopOracleInstance
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
database.oracleSid |
Oracleシステム識別子(SID) |
対象のOracleDBインスタンスを示すシステム識別子(SID)を指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |