Sun Java System Identity Server 2004Q2 管理ガイド |
第 10 章
amadmin コマンド行ツールこの章では、amadmin コマンド行ツールについて説明します。この章は、次の節で構成されています。
amadmin コマンド行実行可能ファイルコマンド行ツール amadmin の第一の目的は、XML サービスファイルを Directory Server にロードして、DIT で管理タスクのバッチ処理を実行することです。amadmin は、IdentityServer_base/SUNWam/bin にあり、次の目的に使用します。
- XML サービスファイルのロード - 管理者は sms.dtd で定義された XML サービスファイル形式を使用するサービスを Identity Server にロードします。すべてのサービスは amadmin を使用してロードする必要がありますが、Identity Server コンソールでインポートすることはできません。
注
XML サービスファイルは、Identity Server で参照される XML データの静的なかたまりとして Directory Server に格納されます。この情報は、LDAP だけを使用できる Directory Server では使用されません。
- DIT に対するアイデンティティオブジェクトのバッチ更新の実行 - 管理者は amadmin.dtd に定義されたバッチ処理用 XML ファイル形式を使用して、Directory Server DIT に対するバッチ更新を実行できます。たとえば管理者が組織を 10、ユーザーを 1000、およびグループを 100 作成する場合、この要求を 1 つ以上のバッチ処理用 XML ファイルに置いて、amadmin でロードすることで、1 回で作成できます。詳細については、『Identity Server Developer's Guide』の「Service Management」の章を参照してください。
amadmin の構文
amadmin を使用するために従わなくてはならない構造的な規則があります。amadmin ツールの一般的な構文は次のとおりです。
- amadmin -u | --runasdn DN 名 -w | --password パスワード [-l | --locale ロケール名] [[-v | --verbose] | [-d |--debug]] -t | --data XML ファイル 1 [XML ファイル 2 ...]
- amadmin -u | --runasdn DN 名 -w | --password パスワード [-l | --locale ロケール名] [[-v | --verbose] | [-d | --debug]] -s | --schema XML ファイル 1 [XML ファイル 2 ...]
- amadmin -u | --runasdn DN 名 -w | --password パスワード [-l | --locale ロケール名] [[-v | --verbose] | [-d | --debug]] -r | --deleteService サービス名 1 [サービス名 2 ...]
- amadmin -u | --runasdn DN 名 -w | --password パスワード または -f | --password file パスワードファイル [-c | --continue] [-l | --locale ロケール名] [[-v | --verbose] | [-d | --debug]] -m | --session サーバー名 パターン
- amadmin -h | --help
- amadmin -n | --version
- amadmin -u | --runasdn DN 名 -w | --password パスワード または - f |--passwordfile パスワードファイル [-l | --locale ロケール名] [[-v | --verbose] | [-d] |--debug]] -a |--addAttributes サービス名 スキーマタイプ XML ファイル[XML ファイル 2] ...
amadmin のオプション
次に、amadmin コマンド行パラメータオプションの定義を説明します。
--runasdn (-u)
--runasdn は、LDAP サーバーに対してユーザーを認証します。引数は、amadmin を実行できるように承認されたユーザーの識別名 (DN) の値です。たとえば次のようになります。
--runasdn uid=amAdmin,ou=People,o=iplanet.com,o=isp
DN は、ドメイン要素間にスペースを挿入し、DN 全体を二重引用符で囲むこともできます。たとえば次のようになります。--runasdn "uid=amAdmin, ou=People, o=iplanet.com, o=isp"
--password (-w)
--password は必須のオプションであり、--runasdn オプションで指定した DN のパスワードの値になります。
--locale (-l)
--locale は、ロケール名の値になります。メッセージ言語をカスタマイズするために使用できます。指定しない場合は、デフォルトのロケールである en_US が使用されます。
--continue (-c)
--continue は、エラーがある場合でも XML ファイルを処理し続けます。たとえば同時にロードされる XML ファイルが 3 つあり、最初の XML ファイルがエラーになった場合、amadmin では残りのファイルをロードし続けます。
--session (-m)
--session (-m) は、セッションを管理したり、現在のセッションを表示したりします。--runasdn を指定するときは、AMConfig.properties のスーパーユーザーの DN、または最上位の管理ユーザーの ID と同じでなければなりません。
次の例では、特定のサービスホスト名に対するすべてのセッションを表示します。
次の例では、特定のユーザーのセッションを表示します。
セッションを中断するには、対応するインデックス番号を入力します。複数のセッションを中断するには、複数のインデックス番号をスペース区切りで入力します。
次のオプションを使用する場合
amadmin -m | --session サーバー名 パターン
パターンには、ワイルドカード (*) も使用できます。このパターンにワイルドカード (*) を使用する場合は、メタ文字 (¥) を使ってシェルからエスケープする必要があります。
--debug (-d)
--debug は、/var/opt/SUNWam/debug ディレクトリに作成される amAdmin ファイルにメッセージを書き込みます。このメッセージは技術的には詳細なものですが、i18n 互換ではありません。amadmin の操作ログを生成するには、データベースのログ書き込み時に、データベースドライバのクラスパスを手作業で追加する必要があります。たとえば、mysql にログを書き込むときに、amadmin に次の行を追加します。
--verbose (-v)
--verbose は、amadmin コマンドの処理状況の全体を画面に出力します。ファイルには詳細な情報を出力しません。コマンド行のメッセージ出力は、i18n 互換です。
--data (-t)
--data は、インポートされるバッチ処理用 XML ファイルの名前の値です。1 つ以上の XML ファイルを指定できます。この XML ファイルではさまざまなディレクトリオブジェクトを作成、削除、および読み取ることができるほか、サービスを登録および登録解除できます。このオプションに渡される XML ファイルの種類の詳細については、『Identity Server Developer's Guide』の「Service Management」の章を参照してください。
--schema (-s)
--schema は、Identity Server サービスの属性を Directory Server にロードします。サービス属性が定義されている XML サービスファイルを引数に取ります。この XML サービスファイルは、sms.dtd を基にしています。1 つ以上の XML ファイルを指定できます。
--deleteservice (-r)
--deleteservice は、サービスとそのスキーマだけを削除します。
--serviceName
--serviceName は、XML サービスファイルの Service name=... タグに指定されているサービス名の値です。この部分をコード例 10-1 に示します。
--help (-h)
--help は、amadmin コマンドの構文を表示する引数です。
--version (-n)
--version は、ユーティリティ名、製品名、製品バージョン、および法律上の通知を表示する引数です。
amadmin を連携管理に使用する
この節では、連携管理で使用する amadmin のパラメータを示します。連携管理の詳細は『Identity Server Federation Management Guide』を参照してください。
Liberty のメタに準拠した XML を Directory Server にロードする
amadmin -u|--runasdn < ユーザーの DN >
--runasdn (-u)
ユーザーの DN
--password (-w)
ユーザーのパスワード
--passwordfile (-f)
ユーザーのパスワードが書かれているファイルの名前です。
--encrypt (-e)
エンティティ名。たとえば、 http://www.example.com などです。エンティティは、1 つの組織に属していなければなりません。
--import (-g)
メタ情報を保持する XML ファイルです。このファイルは Liberty のメタ仕様と XSD に従わなければなりません。
エンティティをデジタル署名なしで XML ファイルにエクスポートする
amadmin -u|--runasdn < ユーザーの DN >
-w|--password <パスワード> または -f|--passwordfile <パスワードファイル>
--runasdn (-u)
ユーザーの DN
--password (-w)
ユーザーのパスワード
--passwordfile (-f)
ユーザーのパスワードが書かれているファイルの名前です。
--encrypt (-e)
Directory Server にあるエンティティ名です。
--export (-o)
エンティティの XML が書かれているファイルの名前です。XML は Liberty のメタ XSD に準拠していなければなりません。
エンティティをデジタル署名つきで XML ファイルにエクスポートする
amadmin -u|--runasdn < ユーザーの DN >
--runasdn (-u)
ユーザーの DN
--password (-w)
ユーザーのパスワード
--passwordfile (-f)
ユーザーのパスワードが書かれているファイルの名前です。
--encrypt (-e)
Directory Server にあるエンティティ名です。
--export (-o)
エンティティの XML が書かれているファイルの名前です。このファイルはデジタル署名されています。XML は Liberty のメタ XSD に準拠していなければなりません。
リソースバンドルに amadmin を使用する
以下の節では、amadmin 構文を使ってリソースバンドルの追加、検索、および削除を行う方法を説明します。
リソースバンドルを追加する
amadmin -u|--runasdn <ユーザーのDN> -w|--password <ユーザーのパスワード>
-b|--addresourcebundle <リソースバンドル名>
-i|--resourcebundlefilename <リソースバンドルファイル名>
[-R|--resourcelocale] <ロケール>
リソース文字列を得る
amadmin -u|--runasdn <ユーザーのDN> -w|--password <ユーザーのパスワード>
-z|--getresourcestrings <リソースバンドル名>
[-R|--resourcelocale] <ロケール>
リソースバンドルを削除する
amadmin -u|--runasdn <ユーザーのDN> -w|--password <ユーザーのパスワード>
-j|--deleteresourcebundle <リソースバンドル名>
[-R|--resourcelocale] <ロケール>