help

コマンドライン・インタフェースについて説明します。

構文

tadmコマンドライン・ユーティリティの使用方法は、次のとおりです。

tadm --version|-V

CLIのバージョンを表示します。
tadm --help|-?

このページをテキスト形式で表示します。
tadm help|-?

このページをテキスト形式で表示します。
tadm --user|-u admin-user [--password-file|-w] [admin-passwd-file] [--host|-h admin-host] [--port|-p admin-port] [[--rcfile|-R rcfile]: tadmをシェル・モードで起動します。
tadm subcommand --help

指定されたサブコマンドのヘルプを表示します。

tadm subcommand options

指定されたサブコマンドの使用構文を表示します。

構文表記法

このドキュメントでは、次の表記規則を使用してコマンドライン・オプションの構文を示します。

プレーン・テキスト: テキストをそのまま入力します。
例: option

イタリック体のテキスト: オプションまたはオペランドの値のプレースホルダです。CLIコマンドを実行する場合、このようなプレースホルダは適切な値に置き換える必要があります。
例: parameter

大カッコ内のテキスト: オプションの引数です。
例: [argument]

大カッコ内のテキストに続くアスタリスク(*): オプションの引数です。複数のインスタンスを指定できます。
例: [argument]*

テキストに続くプラス記号(+): 必須の引数です。複数のインスタンスを指定できます。
例: [argument]+

テキスト間の縦線記号(|): オプションの値です。いずれか1つを指定します。
例: opt1|opt2

説明

コマンドライン・インタフェース(CLI)によって、Oracle Traffic Directorを構成および管理できます。コマンドライン・ツールのtadmを使用して、管理コマンドを実行します。

tadmは、スタンドアロン・モード、シェル・モードまたはファイル・モードで起動できます。

スタンドアロン・モード - スタンドアロン・モードでは、目的のコマンド、オプションおよびオペランドを指定してCLIを直接起動できます。コマンドが完了すると、CLIはシェルに戻ります。

---------------------------------------------------------
シェル・モード - シェル・モードでは、tadm内に埋め込まれたシェルからCLIを起動できます。コマンドが完了すると、CLIはシェルに戻ります。シェルを終了するには、exitまたはquitと入力します。シェル・モードに移行する場合、user、passwordおよびportの各オプションが必須です。ポートの詳細を指定しないと、デフォルト・ポートが使用されます。デフォルト・ポート番号は8989です。

例:

---------------------------------------------------------

$ tadm --user=admin --port=8081 --password-file=./admin.passwd

tadm> list-configs

www.example.org

--------------------------------------------------------
ファイル・モード - ファイル・モードでは、有効なコマンドのリストを含むプレーン・テキストを作成できます。ファイル・モードでは、tadmの起動時にuserとpassword-fileが受け入れられます。

例:

---------------------------------------------------------

$ cat sample.tcl

set tadm::command false

set x [list-configs]

puts $x

$ tadm --user=admin --password-file=./admin.passwd --commands-file=sample.tcl

--------------------------------------------------------

tadm変数

次のtadm変数を設定して、tadmの全体的な動作を変更することもできます。

tadm::command: (ファイル・モード専用)すべてのコマンドをstdoutおよびstderrに出力できます。この変数をtrueに設定すると、例外が発生してもコマンドの実行は停止されず、かわりに例外はstdoutに出力されて次のコマンドが実行されます。この変数はコマンド・ファイルに設定できます。

-------------------------------------------------------

$ cat commands.tcl

set tadm::command true

set x [list-configs]

puts $x

この例で、commands.tclは有効なコマンドのリストを含むファイルの名前です。

--------------------------------------------------------
tadm::savehist: (シェル・モード専用)trueに設定すると、実行するすべてのtadmコマンドがtadm::histfileファイルに保存されます。tadm::histfileは、ホーム・ディレクトリに保存されます。tadm環境にこの変数を設定するには、tadm set tadm::savehist trueコマンドを使用します。
tadm::file: ファイル・モードでtadmコマンドを実行する場合、この変数をtrueに設定します。
tadm::tokenize: trueに設定すると、tadmによってTCL対応形式のログ・ファイルが解析されます。
tadm::log_date_format: この変数を使用して、ログ・ファイルの日付書式を定義します。デフォルトの書式はMM/dd/yyyy:HH:mm:ssです。
tadm::date_format: この変数を使用して、ユーザーが日付を入力できる日付書式を定義します。デフォルト値は、現在のロケールの日付書式です。
tadm::property_separator: この変数を使用して、プロパティのセパレータを定義します。デフォルト値は等号(=)です。たとえば、tadm> set tadm::property_separator :と入力します。
tadm::field_separator: この変数を使用して、フィールドまたは列のセパレータを定義します。デフォルト値は空白( )です。たとえば、tadm> set tadm::field_separator |と入力します。
tadm::field_format: この変数を使用して、フィールドまたは列の表示形式を定義します。デフォルト値は%-15sです。たとえば、tadm> set tadm::field_format %-15s|と入力します。

共通オプション

共通オプションという用語は、このドキュメントとCLIのmanページで次のオプションを表す場合に使用されます。

--user、--port、--hostなど、管理サーバーに接続するために必要なオプション。シェル・モードでは、これらのオプションを指定する必要はありません。

--echoや--verboseなど、複数のコマンドに共通のオプション。

次に、共通オプションの完全なリストを示します。

--user|-u

権限のあるOracle Traffic Director管理者のユーザー名を指定します。

注意:

--user|-uオプションは、次のCLIコマンドでは必須ではありません。

configure-server
unconfigure-server
start-snmp-subagent
stop-snmp-subagent

--user|-uオプションは、reset-admin-passwordコマンドの実行時には必要ありません。

configure-serverコマンドを使用して管理サーバーを作成する場合、--user|-uオプションで、管理サーバーのログイン名を指定します。管理サーバーの構成時に、これはデフォルトでadminに設定されます。

configure-serverコマンドを使用して管理ノードを作成する場合、--user|-uオプションで、管理サーバーに接続するために使用するログイン名を指定します。これは、管理ノード構成時の必須オプションです。

--password-file|-w

パスワード・ファイルの名前と場所を指定します。パスワード・ファイルには、管理サーバーを対象に管理者を認証するためのパスワードが含まれます。管理パスワードとは別に、bind-password、user-password、token-pinなどの他のパスワードを指定することもできます。このオプションを指定しない場合、コマンドの実行時にパスワードの入力を求められます。また、指定されたパスワード・ファイルに必須パスワードが記載されていない場合も、パスワードの入力を求められます。

サンプルのパスワード・ファイルは次のとおりです。

tadm_password=tadm-password
tadm_bind_password=bind-password
tadm_user_password=user-password
tadm_token_pin=token-pin
tadm_new_token_pin=new-token-password
tadm_admin_password=admin-password
tadm_<token_name>=token-pin

注意:

tadm_<token_name>は、start-instanceコマンドでのみ使用できます。tadm_<token_name>を使用して複数のトークンPINを設定し、複数のノードでインスタンスを起動できます。

たとえば、internalというデフォルト・トークンを任意のインスタンス用に構成します。パスワード・ファイルのデフォルト・トークンのエントリは、tadm_internal=88888888になります。

--host|-h

管理サーバーが実行されているコンピュータの名前を指定します。デフォルト・ホストはlocalhostです。

注意:

このオプションは、管理サーバーにリモート接続する場合にのみ必要です。--host|-hオプションは、reset-admin-passwordコマンドの実行時には必要ありません。

--port|-p

管理サーバーのSSLポート番号を指定します。デフォルト・ポートは8989です。

注意:

--port|-pオプションは、reset-admin-passwordコマンドの実行時には必要ありません。

configure-serverコマンドを使用して管理サーバーを作成する場合、--port|-pオプションで、管理サーバーがリスニングするSSLポートを指定します。

configure-serverコマンドを使用して管理ノードを作成する場合、--port|-pオプションで、管理ノードを登録するリモート管理サーバーのSSLポートを指定します。

--no-ssl|-N

このオプションを指定して、管理サーバーと通信するためにプレーン・テキスト接続を使用します。デフォルト接続はSSLです。

--rcfile|-R

tadmの起動時にロードする必要のあるrcfileの名前を指定します。デフォルト・ファイルは~/.tadmrcです。.tadmrcファイルは、コマンドの実行前にロードされるTCLファイルです。オプション名のハイフン(-)をアンダースコア(_)に変更してtadmという接頭辞を付けることで、長いオプションを変数として使用できます。次に例を示します。

--configは、set tadm_config config1として設定できます。
--key-typeは、set tadm_key_type eccとして設定できます。

サンプルのrcfileは次のとおりです。

set tadm_config sampleconfig
set tadm_password mypassword
set tadm_nodehost sample.mail.com

--echo|-e

このオプションを指定して、実行前に標準出力にこのコマンドを出力します。このオプションでは、コマンドに指定していない必須以外のすべてのオプションのデフォルト値も出力されます。

--no-prompt|-Q

このオプションを指定すると、tadmでは、このコマンドの実行時にパスワードの入力が求められません。このオプションは、パスワード・ファイルにすべてのパスワードを定義しており、--password-fileオプションを使用してそのファイルを指定している場合に使用します。

--verbose|-v

このオプションを指定すると、詳細な出力を表示できます。

--command|-C

tadmコマンドのリストを含むコマンド・ファイルの名前を指定します。コマンド・ファイルの詳細は、ファイル・モードの説明を参照してください。

終了コード

次の終了コードが戻されます。

0 - コマンドの実行に成功しました。
1から4 - 接続失敗エラー
10から22 - 解析エラー
33から43 - 入出力エラー
44から56 - 一般エラー(無効な構成値など)
76から96 - 汎用バックエンド・エラー
110から123 - MBean固有のエラー
125以上 - 不明なエラー