この章では、Service Registry の管理ツールの使用方法について説明します。
この章の内容は次のとおりです。
Service Registry 管理ツールは、レジストリへの関連付けの追加やレジストリからのオブジェクトの削除といった一般的な管理作業を行うための、単純なコマンド行インタフェースを提供します。
このツールは次の 2 つのモードのいずれかで動作します。
バッチモードでは、ツールのコマンド行で 1 つまたは複数のコマンドを指定します。
対話型モードでは、ツールの対話型シェル内でコマンドを入力します。
ls や rm などのいくつかのコマンドは、ファイルやフォルダの操作に用いられる有名な UNIX® コマンドの名前と動作の両方を模倣しています。その他のコマンドについては、対応する UNIX コマンドはありません。
管理ツールを起動するには、admin-tool.jar ファイルを実行します。
java -jar ServiceRegistry-base/lib/admin-tool.jar [options]... |
ServiceRegistry-base の場所は、Solaris オペレーティング環境では /opt/SUNWsoar、Linux システムでは /opt/sun/SUNWsoar です。
ツールの起動時に表示される警告は無視してください。重要なものではありません。
管理ツールを終了するには、quit コマンドを使用します。
管理者だけに使用が限定されているコマンドを実行するには、コマンド行から次のように、証明書ファイル (つまりキーストア) の種類、場所、およびパスワードを指定する必要があります (すべてを 1 行で入力)。
java -Djaxr-ebxml.security.storetype=PKCS12 \ -Djaxr-ebxml.security.keystore=security/filename.p12 \ -Djaxr-ebxml.security.storepass=password -jar admin-tool.jar |
ここで、filename は、証明書ファイルのルート名 (デフォルトでは generated-key)、password は、証明書作成時にこのファイルの保護用として指定されたパスワードです。場所 security/filename.p12 は、ディレクトリ $HOME/soar/3.0/jaxr-ebxml からの相対パスです。
入力の手間を省くには、このコマンドを実行するスクリプトを作成します。
管理ツールをバッチモードで実行するには、管理ツール起動時のコマンド行で -command オプションを指定します。
たとえば、次のコマンドは、ls コマンドを実行します。
java -jar ServiceRegistry-base/lib/admin-tool.jar -command "ls *.html" |
管理ツールは、コマンドとその応答を画面上にエコーし、コマンドの実行が完了すると処理を終了します。
シェルにとって特別な意味を持つ文字は、必ず正しくエスケープするようにしてください。
管理ツールを対話型モードで実行するには、コマンド行で -command 以外の任意のオプションを指定して管理ツールシェルを起動します。または、次の例のように、オプションを指定せずに管理ツールシェルを起動します。
java -jar ServiceRegistry-base/lib/admin-tool.jar |
管理ツールは、次のプロンプトを表示し、ユーザーからの入力を待ちます。
admin> |
管理ツールは、「形式」にリストされ、「オプション」で説明されているコマンド行オプションを認識します。
キーストア内のユーザーの証明書にアクセスする際に使用するエイリアス。ユーザー登録時に使用したエイリアスを指定します。
対話型シェルからコマンドを取得しないで実行する管理ツールコマンドシーケンス。複数のコマンドを区切るには、セミコロン (;) を使用します。commands に quit コマンドを含める必要はありません。コマンド区切り文字でないセミコロンを使用する必要がある場合は、セミコロンの前に円記号を付けます。
\; |
管理ツールを実行しているシェルが、円記号をもう 1 つの円記号でエスケープすることを要求する可能性があります。
\\; |
特定のコマンドに空白が含まれている場合、ツールがそのコマンドシーケンスを複数のコマンド行パラメータとしてではなく 1 つのパラメータとして処理できるように、そのシーケンス全体を一重引用符または二重引用符で囲みます。シェルもまたセミコロンをシェルコマンドの区切り文字として解釈する場合には、複数の管理ツールコマンドのシーケンスを常に引用符で囲む必要があります。
-root オプションで指定された RegistryPackage オブジェクトとそのすべての親 RegistryPackage オブジェクトを、必要に応じて作成します。このオプションが有効になるのは、管理ツールの実行ユーザーがオブジェクト作成権限を持っている場合だけです。
デバッグ時に役立つ追加情報を出力します。
これらのオプションの一覧を表示します。
キーストア内のユーザーの証明書にアクセスする際に使用するパスワード。ユーザー登録時に使用したパスワードを指定します。
ローカルファイルシステム内のベースディレクトリ。ローカルファイルシステム内のファイルに関係するコマンドの場合に指定します。
エラーメッセージや状態メッセージ用のリソースバンドルを選択する際に使用するロケール (en、fr など)。デフォルトは、Java 仮想マシン (JVM) によって決定されます。
接続先となる ebXML レジストリの URL。デフォルトは、 http://localhost:6060/soar/registry/soap です。
リポジトリを RegistryPackage オブジェクトのツリーとして扱うコマンドにおいてベースとして使用される RegistryPackage のロケータ (/registry/userData など)。なお、こうしたツリー内の各オブジェクトには、ほかの RegistryObject オブジェクトや RegistryPackage オブジェクトが含まれます。デフォルトは、すべてのユーザーのデータ用に定義された RegistryPackage である、/registry/userData です。
レジストリオブジェクトを選択するための SQL_statement を実行します。この文は、select で始まる完全な SQL 文であるべきです。この SQL 文は、引用符で囲む必要がありますが、末尾にセミコロンを付ける必要はありません。このオプションを指定したあとで、引数なしの select コマンドを使用した場合、SQL_statement 以外の引数を持つ select コマンドを使用するまでその SQL_statement が繰り返し実行されます。
状態メッセージの冗長出力を指定します。
-help オプションの出力には、このリリースでサポートされていないオプションが 2 つ表示されます。-class と -property です。
ここでは、管理ツールの次の特徴について説明します。
管理ツール使用時に実行可能なアクションは、ツール起動時に指定されたキーエイリアスとパスワードに対応するユーザーに許可されているアクションだけです。コマンドの中には、chown のように、管理者のロールを持つユーザーだけが実行できるものもあります。詳細については、「管理者の作成」を参照してください。
管理ツールを使えば、コマンド失敗時に長いスタックトレースが表示されるのを回避できます。
コマンドが失敗した場合、管理ツールは、スタックトレースの 1 行目を出力したあと、次のメッセージを表示します。
An error occurred when executing the function. Use the show exception command to view messages. |
より詳しい情報が必要な場合には、続けて show exception コマンドを実行して、完全なスタックトレースを確認します。
show exception コマンドは常に、直前のコマンドに対するスタックトレースを表示します。
レジストリオブジェクトの特定方法としてもっともよく使用されるのは、名前による特定です。ただし、通常は registry ルートから RegistryPackage までのパスによって RegistryPackage オブジェクトを特定します。たとえば、/registry/userData は、userData RegistryPackage へのパスです。
一部の名前一致では、ワイルドカードがサポートされています。1 文字に一致させるには疑問符 (?) を使用します。0 個以上の文字に一致させるにはアスタリスク (*) を使用します。
cd や chown など、一部のコマンドでは、URN (Uniform Resource Name) によるオブジェクトの特定がサポートされています。ただし、その場合、先頭の urn: まで含めて指定する必要があります。たとえば、urn:uuid:2702f889-3ced-4d49-82d1-e4cd846cb9e4 は有効な URN です。
chown コマンドでは別の方法もサポートされています。その方法では、先行する users コマンドで表示された一覧内の特定の User を、% number を使って参照します。
一部のコマンドでは、空白を含む名前を入力できます。その場合、名前全体を二重引用符で囲むか、名前に含まれる各空白の直前に円記号を付けます。
select コマンドでは、SQL のワイルドカードがサポートされています。複数の文字に一致させるにはパーセント記号 (%) を、1 文字に一致させるにはアンダースコア (_) を、それぞれ使用します。
RegistryObject (または RegistryPackage) は、異なるロケールに関連付けられた複数の名前を持つことができます。
ユーザーが指定したパスやオブジェクト名は、現在のロケールだけに基づいて評価されます。複数の名前を持つレジストリオブジェクトを名前で選択しようとした場合、ユーザーが入力した名前の一致対象となるのは、そのレジストリオブジェクトの名前の 1 つの選択肢 (現在のロケールにもっとも近いロケールを持つ選択肢) のみです。そのレジストリオブジェクトの複数の名前すべてが一致対象になるわけではありません。
たとえば、現在の RegistryPackage が 1 つのメンバーオブジェクトを持ち、そのメンバーオブジェクトが 2 つの名前を持ち、それぞれの名前が異なるロケールに関連付けられているとします。具体的には、red が en (英語) ロケールに、rouge が fr (フランス語) ロケールに、それぞれ関連付けられています。現在のロケールが en である場合、コマンド ls rouge を実行してもそのメンバーオブジェクトは表示されませんが、ロケールが fr (またはその派生の 1 つ) である場合には、そのコマンドによってそのメンバーオブジェクトが表示されます。
管理ツールが認識するコマンド名やリテラルパラメータでは、大文字、小文字の区別はありません。たとえば、ls、Ls、LS はすべて同等です。
値が指定されたオプションは、そのオプションを使用するコードにそのまま渡されます。
次では、利用可能なコマンドについて説明します。各コマンドの形式、オプション説明、およびオペランド説明は、次の文字体裁規約に従って記述されています。
斜体は、コマンド実行時に実際の値に置き換えるべき、オプション引数またはオペランドを示します。
オプションまたはオペランドの選択肢は、大括弧 ({ }) で囲まれます。ユーザーは、この括弧内のオプションまたはオペランドのいずれか 1 つを選択する必要があります。複数のオプションまたはオペランドは、縦棒 (|) で区切られます。
省略可能な 1 つ以上のオプションまたはオペランドは、角括弧 ([ ]) で囲まれます。
1 つのオプションまたはオペランドに続く省略記号 (...) は、その引数またはオペランドを繰り返し指定できることを示します。
上記以外はすべて、コマンド実行時に含める必要のあるリテラルテキストです。
Association オブジェクトをレジストリに追加します。
add association コマンドは、指定されたタイプの Association オブジェクトをレジストリに追加します。次のタイプのいずれかを使用できます。
AccessControlPolicyFor
AffiliatedWith (Subconcept として EmployeeOf と MemberOf を持つ)
Contains
ContentManagementServiceFor
EquivalentTo
Extends
ExternallyLinks
HasFederationMember
HasMember
Implements
InstanceOf
InvocationControlFileFor (Subconcept として CatalogingControlFileFor と ValidationControlFileFor を持つ)
OffersService
OwnerOf
RelatedTo
Replaces
ResponsibleFor
SubmitterOf
Supersedes
Uses
Association オブジェクトのタイプ。
ソースオブジェクトの URN。
ターゲットオブジェクトの URN。
次のコマンド (すべてを 1 行で入力) は、指定された URN を持つ 2 つのオブジェクト間に RelatedTo 関係を作成します。
admin> add association -type RelatedTo urn:uuid:ab80d8f7-3bea-4467-ad26-d04a40045446 urn:uuid:7a54bbca-2131-4a49-8ecc-e7b4ac86c4fd |
特定のユーザーをレジストリに追加します。
add user コマンドは、User オブジェクトを追加します。User オブジェクトには通常、PostalAddress、TelephoneNumber、EmailAddress の各オブジェクトが少なくとも 1 つずつ含まれます。
ユーザーに関する情報を指定するには、それらの情報をコマンド行から直接入力するか、あるいは -load オプションを使ってそれらの情報を含む Java プロパティーファイルを指定します。情報オプションと -load オプションは、コマンド行に指定された順番で評価されます。たとえば、いくつかのプロパティーをコマンド行から指定し、その他のプロパティーをプロパティーファイルから読み込んだあとで、そのプロパティーファイルの情報を後続のコマンド行オプションで上書きする、といったことも可能です。
新規ユーザーごとにアドレス、電話番号、および電子メールアドレスを最大 3 つずつ指定できます。それ以上必要な場合も、あとで Web コンソールや JAXR を使って追加できます。
住所、電話番号、電子メールアドレスのいずれかを指定する際には、 -emailType OfficeEmail のようにタイプの値を指定する必要があります。
コマンド行では、すべてのユーザーで必要となる基本情報のいくつかに対して短形式オプション (-fn など) が使用できるようになっています。ただし、そうした情報をプロパティーファイルで指定する場合には、長形式を使用する必要があります。たとえば、ユーザーの 1 つ目の電子メールアドレスをコマンド行から指定する場合には、- email1.address、-emailAddress、-email のいずれかを使用できますが、1 つ目の電子メールアドレスをプロパティーファイルで指定する場合には、email1.address= を使用する必要があります。ユーザーの 2 つ目の電子メールアドレスに対するオプションは 1 つしか用意されていないため、コマンド行では -email2.address を、プロパティーファイル内では email2.address= を、それぞれ使用する必要があります。
-edit オプションを指定した場合、新しいユーザーの情報を編集できるように、管理ツールによってエディタが起動されます。詳細については、オプション説明を参照してください。
-load の読み込み対象または -edit の編集対象となるプロパティーファイルでは、その他のすべての Java プロパティーファイルと同じく、IS0-8859-1 文字が使用されます。ISO-8859-1 に含まれない文字をプロパティーファイル内で表現する方法の詳細については、java.util.Properties.load(InputStream) のドキュメントを参照してください。
これを指定すると、新しいユーザーの情報を編集できるように、管理ツールによってエディタが起動されます。ツールによってエディタが起動されるのは、ほかのコマンド行パラメータが評価されたあとです。したがって、コマンド行またはプロパティーファイル内に指定された情報の評価結果に基づいて編集作業が開始されます。編集プログラムが正常に終了しないと、コマンドは続行されません。管理ツールは、set editor コマンド (「set」を参照) で指定されたエディタを起動します。これはデフォルトでは vi エディタになっています。
このリリースでは、-edit は、emacsclient および NetBeansTM コマンド bin/runide.sh --open と組み合わせて使用できますが、動作は保証されておらず、vi と組み合わせた場合に正常に動作するかどうかは、明らかになっていません。
ユーザーのプロパティーが格納された Java プロパティーファイルを指定します。そのプロパティー名は、add user コマンドの長形式オプション (lastName、post1.type など) と同一です。
ユーザーの名を指定します。
ユーザーの姓 (名字) を指定します。姓は必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。
ユーザーのミドルネームを指定します。
キーストア内のユーザーの証明書にアクセスする際に使用するエイリアス。このオプションは必須です。エイリアスの文字長は 3 文字以上である必要があります。
キーストア内のユーザーの証明書にアクセスする際に使用するパスワード。このオプションは必須です。パスワードの文字長は 6 文字以上である必要があります。
1 つ目の PostalAddress のタイプ。このタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列 (Office、Home など) です。
1 つ目の PostalAddress の市。
1 つ目の PostalAddress の国。
1 つ目の PostalAddress の郵便番号。
1 つ目の PostalAddress の州または都道府県。
1 つ目の PostalAddress の町名。
1 つ目の PostalAddress の番地。
2 つ目の PostalAddress のタイプ。2 つ目の PostalAddress を指定する場合、そのタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列 (Office、Home など) です。
2 つ目の PostalAddress の市。
2 つ目の PostalAddress の国。
2 つ目の PostalAddress の郵便番号。
2 つ目の PostalAddress の州または都道府県。
2 つ目の PostalAddress の町名。
2 つ目の PostalAddress の番地。
3 つ目の PostalAddress のタイプ。3 つ目の PostalAddress を指定する場合、そのタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列 (Office、Home など) です。
3 つ目の PostalAddress の市。
3 つ目の PostalAddress の国。
3 つ目の PostalAddress の郵便番号。
3 つ目の PostalAddress の州または都道府県。
3 つ目の PostalAddress の町名。
3 つ目の PostalAddress の番地。
1 つ目の TelephoneNumber のタイプ。このタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。 Beeper、FAX、HomePhone、MobilePhone、または OfficePhone。
1 つ目の TelephoneNumber の市外局番。
1 つ目の TelephoneNumber の国番号。
1 つ目の TelephoneNumber の内線。
1 つ目の TelephoneNumber の電話番号サフィックス。国番号や市外局番は含みません。この番号は必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。
1 つ目の TelephoneNumber の URL (この番号に電子的に電話をかけることのできる URL)。
2 つ目の TelephoneNumber のタイプ。2 つ目の TelephoneNumber を指定する場合、そのタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。Beeper、 FAX、HomePhone、MobilePhone、または OfficePhone。
2 つ目の TelephoneNumber の市外局番。
2 つ目の TelephoneNumber の国番号。
2 つ目の TelephoneNumber の内線。
2 つ目の TelephoneNumber の電話番号サフィックス。国番号や市外局番は含みません。2 つ目の TelephoneNumber を指定する場合、その番号は必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。
2 つ目の TelephoneNumber の URL (この番号に電子的に電話をかけることのできる URL)。
3 つ目の TelephoneNumber のタイプ。3 つ目の TelephoneNumber を指定する場合、そのタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。Beeper、 FAX、HomePhone、MobilePhone、または OfficePhone。
3 つ目の TelephoneNumber の市外局番。
3 つ目の TelephoneNumber の国番号。
3 つ目の TelephoneNumber の内線。
3 つ目の TelephoneNumber の電話番号サフィックス。国番号や市外局番は含みません。3 つ目の TelephoneNumber を指定する場合、その番号は必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。
3 つ目の TelephoneNumber の URL (この番号に電子的に電話をかけることのできる URL)。
1 つ目の EmailAddress のタイプ。このタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。HomeEmail または OfficeEmail。
1 つ目の電子メールアドレス。1 つ目の電子メールアドレスは必須です。
2 つ目の EmailAddress のタイプ。2 つ目の EmailAddress を指定する場合、そのタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。HomeEmail または OfficeEmail。
2 つ目の電子メールアドレス。
3 つ目の EmailAddress のタイプ。3 つ目の EmailAddress を指定する場合、そのタイプは必須です。コマンド行、プロパティーファイル内のいずれかで指定する必要があります。値は任意の文字列ですが、次の既知のタイプのいずれかを指定できます。HomeEmail または OfficeEmail。
3 つ目の電子メールアドレス。
次のコマンドは、ユーザーのホームディレクトリ内のファイル JaneSmith.properties から User のプロパティーを読み込みます。
admin> add user -load ~/JaneSmith.properties |
次のコマンド (すべてを 1 行で入力) では、User オブジェクトの作成に最低限必要なプロパティーを指定しています。
admin> add user -ln Smith -postaltype Office -country US -phonetype Office -number 333-3333 -emailtype OfficeEmail -emailaddress JaneSmith@JaneSmith.com -alias 123 -keypass 123456 |
RegistryPackage の場所を変更します。
cd コマンドは、指定されたパスまたは指定された URN を持つ RegistryPackage にディレクトリ (メタファー) を変更します。
このコマンドは、(現在のロケールに対して) 同じパスを持つ RegistryPackage オブジェクトが複数存在する場合には、指定された URN に変更します。
レジストリのルートからリポジトリ内の特定のオブジェクトまでの、複数のレジストリオブジェクト名から成るパス。各オブジェクト名の前にはスラッシュ (/) を付けます。
たとえば、registry RegistryPackage (これ自身はどの RegistryPackage のメンバーにもなっていない) のメンバーになっている userData RegistryPackage のロケータは /registry/userData であり、その userData RegistryPackage のメンバーになっている folder1 RegistryPackage のロケータは /registry/userData/folder1 です。
RegistryPackage の URN。これは、urn: で始まる URN である必要があります。
次のコマンドは、URN urn:uuid:92d3fd01-a929-4eba-a5b4-a3f036733017 を持つ RegistryPackage にディレクトリを変更します。
admin> cd urn:uuid:92d3fd01-a929-4eba-a5b4-a3f036733017 |
次のコマンドは、場所 /registry/userData/myData にディレクトリを変更します。
admin> cd /registry/userData/myData |
特定の RegistryObject の所有者を変更します。
chown コマンドは、先行する select コマンドで選択されたオブジェクトの所有者を、URN として指定されたユーザー、または先行する users コマンドで表示された一覧内の URN への参照として指定されたユーザーに変更します。
このコマンドを正常に実行できるのは、管理者のロールを持つユーザーだけです。
URN によって指定された User オブジェクト。
先行する users コマンドで表示された一覧内に含まれる User オブジェクトの URN への番号参照。
次のコマンドは、選択されたオブジェクトの所有者を、URN urn:uuid:26aa17e6-d669-4775-bfe8-a3a484d3e079 で指定されるユーザーに変更します。
admin> chown urn:uuid:26aa17e6-d669-4775-bfe8-a3a484d3e079 |
次のコマンドは、選択されたオブジェクトの所有者を、先行する users コマンドで番号 2 に対応しているユーザーに変更します。
admin> chown %2 |
ファイルとフォルダをレジストリにコピーします。
cp コマンドは、フォルダおよびファイルをそれぞれ RegistryPackage オブジェクトおよび ExtrinsicObject オブジェクトとして、レジストリ内にコピーします。
ファイルやフォルダのコピー元となるローカルファイルシステム上のローカルディレクトリはデフォルトで、管理ツールの起動元である現在のディレクトリになります。-localdir オプションを使えば、管理ツール起動時にローカルディレクトリを変更できます。また、lcd コマンドを使えば、管理ツール起動後にローカルディスクを変更できます。show localdir コマンドを使えば、現在のローカルディレクトリの絶対パスを取得できます。
このコマンドは再帰的です。つまり、ユーザーが特定のディレクトリを指定すると、このコマンドはそのディレクトリの下にあるすべてのファイルとフォルダをコピーします。
引数の URN または %index に指定されたユーザーに、コピー先のレジストリオブジェクトの所有者を設定します。これらの引数については、chown コマンドの説明を参照してください。自分以外の所有者を指定するには、管理者のロールを持っている必要があります。
指定されたパターンを名前に含むファイル以外のすべてのファイルをコピーします。ここで、pattern は、リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターンです。
このオプションは複数回指定可能です。
指定されたパターンを名前に含むファイルをすべてコピーします。ここで、pattern は、リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターンです。
このオプションは複数回指定可能です。
コピー対象のファイルまたはフォルダ。リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターンを使って指定します。pattern は複数個指定可能です。
次のコマンドは、ディレクトリ mydir をレジストリにコピーし、その所有者として、先行する users コマンドの番号 4 に対応するユーザーを設定します。
admin> cp -owner %4 mydir |
次のコマンドは、ディレクトリ mydir をレジストリにコピーします。ただし、文字列 .z、.c のいずれかで終わるファイルやディレクトリは除外されます。
admin> cp mydir -exclude \\.z -exclude \\.c |
特定の文字列をエコーします。
echo コマンドは、指定された string を出力先にエコーします。このコマンドは、管理ツールをバッチモードで実行する場合に -command オプション内で指定すると、非常に便利です。
文字シーケンス。
次のコマンドは、「date」と ls コマンドの結果をログファイルに出力します。
java -jar admin-tool.jar -command "echo ”date”; ls" > admin.log |
コマンドに関する情報を表示します。
help コマンドは、利用可能なコマンドまたは指定された特定のコマンドに関する情報を表示します。
add や show など、サブコマンドを持つコマンドが指定された場合、help コマンドはそのサブコマンドに関する情報を表示します。
引数が指定されなかった場合、help コマンドは、すべてのコマンドの使用法に関する情報を表示します。
特定の管理ツールコマンドの名前。
次のコマンドは、すべてのコマンドの使用法に関する情報を表示します。
admin> help |
次のコマンドは、lcd コマンドの使用法に関する情報を表示します。
admin> help lcd |
次のコマンドは、add サブコマンドの使用法に関する情報を表示します。
admin> help add |
ローカルファイルシステム上の現在のディレクトリを変更します。
lcd コマンドは、ローカルファイルシステム上の現在のローカルディレクトリを変更します。
引数が指定されなかった場合、lcd コマンドは、現在のディレクトリをユーザーのデフォルトホームディレクトリに変更します。
ディレクトリ名。絶対パス、相対パスのいずれを使ってもかまいません。
次のコマンドは、現在のローカルディレクトリを /usr/share ディレクトリに変更します。
admin> lcd /usr/share |
次のコマンドは、ローカルファイルシステム上の現在のローカルディレクトリをユーザーのデフォルトホームディレクトリに変更します。
admin> lcd |
現在の RegistryPackage 内のオブジェクトを一覧表示します。
引数が指定されなかった場合、ls コマンドは、現在の RegistryPackage 内のオブジェクトを一覧表示します。pattern または URN が指定された場合は、現在の RegistryPackage 内のオブジェクトのうち、(現在のロケールにおける) 名前または一意の識別子が pattern または URN に一致するものを一覧表示します。
リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターン。pattern は複数個指定可能です。
urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd などの、urn: で始まる URN。URN は複数個指定可能です。この URN は、オブジェクトの論理識別子ではなく、一意の識別子である必要があります。
次のコマンドは、現在の RegistryPackage 内のすべてのオブジェクトを一覧表示します。
admin> ls |
次のコマンドは、パターン urn:bird:poultry:chicken に一致する名前を持つか urn:bird:poultry:chicken を ID に持つすべてのオブジェクトを一覧表示します。
admin> ls urn:bird:poultry:chicken |
次のコマンドは、パターン *bird* に一致する名前を持つすべてのオブジェクトを一覧表示します (*bird* が有効な ID である場合、このコマンドは、*bird* を ID に持つオブジェクトも一覧表示する)。
admin> ls *bird* |
次のコマンドは、パターン *bird* に一致する名前を持つか、パターン urn:bird:poultry:chicken に一致する名前を持つか、urn:bird:poultry:chicken を ID に持つような、すべてのオブジェクトを一覧表示します。
admin> ls *bird* urn:bird:poultry:chicken |
現在の RegistryPackage へのパスを表示します。
pwd コマンドは、現在の RegistryPackage への 1 つまたは複数のパスを、現在のロケールにもっともふさわしい名前を使って表示します。また、そのパスに対するロケールも表示します。
admin> pwd (en_US) /registry/userData |
管理ツールを終了します。
quit コマンドは管理ツールを終了します。
admin> quit |
特定の RegistryPackage からオブジェクトを削除します。
rm コマンドは、現在の RegistryPackage のメンバーオブジェクトのうち、(現在のロケールにおける) 名前が pattern または URN で指定されたパターンに一致するものを削除します。
一致する RegistryObject が複数の RegistryPackage オブジェクトのメンバーになっている場合、このコマンドは、現在の RegistryPackage とそのオブジェクトとの間の関連付けだけを削除します。そのオブジェクトがレジストリから削除されるのは、ほかの RegistryObject との関連付けが 1 つも存在しない場合だけです。
一致するメンバーオブジェクト自身がほかのオブジェクトを含む RegistryPackage である場合には、-r、-d のいずれかのオプションが指定されない限り、そのオブジェクトが削除されたり、現在の RegistryPackage とそのメンバー RegistryPackage との間の関連付けが削除されたりすることはありません。
-d オプションと -r オプションが両方とも指定された場合は -d オプションが再帰的に適用されますが、これは、-r の選択対象となるすべてのオブジェクト (とそれらの関連付け) が、ほかの関連付けの有無にかかわらず削除されるようにするためです。
現在の RegistryPackage と指定された RegistryPackage との間の関連付けを削除します。指定された RegistryPackage が削除されるのは、残りの関連付けが自身のメンバーオブジェクトに対するものだけである場合に限ります。削除された RegistryPackage のメンバーオブジェクトのうち、ほかの HasMember 関連付けのターゲットとして固定されていないものは、レジストリのルートのメンバーとしてアクセスできるようになります。
指定された RegistryPackage オブジェクトとその配下にあるすべてのオブジェクトを削除します (ただし、ほかの関連付けを持つオブジェクトが存在する場合を除く)。
リテラル文字と、特殊文字のアスタリスク (*) (0 個以上の文字を表現) または疑問符 (?) (1 文字を表現) で構成されるパターン。pattern は複数個指定可能です。
urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd などの、urn: で始まる URN。URN は複数個指定可能です。
次のコマンドは、文字列 "stat" を含むすべての RegistryPackage オブジェクトと、それらの配下にあるすべてのオブジェクトを削除します。
admin> rm -r *stat* |
SQL の select 文を実行します。
select コマンドは、コマンド全体を 1 つの SQL クエリーとして評価することで、指定されたオブジェクトを選択および一覧表示します。引数が指定されなかった場合、このコマンドは、先行する select コマンドまたは -sqlselect オプションによって選択されたすべてのオブジェクトを一覧表示します。
SQL の select 文 (ただし、先頭の select はすでにコマンド名として存在しているので含めない)。
次のコマンドは、レジストリ内のすべての ClassificationScheme オブジェクトを一覧表示します。
admin> select s.* from ClassificationScheme s |
特定のプロパティーの値を設定します。
set コマンドは、管理ツールシェルの特定のプロパティーの値を設定します。
ツールがサポートするプロパティーと値は、次のとおりです。
set debug {true | on | yes | false | off | no}デバッグメッセージの出力を有効または無効にします。
set editor string対話型エディタ起動時に管理ツールが使用するコマンドを設定します。UNIX および Linux システムにおけるデフォルト値は /bin/vi です。
set verbose { true | on | yes | false | off | no}コマンド実行時における冗長メッセージの出力を有効または無効にします。
次のプロパティーのいずれかです。debug、editor、verbose。
指定されたプロパティーのサポートされている値。詳細については、「説明」を参照してください。
次のコマンドは、エディタをデフォルトの /bin/vi ではなく、/usr/bin/vi に設定します。
admin> set editor /usr/bin/vi |
次のコマンドは、デバッグをオンにします。
admin> set debug true |
次のコマンドは、冗長な出力をオフにします。
admin> set verbose off |
特定のプロパティーの値を表示します。
show コマンドは、管理ツールシェルの特定のプロパティーの値を表示します。
引数が指定されなかった場合、このコマンドはすべてのプロパティーの値を表示します。
このコマンドがサポートするプロパティーは、次のとおりです。
デバッグ出力が有効になっているかどうか。
対話型エディタ起動時に管理ツールが使用するエディタ。
直前に実行されたコマンドで発生した例外スタックトレース (存在する場合のみ)。
ローカルファイルシステム上の現在のディレクトリ。このプロパティーを設定するには lcd コマンドを使用します。詳細については、「lcd」を参照してください。
現在のロケール。
冗長出力が有効になっているかどうか。
現在の値を表示すべきプロパティー。プロパティー exception と locale については、表示は可能ですが、set コマンドによる値の設定は行えません。
次のコマンドは、直前のコマンドで発生した例外を表示します。
admin> show exception |
現在の User オブジェクトを一覧表示します。
users コマンドは、現在レジストリ内に存在している User オブジェクトを一覧表示します。
出力の書式は次のとおりです。
%index: URN lastname, firstname middlename |
出力内の index は数値ですが、chown コマンドまたは cp コマンドを実行する際にこの数値をパーセント記号 (%) も含めて使用すれば、特定のユーザーを参照することができます。 lastname、firstname、および middlename は、ユーザーの姓、名、およびミドルネームです。
次のコマンドは、現在のユーザーを表示します。
admin> users %0: urn:freebxml:registry:predefinedusers:registryoperator Operator, Registry %1: urn:freebxml:registry:predefinedusers:registryguest Guest, Registry %2: urn:freebxml:registry:predefinedusers:farrukh Najmi, Farrukh Salahudin %3: urn:freebxml:registry:predefinedusers:nikola Stojanovic, Nikola %4: urn:uuid:799cc524-b7cd-4e51-8b34-d93b79ac52de User, Test %5: urn:uuid:85428d8e-1bd5-473b-a8c8-b9d595f82728 Parker, Miles |