otxadminの構文を以下に示します
otxadmin command -short-option argument --long-option argument operand
コマンド
コマンドとは、実行される操作またはタスクのことです。コマンドには、大文字と小文字の区別があります。
オプション
オプションによって、ユーティリティによるコマンドの実行方法を変更できます。アルファベットの大文字と小文字は区別されます。短形式のオプションの前にはダッシュを 1 つ付けます (-)。長形式のオプションの前にはダッシュを 2 つ付けます (--)。多くのオプションは、短形式でも長形式でも使用できます。たとえば、--user と -u のどちらを使用してもかまいません。オプションには、必須オプションと省略できるオプションがあります。コマンド構文では、省略できるオプションをかっこで囲んで表しています。コマンドの実行時にはすべての必須オプションを指定する必要があります。指定しないと、エラーメッセージが返され、コマンドは実行されません。
使用可能な長形式および短形式のオプション名については、「
運用管理コマンドリファレンス」を参照してください。
ほとんどのオプションには引数が必要です。たとえば --port には引数 port_number を指定します。ただし、ブール型のオプションは、機能のオンまたはオフを切り替えるために使用されるため、引数を必要としません。
オプションを環境変数に保存することもできます。詳細については、「
環境コマンド」を参照してください。
ブール型のオプション
ブール型のオプションでは、オンまたはオフを切り替えます。たとえば、 --interactive を指定すると対話モードに切り替わります。--no-interactive を指定すると対話モードがオフになります。対話モードでは、オプションに関してプロンプトが表示されます。長形式のオプションの前に --no- を指定すると、そのオプションがオフになります。短形式のオプション名を指定すると、常にデフォルト値の逆の設定になります。
短形式のブール型オプションはまとめて指定できます。たとえば、対話モード (短形式のオプション名 -I) とエコー (短形式のオプション名 -e) を指定したい場合、-Ie と指定することができます。
オペランド
オペランドは、空白文字またはタブで区切って指定します。コマンド構文内にどの順番で指定してもかまいません。オペランドの前に -- を記述すると、オプションとオペランドを区別できます。その後に続く引数は、ダッシュ (-) で始まるものも含め、すべてオペランドとして扱われます。例を示します。
otxadmin>
create-jvm-options -- -Xmx512m
-Xmx512m はダッシュで始まっていますが、オペランドとして扱われます。
構文例
create-file-user --user admin_user [--password admin_password] [-H host_name]
[--port port_number] [--passwordfile file_name] [--terse=true|false] [--echo=true|false]
[--interactive=true|false] [--userpassword user_password] [--groups user_groups[:user_groups]*]
[--authrealmname authrealm_name] username
この構文例では、-H はホスト名の短形式のオプション、--user は admin_user を引数とする長形式のオプション、username はオペランドです。省略できるオプションは、かっこで囲まれています。
次に、構文に実際の値を指定した例を示します。この例では、省略できるオプションの一部が指定されていません。
otxadmin create-file-user -H hostname --port 6212 --userpassword userpassword sampleuser
関連情報