CLI による作業

CLI コマンドの呼び出し

CLI は、一度に 1 つのコマンドを実行する単一行コマンドモードで動作するコマンド pgtool で構成されています。pgtool には、「コマンドの要約」で説明されている多数のサブコマンド、オプション、オペランドがあります。オプションは、フルキーワードまたは短いキーワード (ショートカット) を使用して指定できます。以降のコマンドの説明では、フルキーワードを使用します。対応するショートカットは、表 3–2 を参照してください。

CLI で必要となるブートストラップ情報

要素とプロファイルが含まれるデータストアを見つけ、照会を行うには、ブートストラップ情報が必要です。必要なブートストラップ情報は、サーバー、ポート番号、ベース識別名 (DN)、および管理者のユーザー名です。この情報はコマンド行で指定することも、ブートストラップファイルで指定することもできます。

ブートストラップファイル

ブートストラップ情報は、プロパティーファイルから読み取ることができます。このファイルの場所は、コマンド行で --file オプションによって指定できます。

--file=<bootstrap file> : ブートストラップファイルの完全修飾パス。デフォルトのファイルは $HOME/pgtool.properties です。

例: --file=/var/opt/apoc/cli.properties

ファイルの書式については、『Sun Desktop Manager 1.0 インストールガイド』の付録 A「構成パラメータ」の付録 A「構成パラメータ」を参照してください。

ブートストラップのオプション

ブートストラップは、コマンド行で --url オプションおよび --username オプションを使用して指定できます。

--url=<url> : データストアを識別する URL。URL の書式は ldap://<hostname>:<port>/<base name> です。<hostname> はサーバー名 (デフォルトは localhost)、<port> はサーバー上のポート名 (デフォルトは 389)、および <base name> はベースエントリの識別名です。

例: --url=ldap://server1.sun.com:399/o=apoc.

--username=<username> : ストレージバックエンドで使用される書式による管理者のユーザー名。これによって、管理者はパスワードの入力を求められます。このオプションを指定しない場合に、管理者が pgtool login サブコマンドを使用していないときは、ユーザー名とパスワードの入力を求めるメッセージが表示されます。

例: --username=“jmonroe”.

ユーザー名とパスワードによる認証

コマンドを実行するたびにユーザー名とパスワードが必要です。

ログインコマンドによる認証

CLI には、管理者のホームディレクトリの資格情報ファイルにユーザー名とパスワードのペアを保存できるログインコマンドがあります。そのファイルの名前は .apocpass です。.apocpass ファイルへのアクセスは制限されています。

認証が成功すると、ユーザー名とパスワードのペアのエントリが .apocpass ファイルに追加されます。このペアに対するキーがサーバー / ポート / ベース DN およびユーザー名で構成されるので、ユーザー名とパスワードのペアがその他のバックエンドに対して同じファイルに格納できます。

ログインコマンドが正常に完了すると、ユーザー名またはパスワードを指定することなくほかの CLI コマンドを実行できます。

login コマンドの使用法の詳細は、「ログイン」を参照してください。

その他のコマンドの認証

ほかのコマンドについては、CLI はまず現在のユーザー用の .apocpass ファイルが存在するかどうかをチェックします。

このファイルが存在しないと、ユーザー名とパスワードの入力を求めるメッセージが表示されます。このユーザー名とパスワードの認証が正常に完了すると、コマンドが実行されます。

資格情報ファイルが存在し、かつコマンド行にユーザー名が指定された場合、CLI はホスト、ポート、ベース DN、およびユーザー名のエントリを検索します。エントリが存在すると、保存されているユーザー DN とパスワードが使用されてコマンドが実行されます。エントリが存在しないと、パスワードの入力を求めるメッセージが表示されます。

コマンド行でユーザー名が指定されないと、.apocpass ファイルが検索され、ホスト / ポートとベース DN のペアを使用した鍵の確認が行われます。このペアが一意のエントリとして存在する場合、保存されているユーザー DN とパスワードが使用されてコマンドが実行されます。エントリが一意でない場合、ユーザー名の入力を求めるメッセージが表示されます。これがエントリと一致すると、保存されているユーザー DN とパスワードが使用されてコマンドが実行されます。これが一致しないと、パスワードの入力を求めるメッセージが表示されます。

パスワードの入力を求めるメッセージがユーザーに表示される場合は、.apocpass ファイル内の、このホスト / ポートとベース DN のペアのエントリが使用されてユーザー名とパスワードの認証が行われます。そのようなエントリが存在しない場合には、匿名アクセスが使用されて認証が行われます。

コマンドの実行

コマンドを使用するたびにデータストアに対する接続と初期化が行われ、コマンド実行が完了したところで終了します。error を生成してコマンドが終了しても、構成プロファイルに対する変更は加えられていません。

要素の表現

要素は、LDAP の完全な識別名 (DN) を使用して表されます。

例: uid=jmonroe,ou=People,o=apoc.