この章では、amadmin コマンド行ツールについて説明します。
コマンド行実行可能ファイル amadmin の第一目的は、XML サービスファイルをデータストアにロードすることと、DIT 管理タスクのバッチ処理を実行することです。amadmin は AccessManager-base/SUNWam/bin にあり、次の目的に使用します。
XML サービスファイルのロード - 管理者は sms.dtd で定義された XML サービスファイル形式に従って記述されたサービスを Access Manager にロードします。すべてのサービスは amadmin を使用してロードする必要があります。Access Manager コンソールでインポートすることはできません。
XML サービスファイルは、Access Manager で参照される XML データの静的 BLOB としてデータストアに格納されます。この情報は、LDAP だけを利用する Directory Server では使用されません。
DIT に対するアイデンティティーオブジェクトのバッチ更新の実行 - 管理者は amadmin.dtd に定義されたバッチ処理用 XML ファイル形式を使用して、Directory Server DIT に対するバッチ更新を実行できます。たとえば、管理者が組織を 10 個、ユーザーを 1000 名、およびグループを 100 個作成する場合、この要求を 1 つ以上のバッチ処理用 XML ファイルに置いて、amadmin でロードすることで、1 回で作成できます。
amadmin は、Access Manager コンソールの機能の一部だけをサポートしており、コンソールの代わりに使用することは想定していません。比較的小規模な管理作業にはコンソールを使用し、比較的大規模な管理作業には 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 | --passwordfile パスワードファイル [-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 ファイル [xmlf ファイル 2 ] ...
2 連続するハイフンは、構文に示すとおりに入力する必要があります。
次に、amadmin コマンド行パラメータオプションの定義について説明します。
--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 は必須のオプションであり、--runasdn オプションで指定した DN のパスワードを指定します。
--locale には、ロケール名を指定します。このオプションは、メッセージ言語のカスタマイズに使用できます。指定しない場合は、デフォルトのロケールである en_US が使用されます。
--continue は、エラーがある場合でも XML ファイルを処理し続けます。たとえば、同時にロードされる XML ファイルが 3 つあり、最初の XML ファイルがエラーになった場合、amadmin では残りのファイルをロードし続けます。continue オプションは、個別の要求のみに適用されます。
--session (-m) は、セッションを管理したり、現在のセッションを表示したりします。--runasdn を指定するときは、AMConfig.properties のスーパーユーザーの DN、または最上位の管理ユーザーの ID と同じでなければなりません。
次の例では、特定のサービスホスト名に対するすべてのセッションを表示します。
amadmin -u uid=amadmin,ou=people,dc=iplanet,dc=com -v -w 12345678 -m http://sun.com:58080
次の例では、特定のユーザーのセッションを表示します。
amadmin -u uid=amadmin,ou=people,dc=iplanet,dc=com -v -w 12345678 -m http://sun.com:58080 username
セッションを中断するには、対応するインデックス番号をパターンに指定します。複数のセッションを中断するには、複数のインデックス番号をスペース区切りでパターンに指定します。
次のオプションを使用する場合
amadmin -m | --session サーバー名パターン
パターンには、ワイルドカード (*) も使用できます。このパターンにワイルドカード (*) を使用する場合は、メタ文字 (\\) を使ってシェルからエスケープする必要があります。
--debug は、/var/opt/SUNWam/debug ディレクトリに作成される amAdmin ファイルにメッセージを書き込みます。このメッセージは技術的には詳細なものですが、多言語対応ではありません。amadmin の操作ログを生成するには、データベースのログ書き込み時に、データベースドライバのクラスパスを手作業で追加する必要があります。たとえば、mysql にログを書き込むときに、amadmin に次の行を追加します。
CLASSPATH=$CLASSPATH:/opt/IS61/SUNWam/lib/mysql-connector-java-3.0.6-stable-bin.jar export CLASSPATH
--verbose は、amadmin コマンドの処理状況の全体を画面に出力します。ファイルには詳細な情報を出力しません。コマンド行のメッセージ出力は、多言語対応です。
--data には、インポートされるバッチ処理用 XML ファイルの名前を指定します。1 つ以上の XML ファイルを指定できます。この XML ファイルではさまざまなディレクトリオブジェクトを作成、削除、および読み取ることができるほか、サービスを登録および登録解除できます。
--schema は、Access Manager サービスの属性を Directory Server にロードします。サービス属性が定義されている XML サービスファイルを引数に取ります。この XML サービスファイルは、sms.dtd を基にしています。1 つ以上の XML ファイルを指定できます。
DIT に対するバッチ更新を設定するか、サービススキーマおよび設定データをロードするかによって、--data または --schema オプションを指定する必要があります。
--deleteservice は、サービスとそのスキーマだけを削除します。
--serviceName は、XML サービスファイルの Service name=... タグに指定されているサービス名の値です。この部分を 「--serviceName」に示します。
... <ServicesConfiguration> <Service name="sampleMailService" version="1.0"> <Schema serviceHierarchy="/other.configuration/sampleMailService" i18nFileName="sampleMailService" i18nKey="iplanet-am-sample-mail-service-description"> ... |
--help は、amadmin コマンドの構文を表示する引数です。
--version は、ユーティリティー名、製品名、製品バージョン、および法律上の通知を表示する引数です。
この節では、連携管理で使用する amadmin のパラメータを示します。連携管理の詳細は『Access Manager Federation Management Guide』を参照してください。
amadmin -u|--runasdn <ユーザーの DN> -w|--password <パスワード> または -f|--passwordfile <パスワードファイル> -e|--entityname <エンティティー名> -g|--import <XML ファイル>
ユーザーの DN
ユーザーのパスワードです。
ユーザーのパスワードが書かれているファイルの名前です。
エンティティー名。たとえば、http://www.example.com などです。エンティティーは、1 つの組織に属していなければなりません。
メタ情報を保持する XML ファイルです。このファイルは Liberty のメタ仕様と XSD に従わなければなりません。
amadmin -u|--runasdn <ユーザーの DN>
-w|--password <パスワード> または -f|--passwordfile <パスワードファイル> -e|--entityname <エンティティー名> -o|--export <ファイル名>
ユーザーの DN
ユーザーのパスワードです。
ユーザーのパスワードが書かれているファイルの名前です。
Directory Server にあるエンティティー名です。
エンティティーの XML が書かれているファイルの名前です。XML は Liberty のメタ XSD に準拠していなければなりません。
amadmin -u|--runasdn <ユーザーの DN> -w|--password <パスワード> または -f|--passwordfile <パスワードファイル> -e|--entityname <エンティティー名> -q|--exportwithsig <ファイル名>
ユーザーの DN
ユーザーのパスワードです。
ユーザーのパスワードが書かれているファイルの名前です。
Directory Server にあるエンティティー名です。
エンティティーの XML が書かれているファイルの名前です。このファイルはデジタル署名されています。XML は Liberty のメタ XSD に準拠していなければなりません。
下の節では、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] <ロケール>