| InfoDirectory SDK 使用手引書 |
|
目次
索引
|
| 付録A コマンドリファレンス |
名前
ldapsearch - エントリの検索
形式
ldapsearch -b basedn [-n][-v][-h host][-p port][-V n][-D binddn][-w passwd|-W][-H][-t][-Q attr][-U path][-u][-A][-e][-E attr][-S attr][-x][-P pagesize][-s scope][-a deref][-l time][-z size][-C char_type][-Z file][-Y file][-R][-r][-O times]{filter|-f file "%s"}[attributes ...]
機能説明
InfoDirectoryサーバのエントリを、検索フィルタで指定された条件で検索し、参照します。検索でヒットしたエントリは、標準出力にLDIFで出力されます。
サーチベースのDNを指定します。ここを起点に検索をします。root DSEを検索する場合は、“-b ""”と指定します。
InfoDirectoryサーバに対してバインド要求だけ送信します。削除要求は送信されません。InfoDirectoryサーバの起動確認などに使用します。
詳細情報を出力します。
host パラメタにInfoDirectoryサーバのホスト名、またはIPアドレスを指定します。このオプションを省略した場合は、自ホスト(127.0.0.1)へアクセスします。また、複数のホストは指定できません。
port パラメタにInfoDirectoryサーバのTCPポート番号を指定します。デフォルト(指定がない場合、または0を指定した場合)はポート番号389になります。
V3指定時に-Zオプションを使用した場合のデフォルトは、ポート番号636となります。
n パラメタにLDAPプロトコルバージョンを指定します(2または3)。このオプションを省略した場合、LDAPプロトコルバージョンは3となります。
BINDするDNをbinddn パラメタに指定します。DNは、RFC2253で定義される文字列表現を用いたDNである必要があります。
またbinddn に空白、“*”（アスタリスク）、“\”（エンマーク）といった特殊文字を含む場合、“ "" ”（ダブルクォーテーション）で囲む必要があります。このオプションを省略した場合、アノニマスでBINDされます。
-Dオプションで指定したDNの簡易認証用のパスワードをpasswd パラメタに指定します。本オプションを指定する場合は、同時に-Dオプションを指定する必要があります。
また、-Wオプションとの併用はできません。
対話入力で簡易認証用のパスワードを指定します。入力可能文字数は1 〜 256です。本オプションを指定する場合は、同時に-Dオプションを指定する必要があります。また、-wオプションとの併用はできません。何も入力しないで実行した場合、簡易認証用のパスワードは設定されません。
usageを表示します。
/tmp配下に検索結果のファイルを生成します。
V3を指定した場合、属性値はBase64エンコード形式でファイルに格納されます。ファイル名には、一意的な名前がつけられます。作成されたファイル名は、標準出力に表示されます。
/tmpに指定された属性attr の検索結果の属性値を保持したファイルを作成します。
ファイルの作成先は、-Uオプションで指定できます。検索結果は、バイナリまたはUTF-8でファイルに格納されます。ファイル名には、一意的な名前がつけられます。作成されたファイル名は、fileスキームのURL形式で標準出力に表示されます。属性の後に“;binary”が付加されて表示される属性を指定する場合は、“;binary”を付加した形式で属性を指定してください。
またこの場合、“;”は特殊な意味を持っているため、" "" "（ダブルクォーテーション）や、"\"（エンマーク）でエスケープする必要があります。
なお属性attr にDNは指定できません。
|
dn: cn=富士通 太郎, o=富士通, c=jp |
-Qオプションが指定される場合に、作成されるファイルの作成先のパスを指定します。
このオプションが指定されない場合は、/tmp に出力されます。
出力形式にユーザフレンドリ名を付加して表示します。ユーザフレンドリ名は、ufn: で始まる行です。
|
dn: cn=富士通 太郎, o=富士通, c=jp |
属性名だけを検索します。なお、値は表示されません。
属性値に非ASCII文字(日本語含む)を含む場合、その行をUTF8コードでBase64形式にエンコードして表示します(属性名と属性値との区切りは“::”)。
指定された属性attr の属性値に非ASCII文字(日本語を含む)を含む場合、その行をUTF8コードでbase64形式にエンコードして表示します(属性名と属性値との区切りは“::”)。複数の属性を指定する場合は、属性の間を空白で区切ります。
|
-E "cn sn telephonenumber" |
クライアントで属性attr について結果をソート（昇順）します。attr パラメタが“ "" ”（ダブルクォーテーション）である場合はDNでソートされます。サ―バ上で結果をソートする場合は、-xオプションを付加します。
InfoDirectoryサーバ上でソート（昇順）します。このオプションを指定する場合は、-Sオプションでソートするための属性を指定する必要があります。
またこのオプションを指定した場合、クライアントでのソートは行われません。このオプションを指定している場合に、サーバからリフェラルが通知されても、リフェラルの自動追跡は行われません。
検索結果をページサイズ（1度のリクエストで受取るエントリ数）の単位で受取ります。ページサイズは、pagesize パラメタで指定します。このオプションとクライアント上でのソートは併用できません。その場合は、ソートの指定は無視されます。ソートとの併用は、InfoDirectoryサーバ上でのソート(-x -S sttr)を使用してください。このオプションを指定している場合に、サーバからリフェラルが通知されても、リフェラルの自動追跡は行われません。
検索の範囲(scope パラメタ)を以下の3つのどれかを指定します。
別名の参照解決(deref パラメタ)をどのように行うかを以下の4つから指定します。
検索のタイムリミット（秒単位）およびBIND結果、検索結果の待ち時間（秒単位）をtime パラメタで指定します。デフォルトは無制限です。なお、指定したタイムリミットは、InfoDirectoryサーバの制限を超えない範囲で有効となります。
検索のサイズリミット（エントリ数）をsize パラメタで指定します。デフォルトは無制限です。なお、指定したサイズリミットは、InfoDirectoryサーバの制限を超えない範囲で有効となります。
パラメタおよびLDIFファイル内で使用する文字コード char_type を指定します。選択可能なコード系に関しては、コード変換を参照してください。
SSLを使用して、安全な通信、認証を行う場合に指定します。
file パラメタにはSSL環境設定に必要な項目を記述したファイル名を指定します。
環境設定の詳細に関しては、SSL通信を使用するにはを参照してください。
またSSLを使用する場合でも、BINDするDN、パスワードを指定する必要があります。
SSLを使用して、安全な通信、認証を行う場合に指定します。認証は、指定した証明書環境にある証明書を使用した証明書認証をします。
file パラメタにはSSL環境設定に必要な項目を記述したファイル名を指定します。
環境設定の詳細に関しては、SSL通信を使用するにはを参照してください。
この場合、BINDするDN、パスワードを指定する必要がありません。指定された場合、それらは無視されます。
InfoDirectoryサーバから通知されるリフェラル情報にしたがったリフェラル先への検索を行いません。このオプションを指定しない場合には、通知されたリフェラル先の情報にしたがって、リフェラル先のInfoDirectoryサーバに対し検索します。このオプションが指定される場合、通知されたLDAP URLが表示されます。また-Oオプションは無効になります。
InfoDirectoryサーバから通知されるリフェラル情報にしたがったリフェラル先への検索を行いません。このオプションを指定しない場合には、通知されたリフェラル先の情報にしたがって、リフェラル先のInfoDirectoryサーバに対し検索します。このオプションが指定される場合、正常終了時に通知されたLDAP URLは表示されません。エラー情報として通知されたLDAP URLは表示されます。また-Oオプションは無効になります。
1度のリクエストで通知されるリフェラル情報にしたがい、リフェラル先のInfoDirectoryサーバに検索を行う最大回数です。このオプションを指定しない場合には、最大5回通知されるリフェラル情報にしたがった検索します。-Rオプションが指定される場合、このパラメタは無効になります。
LDAP検索フィルタを指定します。-fオプションを使用し、検索フィルタをファイルから読み込む場合は、filterとして“%s”を指定する必要があります。検索フィルタとして指定可能な最大長は、512バイトまでです。検索フィルタの詳細に関しては、LDAP検索フィルタを参照してください。
LDAP検索フィルタを含むファイルを指定します。検索フィルタをファイルから読み込む場合は、filterとして“%s”を指定する必要があります。ファイルの詳細に関しては、LDAP検索フィルタを参照してください。
検索すべき属性を指定します。ここで属性を指定した場合、検索結果には、ここで指定された属性だけが通知されます（複数ある場合は空白で区切ります）。属性の指定がない場合は、全属性が検索結果として返されます。
以下のシンタックスが設定されている属性を指定する場合、属性名の後に";binary"を指定する必要があります。詳細は、サーバ側のInfoDirectory使用手引書“付録 サポート属性”を参照してください。
|
Audio |
復帰値
0：正常終了
0以外：異常終了
各オプションのデフォルト値、V2/V3サポートは、以下の表を参照してください。
表: ldapsearchコマンドオプション一覧
|
オプション |
機能概要 |
省略時の値 |
V2指定時 |
V3指定時 |
|---|---|---|---|---|
|
サーチベースをbasedn に指定します。 |
− |
◎ |
◎ |
|
|
InfoDirectoryサーバに対してバインド要求だけ送信します。検索要求は送信されません。 |
− |
○ |
○ |
|
|
詳細情報を出力します。 |
− |
○ |
○ |
|
|
host にInfoDirectoryサーバのホスト名、またはIPアドレスを指定します。 |
コマンド実行ホスト |
○ |
○ |
|
|
port にInfoDirectoryサーバのTCPポート番号を指定します。 |
-Zなし → 389 |
○ |
○ |
|
|
n にLDAPプロトコルバージョンを指定します(2または3)。 |
3 |
○ |
○ |
|
|
BINDするDNをbinddn に指定します。省略時はアノニマスバインドとなります。 |
アノニマスバインドをします。 |
○ |
○ |
|
|
passwd に簡易認証用のパスワードを指定します。 |
-Dオプション指定時は省略できません。 |
○ |
○ |
|
|
対話入力で簡易認証用のパスワードを指定します。 |
− |
○ |
○ |
|
|
Usageを表示します。 |
− |
○ |
○ |
|
|
/tmpに検索結果の属性値を保持したファイルを作成します。標準出力に作成したファイル名がフルパスで表示されます。 |
− |
○ |
○ |
|
|
/tmpに指定された属性attr の検索結果の属性値をバイナリまたはUTF-8で保持したファイルを作成します。標準出力に作成したファイル名がURL形式で表示されます。 |
− |
× |
○ |
|
|
-Qオプションが指定される場合に、作成されるファイルの作成先のパスを指定します。 |
/tmp |
× |
○ |
|
|
出力結果にユーザフレンドリ名を追加して出力します。 |
− |
○ |
○ |
|
|
属性名だけを検索結果に出力します。 |
− |
○ |
○ |
|
|
非ASCII文字をbase64形式にエンコードして出力します（V3のみ）。 |
− |
× |
○ |
|
|
指定された属性attr の非ASCII文字をbase64形式にエンコードして出力します。 |
− |
× |
○ |
|
|
属性attr で結果をソートします。 |
− |
○ |
○ |
|
|
InfoDirectoryサーバ上でソートします。 |
− |
× |
○ |
|
|
検索結果をpagesize の単位で受取ります。 |
無制限です。 |
× |
○ |
|
|
検索の範囲をscope で指定します(base,one,sub)。 |
sub |
○ |
○ |
|
|
別名の参照解決をderef に指定します。(never,always,search,find) |
never |
○ |
○ |
|
|
検索のタイムリミット(秒単位)およびBIND結果、検索結果の待ち時間(秒単位)をtime で指定します。 |
無制限です。 |
○ |
○ |
|
|
検索のサイズリミット（エントリ数）をsize で指定します。 |
無制限です。 |
○ |
○ |
|
|
コマンドで使用する文字コードを指定します。 |
EUC |
○ |
○ |
|
|
SSLによる安全な接続、認証をします。file に必要な環境設定を記述します。 |
− |
○ |
○ |
|
|
証明書認証をします。file に必要な環境設定を記述します。 |
− |
× |
○ |
|
|
リフェラルの自動追跡を行いません。通知されたLDAP URLを表示します。 |
リフェラルの自動追跡をします。 |
× |
○ |
|
|
リフェラルの自動追跡を行いません。通知されたLDAP URLを表示しません。 |
リフェラルの自動追跡をします。 |
× |
○ |
|
|
リフェラルの最大自動追跡回数を指定します。 |
5 |
× |
○ |
|
|
LDAP検索フィルタを含むファイルを指定します。 |
標準入力です。 |
○ |
○ |
◎…必須、○…サポート、×…未サポート
備考
LANG環境が日本語UTF-8である場合、または -C オプションで日本語UTF-8を指定する場合において、クライアントソート機能（-S オプション）は未サポートです。
|
目次
索引
|