Oracle Traffic Directorコマンドライン・インタフェースの概要

1.1 一般的な構文

一般的な構文では、コマンド名、共通オプションおよび必須オプションを指定し、次にオペランドを指定します。オプションは、すべて(--)表記で開始します。短縮オプション名は、(-)表記で接頭辞を付ける必要があります。必須ではないオプションは、[]で示されます。共通オプションの詳細は、「help」を参照してください。

オプションの例:

$tadm --user=admin --port=1895

短縮オプションの例:

$tadm -u admin -p 1895

一般的な構文の例を次に示します。

図1-1 CLIの構文

「図1-1 CLIの構文」の説明

1.2 使用モード

この項では、Oracle® Traffic Directorのコマンドライン・モード(スタンドアロン・モード、シェル・モード、ファイル・モード)について説明します。

1.2.1 スタンドアロン・モード

スタンドアロン・モード・オプションでは、コマンド、オプションおよびオペランドを指定して、コマンド・シェルからCLI (tadm)を起動します。コマンドの実行後、CLIは終了してシェルに戻ります。詳細は、「help」を参照してください。

例:

$tadm create-config --user=admin --password-file=./admin.pwd --listener-port=2222 --server-name=syrinx myconfig

CLI201 コマンド'create-config'正常に実行されました。

1.2.2 シェル・モード

シェル・モード・オプションでは、コマンドを入力せずにコマンド・シェルからCLI (tadm)を起動します。CLIによって、コマンドの入力を求められます。コマンドの実行後、制御はtadmシェルに戻ります。シェルは、exitまたはquitコマンドを入力することで終了できます。詳細は、「help」を参照してください。

例:

$tadm --user=admin --password-file=./admin.pwd --host=admin.example.com --port=8989
OTD 1.0 B06/07/2011 09:40
tadm> list-configs
www.example.com
soa.example.org
tadm> exit
$

注意:

シェル・モードでは、ASCII以外の文字の入力をサポートしていません。ただし、スタンドアロン・モードではサポートされています。

1.2.3 ファイル・モード

ファイル・モード・オプションでは、有効なコマンドのリストを含むコマンド・ファイルを指定します。

例:

$tadm --user admin --password-file ./admin.pwd --host=localhost --port 8888 --commands-file file.txt

1.3 セキュリティ

CLIでタスクを実行する際にユーザー名とパスワードを入力するためのガイドラインを次に示します。ユーザー名とパスワードは、Oracle Traffic Directorアプリケーションで定義されているポリシーに従って使用する必要があります。CLIで複数のタスクを実行する場合、ユーザー名とパスワードは、次の組合せで使用する必要があります。

スタンドアロン・モードでは、実行するユーザー・コマンドごとにユーザー名とパスワードを入力する必要があります。

例:

$tadm list-configs --user=admin --password-file=./admin.pwd --host=admin.example.com --port=8888

シェル・モードでタスクを実行する場合、tadm実行可能ファイルが起動されたときにユーザー名とパスワード・ファイルが受け入れられます。シェル・モードでユーザー・コマンドが起動される場合、ユーザー名とパスワード・ファイルのオプションは入力できません。

例:

$tadm --user=admin --host=admin.example.com --port=8888
Enter the password>
tadm>

パスワード・ファイルは、読取り専用モードで管理者に提供するようにし、NFSまたは共有ディスクには格納しないことをお薦めします。パスワード・ファイルの内容は、次のように指定する必要があります。
tadm_password=password

パスワード・ファイルには、複数のパスワードを格納できます。次に例を示します。
```
tadm_password=<password>
  tadm_token-pin=<pin>
```

tadmコマンドでパスワードが必要とされ、そのパスワードがパスワード・ファイルで指定されていない場合、パスワードの入力を求められます。

注意:

ファイル・モードは、シェル・モードと同様です。

1.4 コマンドライン・インタフェース・ユーティリティ

この項では、Oracle® Traffic Directorでサポートされるいくつかのコマンドライン・ユーティリティについて説明します。

1.4.1 短縮名オプション

tadmコマンドを実行する場合、スタンドアロン・オプションとしてブール型オプションの短縮名を使用できます。

例: -e、-vおよび-pを組み合せて、-evpとして使用できます。

注意:

コマンドの機能動作を変更することなく、任意の順序で各オプションを指定できます。

1.4.2 タブ補完

タブ補完は、tadmの機能です。[Tab]キーを2回押すことで、tadmコマンドとそのオプションを自動的に完成します。tadmオプションで、「--」と入力して[Tab]キーを2回押すと、特定のコマンドの使用可能なオプションがtadmシェルにリストされます。「--c」と入力して[Tab]キーを2回押すと、cで始まる他のオプションがなければ、tadmシェルによってオプションが完成されます。オプションがあれば、それらのオプションがリストされます。

例:

$ tadm
$ tadm p<tab><tab>
$ tadm pull-config

1.5 エラー・メッセージ

エラーと警告の指定に使用される一般的な書式は、次のとおりです。

CLI<Error-code>: <Error Message>

例:

CLI004: 必須オプション--vsがコマンドに見つかりません。--vsオプション付きでコマンドを再実行してください。

エラー・コードとその説明は、「help」を参照してください。

1.6 コマンドのリスト

この項には、Oracle® Traffic Directorで使用されるCLIコマンドの機能リストが含まれます。この項を使用して、Oracle® Traffic Directorの機能的な役割に基づいて特定のコマンドを検索できます。

インスタンス・ルート構成

構成管理

リスナー管理

サーバー・プール管理

ヘルス・チェック

get-health-check-prop

set-health-check-prop

オリジン・サーバー

構成プロパティ

get-config-prop

set-config-prop

ローカリゼーション・プロパティ

HTTPプロパティ

キープ・アライブ

スレッド・プール

サービス品質(QoS)

ドメイン名サービス

ドメイン名サービス・キャッシュ

SSLセッション・キャッシュ

アクセス・ログ・バッファ・プロパティ

変数

プロキシ・キャッシュ

仮想サーバー管理

(QoS)制限

エラー・ページ設定

ルール管理

プロキシ・キャッシュ・ルール

リクエスト制限ルール

圧縮ルール

SSL

暗号

PKCS11

証明書管理

証明書失効リスト

監視

エラー・ログ

アクセス・ログ

Stats XML構成

Perfdump構成

SNMP

統計

イベント

インスタンス管理

管理サーバーおよびノード管理

高可用性

1 Oracle Traffic Directorコマンドライン・インタフェースの概要