DGMGRLのオプション・パラメータ

コマンドラインからオプション・パラメータを入力して、Data Guardコマンドライン・インタフェースでの出力の表示方法を指定できます。

出力には、コマンド・プロンプト、バナーおよびメッセージなどの項目が含まれます。

また、単一コマンド・モードも使用可能です。このモードのDGMGRLでは、1つのコマンドが実行され、そのコマンドの終了時にDGMGRLも終了します。終了コードとしてコマンドの結果が戻されます。終了コードが0であれば、コマンドは正常終了しています。それ以外の場合は、エラーがあります。

DGMGRLのコマンドラインは次のとおりです。

% dgmgrl [<options>] [<logon> [<command>] ]

DGMGRLコマンドライン・インタフェースの起動時に、次の任意のキーワードを指定します。

<options>には、次のいずれか1つを選択できます。
- -echo
  
  コマンドの入力と出力をデフォルトの表示デバイスに表示します。このパラメータを使用しない場合、コマンドからの出力のみが表示されます。
- -logfile <file-spec> "<dgmgrl-command>"
  
  DGMGRLコマンドライン・インタフェースの処理情報を取得するファイルを指定します。
  
  ノート:
  DGMGRLの-logfileオプションは、Oracle Database 12cリリース2 (12.2.0.1)では非推奨です。下位互換性のためにのみサポートされています。かわりに、START OBSERVERコマンドでLOGFILE IS句を使用してログ・ファイルが指定されるようになりました。
  関連項目:
  - 「START OBSERVER」コマンド
  - オブザーバ・ログ・ファイルでのオブザーバの処理の取得
- -silent
  
  DGMGRLのコマンド・プロンプト(DGMGRL>)をデフォルトの表示デバイスに表示しません。このオプションは、コマンド出力をファイルまたは他の表示ツールに送る場合に役立ちます。
- -json
  このオプションを使用すると、DGMGRLでコマンド出力をJSON形式に変換できます。JSON形式の出力を使用すると、自動化ツールやスクリプト環境と簡単に統合できます。次の例は、コマンド行で使用される -jsonオプションを示しています:
```
$ dgmgrl -json <connect_auth> "show configuration tracelevel";
{
  "Version" : "26.1.0.24.00",
  "ShowProperty" :
  {
    "Configuration" : "abc",
    "Name" : "TraceLevel",
    "Value" : "USER",
    "Type" : "Configurable"
  }
}
```
  次の例は、対話形式で使用される -jsonオプションを示しています:
```
$ dgmgrl <connect_auth>
          DGMGRL> set json on;
          DGMGRL> show configuration tracelevel;
          {  
             "Version": "26.1.0.24.00",  
             "ShowProperty":  
              {    
                "Configuration": "abc",    
                "Name": "TraceLevel",    
                "Value": "USER",    
                "Type": "Configurable"  
              }
          }
DGMGRL> set json off;
```
<logon>は次のとおりです:
- username [@connect-identifier]
  
  データベースに接続するには、usernameと、オプションでconnect-identifierを入力します。次に、パスワードの入力を求められます。connect-identifierは、完全指定の接続記述子であり、簡易接続を含むOracleネーミング・メソッド(TNSなど)により解決される名前です。
  完全指定の接続記述子が使用されている場合は、引用符を含める必要があります。引用符がないと、invalid optionエラーで接続が失敗します。次に、引用符を使用して接続する例を示します。
```
dgmgrl sys@'(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=sales-server)(PORT=1521)))
(CONNECT_DATA=(SERVICE_NAME=sales.us.example.com)))'
```
```
Enter password: password
```
  完全指定の接続記述子を使用するか、簡易接続ネーミング・メソッドを使用するかに関係なく、接続識別子の指定には次のすべての構文が有効です(パスワードの入力を要求されます)。
  - dgmgrl username@'connect_identifier'
  - dgmgrl username@"connect_identifier"
  - dgmgrl username@"'connect_identifier'"
  警告:
  
  DGMGRLの起動時にコマンドラインでパスワードを指定することには、安全上のリスクがあります。このリスクは、DGMGRLの起動時はパスワードを省略し、後で求められたときに入力するか、外部の認証方式を使用することで回避できます。
- オペレーティング・システム認証(リモート・データベースの再起動を除く)、Secure Sockets Layer(SSL)プロトコルまたはウォレットに格納されたデータベース資格証明を使用する場合は、'/'として接続できます。
<command>は1つのコマンドです。

たとえば:

dgmgrl sys "show database 'North_Sales'"

Password: パスワード

次の各項で、DGMGRL>コマンド・プロンプトから入力するコマンドの書式について説明します。