LDAP modify-entry RDN® コマンド行ユーティリティー
概要
ldapmodrdn [-c] [-C charset] [-d debuglevel][-D binddn]
[-f file][-G realm] [-h ldaphost] [-i file] [-k] [-K keyfile]
[-m mechanism] [-M] [-n] [-N certificatename] [-O hopcount]
[-p ldapport] [-P keyfilepw] [-r] [-R] [-U username] [-v] [-V version]
[-w passwd | ?] [-y proxydn] [-Y] [-Z] [dn newrdn | [-i file]]
説明
ldapmodrdn は、ldap_rename アプリケーション・プログラミング・インターフェース (API) へのコマンド行インターフェースです。
ldapmodrdn は LDAP サーバーへの接続を開き、項目にバインドし、その移動またはその名前変更を行います。
項目の情報は、標準入力から読み取られるか、
-f オプションの使用によってファイルから読み取られるか、
コマンド行の DN と RDN の対から読み取られます。
項目を移動する -s オプションを使用すると、その -s オプションは、コマンドの実行対象のすべての項目に適用されます。
ldapmodrdn の構文ヘルプを表示するには、以下を入力します。
ldapmodrdn -?
オプション
- -c
- 連続操作モード。
エラーは報告されますが、ldapmodrdn は変更処理を続行します。
そうでなければ、デフォルトのアクションでは、エラーの報告後に終了します。
- -C charset
- ldapmodrdn ユーティリティーへの入力として提供されたストリングが、
charset で指定されたローカル文字セットで表されるように設定します。入力ストリングのコード・ページがジョブのコード・ページ値と異なる場合には、
-C charset オプションを使用します。
サポートされる charset 値を調べるには ldap_set_iconv_local_charset() API を
参照してください。charset のサポートされる値は、バージョン 1 LDIF ファイルで
オプションとして定義されている charset タグのためにサポートされている値と同じあることに注意してください。
- -d debuglevel
- LDAP デバッグ・レベルを debuglevel にセットします。
- -D binddn
- binddn を使用して LDAP ディレクトリーにバインドします。
binddn はストリング表記の DN です。
-m DIGEST-MD5 で使用する場合は、権限 ID を指定するために使用します。これは DN とする
こともできるし、あるいは「u:」または「dn:」で始まる authzId ストリングとすることもできます。
- -f file
- 標準入力またはコマンド行 (dn および新規の rdn の指定による) からではなく、LDIF ファイル
から項目の変更情報を読み取ります。また、標準入力をファイル (< file) から提供することもできます。
- -G realm
- レルムを指定します。このパラメーターはオプションです。-m DIGEST-MD5 と一緒に使用する
と、その値はバインド中にサーバーに渡されます。
- -h ldaphost
- LDAP サーバーを実行する代替ホストを指定します。
- -i file
- 標準入力またはコマンド行 (rdn および newrdn を指定) からではなく、
ファイルから項目の変更情報を読み取ります。
標準入力はファイル ("< file") からも提供されます。
- -k
- サーバー管理制御の使用を指定します。
- -K keyfile
- SSL キー・データベース・ファイルの名前を指定します。キー・データベース・ファイルが現行ディレクトリーにない場合は、
完全修飾キー・データベース・ファイル名を指定してください。
ユーティリティーがキー・データベースを探し出すことができない場合には、
デフォルトのトラステッド認証局ルートのハードコーディングされたセットが使われます。キー・データベース・ファイルには、一般に、
クライアントが信頼している認証局 (CA) の 1 つまたは複数の証明書が含まれています。
これらのタイプの X.509 証明書は、トラステッド・ルートとも呼ばれています。
このパラメーターを使用すると、-Z スイッチを使用できるようになります。
IBM® i 上のディレクトリー・サーバー
では、-Z を使用して -K または -N を使用しない場合、ディレクトリー・サービス・クライアント・アプリケーション ID に
関連した証明が使用されます。
- -m mechanism
- mechanism を使用して、
サーバーへのバインドに使用する SASL メカニズムを指定します。
ldap_sasl_bind_s() API が使用されます。-V 2 をセットすると、
-m パラメーターは無視されます。-m を指定しない場合、
単純認証が使用されます。
以下が有効はメカニズムです。
- CRAM-MD5 - サーバーに送信されるパスワードを保護する。
- EXTERNAL - SSL 認証を使用する。-Z が必要。
- GSSAPI - ユーザーの Kerberos 信任状を使用する。
- DIGEST-MD5 - クライアントは username 値をサーバーに送信する必要が
あります。-U が必要。権限 ID を指定するには、-D パラメーター (通常、バインド DN) が
使用されます。これは DN とすることもできるし、あるいは「u:」または「dn:」で
始まる authzId ストリングとすることもできます。
- OS400_PRFTKN - システム・プロジェクト・バックエンド中のユーザーの DN を
使用して、ローカル LDAP サーバーに対して現行 IBM i ユーザーとして認証
します。-D (バインド DN) および -w (パスワード) パラメーターは指定しないでください。
- -M
- 参照オブジェクトを普通の項目として管理します。
- -n
- 実行される処理が表示されますが、実際の項目変更は行いません。-v
と併用してデバッグに使用すると便利です。
- -N certificatename
- キー・データベース・ファイル内のクライアント証明書に関連したラベルを指定します。
LDAP サーバーがサーバー認証だけを実行するように構成されている場合は、
クライアント証明書は不要です。
LDAP サーバーがクライアントおよびサーバーの認証を実行するように構成されている場合は、
クライアント証明書が必要です。
デフォルトの証明書/秘密鍵のペアがデフォルトとして指定されている場合は、certificatename は不要です。
同様に、
指定したキー・データベース・ファイル内に証明書/秘密鍵のペアが 1 つある場合も、
certificatename は不要です。-Z と -K をどちらも指定していない場合は、
このパラメーターは無視されます。
IBM i 上のディレクトリー・サーバー
では、-Z を使用して -K または -N を使用しない場合、ディレクトリー・サービス・クライアント・アプリケーション ID に
関連した証明が使用されます。
- -O hopcount
- 参照を追跡する際にクライアント・ライブラリーが取るホップの最大数を
設定するよう hopcount を指定します。デフォルトのホップ・カウントは 10 です。
- -p ldapport
- LDAP サーバーが listen する代替 TCP ポートを指定します。
デフォルトの LDAP ポートは 389 です。
この値の指定がなく、-Z が指定されている場合は、
デフォルトの LDAP SSL ポート 636 が使用されます。
- -P keyfilepw
- キー・データベースのパスワードを指定します。このパスワードは、キー・データベース・ファイル内の暗号化された情報 (1 つ以上の秘密鍵を含む場合がある) に
アクセスするために必要です。パスワードの stash ファイルがキー・データベース・ファイルに関連付けられている場合、
パスワードはそのパスワード stash ファイルから取得されるので、-P
パラメーターは必要ありません。-Z と -K をどちらも指定していない場合は、
このパラメーターは無視されます。
- -r
- 項目から、古い RDN 値を除去します。デフォルトのアクションでは古い値が保持されます。
- -R
- 参照を自動的に行わないことを指定します。
- -s newSuperior
- 名前変更後の項目の再配置先の新しい上位項目の DN を指定します。
newSuperior 引数は、ゼロの長さのストリング (-s "") でかまいません。
注: 新規の superior オプションは、V6R1 (ITDS v6.0) より前のリリースのサーバーへの接続時にはサポートされません。
現在、このオプションは、リーフ項目に対してのみ指定できます。
- –U username
- ユーザー名を指定します。-m DIGEST-MD5 には必要ですが、その他のメカニズムでは無視されます。
- -v
- 冗長モードを使用して、多くの診断結果を標準出力に書き込みます。
- -V version
- LDAP サーバーにバインドするときに、ldapmodrdn によって
使用されるよう、LDAP バージョンを指定します。デフォルトの設定では、LDAP V3 接続が確立されます。
明示的に LDAP V3 を選択する場合は -V
3 と指定し、LDAP V2 アプリケーションとして実行する場合は -V 2 と指定します。ldapmodrdn などのアプリケーションでは、ldap_open の代わりに
ldap_init が使用され、LDAP V3 が優先プロトコルとして選択されます。
- -w passwd | ?
- passwd を認証用のパスワードとして使用します。
? を使用してパスワード・プロンプトを生成します。
- -y proxydn
- プロキシー権限操作のプロキシー ID を設定します。
- –Y
- セキュア LDAP 接続 (TLS) を使用します。
- -Z
- セキュア SSL 接続を使用して LDAP サーバーと通信します。
IBM i 上のディレクトリー・サーバー
では、-Z を使用して -K または -N を使用しない場合、ディレクトリー・サービス・クライアント・アプリケーション ID に
関連した証明が使用されます。
- dn newrdn
- 詳しくは、以下の『dn newrdn の入力形式』のセクションを
参照してください。
dn newrdn の入力フォーマット
コマンド行引数 dn および newrdn を指定した場合は、DN で指定された項目の RDN である dn が、newrdn で置き換えられます。
これらの引数を指定しない場合は、ファイルの内容 (または、
- i フラグを指定していない場合は標準入力) は、
1 つまたは複数の項目で構成されます。
識別名 (DN)
相対識別名 (RDN)
1 行以上のブランク行でそれぞれの DN と RDN ペアを分離する場合があります。
例
/tmp/entrymods というファイルがあり、
このファイルの内容は次のとおりです。
cn=Modify Me, o=University of Life, c=US
cn=The New Me
次のコマンド:
ldapmodrdn -r -i /tmp/entrymods
は、Modify Me 項目の RDN を、Modify Me から The New Me に変更し、古い cn、Modify Me は除去されます。
注
-i オプションを使用してファイルから (または
コマンド行ペア dn および rdn から) 入力情報が供給されていない場合は、
ldapmodrdn コマンドは標準入力から項目を読み取るまで待機します。
診断
エラーがない場合は、戻り状況は 0 です。
エラーがあった場合は、ゼロ以外の戻り状況が発生し、標準エラーに診断メッセージが書き込まれます。