A Oracle Unified Directoryコマンドライン・インタフェース

Oracle Unified Directoryには、ディレクトリ・サーバーおよびプロキシ・サーバーとの連携に使用される多数のコマンドライン・ユーティリティが組み込まれています。また、レプリケーション・ゲートウェイを使用するマルチ・バージョンのトポロジに含まれるようにサーバーを準備するためのユーティリティも用意されています。

この付録では、Oracle Unified Directory 11gリリース2 (11.1.2)で提供されるすべてのコマンドについて説明します。これらのコマンドのなかには、ディレクトリ・サーバー・インスタンスに固有であって、プロキシ・サーバーの構成には使用できないものがあります。同様に、多数のコマンドはプロキシに固有であり、ディレクトリ・サーバーの構成には使用できません。

ここで説明する項目は、次のとおりです:

第A.1項「一般的なコマンドラインの使用方法に関する情報」
第A.2項「サーバー管理コマンド」
第A.3項「データ管理コマンド」
第A.4項「LDAPクライアント・コマンド」

A.1 一般的なコマンドラインの使用方法に関する情報

次の各項では、コマンドの一般的な使用方法について説明します:

第A.1.1項「サーバー・コマンドとその使用のサマリー」
第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」

A.1.1 サーバー・コマンドとその使用のサマリー

この項の各表は、サーバー・コマンドとその使用方法のサマリーを示しています。表で使用する凡例は次のとおりです:

リモート: コマンドはリモート・サーバーで起動できます。
オフライン: コマンドはサーバーが停止しているときに起動できます。
オンライン: コマンドは実行中のサーバー・インスタンスに接続しています。
管理ポートのみ: コマンドは、管理コネクタを使用してサーバー(デフォルトでは、ポート4444にあります)にアクセスする必要があります。

注意:

以降の各表に示すすべてのコマンドがプロキシ・サーバー・インスタンス用にサポートされているわけではありません。

表A-1 サーバー管理コマンド

コマンド	リモート	オフライン	オンライン	管理コネクタ
create-rc-script
dsconfig	`X`		`X`	`X`
dsjavaproperties		`X`
dsreplication	`X`		`X`	`X`
gicadm	`X`		`X`	`X`
oudExtractMovePlan		`X`	`X`
oudCopyConfig		`X`	`X`
oudPasteConfig		`X`
start-ds		`X`
status	`X`	`X`	`X`	`X`
stop-ds	`X`		`X`	`X`
uninstall		`X`	`X`	`X`
upgrade		`X`
windows-service		`X`

表A-2 データ管理コマンド

コマンド	リモート	オフライン	オンライン	管理コネクタ
backup	`X` *	`X`	`X`	`X`
base64		`X`
dbtest		`X`
encode-password		`X`
export-ldif	`X` *	`X`	`X`	`X`
import-ldif	`X` *	`X`	`X`	`X`
ldapcompare	`X`		`X`
ldapdelete	`X`		`X`
ldapmodify	`X`		`X`
ldappasswordmodify	`X`		`X`
ldapsearch	`X`		`X`
ldif-diff		`X`
ldifmodify		`X`
ldifsearch		`X`
list-backends		`X`
make-ldif		`X`
manage-account	`X`		`X`	`X`
manage-tasks	`X`		`X`	`X`
rebuild-index		`X`
restore	`X` *	`X`	`X`	`X`
split-ldif		`X`	`X`
verify-index		`X`

* このコマンドはリモートに起動できますが、データ・ファイルはサーバーが実行しているホスト上にある必要があります。

A.1.2 サーバー・コマンドによるプロパティ・ファイルの使用方法

特定のコマンドライン・ユーティリティは、コマンド・プロパティ・ファイルを使用して、次のようなオプションにデフォルト値を指定できます:

サーバーのホスト名およびポート番号
サーバーとの通信にSSLまたはStartTLSを使用するかどうか
サーバーへの接続時に使用するバインドDN

次のユーティリティはプロパティ・ファイルを使用できます:

backup
dsconfig
dsreplication
export-ldif
gicadm
import-ldif
split-ldif
ldapcompare
ldapdelete
ldapmodify
ldappasswordmodify
ldapsearch
manage-tasks
oud-setup
oud-proxy-setup
oud-replication-gateway-setup
restore
status
stop-ds
uninstall

次の相互に排他的なオプションは、プロパティ・ファイルが使用されているかどうかを示すためにコマンドライン・ユーティリティとともに使用します:

--propertiesFilePath path: コマンドライン・オプションのデフォルト値が含まれているファイルへのパスを指定します。
--noPropertiesFile: コマンドライン・オプションのデフォルト値の取得にプロパティ・ファイルが使用されていないことを示します。

A.1.2.1 プロパティ・ファイルの検索

共通のプロパティ・ファイルを使用するユーティリティには、次のデフォルトの動作が設定されています:

--noPropertiesFileオプションを指定した場合、コマンドライン・インタフェースはプロパティ・ファイルの検索を試行しません。コマンドラインで指定されたオプションのみが評価されます。
--propertiesFilePathオプションを指定した場合、プロパティ値はこのファイルから読み取られます。
--propertiesFilePathと--noPropertiesFileがどちらも指定されなかった場合、コマンドライン・インタフェースは次の場所でプロパティ・ファイルの検索を試行します:
- USERDIRECTORY/.opends/tools.properties
- INSTANCE_DIR/OUD/config/tools.properties
このいずれの場所でもプロパティ・ファイルが見つからなかった場合は、デフォルト動作が適用されます(コマンドラインで指定された引数のみが評価されます)。

A.1.2.2 オプションおよびプロパティの優先順位

オプションがコマンドラインで指定された場合、そのオプションとそれに対応する値がコマンドライン・インタフェースによって使用されます。つまり、コマンドラインで指定されたオプションが、プロパティ・ファイルで定義されたプロパティよりも優先されます。

プロパティ・ファイルは標準のJAVAプロパティ・ファイルの形式(property-name=value)を使用します。そのため、このファイルはプロパティ名のバリエーションをサポートしており、プロパティ名を使用するコマンドに従ってプロパティ名がオーバーライドできるようにします。たとえば、プロパティ・ファイルには次の内容を含めることができます:

hostname=localhost
port=4444
bindDN=cn=Directory Manager
bindPasswordFile=/path/pwd-file
baseDN=dc=example,dc=com
searchScope=sub
sortOrder=givenName
virtualListView=0:2:1:0

コマンドライン・インタフェースでportプロパティを使用している場合は、まずtoolname.port定義の検索を試みます。これが定義されていない場合は、port定義の検索を試みます。たとえば、プロパティ・ファイルには、様々なユーティリティに定義されている次のような複数のポート・オプションを設定することもできます:

port=4444
ldapsearch.port=1389
ldapcompare.port=1389
ldapmodify.port=1389
ldapdelete.port=1389

注意:

プロパティ・ファイルでは、値の前後に引用符を使用しないでください(例: port="4444")。

A.2 サーバー管理コマンド

次の各項では、サーバー管理コマンドについて説明します:

第A.2.1項「create-rc-script」
第A.2.2項「dps2oud」
第A.2.3,項「ds2oud」
第A.2.4項「dsconfig」
第A.2.5項「dsjavaproperties」
第A.2.6項「dsreplication」
第A.2.7項「gicadm」
第A.2.8項「manage-tasks」
第A.2.9項「oudCopyConfig」
第A.2.10項「oudExtractMovePlan」
第A.2.11項「oudPasteConfig」
第A.2.12項「oud-replication-gateway-setup」
第A.2.13項「oud-setup」
第A.2.14項「oud-proxy-setup」
第A.2.15項「start-ds」
第A.2.16項「status」
第A.2.17項「stop-ds」
第A.2.18項「uninstall」
第A.2.19項「windows-service」

A.2.1 create-rc-script

create-rc-scriptコマンドは、ディレクトリ・サーバーを起動、停止、および再起動するシェル・スクリプトを生成します。

A.2.1.1 シノプシス

create-rc-script [options]

A.2.1.2 説明

create-rc-scriptコマンドは、ディレクトリ・サーバーを起動、停止、および再起動するシェル・スクリプトの生成に使用できます。ディレクトリ・サービスのニーズに適合するように結果のスクリプトを更新できます。このコマンドは、UNIXシステムまたはLinuxシステムのみで使用できます。

create-rc-scriptコマンドは、OPENDS_JAVA_*変数とJAVA_*変数を使用します。

A.2.1.3 オプション

create-rc-scriptコマンドは、短いフォーム(例: -f filename)または同等の長いフォーム(例: --outputFile filename)のいずれかのオプションを受け入れます。

-f, --outputFile filename: 出力ファイルへのパスを指定します。
-j, --javaHome javaHomePath: サーバーの実行に使用する必要のあるJavaインストールへのパスを指定します。
-J, --javaArgs javaArgs: サーバーを実行するときにJVMに渡す必要のある引数のセットを指定します。
-u, --userName userName: サーバーの実行に必要なユーザー・アカウントの名前を指定します。ユーザー・アカウントは、スクリプトを実行するために適切な権限を持っている必要があります。

A.2.1.4 一般オプション

--version: ディレクトリ・サーバーのバージョン情報を表示します。
-?, -H, --help: create-rc-scriptコマンドのコマンドライン使用情報を表示します。

A.2.1.5 例

次の例は、create-rc-scriptコマンドの使用方法を示しています。

例A-1 スクリプトの作成

次のコマンドは、ディレクトリ・サーバーを起動、停止、および再起動するスクリプトを生成します。-fオプションによって指定されたmyscriptというファイルが作成されます:

$ create-rc-script -f myscript

例A-2 新規スクリプトを使用したディレクトリ・サーバーの起動

次のコマンドでは、ディレクトリ・サーバーを起動するために、新しく作成されたスクリプト(前の例を参照)を使用しています。

$ myscript start

例A-3 新規スクリプトを使用したディレクトリ・サーバーの停止

次のコマンドでは、ディレクトリ・サーバーを停止するために、新しく作成されたスクリプト(最初の例を参照)を使用しています。

$ myscript stop

例A-4 新規スクリプトを使用したディレクトリ・サーバーの再起動

次のコマンドでは、ディレクトリ・サーバーを再起動するために、新しく作成されたスクリプト(最初の例を参照)を使用しています。

$ myscript restart

例A-5 スクリプトでのJAVA_HOMEおよびJAVA_ARGSの指定

次のコマンドは、-u (--userName), -j (--javaHome)オプションおよび-J (--javaArgs)オプションを使用しています。

$ create-rc-script -f myscript -u sysAdmin -j /usr/java -J "-Xms128m -Xmx128m"

A.2.1.6 `create-rc-script`コマンドにより生成されるコード

上記の例のcreate-rc-scriptコマンドにより、次のコードが生成されます:

# /bin/sh
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License, Version 1.0 only
# (the "License").  You may not use this file except in compliance
# with the License.
#
# You can obtain a copy of the license at
# https://OpenDS.dev.java.net/OpenDS.LICENSE.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at
# trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
# add the following below this CDDL HEADER, with the fields enclosed
# by brackets "[]" replaced with your own identifying information:
#      Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END

# Set the path to the OpenDS instance to manage
INSTANCE_ROOT="/usr/local/opends/standalone/ds-server-1"
export INSTANCE_ROOT

# Specify the path to the Java installation to use
OPENDS_JAVA_HOME="/usr/java"
export OPENDS_JAVA_HOME

# Specify arguments that should be provided to the JVM
JAVA_ARGS="-Xms128m -Xmx128m"
export JAVA_ARGS

# Determine what action should be performed on the server
case "${1}" in
start)
/bin/su sysAdmin "${INSTANCE_ROOT}/bin/start-ds" --quiet
exit ${?}
;;
stop)
/bin/su sysAdmin "${INSTANCE_ROOT}/bin/stop-ds" --quiet
exit ${?}
;;
restart)
/bin/su sysAdmin "${INSTANCE_ROOT}/bin/stop-ds" --restart --quiet
exit ${?}
;;
*)

echo "Usage:  $0 { start | stop | restart }"
exit 1
;;
esac

A.2.1.7 終了コード

終了コード0は成功を示します。ゼロ以外の終了コードは、エラーが発生したことを示します。

A.2.1.8 場所

create-rc-scriptコマンドは、次のパスに置かれています:

UNIXおよびLinux: INSTANCE_DIR/OUD/bin

A.2.1.9 関連コマンド

第A.2.15項「start-ds」

第A.2.17項「stop-ds」

A.2.2 dps2oud

dps2oudコマンドによって、ディレクトリ・プロキシ・サーバー(DPS)構成をOracle Unified Directory構成に移行できます。

A.2.2.1 シノプシス

dps2oud [options]

A.2.2.2 説明

dps2oudコマンドによって、DPS構成をOracle Unified Directory構成に移行できます。dps2oudコマンドはDPS構成を入力として取り込み、同等のOracle Unified Directory構成の作成に使用されるdsconfigコマンドからなるバッチ・ファイルを生成します。dps2oudコマンドは、ファイルから、または実行中のDPSインスタンス上のLDAPプロトコルを通してDPS構成を読み取ります。

A.2.2.3 オプション

dps2oudコマンドは、次のオプションを受け入れます。

-o, --outputFile file: dsconfigコマンドの出力ファイル。
-f, --dpsConfigFile file: 使用するDPS構成ファイルの名前を指定します。
-c, --createDisabledObjects: Creates DPSで無効なオブジェクトを作成します。
-P, --printDsConfigCmds: dsconfigコマンドを印刷します。

A.2.2.4 LDAP接続オプション

-h, --hostname host: DPSサーバーのホスト名またはIPアドレス。
-j, --bindPasswordFile filename: バインド・パスワードが含まれているファイルへのフルパス。
-p, --port port: DPSサーバーのポート番号。
-D, --BindDN bindDN: DPSサーバーへのバインドに使用するDN。

A.2.2.5 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、ディレクトリ・サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.2.2.6 例

次の例は、dps2oudコマンドの使用方法を示しています。

例A-6 グローバル・ヘルプ・サブコマンドの表示

次のコマンドは、使用可能なグローバル・ヘルプ・サブコマンドを表示します:

$ dps2oud --help

例A-7 ディレクトリ・プロキシ・サーバー構成のOracle Unified Directory構成への移行

DPS構成をOracle Unified Directory構成に移行するには、次の方法のいずれかが使用できます:

方法1: DPS構成をLDIFファイルから読み取る

次のコマンドは、DPS構成をLDIFファイルから読み取る方法を表示します:

$ dps2oud -f dse.ldif -o oud_conf_cmds

次のコマンドは、実行される一連のdsconfigコマンドが含まれているバッチ・ファイルへのパスを指定します:

$ dsconfig -F oud_conf_cmds

方法2: DPS構成を実行中のDPSインスタンスから読み取る

次のコマンドは、DPS構成をDPSインスタンスから読み取る方法を表示します:

$ dps2oud -h dpsHost -p 389 -D "cn=Proxy Manager"  -j /path/pwd-file -o oud_conf_cmds

次のコマンドは、実行される一連のdsconfigコマンドが含まれているバッチ・ファイルへのパスを指定します:

$ dsconfig -F oud_conf_cmds

A.2.2.7 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.2.2.8 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/dps2oud
Windows: INSTANCE_DIR\OUD\bat\dps2oud.bat

A.2.2.9 関連コマンド

第A.2.4項「dsconfig」

A.2.3 ds2oud

ds2oudコマンドは、Oracle Directory Server Enterprise Editionディレクトリ・サーバー・インスタンスからOracle Unified Directoryへの移行を管理します。

A.2.3.1 シノプシス

ds2oud [options]

A.2.3.2 説明

ds2oudコマンドにより、Oracle Directory Server Enterprise Editionディレクトリ・サーバー・インスタンスからOracle Unified Directoryへの移行を管理できます。ds2oudコマンドでは、まず、対象となるOracle Directory Server Enterprise Editionディレクトリ・サーバー・インスタンスの診断を許可したあとで、移行タスクを実行します。これは、既存のOracle Unified Directoryインスタンスが、移行されるOracle Directory Server Enterprise Editionディレクトリ・サーバーと互換性を持つように変更されることを前提としています。ds2oudコマンドは、オプションを指定しない場合はインタラクティブ・モードで実行します。インタラクティブ・モードは、移行のすべての局面を1つずつ実行するウィザードのように機能します。

また、ds2oudコマンドはバッチ・モードでも実行できます。バッチ・モードでは、dsconfigコマンドで構成されるバッチ・ファイルが生成されます。これらのコマンドは、同等のOracle Unified Directory構成の作成に使用されます。したがって、ds2oudを1回実行すると、1つのバッチ・ファイルを作成し、それを使用してOracle Unified Directoryインスタンスをいくつでも構成できます。

ds2oudコマンドを実行する際、(Oracle Directory Server Enterprise Editionインスタンスの移行先である)Oracle Unified Directoryインスタンスが接尾辞を使用せずに構成されていることを確認する必要があります。

A.2.3.3 オプション

ds2oudコマンドは、次のオプションを受け入れます。

-d, --diagnose

対象となるOracle Directory Server Enterprise Editionディレクトリ・サーバーを診断します。

-f, --ldifDBFile file

Oracle Directory Server Enterprise Editionディレクトリ・サーバーのLDIFデータベース・ファイルを診断します。

-u, --userSchemaFile file

考慮されるユーザー・スキーマを指定します。これは-fサブコマンドに適用されます。

-a, --migrateAll

スキーマと構成要素をOracle Directory Server Enterprise Editionディレクトリ・サーバーからOracle Unified Directoryサーバーへ伝播します。

-s, --migrateUserSchema

ユーザー・スキーマをOracle Directory Server Enterprise Editionディレクトリ・サーバーからOracle Unified Directoryサーバーへ伝播します。

スキーマの移行は、構成を移行する前に行う必要があります。そうしないと、移行によって予測できない結果がもたらされる可能性があるためです。

-c, --migrateConfiguration

構成要素をOracle Directory Server Enterprise Editionディレクトリ・サーバーからOracle Unified Directoryサーバーへ伝播します。

-w, --uniqueWorkflowElement

移行するすべてのネーミング・コンテキストに対して一意のワークフロー要素を使用します。これは-cサブコマンドに適用されます。

A.2.3.4 Oracle Directory Server Enterprise EditionのLDAP接続オプション

-D, --odseeBindDN bindDN: Oracle Directory Server Enterprise Editionサーバーへのバインドに使用するDN。
-j, --odseeBindPasswordFile filename: Oracle Directory Server Enterprise Editionのバインド・パスワード・ファイル。
-h, --odseeHostname host: Oracle Directory Server Enterprise Editionサーバーのホスト名。デフォルトの値はlocalhostです。
-p, --odseePort port: Oracle Directory Server Enterprise Editionサーバーのポート番号。デフォルト値は389です。
-Z, --odseeUseSSL: Oracle Directory Server Enterprise EditionのSSL暗号化の接続を確立します。
-P, --odseeTrustStorePath trustStorePath: 指定されたパスにOracle Directory Server Enterprise Editionのトラスト・ストア証明書を使用します。このオプションは、-Xを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-U, --odseeTrustStorePasswordFile filename: Oracle Directory Server Enterprise Editionのトラスト・ストアの証明書にアクセスするには、指定されたファイルでパスワードを使用します。このオプションは、--odseeTrustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --odseeTrustAll: Oracle Directory Server Enterprise Editionサーバーによって提示されるすべての証明書を信頼します。このオプションはテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してOracle Directory Server Enterprise Editionがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.2.3.5 Oracle Unified DirectoryのLDAP接続オプション

--oudBindDN bindDN: Oracle Unified Directoryサーバーへのバインドに使用するDN。
--oudBindPasswordFile filename: Oracle Unified Directoryのバインド・パスワード・ファイル。
--oudHostname host: Oracle Unified Directoryサーバーのホスト名。デフォルトの値はlocalhostです。
--oudPort port: Oracle Unified Directoryサーバーのポート番号。デフォルト値は389です。
--oudAdminPort port: Oracle Unified Directoryサーバーの管理ポート。デフォルト値は444です。
--oudUseSSL: Establishes an Oracle Unified DirectoryのSSL暗号化の接続を確立します。
--oudTrustStorePath trustStorePath: 指定されたパスにOracle Unified Directoryのトラスト・ストア証明書を使用します。
--oudTrustStorePasswordFile filename: Oracle Unified Directoryのトラスト・ストアの証明書にアクセスするには、指定されたファイルでパスワードを使用します。このオプションは、--oudTrustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
--oudTrustAll: Oracle Unified Directoryサーバーによって提示されるすべての証明書を信頼します。このオプションはテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してOracle Unified Directoryがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.2.3.6 コマンド入力/出力オプション

-n, --no-prompt

非インタラクティブ・モードを使用します。コマンドのデータが見つからない場合、ユーザーにはプロンプトが表示されず、ツールは失敗します。

-o, --outputFile filename

出力を指定した出力ファイルにリダイレクトします。

-F, --batchFilePath filename

このオプションは、構成を移行するために実行される一連のdsconfigコマンドが含まれている出力ファイルの名前を指定します。

このオプションを指定してds2oudを実行した場合、同等のOracle Unified Directory構成の作成に必要なすべてのdsconfigコマンドを含めたバッチ・ファイルが生成されます。したがって、ds2oudを1回実行すると、1つのバッチ・ファイルを作成し、それを使用してOracle Unified Directoryインスタンスをいくつでも構成できます。

--displayCommand

同等の非インタラクティブなdsconfigコマンドを表示します(Oracle Directory Server Enterprise Editionの構成パラメータを移行するため)。

A.2.3.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、ディレクトリ・サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.2.3.8 例

次の例は、ds2oudコマンドの使用方法を示しています。

例A-8 グローバル・ヘルプ・サブコマンドの表示

次のコマンドは、使用可能なグローバル・ヘルプ・サブコマンドを表示します:

$ ds2oud --help

例A-9 コマンドラインからのインタラクティブ・モードでのds2oudの実行

ds2oudコマンドはインタラクティブ・モードで実行できます。このモードでは、移行オプションに関してプロンプトが表示されます。ds2oudをインタラクティブ・モードで実行するには、次のコマンドを入力します:

$ ds2oud
What do you want to do ?

1)  Diagnose an ODSEE directory server instance
2)  Diagnose an ODSEE LDIF data file
3)  Migrate all ( user schema + configuration )
4)  Migrate the user schema
5)  Migrate global configuration parameters

c)  cancel

前のアクションごとに、まず、接続オプションをOracle Directory Server Enterprise Editionサーバーに対して指定するか(診断の場合)、Oracle Directory Server Enterprise EditionサーバーとOracle Unified Directoryサーバーの両方に対して指定する(移行の場合)必要があります。

例A-10 データ診断用のds2oudの実行

次のコマンドは、Oracle Directory Server Enterprise Editionディレクトリ・サーバーにあるデータを診断するために実行されます:

$ ds2oud -f odseeDataFile.ldif -u 99user.ldif

*******************************************************************************
* Diagnose ODSEE LDIF data file :  odseeDataFile.ldif
*******************************************************************************
The data were validated successfully regarding the OUD schema

例A-11 既存のOracle Directory Server Enterprise Edition構成のOracle Unified Directory構成への移行

次のコマンドを使用した既存のOracle Directory Server Enterprise Edition構成の新しいOracle Unified Directory構成への移行

次のコマンドは、既存のOracle Directory Server Enterprise Edition構成とスキーマを移行します:

$ ds2oud --migrateAll -D "cn=directory manager"
-j /tmp/pwd -h hostname -p ldapPort  
--oudBindDN "cn=directory manager" --oudBindPasswordFile /tmp/pwd
--oudHostname hostname2 --oudPort ldapPort2 --oudAdminPort adminPort  -n

次のコマンドは、新しいOracle Unified Directory構成を作成するために実行される一連のdsconfigコマンドが含まれているバッチ・ファイルへのパスを指定します:

$ ds2oud --migrateConfiguration --batchFilePath batchFile
-D "cn=directory manager" -j /tmp/pwd -h hostname 
-p ldapPort --oudBindDN "cn=directory manager"
--oudBindPasswordFile /tmp/pwd  --oudHostname hostname2 
--oudPort ldapPort2 --oudAdminPort adminPort -n

A.2.3.9 終了コード

0: 成功。
1: 引数を初期化できません。
2: 指定された引数が有効でないか、ユーザー・データのチェックでエラーが発生したため、引数を解析できません。
3: 移行プロセスの少なくとも1つのステップが失敗しました。
4: ユーザーがインタラクティブ・モードで操作を取り消しました。

A.2.3.10 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ds2oud
Windows: INSTANCE_DIR\OUD\bat\ds2oud.bat

A.2.3.11 関連コマンド

第A.2.4項「dsconfig」

A.2.4 dsconfig

dsconfigコマンドにより、Directory Serverの基本構成を定義できます。

A.2.4.1 シノプシス

dsconfig [subcommands] [Options]

A.2.4.2 説明

dsconfigコマンドにより、サーバー・インスタンスの基本構成を作成、管理、および削除できます。このサーバー構成は、dsconfigが1つ以上のサブコマンドを使用してアクセスできる一連のコンポーネントとして編成されます。すべてのコンポーネントには、ゼロ個以上の構成プロパティが割り当てられています。これらのプロパティに対して問合せを実行し、コンポーネントの動作を変更するように修正できます。

dsconfigコマンドは、管理コネクタを介してSSL上のサーバーにアクセスします(第14.3項「サーバーへの管理トラフィックの管理」で説明しています)。

すべての構成パラメータと-n (--no-prompt)オプションを指定した場合を除き、dsconfigはインタラクティブ・モードで実行します。インタラクティブ・モードは、サーバー構成のすべての局面を1つずつ実行するウィザードのように機能します。詳細は、第14.1.2項「インタラクティブ・モードでのdsconfigの使用」を参照してください。

A.2.4.3 ヘルプ・サブコマンド

dsconfigコマンドは、基本構成の管理に必要なコンポーネントのサブコマンドをリストしたヘルプ関数を指定します。

--help-distribution: 分散に関連するサブコマンドを表示します。
--help-general-configuration: 一般構成に関連するサブコマンドを表示します。
--help-load-balancing: ロード・バランシングに関連するサブコマンドを表示します。
--help-local-storage: ローカル記憶域に関連するサブコマンドを表示します。
--help-miscellaneous-workflow-elements: その他のワークフロー要素に関連するサブコマンドを表示します。
--help-remote-storage: リモート記憶域に関連するサブコマンドを表示します。
--help-replication: レプリケーションに関連するサブコマンドを表示します。
--help-schema: スキーマに関連するサブコマンドを表示します。
--help-security: 認証および認可に関連するサブコマンドを表示します。
--help-virtualization: 仮想化に関連するサブコマンドを表示します。
--help-all: すべてのサブコマンドを表示します。

A.2.4.4 一般サブコマンド

次のサブコマンドは、サーバー・インスタンスのオブジェクトとプロパティをリストします。

list-properties

管理対象のオブジェクトとプロパティを表示します。オプション・タイプは次のとおりです:

r — プロパティ値は読取り可能です。

w — プロパティ値は書込み可能です。

m — プロパティは必須です。

s — プロパティは単一値です。

a — 変更を有効にするには管理アクションが必要です。

サブオプションは次のとおりです:

-t, --type type。コンポーネント・タイプ。

-c, --category category。コンポーネントのカテゴリ。typeの値は、--categoryサブオプションを使用して指定されるcategoryに関連付けられたコンポーネント・タイプの1つである必要があります。

--inherited。コンポーネントの継承プロパティを表示するように表示出力を変更します。

--advanced。コンポーネントの拡張プロパティを表示するように表示出力を変更します。

--property property。表示されるプロパティの名前。

A.2.4.5 分散サブコマンド

次のサブコマンドにより、ディレクトリ・サーバーの基本構成を定義できます。

create-distribution-algorithm

分散アルゴリズムを作成します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--set property:value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。

-t,--type type。作成する分散アルゴリズムのタイプ。typeの値には、capacity、dnpattern、generic、lexico、またはnumericのいずれかを指定できます。

create-distribution-partition

分散パーティションを作成します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--partition-name name。新しい分散パーティションの名前。

-t,--type type。作成する分散パーティションのタイプ。typeの値には、capacity、dnpattern、generic、lexico、またはnumericのいずれかを指定できます。

create-workflow-element --type distribution

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t, --type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

create-global-index

グローバル索引を作成します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--index-name name。新しいグローバル索引の名前。

create-extension --type global-index-catalog

拡張を作成します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

-t,--type type。作成する拡張のタイプ。タイプの値には、global-index-catalog、global-index-catalogs-shared-cache、ldap-serverのいずれかを指定できます。

create-global-index-catalog-replication-domain

グローバル索引カタログ・レプリケーション・ドメインを作成します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

create-extension --type global-index-catalogs-shared-cache

拡張を作成します。サブオプションは次のとおりです:

--extension-name name。新しい拡張の名前。

-t,--type type。作成する拡張のタイプ。typeの値には、global-index-catalog、global-index-catalogs-shared-cache、ldap-serverのいずれかを指定できます。

create-workflow-element --type global-index-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-workflow-element --type global-index-replication-changes-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

delete-distribution-algorithm

分散アルゴリズムを削除します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

-f,--force。存在しない分散アルゴリズムを無視します。

delete-distribution-partition

分散パーティションを削除します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--partition-name name。分散パーティションの名前。

-f,--force。存在しない分散パーティションを無視します。

delete-extension

拡張を削除します。サブオプションは次のとおりです:

--extension-name name。拡張の名前。

-f,--force。存在しない拡張を無視します。

delete-global-index

グローバル索引を削除します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--index-name name。グローバル索引の名前。

-f,--force。存在しないグローバル索引を無視します。

delete-global-index-catalog-replication-domain

このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、第A.2.7項「gicadm」を参照してください。

グローバル索引カタログ・レプリケーション・ドメインを削除します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

-f,--force。存在しないグローバル索引カタログ・レプリケーション・ドメインを無視します。

delete-workflow-element

ワークフロー要素を削除します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f,--force。存在しないワークフロー要素を無視します。

get-distribution-algorithm-prop

分散アルゴリズムのプロパティを表示します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

-z,--unit-size unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b、kb、mb、gb、またはtb(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。

-m,--unit-time unit。指定された単位を使用して時間データを表示します。unitの値には、ms、s、m、h、d、またはw(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。

get-distribution-partition-prop

分散パーティションのプロパティを表示します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--partition-name name。分散パーティションの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-global-index-catalog-replication-domain-prop

このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、第A.2.7項「gicadm」を参照してください。

グローバル索引カタログ・レプリケーション・ドメインのプロパティを表示します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-global-index-prop

このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、第A.2.7項「gicadm」を参照してください。

グローバル索引のプロパティを表示します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--index-name name。グローバル索引の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-distribution-algorithm

このコマンドはプロキシのみにサポートされます。

既存の分散アルゴリズムをリストします。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--property property。表示されるプロパティの名前。

list-distribution-partitions

このコマンドはプロキシのみにサポートされます。

既存の分散パーティションをリストします。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--property property。表示されるプロパティの名前。

list-extensions

既存の拡張をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-global-index-catalog-replication-domain

このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、第A.2.7項「gicadm」を参照してください。

既存のグローバル索引カタログ・レプリケーション・ドメインをリストします。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--property property。表示されるプロパティの名前。

list-global-indexes

既存のグローバル索引をリストします。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--property property。表示されるプロパティの名前。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-distribution-algorithm-prop

このコマンドはプロキシのみにサポートされます。

分散アルゴリズムのプロパティを変更します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-distribution-partition-prop

このコマンドはプロキシのみにサポートされます。

分散パーティションのプロパティを変更します。サブオプションは次のとおりです:

--element-name name。分散ワークフロー要素の名前。

--partition-name name。分散パーティションの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-extension-prop

拡張のプロパティを変更します。サブオプションは次のとおりです:

--extension-name name。拡張の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-global-index-catalog-replication-domain-prop

このコマンドはプロキシのみにサポートされます。

グローバル索引カタログ・レプリケーション・ドメインのプロパティを変更します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-global-index-prop

このコマンドはプロキシのみにサポートされます。

グローバル索引のプロパティを変更します。サブオプションは次のとおりです:

--extension-name name。グローバル索引カタログ拡張の名前。

--index-name name。グローバル索引の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-element-prop

ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.6 一般構成サブコマンド

次のサブコマンドによって、コア・サーバーが構成されます。

create-alert-handler

アラート・ハンドラを作成します。サブオプションは次のとおりです:

--handler-name name。新しいアラート・ハンドラの名前。

-t,--type type。作成するアラート・ハンドラのタイプ。typeの値には、custom、jmx、またはsmtpのいずれかを指定できます。

create-certificate-mapper

証明書マッパーを作成します。サブオプションは次のとおりです:

--mapper-name name。新しい証明書マッパーの名前。

-t,--type type。作成する証明書マッパーのタイプ。typeの値には、custom、fingerprint、subject-attribute-to-user-attribute、subject-dn-to-user-attribute、またはsubject-equals-dnのいずれかを指定できます。

create-connection-handler

接続ハンドラを作成します。サブオプションは次のとおりです:

--handler-name name。新しい接続ハンドラの名前。

-t,--type type。作成する接続ハンドラのタイプ。typeの値には、custom、jmx、ldap、snmp、またはldifのいずれかを指定できます。

create-debug-target

デバッグ・ターゲットを作成します。サブオプションは次のとおりです:

--publisher-name name。デバッグ・ログ・パブリッシャの名前。

--target-name java-name。新しいデバッグ・ターゲットの名前で、これはdebug-scopeプロパティの値としても使用できます。このターゲット定義の設定の影響を受ける完全修飾されたOracle Unified DirectoryのJavaパッケージ、クラス、またはメソッド。シャープ記号(#)を使用して、クラス名とメソッド名を分離します(例: org.opends.server.core.DirectoryServer#startUp)。

create-extended-operation-handler

このコマンドはプロキシに対してサポートされていません。

拡張操作ハンドラを作成します。サブオプションは次のとおりです:

--handler-name name。新しい拡張操作ハンドラの名前。

--set property:value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。

-t,--type type。作成する拡張操作ハンドラのタイプ。typeの値には、cancel、custom、get-connection-id、get-symmetric-key、password-modify、password-policy-state、start-tls、またはwho-am-iのいずれかを指定できます。

create-identity-mapper

IDマッパーを作成します。サブオプションは次のとおりです:

--mapper-name name。新しいIDマッパーの名前。

-t,--type type。作成するIDマッパーのタイプ。typeの値には、custom,exact-match、またはmatch-and-replaceのいずれかを指定できます。

create-log-publisher

ログ・パブリッシャを作成します。サブオプションは次のとおりです:

--publisher-name name。新しいログ・パブリッシャの名前。

-t,--type type。作成するログ・パブリッシャのタイプ。typeの値には、custom-access、custom-debug、custom-error、file-based-access、file-based-debug、またはfile-based-errorのいずれかを指定できます。

create-log-retention-policy

ログ保持ポリシーを作成します。サブオプションは次のとおりです:

--policy-name name。新しいログ保持ポリシーの名前。

-t,--type type。作成するログ保持ポリシーのタイプ。typeの値には、custom,file-count、free-disk-space、またはsize-limitのいずれかを指定できます。

create-log-rotation-policy

ログ・ローテーション・ポリシーを作成します。サブオプションは次のとおりです:

--policy-name name。新しいログ・ローテーション・ポリシーの名前。

-t,--type type。作成するログ・ローテーション・ポリシーのタイプ。typeの値には、custom、fixed-time、size-limit、またはtime-limitのいずれかを指定できます。

create-workflow-element --type monitor-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-network-group

ネットワーク・グループを作成します。サブオプションは次のとおりです:

--group-name name。新しいネットワーク・グループの名前。

create-network-group-qos-policy

ネットワーク・グループのリソース制限を作成します。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

-t, --type type。作成するサービスのクオリティ・ポリシーのタイプ。typeの値には、次のaffinity、referral、request-filtering、またはresource-limitsのいずれかを指定できます。

create-workflow

ワークフローを作成します。サブオプションは次のとおりです:

--workflow-name name。新規ワークフローの名前。この名前は、workflow-idプロパティの値としても使用されます。

delete-alert-handler

アラート・ハンドラを削除します。サブオプションは次のとおりです:

--handler-name name。アラート・ハンドラの名前。

-f,--force。存在しないアラート・ハンドラを無視します。

delete-certificate-mapper

証明書マッパーを削除します。サブオプションは次のとおりです:

--mapper-name name。証明書マッパーの名前。

-f,--force。存在しない証明書マッパーを無視します。

delete-connection-handler

接続ハンドラを削除します。サブオプションは次のとおりです:

--handler-name name。接続ハンドラの名前。

-f,--force。存在しない接続ハンドラを無視します。

delete-debug-target

デバッグ・ターゲットを削除します。サブオプションは次のとおりです:

--publisher-name name。デバッグ・ログ・パブリッシャの名前。

--target-name name。デバッグ・ターゲットの名前。

-f,--force。存在しないデバッグ・ターゲットを無視します。

delete-extended-operation-handler

拡張操作ハンドラを削除します。サブオプションは次のとおりです:

--handler-name name。拡張操作ハンドラの名前。

-f,--force。存在しない拡張操作ハンドラを無視します。

delete-identity-mapper

IDマッパーを削除します。サブオプションは次のとおりです:

--mapper-name name。IDマッパーの名前。

-f,--force。存在しないIDマッパーを無視します。

delete-log-publisher

ログ・パブリッシャを削除します。サブオプションは次のとおりです:

--publisher-name name。ログ・パブリッシャの名前。

-f,--force。存在しないログ・パブリッシャを無視します。

delete-log-retention-policy

ログ保持ポリシーを削除します。サブオプションは次のとおりです:

--policy-name name。ログ保持ポリシーの名前。

-f,--force。存在しないログ保持ポリシーを無視します。

delete-log-rotation-policy

ログ・ローテーション・ポリシーを削除します。サブオプションは次のとおりです:

--policy-name name。ログ・ローテーション・ポリシーの名前。

-f,--force。存在しないログ・ローテーション・ポリシーを無視します。

delete-network-group

ネットワーク・グループを削除します。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

-f,--force。存在しないネットワーク・グループを無視します。

delete-network-group-qos-policy

ネットワーク・グループのサービスのクオリティ・ポリシーを削除します。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

--policy-type name。QOSポリシーの名前。

-f,--force。存在しないネットワーク・グループのリソース制限を無視します。

delete-workflow

ワークフローを削除します。サブオプションは次のとおりです:

-f,--force。存在しないワークフローを無視します。

--workflow-name name。ワークフローの名前。

delete-workflow-element

ワークフロー要素を削除します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f,--force。存在しないワークフロー要素を無視します。

get-administration-connector-prop

管理コネクタのプロパティを表示します。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-alert-handler-prop

アラート・ハンドラのプロパティを表示します。サブオプションは次のとおりです:

--handler-name name。アラート・ハンドラの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-certificate-mapper-prop

証明書マッパーのプロパティを表示します。サブオプションは次のとおりです:

--mapper-name name。証明書マッパーの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-connection-handler-prop

接続ハンドラのプロパティを表示します。サブオプションは次のとおりです:

--handler-name name。接続ハンドラの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-debug-target-prop

デバッグ・ターゲットのプロパティを表示します。サブオプションは次のとおりです:

--publisher-name name。デバッグ・ログ・パブリッシャの名前。

--target-name name。デバッグ・ターゲットの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-extended-operation-handler-prop

拡張操作ハンドラのプロパティを表示します。サブオプションは次のとおりです:

--handler-name name。拡張操作ハンドラの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-global-configuration-prop

グローバル構成のプロパティを表示します。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-identity-mapper-prop

IDマッパーのプロパティを表示します。サブオプションは次のとおりです:

--mapper-name name。IDマッパーの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-log-publisher-prop

ログ・パブリッシャのプロパティを表示します。サブオプションは次のとおりです:

--publisher-name name。ログ・パブリッシャの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-log-retention-policy-prop

ログ保持ポリシーのプロパティを表示します。サブオプションは次のとおりです:

--policy-name name。ログ保持ポリシーの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-log-rotation-policy-prop

ログ・ローテーション・ポリシーのプロパティを表示します。サブオプションは次のとおりです:

--policy-name name。ログ・ローテーション・ポリシーの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-network-group-prop

ネットワーク・グループのプロパティを表示します。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-network-group-qos-policy-prop

ネットワーク・グループのサービスのクオリティ・ポリシーのプロパティを表示します。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

--policy-type name。サービスのクオリティ・ポリシーの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-plugin-root-prop

プラグイン・ルートのプロパティを表示します。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-root-dse-backend-prop

ルートDSEバックエンドのプロパティを表示します。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-work-queue-prop

ワーク・キューのプロパティを表示します。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-workflow-prop

ワークフローのプロパティを表示します。サブオプションは次のとおりです:

--workflow-name name。ワークフローの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-alert-handlers

既存のアラート・ハンドラをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-certificate-mappers

既存の証明書マッパーをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-connection-handlers

既存の接続ハンドラをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-debug-targets

既存のデバッグ・ターゲットをリストします。サブオプションは次のとおりです:

--publisher-name name。デバッグ・ログ・パブリッシャの名前。

--property property。表示されるプロパティの名前。

list-extended-operation-handlers

既存の拡張操作ハンドラをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-identity-mappers

既存のIDマッパーをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-log-publishers

既存のログ・パブリッシャをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-log-retention-policies

既存のログ保持ポリシーをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-log-rotation-policies

既存のログ・ローテーション・ポリシーをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-network-group-qos-policies

既存のネットワーク・グループのQOSポリシーをリストします。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

--property property。表示されるプロパティの名前。

list-network-groups

既存のネットワーク・グループをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-workflows

既存のワークフローをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-administration-connector-prop

管理コネクタのプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-alert-handler-prop

アラート・ハンドラのプロパティを変更します。サブオプションは次のとおりです:

--handler-name name。アラート・ハンドラの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-certificate-mapper-prop

証明書マッパーのプロパティを変更します。サブオプションは次のとおりです:

--mapper-name name。証明書マッパーの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-connection-handler-prop

接続ハンドラのプロパティを変更します。サブオプションは次のとおりです:

--handler-name name。接続ハンドラの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-debug-target-prop

デバッグ・ターゲットのプロパティを変更します。サブオプションは次のとおりです:

--publisher-name name。デバッグ・ログ・パブリッシャの名前。

--target-name name。デバッグ・ターゲットの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-extended-operation-handler-prop

拡張操作ハンドラのプロパティを変更します。サブオプションは次のとおりです:

--handler-name name。拡張操作ハンドラの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-global-configuration-prop

グローバル構成のプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-identity-mapper-prop

IDマッパーのプロパティを変更します。サブオプションは次のとおりです:

--mapper-name name。IDマッパーの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-log-publisher-prop

ログ・パブリッシャのプロパティを変更します。サブオプションは次のとおりです:

--publisher-name name。ログ・パブリッシャの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-log-retention-policy-prop

ログ保持ポリシーのプロパティを変更します。サブオプションは次のとおりです:

--policy-name name。ログ保持ポリシーの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-log-rotation-policy-prop

ログ・ローテーション・ポリシーのプロパティを変更します。サブオプションは次のとおりです:

--policy-name name。ログ・ローテーション・ポリシーの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-network-group-prop

ネットワーク・グループのプロパティを変更します。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-network-group-qos-policy-prop

ネットワーク・グループのサービスのクオリティ・ポリシーのプロパティを変更します。サブオプションは次のとおりです:

--group-name name。ネットワーク・グループの名前。

--policy-type name。QOSポリシーの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-plugin-root-prop

プラグイン・ルートのプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-root-dse-backend-prop

ルートDSEバックエンドのプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-work-queue-prop

ワーク・キューのプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-element-prop

ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-prop

ワークフローのプロパティを変更します。サブオプションは次のとおりです:

--workflow-name name。ワークフローの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.7 ロード・バランシング・サブコマンド

次のサブコマンドによって、プロキシ・サーバーのロード・バランシングが構成されます。

create-load-balancing-algorithm

このコマンドはプロキシのみにサポートされます。

ロード・バランシングのアルゴリズムを作成します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

-t,--type type。作成するロード・バランシングのアルゴリズムのタイプ。typeの値には、failover、generic、optimal、proportional、saturation、またはsearchfilterのいずれかを指定できます。デフォルト値はgenericです。

create-load-balancing-route

このコマンドはプロキシのみにサポートされます。

ロード・バランシングのルートを作成します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--route-name name。新しいロード・バランシングのルートの名前。

-t,--type type。作成するロード・バランシングのルートのタイプ。typeの値には、failover、generic、optimal、proportional、saturation、またはsearchfilterのいずれかを指定できます。デフォルト値はgenericです。

create-workflow-element --type load-balancing

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

delete-load-balancing-algorithm

ロード・バランシングのアルゴリズムを削除します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

-f,--force。存在しないロード・バランシングのアルゴリズムを無視します。

delete-load-balancing-route

ロード・バランシングのルートを削除します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--route-name name。ロード・バランシングのルートの名前。

-f,--force。存在しないロード・バランシングのルートを無視します。

delete-workflow-element

ワークフロー要素を削除します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f,--force。存在しないワークフロー要素を無視します。

get-load-balancing-algorithm-prop

ロード・バランシングのアルゴリズムのプロパティを表示します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-load-balancing-route-prop

このコマンドはプロキシのみにサポートされます。

ロード・バランシングのルートのプロパティを表示します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--route-name name。ロード・バランシングのルートの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-load-balancing-algorithm

このコマンドはプロキシのみにサポートされます。

既存のロード・バランシングのアルゴリズムをリストします。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--property property。表示されるプロパティの名前。

list-load-balancing-routes

このコマンドはプロキシのみにサポートされます。

既存のロード・バランシングのルートをリストします。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--property property。表示されるプロパティの名前。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-load-balancing-algorithm-prop

このコマンドはプロキシのみにサポートされます。

ロード・バランシングのアルゴリズムのプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-load-balancing-route-prop

このコマンドはプロキシのみにサポートされます。

ロード・バランシングのルートのプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ロード・バランシングのワークフロー要素の名前。

--route-name name。ロード・バランシングのルートの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-element-prop

ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.8 ローカル記憶域サブコマンド

create-account-status-notification-handler

アカウント・ステータス通知ハンドラを作成します。サブオプションは次のとおりです:

--handler-name name。新しいアカウント・ステータス通知ハンドラの名前。

-t,--type type。作成するアカウント・ステータス通知ハンドラのタイプ。typeの値には、custom、error-log、またはsmtpのいずれかを指定できます。

create-workflow-element --type backup-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

create-workflow-element --type db-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

create-entry-cache

エントリ・キャッシュを作成します。サブオプションは次のとおりです:

--cache-name name。新しいエントリ・キャッシュの名前。

-t,--type type。作成するエントリ・キャッシュのタイプ。typeの値には、custom、fifo、file-system、またはsoft-referenceのいずれかを指定できます。

create-group-implementation

このコマンドはプロキシに対してサポートされていません。

グループ実装を作成します。サブオプションは次のとおりです:

--implementation-name name。新しいグループ実装の名前。

-t, --type type。作成するグループ実装のタイプ。typeの値には、dynamic、static、またはvirtual-staticのいずれかを指定できます。

create-workflow-element --type ldif-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

create-local-db-index

ローカルDB索引を作成します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドのワークフロー要素の名前。

--index-name name。新しいローカルDB索引の名前で、これはattributeプロパティの値としても使用できます。これによって、索引が維持される属性の名前が指定されます。

create-local-db-vlv-index

ローカルDBのVLV索引を作成します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドのワークフロー要素の名前。

--index-name name。新しいローカルDBのVLV索引の名前で、これはnameプロパティの値としても使用できます。このプロパティによって、このVLV索引に一意の名前が指定されます。

create-workflow-element --type memory-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

create-workflow-element --type null-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

create-password-generator

パスワード・ジェネレータを作成します。サブオプションは次のとおりです:

--generator-name name。新しいパスワード・ジェネレータの名前。

-t,--type type。作成するパスワード・ジェネレータのタイプ。typeの値には、customまたはrandomのいずれかを指定できます。

create-password-policy

パスワード・ポリシーを作成します。サブオプションは次のとおりです:

--policy-name name。新しいパスワード・ポリシーの名前。

create-plugin --type password-policy-import

プラグインを作成します。サブオプションは次のとおりです:

--plugin-name name。新しいプラグインの名前。

-t,--type type。作成するプラグインのタイプ。typeの値には、dsee-gateway、password-policy-import、referential-integrity、seven-bit-clean、unique-attributeのいずれかを指定できます。

create-password-storage-scheme

パスワード・ストレージ・スキームを作成します。サブオプションは次のとおりです:

--scheme-name name。新しいパスワード・ストレージ・スキームの名前。

-t,--type type。作成するパスワード・ストレージ・スキームのタイプ。typeの値には、aes、base64、blowfish、clear、crypt、custom、md5、rc4、salted-md5、salted-sha1、salted-sha256、salted-sha384、salted-sha512、sha1、またはtriple-desのいずれかを指定できます。

create-password-validator

パスワード・バリデータを作成します。サブオプションは次のとおりです:

--validator-name name。新しいパスワード・バリデータの名前。

-t,--type type。作成するパスワード・バリデータのタイプ。typeの値には、attribute-value、character-set、custom、dictionary、length-based、repeated-characters、similarity-based、またはunique-charactersのいずれかを指定できます。

create-plugin --type referential-integrity

プラグインを作成します。サブオプションは次のとおりです:

--plugin-name name。新しいプラグインの名前。

create-plugin --type seven-bit-clean

プラグインを作成します。サブオプションは次のとおりです:

--plugin-name name。新しいプラグインの名前。

create-plugin --type unique-attribute

プラグインを作成します。サブオプションは次のとおりです:

--plugin-name name。新しいプラグインの名前。

create-virtual-attribute

このコマンドはプロキシに対してサポートされていません。

仮想属性を作成します。サブオプションは次のとおりです:

--name name。新しい仮想属性の名前。

-t,--type type。作成する仮想属性のタイプ。typeの値には、collective-attribute-subentries、custom、entry-dn、entry-uuid、governing-structure-rule、has-subordinates、is-member-of、member、nsuniqueid、num-subordinates、orclguid、password-policy-subentry、proximity、structural-object-class、subschema-subentry、user-definedのいずれかを指定できます。

delete-account-status-notification-handler

アカウント・ステータス通知ハンドラを削除します。サブオプションは次のとおりです:

--handler-name name。アカウント・ステータス通知ハンドラの名前。

-f,--force。存在しないアカウント・ステータス通知ハンドラを無視します。

delete-entry-cache

エントリ・キャッシュを削除します。サブオプションは次のとおりです:

--cache-name name。エントリ・キャッシュの名前。

-f,--force。存在しないエントリ・キャッシュを無視します。

delete-group-implementation

このコマンドはプロキシに対してサポートされていません。

グループ実装を削除します。サブオプションは次のとおりです:

--implementation-name name。グループ実装の名前。

-f,--force。存在しないグループ実装を無視します。

delete-local-db-index

ローカルDB索引を削除します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドのワークフロー要素の名前。

--index-name name。ローカルDB索引の名前。

-f,--force。存在しないローカルDB索引を無視します。

delete-local-db-vlv-index

ローカルDBのVLV索引を削除します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドのワークフロー要素の名前。

--index-name name。ローカルDBのVLV索引の名前。

-f,--force。存在しないローカルDBのVLV索引を無視します。

delete-password-generator

パスワード・ジェネレータを削除します。サブオプションは次のとおりです:

--generator-name name。パスワード・ジェネレータの名前。

-f,--force。存在しないパスワード・ジェネレータを無視します。

delete-password-policy

パスワード・ポリシーを削除します。サブオプションは次のとおりです:

--policy-name name。パスワード・ポリシーの名前。

-f,--force。存在しないパスワード・ポリシーを無視します。

delete-password-storage-scheme

パスワード・ストレージ・スキームを削除します。サブオプションは次のとおりです:

--scheme-name name。パスワード・ストレージ・スキームの名前。

-f,--force。存在しないパスワード・ストレージ・スキームを無視します。

delete-password-validator

パスワード・バリデータを削除します。サブオプションは次のとおりです:

--validator-name name。パスワード・バリデータの名前。

-f,--force。存在しないパスワード・バリデータを無視します。

delete-plugin

プラグインを削除します。サブオプションは次のとおりです:

--plugin-name name。プラグインの名前。

-f,--force。存在しないプラグインを無視します。

delete-virtual-attribute

このコマンドはプロキシに対してサポートされていません。

仮想属性を削除します。サブオプションは次のとおりです:

--name name。仮想属性の名前。

-f,--force。存在しない仮想属性を無視します。

delete-workflow-element

ワークフロー要素を削除します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f,--force。存在しないワークフロー要素を無視します。

get-account-status-notification-handler-prop

アカウント・ステータス通知ハンドラのプロパティを表示します。サブオプションは次のとおりです:

--handler-name name。アカウント・ステータス通知ハンドラの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-entry-cache-prop

エントリ・キャッシュのプロパティを表示します。サブオプションは次のとおりです:

--cache-name name。エントリ・キャッシュの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-group-implementation-prop

このコマンドはプロキシに対してサポートされていません。

グループ実装のプロパティを表示します。サブオプションは次のとおりです:

--implementation-name name。グループ実装の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-local-db-index-prop

ローカルDB索引のプロパティを表示します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドのワークフロー要素の名前。

--index-name name。ローカルDB索引の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-local-db-vlv-index-prop

ローカルDBのVLV索引のプロパティを表示します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドの名前。

--index-name name。ローカルDBのVLV索引の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-password-generator-prop

パスワード・ジェネレータのプロパティを表示します。サブオプションは次のとおりです:

--generator-name name。パスワード・ジェネレータの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-password-policy-prop

パスワード・ポリシーのプロパティを表示します。サブオプションは次のとおりです:

--policy-name name。パスワード・ポリシーの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-password-storage-scheme-prop

パスワード・ストレージ・スキームのプロパティを表示します。サブオプションは次のとおりです:

--scheme-name name。パスワード・ストレージ・スキームの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-password-validator-prop

パスワード・バリデータのプロパティを表示します。サブオプションは次のとおりです:

--validator-name name。パスワード・バリデータの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-virtual-attribute-prop

このコマンドはプロキシに対してサポートされていません。

仮想属性のプロパティを表示します。サブオプションは次のとおりです:

--name name。仮想属性の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-account-status-notification-handlers

既存のアカウント・ステータス通知ハンドラをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-entry-caches

既存のエントリ・キャッシュをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-group-implementations

このコマンドはプロキシに対してサポートされていません。

既存のグループ実装をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-local-db-indexes

既存のローカルDB索引をリストします。サブオプションは次のとおりです:

--element-name name。DBローカル・バックエンドのワークフロー要素の名前。

--property property。表示されるプロパティの名前。

list-local-db-vlv-indexes

既存のローカルDBのVLV索引をリストします。サブオプションは次のとおりです:

--element-name name。DBローカル・バックエンドのワークフロー要素の名前。

--property property。表示されるプロパティの名前。

list-password-generators

既存のパスワード・ジェネレータをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-password-policies

既存のパスワード・ポリシーをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-password-storage-schemes

既存のパスワード・ストレージ・スキームをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-password-validators

既存のパスワード・バリデータをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-plugins

既存のプラグインをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-virtual-attributes

このコマンドはプロキシに対してサポートされていません。

既存の仮想属性をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-account-status-notification-handler-prop

アカウント・ステータス通知ハンドラのプロパティを変更します。サブオプションは次のとおりです:

--handler-name name。アカウント・ステータス通知ハンドラの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-entry-cache-prop

エントリ・キャッシュのプロパティを変更します。サブオプションは次のとおりです:

--cache-name name。エントリ・キャッシュの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-group-implementation-prop

このコマンドはプロキシに対してサポートされていません。

グループ実装のプロパティを変更します。サブオプションは次のとおりです:

--implementation-name name。グループ実装の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-local-db-index-prop

ローカルDB索引のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドのワークフロー要素の名前。

--index-name name。ローカルDB索引の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-local-db-vlv-index-prop

ローカルDBのVLV索引のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ローカルDBバックエンドのワークフロー要素の名前。

--index-name name。ローカルDBのVLV索引の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-password-generator-prop

パスワード・ジェネレータのプロパティを変更します。サブオプションは次のとおりです:

--generator-name name。パスワード・ジェネレータの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-password-policy-prop

パスワード・ポリシーのプロパティを変更します。サブオプションは次のとおりです:

--policy-name name。パスワード・ポリシーの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-password-storage-scheme-prop

パスワード・ストレージ・スキームのプロパティを変更します。サブオプションは次のとおりです:

--scheme-name name。パスワード・ストレージ・スキームの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-password-validator-prop

パスワード・バリデータのプロパティを変更します。サブオプションは次のとおりです:

--validator-name name。パスワード・バリデータの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-plugin-prop

プラグインのプロパティを変更します。サブオプションは次のとおりです:

--plugin-name name。プラグインの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-virtual-attribute-prop

このコマンドはプロキシに対してサポートされていません。

仮想属性のプロパティを変更します。サブオプションは次のとおりです:

--name name。仮想属性の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-element-prop

ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.9 その他のワークフロー要素サブコマンド

この項では、様々なワークフロー操作のサブコマンドについて説明します。

create-workflow-element --type ad-paging

このコマンドにより、ADページングのワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-workflow-element --type eus-context

このコマンドにより、EUSコンテキストのワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-workflow-element --type eus

このコマンドにより、EUSのワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-workflow-element --type fa

このコマンドにより、FAのワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-workflow-element --type kerberos-auth-provider

このコマンドにより、Kerberos認証プロバイダのワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-workflow-element --type pass-through-authentication

このコマンドにより、パススルー認証のワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

create-workflow-element --type plugin

このコマンドにより、プラグインのワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

delete-workflow-element

このコマンドにより、ワークフロー要素が削除されます。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f, --force。存在しないワークフロー要素を無視します。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-workflow-element-prop

ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.10 リモート記憶域サブコマンド

この項では、様々なリモート記憶域操作のサブコマンドについて説明します。

create-extension --type ldap-server

このコマンドにより、LDAPサーバー拡張が作成されます。サブオプションは次のとおりです:

--extension-name name。新しい拡張の名前。

-t, --type type。作成する拡張のタイプ。typeの値には、global-index-catalog、global-index-catalogs-shared-cache、ldap-serverのいずれかを指定できます。

create-workflow-element --type proxy-ldap

このコマンドにより、プロキシLDAPのワークフロー要素が作成されます。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

delete-extension

を削除します。サブオプションは次のとおりです:

--extension-name name。拡張の名前。

-f,--force。存在しない拡張を無視します。

delete-workflow-element

ワークフロー要素を削除します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f,--force。存在しないワークフロー要素を無視します。

list-extensions

既存の拡張をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-extension-prop

このコマンドにより、拡張のプロパティが変更されます。サブオプションは次のとおりです:

--extension-name name。拡張の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-element-prop

このコマンドにより、ワークフロー要素のプロパティが変更されます。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.11 レプリケーション・サブコマンド

この項では、様々なレプリケーション操作のサブコマンドについて説明します。

create-plugin --type dsee-gateway

プラグインを作成します。サブオプションは次のとおりです:

--plugin-name name。プラグインの名前。

-t, --type type。作成するプラグインのタイプ。typeの値には、dsee-gateway、password-policy-import、referential-integrity、seven-bit-clean、unique-attributeのいずれかを指定できます。

create-gateway-domain

ゲートウェイ・ドメインを作成します。サブオプションは次のとおりです:

--plugin-name name。DSEEゲートウェイ・プラグインの名前。

--domain-name name。ゲートウェイ・ドメインの名前。

create-replication-domain

レプリケーション・ドメインを作成します。サブオプションは次のとおりです:

--provider-name name。マルチマスター同期化プロバイダの名前。

--domain-name name。新しいレプリケーション・ドメインの名前。

create-replication-server

レプリケーション・サーバーを作成します。サブオプションは次のとおりです:

--provider-name name。マルチマスター同期化プロバイダの名前。

create-synchronization-provider

同期化プロバイダを作成します。サブオプションは次のとおりです:

--provider-name name。新しい同期化プロバイダの名前。

-t,--type type。作成する同期化プロバイダのタイプ。typeの値には、custom、replicationのいずれかを指定できます。

delete-gateway-domain

ゲートウェイ・ドメインを削除します。サブオプションは次のとおりです:

--plugin-name name。DSEEゲートウェイ・プラグインの名前。

--domain-name name。ゲートウェイ・ドメインの名前。

-f, --force。存在しないゲートウェイ・ドメインを無視します。

delete-plugin

プラグインを削除します。サブオプションは次のとおりです:

--plugin-name name。プラグインの名前。

-f,--force。存在しないプラグインを無視します。

delete-replication-domain

レプリケーション・ドメインを削除します。サブオプションは次のとおりです:

--provider-name name。同期化プロバイダの名前。

--domain-name name。レプリケーション・ドメインの名前。

-f,--force。存在しないレプリケーション・ドメインを無視します。

delete-replication-server

レプリケーション・サーバーを削除します。サブオプションは次のとおりです:

--provider-name name。同期化プロバイダの名前。

-f,--force。存在しないレプリケーション・サーバーを無視します。

delete-synchronization-provider

同期化プロバイダを削除します。サブオプションは次のとおりです:

--provider-name name。同期化プロバイダの名前。

-f,--force。存在しない同期化プロバイダを無視します。

get-external-changelog-domain-prop

外部変更ログ・ドメインのプロパティを表示します。サブオプションは次のとおりです:

--provider-name name。レプリケーション同期化プロバイダの名前。

--domain-name name。レプリケーション・ドメインの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-gateway-domain-prop

ゲートウェイ・ドメインのプロパティを表示します。

--plugin-name name。DSEEゲートウェイ・プラグインの名前。

--domain-name name。ゲートウェイ・ドメインの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-replication-domain-prop

レプリケーション・ドメインのプロパティを表示します。サブオプションは次のとおりです:

--provider-name name。マルチマスター同期化プロバイダの名前。

--domain-name name。レプリケーション・ドメインの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-replication-server-prop

レプリケーション・サーバーのプロパティを表示します。サブオプションは次のとおりです:

--provider-name name。マルチマスター同期化プロバイダの名前。

--property property。表示されるプロパティの名前。

-E, --record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-synchronization-provider-prop

同期化プロバイダのプロパティを表示します。サブオプションは次のとおりです:

--provider-name name。同期化プロバイダの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-plugins

既存のプラグインをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-gateway-domains

既存のゲートウェイ・ドメインをリストします。サブオプションは次のとおりです。

--plugin-name name。DSEEゲートウェイ・プラグインの名前。

--property property。表示されるプロパティの名前。

list-replication-domains

既存のレプリケーション・ドメインをリストします。サブオプションは次のとおりです:

--provider-name name。レプリケーション同期化プロバイダの名前。

--property property。表示されるプロパティの名前。

list-replication-server

既存のレプリケーション・サーバーをリストします。サブオプションは次のとおりです:

--provider-name name。レプリケーション同期化プロバイダの名前。

--property property。表示されるプロパティの名前。

list-synchronization-providers

既存の同期化プロバイダをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-external-changelog-domain-prop

外部変更ログ・ドメインのプロパティを変更します。サブオプションは次のとおりです:

--provider-name name。レプリケーション同期化プロバイダの名前。

--domain-name name。レプリケーション・ドメインの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-gateway-domain-prop

ゲートウェイ・ドメインのプロパティを変更します。サブオプションは次のとおりです:

--plugin-name name。DSEEゲートウェイ・プラグインの名前。

--domain-name name。ゲートウェイ・ドメインの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-plugin-prop

プラグインのプロパティを変更します。サブオプションは次のとおりです:

--plugin-name name。プラグインの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-replication-domain-prop

レプリケーション・ドメインのプロパティを変更します。サブオプションは次のとおりです:

--provider-name name。レプリケーション同期化プロバイダの名前。

--domain-name name。レプリケーション・ドメインの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-replication-server-prop

レプリケーション・サーバーのプロパティを変更します。サブオプションは次のとおりです:

--provider-name name。レプリケーション同期化プロバイダの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-synchronization-provider-prop

同期化プロバイダのプロパティを変更します。サブオプションは次のとおりです:

--provider-name name。同期化プロバイダの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.12 スキーマ・サブコマンド

この項では、様々なスキーマ操作のサブコマンドについて説明します。

create-attribute-syntax

このコマンドはプロキシに対してサポートされていません。

属性構文を作成します。サブオプションは次のとおりです:

--syntax-name name。新しい属性構文の名前。

-t,--type type。作成する属性構文のタイプ。typeの値には、attribute-type-description、directory-string、generic、またはtelephone-numberのいずれかを指定できます。

create-matching-rule

このコマンドはプロキシに対してサポートされていません。

一致ルールを作成します。サブオプションは次のとおりです:

--rule-name name。新しい一致ルールの名前。

-t,--type type。作成する一致ルールのタイプ。typeの値には、collationまたはgeneric.のいずれかを指定できます。

delete-attribute-syntax

このコマンドはプロキシに対してサポートされていません。

属性構文を削除します。サブオプションは次のとおりです:

--syntax-name name。属性構文の名前。

-f,--force。存在しない属性構文を無視します。

delete-matching-rule

このコマンドはプロキシに対してサポートされていません。

一致ルールを削除します。サブオプションは次のとおりです:

--rule-name name。一致ルールの名前。

-f,--force。存在しない一致ルールを無視します。

get-attribute-syntax-prop

このコマンドはプロキシに対してサポートされていません。

属性構文のプロパティを表示します。サブオプションは次のとおりです:

--syntax-name name。属性構文の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-matching-rule-prop

このコマンドはプロキシに対してサポートされていません。

一致ルールのプロパティを表示します。サブオプションは次のとおりです:

--rule-name name。一致ルールの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-attribute-syntaxes

このコマンドはプロキシに対してサポートされていません。

既存の属性構文をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-matching-rules

このコマンドはプロキシに対してサポートされていません。

既存の一致ルールをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-attribute-syntax-prop

このコマンドはプロキシに対してサポートされていません。

属性構文のプロパティを変更します。サブオプションは次のとおりです:

--syntax-name name。属性構文の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-matching-rule-prop

このコマンドはプロキシに対してサポートされていません。

一致ルールのプロパティを変更します。サブオプションは次のとおりです:

--rule-name name。一致ルールの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.13 セキュリティ・サブコマンド

create-key-manager-provider

キー・マネージャ・プロバイダを作成します。サブオプションは次のとおりです:

--provider-name name。新しいキー・マネージャ・プロバイダの名前。

-t,--type type。作成するキー・マネージャ・プロバイダのタイプ。typeの値には、file-based、custom、またはpkcs11のいずれかを指定できます。

PKCS#11は、プロキシ・サーバー・インスタンスに対してサポートされていません。

create-sasl-mechanism-handler

このコマンドはプロキシに対してサポートされていません。

SASLメカニズム・ハンドラを作成します。サブオプションは次のとおりです:

--handler-name name。新しいSASLメカニズム・ハンドラの名前。

-t,--type type。作成するSASLメカニズム・ハンドラのタイプ。typeの値には、anonymous、cram-md5、digest-md5、external、custom、gssapi、またはplainのいずれかを指定できます。

create-trust-manager-provider

信頼マネージャ・プロバイダを作成します。サブオプションは次のとおりです:

--provider-name name。新しい信頼マネージャ・プロバイダの名前。

-t,--type type。作成する信頼マネージャ・プロバイダのタイプ。typeの値には、blind、file-based、またはcustomのいずれかを指定できます。

create-workflow-element --type trust-store-local-backend

ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend、distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

delete-key-manager-provider

キー・マネージャ・プロバイダを削除します。サブオプションは次のとおりです:

--provider-name name。キー・マネージャ・プロバイダの名前。

-f,--force。存在しないキー・マネージャ・プロバイダを無視します。

delete-sasl-mechanism-handler

このコマンドはプロキシに対してサポートされていません。

SASLメカニズム・ハンドラを削除します。サブオプションは次のとおりです:

--handler-name name。SASLメカニズム・ハンドラの名前。

-f,--force。存在しないSASLメカニズム・ハンドラを無視します。

delete-trust-manager-provider

信頼マネージャ・プロバイダを削除します。サブオプションは次のとおりです:

--provider-name name。信頼マネージャ・プロバイダの名前。

-f,--force。存在しない信頼マネージャ・プロバイダを無視します。

delete-workflow-element

ワークフロー要素を削除します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f,--force。存在しないワークフロー要素を無視します。

get-access-control-handler-prop

アクセス制御ハンドラのプロパティを表示します。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-crypto-manager-prop

暗号化マネージャのプロパティを表示します。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-key-manager-provider-prop

キー・マネージャ・プロバイダのプロパティを表示します。サブオプションは次のとおりです:

--provider-name name。キー・マネージャ・プロバイダの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-root-dn-prop

ルートDNのプロパティを表示します。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-sasl-mechanism-handler-prop

SASLメカニズム・ハンドラのプロパティを表示します。サブオプションは次のとおりです:

--handler-name name。SASLメカニズム・ハンドラの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-trust-manager-provider-prop

信頼マネージャ・プロバイダのプロパティを表示します。サブオプションは次のとおりです:

--provider-name name。信頼マネージャ・プロバイダの名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-key-manager-providers

既存のキー・マネージャ・プロバイダをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-sasl-mechanism-handlers

このコマンドはプロキシに対してサポートされていません。

既存のSASLメカニズム・ハンドラをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-trust-manager-providers

既存の信頼マネージャ・プロバイダをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-access-control-handler-prop

アクセス制御ハンドラのプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-crypto-manager-prop

暗号化マネージャのプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-key-manager-provider-prop

キー・マネージャ・プロバイダのプロパティを変更します。サブオプションは次のとおりです:

--provider-name name。キー・マネージャ・プロバイダの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-root-dn-prop

ルートDNのプロパティを変更します。サブオプションは次のとおりです:

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-sasl-mechanism-handler-prop

このコマンドはプロキシに対してサポートされていません。

SASLメカニズム・ハンドラのプロパティを変更します。サブオプションは次のとおりです:

--handler-name name。SASLメカニズム・ハンドラの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-trust-manager-provider-prop

信頼マネージャ・プロバイダのプロパティを変更します。サブオプションは次のとおりです:

--provider-name name。信頼マネージャ・プロバイダの名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-element-prop

ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.14 仮想化サブコマンド

この項では、仮想化のサブコマンドについて説明します。

create-transformation --type add-inbound-attribute

「インバウンドの追加」属性の変換を作成します。サブオプションは次のとおりです:

--transformation-name name。新しい変換の名前。

-t,--type type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attributeのいずれかを指定できます。各変換の詳細は、第11.6.3.2項「CLIを使用した変換の構成例」を参照してください。

create-transformation --type add-outbound-attribute

「アウトバウンドの追加」属性の変換を作成します。サブオプションは次のとおりです:

--transformation-name name。新しい変換の名前。

create-workflow-element --type dn-renaming

DNリネーム・ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

create-transformation --type filter-inbound-attribute

「インバウンドのフィルタ」属性の変換を作成します。サブオプションは次のとおりです:

--transformation-name name。新しい変換の名前。

create-transformation --type filter-outbound-attribute

「アウトバウンドのフィルタ」属性の変換を作成します。サブオプションは次のとおりです:

--transformation-name name。新しい変換の名前。

create-transformation --type map-attribute

属性のマップの変換を作成します。サブオプションは次のとおりです:

--transformation-name name。新しい変換の名前。

create-workflow-element --type rdn-changing

RDN変更ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

create-transformation

変換を作成します。サブオプションは次のとおりです:

--transformation-name name。新しい変換の名前。

-t,--type type。作成する変換のタイプ。typeの値には、add-inbound-attribute、dd-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attributeのいずれかを指定できます。

create-workflow-element --type transformations

変換ワークフロー要素を作成します。サブオプションは次のとおりです:

--element-name name。新しいワークフロー要素の名前。

-t,--type type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、backup-local-backend、db-local-backend,distribution、dn-renaming、eus、eus-context、fa、global-index-local-backend、global-index-replication-changes-local-backend、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdn-changing、transformations、trust-store-local-backendのいずれかを指定できます。

delete-transformation

変換を削除します。サブオプションは次のとおりです:

--transformation-name name。変換名。

-f, --force。存在しない変換を無視します。

delete-workflow-element

ワークフロー要素を削除します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

-f, --force。存在しないワークフロー要素を無視します。

get-transformation-prop

変換のプロパティを表示します。サブオプションは次のとおりです:

--transformation-name name。変換要素の名前。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

list-transformations

既存の変換をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

list-workflow-elements

既存のワークフロー要素をリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。

set-transformation-prop

変換のプロパティを変更します。サブオプションは次のとおりです:

--transformation-name name。変換要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

set-workflow-element-prop

ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:

--element-name name。ワークフロー要素の名前。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。

A.2.4.15 オプション

dsconfigコマンドは、短いフォーム(例: -h hostname)または同等の長いフォーム(例: --hostname hostname)のいずれかでオプションを受け入れます。

--advanced: 拡張コンポーネントとプロパティの構成を可能にします。

A.2.4.16 LDAP接続オプション

dsconfigコマンドは、管理コネクタを介してSSL上のディレクトリ・サーバーに接続します(第14.3項「サーバーへの管理トラフィックの管理」で説明しています)。これらの接続オプションは、ディレクトリ・サーバーとの接続に使用します。

-D, --bindDN bindDN

バインドDNを使用してサーバーにバインドします。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-h, --hostname hostname

指定されたホスト名またはIPアドレスのサーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。

-j, --bindPasswordFile filename

サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。

-K, --keyStorePath path

指定されたパスにクライアント・キーストア証明書を使用します。

-N, --certNickname nickname

SSLクライアント認証に証明書のニックネームを使用します。

-o, --saslOption name=value

指定されたオプションをSASL認証に使用します。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-p, --port port

指定された管理ポートでサーバーに接続します。このオプションが指定されない場合は、ローカル構成の管理ポートが使用されます。

-P, --trustStorePath path

指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。

-u, --keyStorePasswordFile filename

クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。

-U, --trustStorePasswordFile filename

クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。

-X, --trustAll

サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。クライアントとサーバーが同じインスタンスで実行している場合は、証明書の相互作用は生じません。

--connectTimeout {timeout}

これは、接続の確立に許容される最長時間(ミリ秒)の指定に使用します。タイムアウトを指定しない場合は、0を使用します。デフォルト値は30000です。

A.2.4.17 コマンド入力/出力オプション

--commandFilePath path: このコマンドがインタラクティブ・モードで実行されているときに同等の非インタラクティブ・コマンドの書込み先となるファイルへのフルパスを指定します。
--displayCommand: このコマンドがインタラクティブ・モードで実行されているときに、同等の非インタラクティブ・オプションを標準出力に表示します。
-F, --batchFilePath batchFilePath: 実行される一連のdsconfigコマンドが含まれているファイルへのパスを指定します。このオプションでは、行分割、バックスラッシュ('\')、引用文字列内での引用符(")とエスケープ付引用符(\")、およびコメント用ハッシュ('#')をサポートしています。
-n, --no-prompt: 非インタラクティブ・モードを使用します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
--noPropertiesFile: このコマンドでは、デフォルトのコマンドライン・オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
--sortMenuItems: インタラクティブ・モードを使用しているときに、メニュー・アイテムをソートできるようにします。ソート順序は、ユーザー・ロケールのアルファベット順です。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-s, --script-friendly: スクリプト・フレンドリ・モードで実行します。スクリプトが解析しやすいフォーマットで出力を表示します。
-v, --verbose: 標準出力に診断を表示する冗長モードで実行します。

A.2.4.18 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.4.19 例

次の例は、dsconfigコマンドの使用方法を示しています。その他のdsconfigの例については、第14.1項「dsconfigによるサーバー構成の管理」を参照してください。

例A-12 グローバル・ヘルプ・サブコマンドとグローバル・オプションの表示

次のコマンドは、サーバーに対して使用可能なグローバル・ヘルプ・サブコマンドとグローバル・オプションを表示します:

$ dsconfig --help

例A-13 コンポーネントのサブコマンドとヘルプ情報の表示

次のコマンドは、認証および認可に関連するサブコマンドを表示します:

$ dsconfig --help-security

例A-14 個別サブコマンドのヘルプの表示

次のコマンドは、set-distribution-partition-propサブコマンドのヘルプ情報を表示します:

$ dsconfig set-distribution-partition-prop --help

例A-15 コンポーネントのプロパティの表示

次のコマンドは、local-db-indexのプロパティを表示します。-tを指定しない場合は、すべてのコンポーネントのプロパティが表示されます。

$ dsconfig list-properties -c local-db-index
Option Types:

 r -- Property value(s) are readable
 w -- Property value(s) are writable
 m -- The property is mandatory
 s -- The property is single-valued
 a -- Administrative action is required for changes to take effect

Component       Type     Property                        Options  Syntax
------------------------------------------------------------------------------
local-db-index  generic  attribute                       r-ms-    OID
local-db-index  generic  index-entry-limit               rw-sa    INTEGER
local-db-index  generic  index-extensible-matching-rule  rw--a    LOCALE | OID
local-db-index  generic  index-type                      rwm-a    TYPE

次のコマンドは、crypto-managerのプロパティを表示します。

$ dsconfig list-properties -c crypto-manager
Option Types:

 r -- Property value(s) are readable
 w -- Property value(s) are writable
 m -- The property is mandatory
 s -- The property is single-valued
 a -- Administrative action is required for changes to take effect

Component       Type     Property                     Options  Syntax
----------------------------------------------------------------------
crypto-manager  generic  key-wrapping-transformation  rw-s-    STRING
crypto-manager  generic  ssl-cert-nickname            rw-sa    STRING
crypto-manager  generic  ssl-cipher-suite             rw---    STRING
crypto-manager  generic  ssl-encryption               rw-s-    BOOLEAN
crypto-manager  generic  ssl-protocol                 rw---    STRING

例A-16 -F, --batchFilePathサブコマンドでサポートされるパラメータ

この例では、-F, --batchFilePathサブコマンドでサポートされる様々なパラメータについて説明しています。

行分割アプローチを使用して-F, --batchFilePathサブコマンドを実行します。ファイル/tmp/batchには、次のコマンド・セットが含まれています:

create-workflow-element \
--type db-local-backend \
--set base-dn:cn=myexample,cn=com \
--set enabled:true \
--element-name myBackend

-F, --batchFilePathサブコマンドを実行します。

dsconfig -X -j /path/pwd-file -F /tmp/batch -n

引用符文字列内で引用符(")とエスケープ付引用符(\")を使用して、-F, --batchFilePathサブコマンドを実行します。ファイル/tmp/batchには、次のコマンド・セットが含まれています:

set-access-control-handler-prop \
--add global-aci:"(targetattr != \"description || mail\") \
(version 3.0; acl \"Allow self entry modification except for \
description and mail attributes\"; allow (write)userdn =\"ldap:///self\";) "

-F, --batchFilePathサブコマンドを実行します。

dsconfig -X  -j /path/pwd-file -F /tmp/batch -n

例A-17 sortMenuItemオプションを使用したロケール別の情報表示

この例では、--sortMenuItemsサブコマンドを使用してユーザーのロケール別に情報を表示する方法について説明します。この例では、dsconfigコマンドを実行する際に、--sortMenuItemsサブコマンドを指定した場合と指定しない場合の情報の表示方法の相違を強調表示しています。ステップ2ではメニューが米国式の順序で表示されるのに対し、ステップ3ではフランス式の順序で表示されます。

次のコマンドを使用して、目的のロケールを設定します:
```
export LC_ALL=fr_FR.UTF-8
```

--sortMenuItemsサブコマンドを指定しないで、dsconfigコマンドを実行します。

dsconfig -j /path/pwd-file

>>>> SpÃ©cifiez les paramÃ¨tres de connexion LDAP Oracle Unified Directory

Nom d'hÃ´te ou adresse IP du serveur d'annuaire [nixes] : 
NumÃ©ro de port d'administration du serveur d'annuaire [11444] : 
DN de liaison de l'administrateur [cn=Directory Manager] : 

>>>> Menu principal de la console de configuration Oracle Unified Directory

Que voulez-vous configurer ?

    1)   Gestionnaire de contrÃ´le      26)  Index VLV de base de donnÃ©es
         d'accÃ¨s                             locale
    2)   Gestionnaire de notification   27)  Editeur de journal
         de statuts de comptes               
    3)   Connecteur d'administration    28)  StratÃ©gie de conservation de
                                             journal
    4)   Gestionnaire d'alertes         29)  StratÃ©gie de rotation des
                                             journaux
    5)   Syntaxe d'attribut             30)  RÃ¨gle de correspondance
    6)   Mappeur de certificats         31)  Fournisseur de surveillance
    7)   Gestionnaire de connexions     32)  Groupe de rÃ©seaux
    8)   Gestionnaire de cryptage       33)  StratÃ©gie de qualitÃ© de service
                                             (QoS) du groupe de rÃ©seaux
    9)   Cible de dÃ©bogage             34)  GÃ©nÃ©rateur de mot de passe
    10)  Algorithme de distribution     35)  StratÃ©gie de mot de passe
    11)  Partition de distribution      36)  SchÃ©ma de stockage de mot de
                                             passe
    12)  Cache d'entrÃ©e                37)  Valideur de mot de passe
    13)  Gestionnaire d'opÃ©rations     38)  Plug-in
         d'extension                         
    14)  Extension                      39)  Racine de plug-in
    15)  Domaine de journal des         40)  Domaine de rÃ©plication
         modifications externe               
    16)  Domaine de passerelle          41)  Serveur de rÃ©plication
    17)  Configuration globale          42)  Nom distinctif (DN) racine
    18)  Index global                   43)  Back-end de la DSE racine
    19)  Domaine de rÃ©plication du     44)  Gestionnaire de mÃ©canisme SASL
         catalogue d'index globaux           
    20)  ImplÃ©mentation de groupe      45)  Fournisseur de synchronisation
    21)  Mappeur d'identitÃ©s           46)  Fournisseur de gestionnaire de
                                             sÃ©curisation
    22)  Fournisseur de gestionnaire    47)  Attribut virtuel
         de clÃ©s                             
    23)  Algorithme d'Ã©quilibrage de   48)  File d'attente de travaux
         charge                              
    24)  Route d'Ã©quilibrage de charge  49)  Workflow
    25)  Index de base de donnÃ©es       50)  ElÃ©ment de workflow

q)   quit

Entrez votre choix :

--sortMenuItemsサブコマンドを指定して、dsconfigコマンドを実行します。

dsconfig -j /path/pwd-file --sortMenuItems

>>>> SpÃ©cifiez les paramÃ¨tres de connexion LDAP Oracle Unified Directory

Nom d'hÃ´te ou adresse IP du serveur d'annuaire [nixes] : 
NumÃ©ro de port d'administration du serveur d'annuaire [11444] : 
DN de liaison de l'administrateur [cn=Directory Manager] : 

>>>> Menu principal de la console de configuration Oracle Unified Directory

Que voulez-vous configurer ?

    1)   Algorithme d'Ã©quilibrage de   26)  Gestionnaire de mÃ©canisme SASL
         charge                              
    2)   Algorithme de distribution     27)  Gestionnaire de notification de
                                             statuts de comptes
    3)   Attribut virtuel               28)  Groupe de rÃ©seaux
    4)   Back-end de la DSE racine      29)  GÃ©nÃ©rateur de mot de passe
    5)   Cache d'entrÃ©e                30)  ImplÃ©mentation de groupe
    6)   Cible de dÃ©bogage             31)  Index de base de donnÃ©es locale
    7)   Configuration globale          32)  Index global
    8)   Connecteur d'administration    33)  Index VLV de base de donnÃ©es
                                             locale
    9)   Domaine de journal des         34)  Mappeur d'identitÃ©s
         modifications externe               
    10)  Domaine de passerelle          35)  Mappeur de certificats
    11)  Domaine de rÃ©plication        36)  Nom distinctif (DN) racine
    12)  Domaine de rÃ©plication du     37)  Partition de distribution
         catalogue d'index globaux           
    13)  Editeur de journal             38)  Plug-in
    14)  ElÃ©ment de workflow           39)  Racine de plug-in
    15)  Extension                      40)  Route d'Ã©quilibrage de charge
    16)  File d'attente de travaux      41)  RÃ¨gle de correspondance
    17)  Fournisseur de gestionnaire    42)  SchÃ©ma de stockage de mot de
         de clÃ©s                             passe
    18)  Fournisseur de gestionnaire    43)  Serveur de rÃ©plication
         de sÃ©curisation                     
    19)  Fournisseur de surveillance    44)  StratÃ©gie de conservation de
                                             journal
    20)  Fournisseur de                 45)  StratÃ©gie de mot de passe
         synchronisation                     
    21)  Gestionnaire d'alertes         46)  StratÃ©gie de qualitÃ© de service
                                             (QoS) du groupe de rÃ©seaux
    22)  Gestionnaire d'opÃ©rations     47)  StratÃ©gie de rotation des
         d'extension                         journaux
    23)  Gestionnaire de connexions     48)  Syntaxe d'attribut
    24)  Gestionnaire de contrÃ´le      49)  Valideur de mot de passe
         d'accÃ¨s                             
    25)  Gestionnaire de cryptage       50)  Workflow

q)   quit

Entrez votre choix :

A.2.4.20 終了コード

終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。

A.2.4.21 プロパティ・ファイルの使用方法

サーバーでは、dsconfigコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

bindDN
bindPasswordFile
certNickname
hostname
keyStorePasswordFile
keyStorePath
port
saslOption

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
trustAll
trustStorePasswordFile
trustStorePath
useSSL
useStartTLS

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

dsconfig.trustAll=Yes

A.2.4.22 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/dsconfig
Windows: INSTANCE_DIR\OUD\bat\dsconfig.bat

A.2.4.23 関連コマンド

第A.2.7項「gicadm」

第A.2.6項「dsreplication」

A.2.5 dsjavaproperties

dsjavapropertiesコマンドは、各サーバー・コマンドで使用するJVMバージョンおよびJava引数を指定します。

A.2.5.1 シノプシス

dsjavaproperties [options]

A.2.5.2 説明

dsjavapropertiesコマンドを使用して、各サーバー・コマンドで使用するJVMバージョンおよびJava引数を指定できます。コマンド別のJVMおよびJava引数は、INSTANCE_DIR/OUD/config/java.propertiesに置かれているプロパティ・ファイル内で指定されます。dsjavapropertiesコマンドを実行しないかぎり、プロパティ・ファイルは使用されません。プロパティ・ファイルを編集する場合は、dsjavapropertiesを再実行して、新しい設定が考慮されるようにする必要があります。

dsjavapropertiesを使用して、-serverモードまたは-clientモードでJVMを使用してコマンドを実行するかどうか(特に引数)を指定できます。デフォルトでは、すべてのクライアント・アプリケーションは-clientモードで実行し、すべてのサーバー・ユーティリティは-serverモードで実行しています。一般に、-serverモードのスループットは-clientモードよりも高いものの、起動には若干多くの時間がかかります。

特定のコマンドについては(import-ldif、export-ldif、backup、およびrestore)、コマンドがオンライン・モードで実行しているか、またはオフライン・モードで実行しているかに応じて異なるJava引数(および異なるJVM)を指定することもできます。

overwrite-env-java-homeプロパティがjava.propertiesファイルでfalseに設定されている場合は、プロパティ・ファイルで指定された引数よりもOPENDS_JAVA_HOME環境変数が優先されます。overwrite-env-java-argsプロパティがjava.propertiesファイルでfalseに設定されている場合は、プロパティ・ファイルで指定された引数よりもOPENDS_JAVA_ARGS環境変数が優先されます。

A.2.5.3 オプション

dsjavapropertiesコマンドは、短いフォーム(例: -Q)または同等の長いフォーム(例: --quiet)のいずれかでオプションを受け入れます。

-Q, --quiet: 最小モードで実行します。最小モードでは、進捗状況情報は標準出力に出力されません。
-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.5.4 例

次の例は、export—ldifコマンドの使用方法を示しています。

例A-18 スクリプトの変更

この例は、コマンドがサーバー・オンラインで実行されるときにJVMの最大ヒープ・サイズである256Mバイトを使用するようにexport-ldifスクリプトを変更する方法を示しています。

INSTANCE_DIR/OUD/config/java.propertiesファイルを次のように編集して、export-ldif.online引数を設定します:
```
export-ldif.online.java-args=-client -Xms8m -Xmx256m
```

dsjavapropertiesコマンドを実行して、変更を有効にします。

$ dsjavaproperties
 The script files were successfully updated.  The Oracle Unified Directory 
 command-line utilities will use the java properties specified in the 
 properties file INSTANCE_DIR/OUD/config/java.properties

A.2.5.5 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.2.5.6 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/dsjavaproperties
Windows: INSTANCE_DIR\OUD\bat\dsjavaproperties.bat

A.2.6 dsreplication

dsreplicationコマンドは、ディレクトリ・サーバー間でレプリケーションを構成して、サーバーのデータが同期化されるようにします。

このコマンドはプロキシに対してサポートされていません。

A.2.6.1 シノプシス

dsreplication [subcommands] [options]

A.2.6.2 説明

dsreplicationコマンドを使用してディレクトリ・サーバー間でレプリケーションを構成し、サーバーのデータを同期化することができます。まず、enableサブコマンドを使用してレプリケーションを有効にし、次にinitializeサブコマンドを使用して一方のディレクトリ・サーバーのコンテンツをもう一方のサーバーのコンテンツで初期化します。

dsreplicationコマンドは、管理コネクタを使用してSSL上のサーバーに接続します(第14.3項「サーバーへの管理トラフィックの管理」を参照すること)。

dsconfigコマンドと同様に、dsreplicationはインタラクティブ・モードで実行できるため、レプリケーションの設定プロセスを段階的に処理することができます。dsreplicationをインタラクティブ・モードで実行するには、次の例に示すように、パラメータを指定しないでコマンド名を入力します:

$ dsreplication
What do you want to do?

1)  Enable Replication
2)  Disable Replication
3)  Initialize Replication on one Server
4)  Initialize All Servers
5)  Pre External Initialization
6)  Post External Initialization
7)  Display Replication Status
8)  Purge Historical
9)  Set the trust flag of the Directory Server
10) Enable External Changelog
11) Disable External Changelog

c)  cancel

Enter choice: 1
...

同等の非インタラクティブ・コマンドを表示するには、--displayCommandオプションまたは--commandFilePathオプションを使用します。

A.2.6.3 サーバー・サブコマンド

dsreplicationコマンドで使用されるサブコマンドは、次のとおりです。

disable

指定されたベースDNに対して、指定されたディレクトリ・サーバーのレプリケーションを無効にします。このサブコマンドは、このサーバーがデータをレプリケートしているサーバーの構成内で、指定されたサーバーへの参照を削除します。サブオプションは次のとおりです:

-D, --bindDN bindDN。レプリケーションが無効になるサーバーへのバインドに使用されるDN。サーバーでグローバル管理者が定義されていない場合、またはレプリケートされる他のサーバーで参照を削除したくない場合には、このオプションを使用する必要があります。このオプションを指定すると、グローバル管理者に対して指定されたパスワードが使用されます。

-a, --disableAll。指定されたサーバーのレプリケーション構成を無効にします。サーバーのコンテンツはレプリケートされなくなり、レプリケーション・サーバー(変更ログとレプリケーション・ポート)が構成されている場合はそれが無効になります。

--disableReplicationServer。レプリケーション・サーバーを無効にします。指定されたサーバーで、レプリケーション・ポートと変更ログが無効になります。

-h, --hostname host。ディレクトリ・サーバーのホスト名またはIPアドレス。

-p, --port port。ディレクトリ・サーバーの管理ポート番号。

disable-changelog

一連のベースDNの外部変更ログを無効にします。レプリケートするデータが存在しない場合、関連付けられたレプリケーション構成がすべて削除されます。外部変更ログの詳細は、第26.5項「外部変更ログの使用」を参照してください。サブオプションは次のとおりです:

-h, --hostname host

ディレクトリ・サーバーのホスト名またはIPアドレス。

-p, --port port

ディレクトリ・サーバーの管理ポート番号。

-D, --bindDN bindDN

外部変更ログの構成場所であるサーバーとのバインドに使用するDN。デフォルト値はcn=Directory Managerです。

enable-changelog

一連のベースDNに対して外部変更ログを作成します。外部変更ログの機能により、特定のベースDNで実行された変更を取得できます。外部変更ログの詳細は、第26.5項「外部変更ログの使用」を参照してください。サブオプションは次のとおりです:

-h, --hostname host

ディレクトリ・サーバーのホスト名またはIPアドレス。

-p, --port port

ディレクトリ・サーバーの管理ポート番号。

-D, --bindDN bindDN

外部変更ログの構成場所であるサーバーとのバインドに使用するDN。デフォルト値はcn=Directory Managerです。

-r, --replicationPort port

変更ログの構成に必要なポート。このオプションは、サーバーで変更ログ(またはレプリケーション)が以前に構成されていない場合のみ、指定する必要があります。デフォルト値は8989です。

enable

指定されたベースDNでデータをレプリケートするようにディレクトリ・サーバーの構成を更新します。指定したサーバーの1つがベースDNでデータをすでにレプリケートしている場合は、このサブコマンドを実行することによって全サーバーの構成が更新されます。したがって、レプリケーション・トポロジに追加されるサーバーごとに1回、このサブコマンドを実行するだけで十分です。サブオプションは次のとおりです:

--bindDN2 bindDN。レプリケートされるコンテンツのある第2のサーバーのバインドに使用するDN。バインドDNが指定されていない場合は、グローバル管理者がバインドに使用されます。

--bindPasswordFile1 filename。レプリケートされるコンテンツのある第1のサーバーへのバインドに使用されるパスワードが含まれているファイル。第1のサーバーに対してバインドDNが指定されていない場合は、グローバル管理者のパスワードがバインドに使用されます。

-D, --bindDN1 bindDN。レプリケートされるコンテンツのある第1のサーバーのバインドに使用するDN。バインドDNが指定されていない場合は、グローバル管理者がバインドに使用されます。

-F, --bindPasswordFile2 filename。レプリケートされるコンテンツのある第2のサーバーへのバインドに使用されるパスワードが含まれているファイル。第2のサーバーに対してバインドDNが指定されていない場合は、グローバル管理者のパスワードがバインドに使用されます。

-h, --host1 host。レプリケートされるコンテンツのある第1のサーバーのホスト名またはIPアドレス。

--noReplicationServer1。第1のサーバーで、レプリケーション・ポートまたは変更ログを構成しません。第1のサーバーにはレプリケートされたデータが含まれますが、レプリケートされたデータの変更をまとめた変更ログは含まれません。レプリケートされた各トポロジには、シングル・ポイント障害を回避するために、変更ログのあるサーバーが少なくとも2つ含まれている必要があります。

--noReplicationServer2。第2のサーバーで、レプリケーション・ポートまたは変更ログを構成しません。第2のサーバーにはレプリケートされたデータが含まれますが、レプリケートされたデータの変更をまとめた変更ログは含まれません。レプリケートされた各トポロジには、シングル・ポイント障害を回避するために、変更ログのあるサーバーが少なくとも2つ含まれている必要があります。

--noSchemaReplication。サーバー間でスキーマをレプリケートしません。スキーマ・レプリケーションはデフォルトで有効になっています。サーバー間でスキーマが同期化されないようにする場合は、このオプションを使用します。

--onlyReplicationServer1。第1のサーバーで、変更ログとレプリケーション・ポートのみを構成します。第1のサーバーにはレプリケートされたデータは含まれませんが、別のサーバー上でレプリケートされたデータの変更をまとめた変更ログは含まれます。

--onlyReplicationServer2。第2のサーバーで、変更ログとレプリケーション・ポートのみを構成します。第2のサーバーにはレプリケートされたデータは含まれませんが、別のサーバー上でレプリケートされたデータの変更をまとめた変更ログは含まれます。

-O, --host2 host。レプリケートされるコンテンツのある第2のサーバーのホスト名またはIPアドレス。

-p, --port1 port。レプリケートされるコンテンツのある第1のサーバーのディレクトリ・サーバー管理ポート番号。

--port2 port。レプリケートされるコンテンツのある第2のサーバーのディレクトリ・サーバー管理ポート番号。

-r, --replicationPort1 port。他のサーバーと通信するために、最初のディレクトリ・サーバーのレプリケーション・メカニズムにより使用されるポート。このオプションは、最初のディレクトリ・サーバーでレプリケーションが以前に構成されていない場合のみ指定します。

-R, --replicationPort2 port。他のサーバーと通信するために、2番目のディレクトリ・サーバーのレプリケーション・メカニズムにより使用されるポート。このオプションは、第2のサーバーでレプリケーションが以前に構成されていない場合のみ指定します。

-S, --skipPortCheck。指定されたレプリケーション・ポートが使用可能かどうかの判別チェックをスキップします。この引数が指定されない場合、サーバーは、ローカル・ホストを構成している場合のみポートが使用可能であると判断します。

--secureReplication1。第1のサーバーのレプリケーション・ポートを介した通信が暗号化されているかどうかを指定します。このオプションは、第1のサーバーでレプリケーションが初めて構成されるときのみ考慮されます。

--secureReplication2。第2のサーバーのレプリケーション・ポートを介した通信が暗号化されているかどうかを指定します。このオプションは、第2のサーバーでレプリケーションが初めて構成されるときのみ考慮されます。

--useSecondServerAsSchemaSource。第2のサーバーを使用して、第1のサーバーのスキーマを初期化します。このオプションと--noSchemaReplicationオプションがいずれも指定されていない場合は、第1のサーバーのスキーマを使用して第2のサーバーのスキーマが初期化されます。

initialize

宛先ディレクトリ・サーバー上の指定されたベースDNのデータのコンテンツを、ソース・サーバーのコンテンツで初期化します。この操作は、レプリケーションを有効にした後で必要になります。サブオプションは次のとおりです:

-h, --hostSource host。宛先サーバーの初期化に使用されるコンテンツのあるソース・サーバーのディレクトリ・サーバー・ホスト名またはIPアドレス。

-O, --hostDestination host。初期化されるコンテンツのある宛先サーバーのディレクトリ・サーバー・ホスト名またはIPアドレス。

-p, --portSource port。宛先サーバーの初期化に使用されるコンテンツのあるソース・サーバーのディレクトリ・サーバー管理ポート番号。

--portDestination port。初期化されるコンテンツのある宛先サーバーのディレクトリ・サーバー管理ポート番号。

initialize-all

トポロジ内のすべてのディレクトリ・サーバーで、指定されたベースDNのデータを指定されたサーバーのデータで初期化します。この操作は、レプリケーションを有効にしてレプリケーションが機能するようにした後で必要になります。または、トポロジ内の個々のサーバーでinitializeサブコマンドを使用することもできます。サブオプションは次のとおりです:

-h, --hostname host。ソース・サーバーのディレクトリ・サーバー・ホスト名またはIPアドレス。

-p, --port port。ソース・サーバーのディレクトリ・サーバー管理ポート番号。

post-external-initialization

import-ldifまたはバイナリ・コピーを使用してトポロジ全体が再初期化された後で、レプリケーションが機能できるようにします。import-ldifまたはバイナリ・コピーを使用してトポロジ内のすべてのディレクトリ・サーバーのコンテンツを初期化した後で、このサブコマンドをコールする必要があります。このサブコマンドを実行しない場合、初期化後にレプリケーションは機能しなくなります。サブオプションは次のとおりです:

-h, --hostname host。ディレクトリ・サーバーのホスト名またはIPアドレス。

-p, --port port。ディレクトリ・サーバーの管理ポート番号。

pre-external-initialization

import-ldifまたはバイナリ・コピーを使用して、初期化のためにレプリケーション・トポロジを準備します。import-ldifまたはバイナリ・コピーを使用してトポロジ内のすべてのディレクトリ・サーバーのコンテンツを初期化する前に、このサブコマンドをコールする必要があります。このサブコマンドを実行しない場合、初期化後にレプリケーションは機能しなくなります。このサブコマンドを実行した後で、トポロジ内のすべてのサーバーのコンテンツを初期化し、さらにサブコマンドpost-external-initializationを実行します。サブオプションは次のとおりです:

-h, --hostname host。ディレクトリ・サーバーのホスト名またはIPアドレス。

-l, --local-only。指定されたディレクトリ・サーバーのみのコンテンツを外部方法によって初期化する場合に、このオプションを使用します。

-p, --port port。ディレクトリ・サーバーの管理ポート番号。

purge-historical

ユーザー・エントリに保存されている履歴情報のパージ処理をレプリケーションによって起動します。この処理には少し時間がかかるため、この処理の最大継続時間を指定する必要があります。サブオプションは次のとおりです:

-h, --hostname host。ディレクトリ・サーバーのホスト名またはIPアドレス。

-p, --port port。ディレクトリ・サーバーの管理ポート番号。

--maximumDuration maximum duration。パージ処理が継続される必要のある最大継続時間を秒単位で指定します。デフォルト値は3600です。

-t, --start startTime。この処理がサーバー・タスクとしてスケジュールされている場合、UTC時間の場合はYYYYMMDDhhmmssZで、ローカル時間の場合はYYYYMMDDhhmmssで表記した処理の開始日時を指定します。タスクを即時実行するようにスケジュールするには、0を使用します。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にユーティリティが終了します。

--recurringTask schedulePattern。タスクは再帰的であり、crontab(5)互換の時間/日付パターンで表記される値引数に従ってスケジュールされることを示します。

--completionNotify emailAddress。タスク終了時に通知される受信者の電子メール・アドレスを示します。このオプションは、複数回指定できます。

--errorNotify emailAddress。このタスクの実行時にエラーが発生した場合に通知される受信者の電子メール・アドレスを示します。このオプションは、複数回指定できます。

--dependency taskID。このタスクが依存するタスクのIDを示します。依存タスクがすべて実行を完了するまで、タスクの実行は開始しません。

--failedDependencyAction action。依存タスクの1つが失敗した場合に行われる必要のあるアクションを示します。これには、次の値、PROCESS、CANCEL、またはDISABLEのいずれか1つが割り当てられている必要があります。デフォルト値はCANCELです。

set-trust

ディレクトリ・サーバーの信頼フラグを設定します。信頼できないディレクトリ・サーバーによって送信された変更は、トポロジのその他のサーバーにより破棄されます。信頼できるディレクトリ・サーバーのみが変更を送信して、他のディレクトリ・サーバーでその変更がリプレイされるようにすることができます。サブオプションは次のとおりです:

-h, --trustedHost host。変更を実行するディレクトリ・サーバーの完全修飾ホスト名またはIPアドレスを指定します。

-p, --trustedPort port。変更を実行するディレクトリ・サーバーの管理ポート番号を指定します。

-M, --modifiedHost host。信頼フラグが変更されるディレクトリ・サーバーの完全修飾ホスト名またはIPアドレスを指定します。

-c, --modifiedPort port。信頼フラグが変更されるディレクトリ・サーバーの管理ポート番号を指定します。

-t, --trustValue trusted|untrusted。変更されるディレクトリ・サーバーの信頼フラグの新しい値を指定します。値には、trustedまたはuntrustedを指定できます。デフォルト値はtrustedです。

status

登録情報に定義されたすべてのディレクトリ・サーバーの指定されたベースDNに対するレプリケーション構成をリストします。ベースDNが指定されない場合は、すべてのベースDNの情報が表示されます。サブオプションは次のとおりです:

-h, --hostname host。ディレクトリ・サーバーのホスト名またはIPアドレス。

-p, --port port。ディレクトリ・サーバーの管理ポート番号。

-s, --script-friendly。スクリプトにより解析可能なフォーマットでステータスを表示します。

statusサブコマンドは次の値を持ちます:

正常。レプリケーション・サーバーとの接続が正しいデータ・セットで確立されます。レプリケーションが機能しています。保証モードを使用している場合は、このディレクトリ・サーバーから承認シグナルが送信されます。
機能低下。レプリケーション・サーバーとの接続が正しいデータ・セットで確立されます。ディレクトリ・サーバーのリプレイの必要な多数の変更がレプリケーション・サーバー・キューに保留中であるため、レプリケーションは低下モードで動作しています。保証モードを使用している場合、このディレクトリ・サーバーからの承認シグナルは予想されません。
完全更新。レプリケーション・サーバーとの接続が確立され、ローカル・バックエンドを初期化するために、新しいデータ・セットがこの接続から受信されます(オンライン・インポート)。
不正データ・セット。レプリケーション・サーバーとの接続が、トポロジの他のディレクトリ・サーバーとは異なるデータ・セットで確立されます。レプリケーションは機能していません。トポロジの他のディレクトリ・サーバーを互換性のあるデータ・セットで初期化するか、このサーバーを他のサーバーと互換性のある別のデータ・セットで初期化する必要があります。
未接続。ディレクトリ・サーバーは、どのレプリケーション・サーバーとも接続されていません。

A.2.6.4 オプション

dsreplicationコマンドは、短いフォーム(例: -H)または同等の長いフォーム(例: --help)のいずれかでオプションを受け入れます。

-b, --baseDN baseDN: レプリケートまたは初期化するデータ、あるいはレプリケーションを無効にする必要のあるデータのベースDNを指定します。このオプションを複数回使用すると、複数のベースDNを指定できます。

A.2.6.5 構成オプション

--advanced: このコマンドをインタラクティブ・モードで実行しているときに、このオプションを使用して詳細設定にアクセスします。

A.2.6.6 LDAP接続オプション

-I, --adminUID adminUID

サーバーにバインドするためにグローバル管理者のユーザーIDを指定します。どのサーバーに対しても以前にグローバル管理者が定義されていない場合は、このオプションによって、指定されたデータを使用してグローバル管理者が作成されます。

-j, --adminPasswordFile bindPasswordFile

ディレクトリ・サーバーに対して認証を受ける際、指定したファイルでグローバル管理者パスワードを使用します。

-o, --saslOption name=value

指定されたオプションをSASL認証に使用します。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-X, --trustAll

SSLまたはStartTLSのネゴシエーション中にサーバーによって提示される可能性のある証明書をすべて信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

-P, --trustStorePath trustStorePath

-U, --TrustStorePasswordFile path

-K, --keyStorePath keyStorePath

指定されたパスにクライアント・キーストア証明書を使用します。

-u, --keyStorePasswordFile keyStorePasswordFile

-N, --certNickname nickname

指定された証明書を認証に使用します。

--connectTimeout timeout

接続の確立に許容される最長時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、0を使用します。デフォルト値は30000です。

A.2.6.7 コマンド入力/出力オプション

--commandFilePath path: このコマンドがインタラクティブ・モードで実行されているときに同等の非インタラクティブ・コマンドの書込み先となるファイルへのフルパスを指定します。
--displayCommand: コマンドがインタラクティブ・モードで実行されているときに、同等の非インタラクティブ・コマンドを標準出力に表示します。
-n, --no-prompt: 非インタラクティブ・モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
--noPropertiesFile: このコマンドでは、デフォルトのコマンドライン・オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath propertiesFilePath: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。

A.2.6.8 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.6.9 例

次の例では、2つのディレクトリ・サーバー、host1およびhost2がインストールされていることが前提となります。両方のサーバーがデフォルトの管理ポート(4444)を使用して構成されています。ベースDN dc=example,dc=comに、host1のデータが移入されます。ベースDNはhost2に存在していますが、空です。この例では、2つのサーバー間でレプリケーションを構成し、host2をデータで初期化しています。

注意:

dsreplicationの最も簡単な使用方法はインタラクティブ・モードで使用することです。その場合、すべての関連引数に関してプロンプトが表示されます。ただし、構成される引数を示すために、これらの例ではインタラクティブ・モードを使用していません。

例A-19 ディレクトリ・サーバー・レプリケーションの有効化

次のコマンドによって、host1およびhost2のベースDNdc=example,dc=comに対してレプリケーションが有効になります。このコマンドは非インタラクティブ・モードで実行し(-n)、すべてのサーバー証明書を受け入れる必要があることを指定します(-X)。

$ dsreplication enable \
  --host1 host1 --port1 4444 --bindDN1 "cn=Directory Manager" \
  --bindPasswordFile1 /tmp/pwd-file --replicationPort1 8989 \
  --host2 host2 --port2 4444 --bindDN2 "cn=Directory Manager" \
  --bindPasswordFile2 /tmp/pwd-file --replicationPort2 8989 \
  --adminUID admin --adminPasswordFile /tmp/pwd-file --baseDN "dc=example,dc=com" -X -n

例A-20 ディレクトリ・サーバー・レプリケーションの初期化

あるレプリカを別のレプリカから初期化するには、initializeサブコマンドを使用します。次のコマンドによって、host2にあるベースDNdc=example,dc=comがhost1に含まれているデータで初期化されます。このコマンドは非インタラクティブ・モードで実行し(-n)、すべてのサーバー証明書を受け入れる必要があることを指定します(-X)。

$ dsreplication initialize --baseDN "dc=example,dc=com" \
  --adminUID admin --adminPasswordFile /tmp/pwd-file \
  --hostSource host1 --portSource 4444 \
  --hostDestination host2 --portDestination 4444 -X -n

トポロジ全体を初期化するには、initialize-allサブコマンドを使用します。このサブコマンドはソース・ディレクトリ・サーバーの詳細をオプションとして取り、レプリケーションが有効になっているその他のすべてのレプリカを初期化します。

例A-21 ディレクトリ・サーバーのレプリケーション・ステータスの取得

次のコマンドにより、トポロジ内のディレクトリ・サーバーのレプリケーション・ステータスが取得されます。

$ dsreplication status --adminUID admin --adminPasswordFile /tmp/pwd-file -X --hostname host1 --port 4444

dc=example,dc=com - Replication Enabled
=======================================
Server     : Entries:M.C.[1]:A.O.M.C.[2]:Port[3]:Encryption[4]:Trust[5]:U.C.[6]:Status[7]:ChangeLog[8]:Group ID[9]:Connected to[10]
-----------:--------:-------:-----------:-------:-------------:--------:-------:---------:------------:-----------:-------------------------
host1:4444 : 200000 : 0     : N/A       : 1898  : Disabled    :Trusted : N/A   : Normal  : Enabled    : 1         :host1/203.0.113.24:1898
host2:5444 : 200000 : 0     : N/A       : 2898  : Disabled    :Trusted : N/A   : Normal  : Enabled    : 1         :host2/203.0.113.24:2898

[1] The number of changes that are still missing on this server (and that have been applied to at least one 
    other server).
[2] Age of oldest missing change: the age (in seconds) of the oldest change that has not yet arrived on this 
    server.
[3] The port used to communicate between the servers whose contents are being replicated.
[4] Whether the replication communication through the replication port is encrypted or not.
[5] Whether this directory server is trusted or not. Updates coming from an untrusted server are discarded and 
    not propagated.
[6] The number of untrusted changes. These are changes generated on this server while it is untrusted.
    Those changes are not propagated to the rest of the topology but are effective on the untrusted server.
[7] The status of the replication domain on this directory server.
[8] Whether the external change log is enabled or not for the base DN on this server.
[9] The ID of the replication group to which the server belongs.
[10] The replication this server is connected to.

例A-22 ディレクトリ・サーバー・レプリケーションの無効化

次のコマンドによって、host2にあるベースDNdc=example,dc=comのレプリケーションが無効になります。あるディレクトリ・サーバーのレプリケーションを無効にすると、そのサーバーに対するすべての参照が、レプリケーション・トポロジにあるその他のディレクトリ・サーバーから削除されます。

$ dsreplication disable --baseDN "dc=example,dc=com" \
--hostname host2 --port 4444 --adminUID admin --adminPasswordFile /tmp/pwd-file \
-X -n
Establishing connections ..... Done.
Disabling replication on base DN cn=admin data of server host2:4444 ..... Done.
Disabling replication on base DN dc=example,dc=com of server host2:4444 ..... Done.
Disabling replication on base DN cn=schema of server host2:4444 ..... Done.
Removing references on base DN cn=admin data of server host1:4444 ..... Done.
Removing references on base DN dc=example,dc=com of server host1:4444 ..... Done.
Removing references on base DN cn=schema of server host1:4444 ..... Done.
Disabling replication port 8990 of server host2:4444 ..... Done.

例A-23 レプリケートされないサーバーでの外部変更ログの構成

次のコマンドによって、レプリケートされないサーバーで外部変更ログが有効になります。

$ dsreplication status -h localhost -p 4444 -D "cn=directory manager" --adminPasswordFile /tmp/pwd-file -X -n

dc=example,dc=com - Replication Disabled
========================================
Server         : Entries : ChangeLog [8]
---------------:---------:--------------
localhost:4444 : 0       : Disabled

dsreplication enable-changelog -h localhost -p 4444 -D "cn=directory manager" --adminPasswordFile /tmp/pwd-file -X -b dc=example,dc=com -n

Establishing connections ..... Done.
Enabling Changelog on base DN 'dc=example,dc=com' ...... Done.
Configuring Replication port on server localhost:4444 ..... Done.

dsreplication status -h localhost -p 4444 -D "cn=directory manager" -j pwd-file -x -n

dc=example,dc=com - Replication Enabled
=======================================
Server     : Entries:M.C.[1]:A.O.M.C.[2]:Port[3]:Encryption[4]:Trust[5]:U.C.[6]:Status[7]:ChangeLog[8]:Group ID[9]:Connected to[10]
-----------:--------:-------:-----------:-------:-------------:--------:-------:---------:------------:----------:-------------------------
host1:4444 : 200000 : N/A   : N/A       : 1898  : Disabled    :Trusted : N/A   : Normal  : Enabled    : 1        : host1/203.0.113.24:1898

[1] The number of changes that are still missing on this server (and that have been applied to at least one 
    other server).
[2] Age of oldest missing change: the age (in seconds) of the oldest change that has not yet arrived on this 
    server.
[3] The port used to communicate between the servers whose contents are being replicated.
[4] Whether the replication communication through the replication port is encrypted or not.
[5] Whether this directory server is trusted or not. Updates coming from an untrusted server are discarded and 
    not propagated.
[6] The number of untrusted changes. These are changes generated on this server while it is untrusted.
    Those changes are not propagated to the rest of the topology but are effective on the untrusted server.
[7] The status of the replication domain on this directory server.
[8] Whether the external change log is enabled or not for the base DN on this server.
[9] The ID of the replication group to which the server belongs.
[10] The replication this server is connected to.

A.2.6.10 終了コード

0: 成功。
1: 引数を初期化できません。
2: 指定された引数が有効でないか、ユーザー・データのチェックでエラーが発生したため、引数を解析できません。
3: ユーザーがインタラクティブ・モードで操作を取り消しました。
4: 引数が競合しています。
5: 指定されたベースDNを使用してレプリケーションを有効にすることができません。
6: 指定されたベースDNを使用してレプリケーションを無効にすることができません。
7: 指定されたベースDNを使用してレプリカのコンテンツを初期化することができません。
8: 指定された資格証明による接続でエラーが生じました。
9: レプリカの初期化に使用するドメインのレプリケーションIDが見つかりませんでした。
10: 初期化開始の最大試行回数を超えています。システマティックな「ピアが見つからないエラー」が受信されました。
11: ベースDNでのレプリケーションの有効化でエラーが生じました。
12: ベースDNの初期化でエラーが生じました。
13: 構成の読取り中にエラーが生じました。
14: ADSの更新中にエラーが生じました。
15: ADSの読取り中にエラーが生じました。
16: トポロジ・キャッシュの読取り中にエラーが生じました。
17: レプリケーション・サーバーの構成中にエラーが生じました。
18: サポートされていないADSシナリオです。
19: ベースDNでのレプリケーションの無効化でエラーが生じました。
20: ベースDNでのレプリケーション・ポート参照の削除中にエラーが生じました。
21: 管理フレームワークの初期化でエラーが生じました。
22: トラスト・ストアのシード中にエラーが生じました。
23: 事前外部初期化の起動中にエラーが生じました。
24: 事後外部初期化の起動中にエラーが生じました。
25: レプリケーション・サーバーの無効化でエラーが生じました。
26: 履歴のパージの実行中にエラーが生じました。
27: 指定されたベースDNをパージできません。
28: 履歴のパージの起動中にエラーが生じました。
29: 履歴のローカル・パージでの構成クラスのロード中にエラーが生じました。
30: 履歴のローカル・パージでのサーバーの起動中にエラーが生じました。
31: 履歴のローカル・パージでタイムアウト・エラーが生じました。
32: 履歴のローカル・パージ実行中の一般的なエラーです。
33: 信頼できるホストがADSに見つかりませんでした。
34: 変更されたホストがADSに見つかりませんでした。
35: このベースDNでは変更ログを有効にできません。
36: このベースDNでは変更ログを無効にできません。
37: 変更ログの構成中にエラーが生じました。
38: 指定されたホストが構成に見つかりませんでした。

A.2.6.11 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、dsreplicationコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

adminUID
baseDN
certNickname
keyStorePasswordFile
keyStorePath
saslOption

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
trustAll
trustStorePasswordFile
trustStorePath

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

dsreplication.baseDN=dc=example,dc=com

A.2.6.12 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/dsreplication
Windows: INSTANCE_DIR\OUD\bat\dsreplication.bat

A.2.6.13 関連コマンド

第A.2.4項「dsconfig」

A.2.7 gicadm

gicadmコマンドは、グローバル索引とグローバル索引カタログを管理します。

このコマンドはプロキシのみにサポートされます。

A.2.7.1 シノプシス

gicadm [subcommand] [options]

A.2.7.2 説明

gicadmコマンドにより、グローバル索引カタログの作成と削除、グローバル索引カタログ内でのグローバル索引の追加、変更、および削除と、グローバル索引カタログのレプリケーションの管理を実行できます。また、グローバル索引と分散との関連付けも実行できます。

gicadmコマンドは、管理コネクタを介してSSL上のサーバーにアクセスします。

A.2.7.3 オプション

gicadmコマンドは、次のオプションを受け入れます。

add-index

新しいグローバル索引をグローバル索引カタログに追加します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--attributeName attribute-name。グローバル索引属性の識別子。この識別子はグローバル索引カタログのコンテキストにおいて一意である必要があり、グローバル索引の識別に使用されます。

associate

グローバル索引カタログを分散ワークフロー要素に関連付けます。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

-d, --distributionWorkflowElement distribution-workflow-element。このグローバル索引カタログを使用する分散ワークフロー要素のオブジェクト名であり、グローバル索引カタログはこの関連付けを解除されます。

create-catalog

新しいグローバル索引カタログを作成します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

delete-catalog

グローバル索引カタログを削除します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

disable-replication

指定されたグローバル索引カタログに対して指定されたサーバーのレプリケーションを無効にし、そのサーバーに対するすべての参照を、レプリケーション・トポロジにあるその他のサーバーから削除します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--adminUID adminUID。サーバーへのバインドに使用するグローバル管理者のユーザーID。enable-replicationサブコマンドについては、以前にグローバル管理者が定義されていない場合は、指定されたデータを使用してグローバル管理者が作成されます。

disassociate

グローバル索引カタログの分散ワークフロー要素への関連付けを解除します。サブオプションは次のとおりです:

enable-replication

グローバル索引カタログとそのグローバル索引がすべてレプリケートされるようにサーバー構成を更新します。指定したサーバーの1つが指定されたグローバル索引に対してグローバル索引カタログをすでにレプリケートしている場合は、このサブコマンドを実行することによってトポロジ内の全サーバーの構成が更新されます。したがって、レプリケーション・トポロジに追加されるサーバーごとに1回、このコマンドを実行するだけで十分です。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--adminPasswordFile bindPasswordFile。グローバル管理者のパスワードが含まれているファイル。

--localReplicationPort port。レプリケートされるコンテンツのある第1のサーバーのレプリケーション・ポート番号。

--localSecureReplication。第1のサーバーのレプリケーション・ポートを介した通信が暗号化されているかどうかを指定します。このオプションは、第1のサーバーでレプリケーションが初めて構成されるときのみ考慮されます。

--remoteAdminPort port。レプリケートされるコンテンツのある第2のサーバーのディレクトリ・サーバー管理ポート番号。

--remoteHost host。レプリケートされるコンテンツのある第2のサーバーの完全修飾ディレクトリ・サーバー・ホスト名またはIPアドレス。

--remoteBindDN bindDN。レプリケートされるコンテンツのある第2のサーバーのバインドに使用するDN。指定されていない場合は、グローバル管理者がバインドに使用されます。

--remoteBindPasswordFile bindPasswordFile。レプリケートされるコンテンツのある第2のサーバーへのバインドに使用されるパスワードが含まれているファイル。第2のサーバーに対してバインドDNが指定されていない場合は、グローバル管理者のパスワードがバインドに使用されます。

--remoteReplicationPort port。レプリケートされるコンテンツのある第2のサーバーのレプリケーション・ポート番号。

--remoteSecureReplication。第2のサーバーのレプリケーション・ポートを介した通信が暗号化されているかどうかを指定します。このオプションは、初回のみ考慮されます。

export

グローバル索引カタログをファイルにエクスポートします。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--exportDirectory directory。グローバル索引カタログのエクスポートに使用されるディレクトリへのパス。これは必須の引数です。

-a, --attributeName attribute-name。グローバル索引属性の名前。このオプションを複数回使用して、複数の索引付き属性を指定できます。このオプションが指定された場合、インポート・ソース内の一致しない索引付き属性はすべてスキップされます。

get-catalog-prop

グローバル索引カタログのプロパティを表示します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--property property。表示されるプロパティの名前。

-E,--record。表示出力を1行ごとに1つのプロパティ値を表示するように変更します。

get-index-prop

索引のプロパティを表示します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

-a, --attributeName attribute-name。グローバル索引属性の識別子。この識別子はグローバル索引カタログのコンテキストにおいて一意である必要があり、グローバル索引の識別に使用されます。

--property property。表示されるプロパティの名前。有効なプロパティ名は、all、global-index-deleted-entry-retention-timeout、db-cleaner-min-utilization、db-log-file-max、db-checkpointer-bytes-interval、db-checkpointer-wakeup-interval, db-num-lock-tables, db-num-cleaner-threads, db-txn-no-sync、db-txn-write-no-sync、je-property、db-directory、db-directory-permissions、global-index-catalogs-shared-cache、およびglobal-index-attributeです。

import

ファイルのコンテンツを指定されたグローバル索引カタログにインポートします。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--importDirectory directory。グローバル索引カタログのインポートに使用されるファイルへのパス。これは必須の引数です。

--attributeName attribute-name。グローバル索引属性の識別子。この識別子はグローバル索引カタログのコンテキストにおいて一意である必要があり、グローバル索引の識別に使用されます。

--append。既存のグローバル索引を上書きするのではなく、それに追加します。

initialize-replication

グローバル索引カタログのレプリケーションを初期化します。レプリケートされたグローバル索引カタログ(レプリケーション・トポロジの一部)をすべて一度に初期化できます。または、指定されたグローバル索引カタログ(これもレプリケーション・トポロジの一部)からローカルのグローバル索引カタログが初期化されます。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--adminUID adminUID。サーバーへのバインドに使用するグローバル管理者のユーザーID。initialize-replicationサブコマンドについては、以前にグローバル管理者が定義されていない場合は、指定されたデータを使用してグローバル管理者が作成されます。

--fromServerPort port。宛先サーバーの初期化に使用されるコンテンツのあるソース・サーバーのディレクトリ・サーバー・ポート番号。

--fromServerHost host。宛先サーバーの初期化に使用されるコンテンツのあるソース・サーバーのディレクトリ・サーバー・ホスト名またはIPアドレス。

--all。指定されたサーバーのコンテンツによってレプリケートされるコンテンツのあるすべてのサーバー上で、グローバル索引属性のコンテンツを初期化します。

list-catalogs

定義済のグローバル索引カタログをリストします。サブオプションは次のとおりです:

--property property。表示されるプロパティの名前。有効なプロパティ名は、all、replication-server、server-id、window-size、heartbeat-interval、およびgroup-idです。

list-indexes

グローバル索引カタログで定義済のグローバル索引をリストします。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

post-external-initialization

このサブコマンドは、このツールのimportサブコマンドを使用してレプリケートされたすべてのグローバル索引のコンテンツを初期化した後で、コールする必要があります。これは、有効なインスタンスとしてターゲットとなるインスタンスの生成IDを使用します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

-a, --attributeName attribute-name。グローバル索引属性の識別子。このオプションを複数回使用して、複数の索引付き属性を指定できます。このオプションが指定された場合、インポート・ソース内の一致しない索引付き属性はすべてスキップされます。

pre-external-initialization

このサブコマンドは、このツールのimportサブコマンドを使用してレプリケートされたすべてのサーバーのコンテンツを初期化する前にコールできます。レプリケーション・サーバーに保存されているレプリケーション変更ログを削除します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

remove-index

グローバル索引をグローバル索引カタログから削除します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

set-catalog-prop

グローバル索引カタログのプロパティを変更します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--set property:value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。有効なプロパティ名は、all、global-index-deleted-entry-retention-timeout、db-cleaner-min-utilization、db-log-file-max、db-checkpointer-bytes-interval、db-checkpointer-wakeup-interval, db-num-lock-tables, db-num-cleaner-threads, db-txn-no-sync、db-txn-write-no-sync、je-property、db-directory、db-directory-permissions、global-index-catalogs-shared-cache、およびglobal-index-attributeです。

--reset property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。有効なプロパティ名は、all、global-index-deleted-entry-retention-timeout、db-cleaner-min-utilization、db-log-file-max、db-checkpointer-bytes-interval、db-checkpointer-wakeup-interval, db-num-lock-tables, db-num-cleaner-threads, db-txn-no-sync、db-txn-write-no-sync、je-property、db-directory、db-directory-permissions、global-index-catalogs-shared-cache、およびglobal-index-attributeです。

--add property:value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。

--remove property:value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。有効なプロパティ名は、all、global-index-deleted-entry-retention-timeout、db-cleaner-min-utilization、db-log-file-max、db-checkpointer-bytes-interval、db-checkpointer-wakeup-interval, db-num-lock-tables, db-num-cleaner-threads, db-txn-no-sync、db-txn-write-no-sync、je-property、db-directory、db-directory-permissions、global-index-catalogs-shared-cache、およびglobal-index-attributeです。

set-index-prop

索引のプロパティを変更します。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

status-replication

グローバル索引カタログの基本的なレプリケーション構成を含むリストを表示します。グローバル索引カタログが指定されない場合は、レプリケートされたすべてのグローバル索引カタログの情報が表示されます。サブオプションは次のとおりです:

-c, --catalogName name。グローバル索引カタログの一意の識別子。これは必須の引数です。

--adminUID adminUID。サーバーへのバインドに使用するグローバル管理者のユーザーID。status-replicationサブコマンドについては、以前にグローバル管理者が定義されていない場合は、指定されたデータを使用してグローバル管理者が作成されます。

-s, --scriptFriendly。スクリプト・フレンドリ・モードを使用します。

A.2.7.4 LDAP接続オプション

gicadmコマンドは、管理コネクタを介してSSL上のディレクトリ・サーバーに接続します(第14.3項「サーバーへの管理トラフィックの管理」で説明しています)。これらの接続オプションは、ディレクトリ・サーバーとの接続に使用します。

-h, --hostname host: ディレクトリ・サーバーのホスト名またはIPアドレス。
-D, --bindDN bindDN: サーバーへのバインドに使用するDN。
-j, --bindPasswordFile filename: バインド・パスワードが含まれているファイルへのフルパス。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: SSLクライアント認証に証明書を使用します。
-o, --saslOptionname=value: SASLバインド・オプション。
-p, --port port: ディレクトリ・サーバーの管理ポート番号。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: サーバーによって提示されるすべての証明書を信頼します。このオプションはテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
--connectTimeout timeout: 接続の確立に許容される最大継続時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、Oを使用します。デフォルト値は、 30000 ミリ秒です。

A.2.7.5 コマンド入力/出力オプション

--noPropertiesFile: このコマンドでは、デフォルトのコマンドライン・オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath propertiesFilePath: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-v, --verbose: 標準出力に診断を表示する冗長モードで実行します。

A.2.7.6 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、ディレクトリ・サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.2.7.7 例

次の例は、gicadmコマンドの使用方法を示しています。

注意:

グローバル索引カタログの作成、グローバル索引の追加、グローバル索引カタログの分散への関連付けに関する次の例は、分散デプロイメントでグローバル索引カタログを使用するために必要な3つの手順です。

例A-24 グローバル・ヘルプ・サブコマンドとグローバル・オプションの表示

次のコマンドは、グローバル索引カタログの管理に使用可能なグローバル・ヘルプ・サブコマンドとグローバル・オプションを表示します:

$ gicadm --help

例A-25 個別サブコマンドのヘルプの表示

次のコマンドは、create-catalogサブコマンドのヘルプ情報を表示します:

$ gicadm create-catalog --help

例A-26 gicadmを使用したグローバル索引カタログの作成

このコマンドを実行する前に、分散を使用してプロキシをデプロイしておく必要があります。

$ gicadm -h localhost -p 4444 -D "cn=Directory Manager" -j /path/pwd-file -X \
create-catalog --catalogName myCatalog

例A-27 gicadmを使用したグローバル索引カタログへのグローバル索引の追加

このコマンドを実行する前に、分散を使用してプロキシをデプロイしておく必要があります。さらに、このコマンドを実行する前に、グローバル索引カタログを作成しておく必要があります。

$ gicadm -h localhost -p 4444 -D "cn=Directory Manager" -j /tmp-pwd-file -X \
add-index --catalogName myCatalog --attributeName telephoneNumber

例A-28 gicadmを使用したグローバル索引カタログの分散への関連付け

$ gicadm -h localhost -p 4444 -D "cn=Directory Manager" -j /tmp-pwd-file -X \
associate --catalogName myCatalog --distributionWorkflowElement myDistributionName

A.2.7.8 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.2.7.9 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/gicadm
Windows: INSTANCE_DIR\OUD\bat\gicadm.bat

A.2.7.10 関連コマンド

dsconfig
split-ldif

A.2.8 manage-tasks

manage-tasksコマンドは、ディレクトリ・サーバーでの実行がスケジュールされているタスクの管理と監視を行います。

このコマンドはプロキシに対してサポートされていません。

A.2.8.1 シノプシス

manage-tasks [options]

A.2.8.2 説明

manage-tasksコマンドを使用して、ディレクトリ・サーバーでの実行がスケジュールされているタスクを管理および監視できます。タスクを起動するときに適切なスケジュール情報を指定することにより、タスクがスケジュールされます(第14.4項「タスクとしてのコマンドの構成」を参照)。manage-tasksコマンドを使用して、現在スケジュールされているタスク、またはすでに実行されているタスクをリストすることができます。さらに、タスクのスケジュール済時間と実行時間、タスクのログ・メッセージ、およびオプションについて詳細情報を取得できます。

manage-tasksコマンドはオンライン・サーバー・インスタンスでのみ実行でき、管理コネクタを介してSSL上のサーバーにアクセスします(第14.3項「サーバーへの管理トラフィックの管理」で説明しています)。

A.2.8.3 オプション

manage-tasksコマンドは、短いフォーム(例: -c taskID)または同等の長いフォーム(例: --cancel taskID)のいずれかのオプションを受け入れます。

-c, --cancel taskID: 取り消す特定のタスクを指定します。
-i, --info taskID: 特定のタスクに関する情報を表示します。
-s, --summary: タスクのサマリーを印刷します。

A.2.8.4 LDAP接続オプション

-D, --bindDN bindDN: バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-h, --hostname hostname: 指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: 指定された証明書をクライアント認証に使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-p, --port port: 指定された管理ポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、4444というデフォルトの管理ポートが使用されます。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: ディレクトリ・サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.2.8.5 コマンド入力/出力オプション

-n,--no-prompt: 非インタラクティブ・モードを使用します。必須オプションの値が見つからない場合、プロンプトが表示されず、コマンドは失敗します。
--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されていないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。

A.2.8.6 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、タスクの管理を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.8.7 例

次の例は、manage-tasksコマンドの使用方法を示しています。

例A-29 スケジュール済タスクのサマリーの表示

次のコマンドは、スケジュール済タスクのリストを表示します:

$ manage-tasks -h localhost -p 4444 -D "cn=directory manager" -j /path/pwd-file \
  -X -s

  ID                Type     Status
  -------------------------------------------------
  2008101610361710  Backup   Completed successfully
  2008101610403710  Restore  Completed successfully
  2008101610442610  Restore  Waiting on start time

例A-30 タスク情報の取得

次のコマンドは、特定のタスクに関する情報を返します:

$ manage-tasks -h localhost -p 4444 -D "cn=directory manager" -j /path/pwd-file \
  -X -i 2008101610442610
  Task Details
  -------------------------------------------------------
  ID                        2008101610442610
  Type                      Restore
  Status                    Waiting on start time
  Scheduled Start Time      Jan 25, 2009 12:15:00 PM SAST
  Actual Start Time
  Completion Time
  Dependencies              None
  Failed Dependency Action  None
  Email Upon Completion     admin@example.com
  Email Upon Error          admin@example.com

  Restore Options
  ----------------------------------
  Backup Directory  /backup/userRoot

例A-31 スケジュール済タスクの取消し

次のコマンドは、スケジュール済タスクを取り消します。このコマンドは、--no-promptオプションを使用して非インタラクティブ・モードで実行します。

$ manage-tasks -h localhost -p 4444 -D "cn=directory manager" -j /path/pwd-file \
  -X -c 2008101610442610
Task 2008101610442610 canceled

A.2.8.8 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.2.8.9 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、manage-tasksコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

A.2.8.10 場所

UNIXおよびLinux: OUD_ORACLE_HOME/bin/manage-tasks
Windows: OUD_ORACLE_HOME\bat\manage-tasks.bat

A.2.9 oudCopyConfig

oudCopyConfigコマンドは、既存の構成のコピーをソース環境から取得するために使用します。

テストから本番環境への移動の詳細は、第28章「テストから本番環境への移動」を参照してください。

A.2.9.1 シノプシス

oudCopyConfig [options]

A.2.9.2 説明

既存の構成のコピーを取得するには、ソース環境でoudCopyConfigコマンドを実行します。

oudCopyConfigコマンドは、次のアクションを実行します:

テスト・インスタンス(instHomePath)の本番環境への移動に必要な構成データが含まれているアーカイブ(archivePath)を作成します。-archiveLocオプションは、アーカイブへのフルパスを指定します。
アーカイブに移動計画を作成します。
すべてのメッセージをlog_directory.に記録します。指定されない場合、記録されたメッセージのデフォルト場所はシステムの一時ディレクトリになります。

A.2.9.3 オプション

oudCopyConfigコマンドは、オプションを次のフォームで受け入れます。

-javaHome, javaHomePath: JDKの絶対パス。
-al, -archiveLoc archivePath: アーカイブの場所の絶対パス。これには、テスト・インスタンス(instHomePath)の本番環境への移動に必要な構成データが含まれています。
-sih, -sourceInstanceHomeLoc instHomePath: 本番環境にコピーする既存のインスタンスの絶対パス。
-h, -help: このヘルプ・メッセージを表示して終了します。このパラメータはオプションです。
-ldl, -logDirLoc logPath: 既存のログ・ディレクトリの場所。デフォルトの場所は、システムの一時的な場所です。このパラメータはオプションです。

A.2.9.4 例

次の例は、oudCopyConfigコマンドの使用方法を示しています。

例A-32 既存の構成のコピーの取得

次のコマンドは、既存の構成のコピーを取得します。

$ OUD_ORACLE_HOME/bin/oudCopyConfig -javaHome /usr/jdk \
-sourceInstanceHomeLoc /local/asinst_1 -archiveLoc /tmp/oud.jar \
-logDirLoc /tmp/logs

例A-33 ヘルプ・コマンド・オプションの実行

$ OUD_ORACLE_HOME/bin/oudCopyConfig -javaHome /usr/jdk -help

A.2.9.5 場所

UNIXおよびLinux: OUD_ORACLE_HOME/bin/oudCopyConfig
Windows: OUD_ORACLE_HOME\bat\oudCopyConfig.bat

A.2.9.6 関連コマンド

第A.2.10項「oudExtractMovePlan」
第A.2.11項「oudPasteConfig」

A.2.10 oudExtractMovePlan

oudExtractMovePlanコマンドは、-planDirLoc引数により指定された場所にあるmoveplan.xml,というファイル内の構成の編集可能バージョンを作成するために使用します。このディレクトリが存在していて、書込み可能である必要があります。

テストから本番環境への移動の詳細は、第28章「テストから本番環境への移動」を参照してください。

A.2.10.1 シノプシス

oudExtractMovePlan [options]

A.2.10.2 説明

移動計画を編集することによって、特定の構成パラメータを変更できます。移動計画とは、環境にまたがっての移動中にカスタマイズ可能なパラメータを公開するXMLファイルです。

移動計画は、oudCopyConfigコマンドを実行するときに生成され、構成を複製するためにoudPasteConfigコマンドによって使用されます。

A.2.10.3 オプション

oudExtractMovePlanコマンドは、オプションを次のフォームで受け入れます:

-javaHome, javaHomePath: JDKの絶対パス。
-al, -archiveLoc archivePath: アーカイブの場所の絶対パス。
-pdl, -planDirLoc planPath: 移動計画を抽出するディレクトリへの絶対パス。移動計画ファイルの名前はmoveplan.xmlです。
-h, -help: このヘルプ・メッセージを表示して終了します。このパラメータはオプションです。
-ldl, -logDirLoc logPath: 既存のログ・ディレクトリの場所。デフォルトの場所は、システムの一時的な場所です。このパラメータはオプションです。

A.2.10.4 例

次の例は、oudExtractMovePlanコマンドの使用方法を示しています。

例A-34 構成の編集

次のコマンドによって、構成を編集できます。

$ OUD_ORACLE_HOME/bin/oudExtractMovePlan -javaHome /usr/jdk \
-al /tmp/oud.jar -pdl /tmp -logDirLoc /tmp/logs

例A-35 ヘルプ・コマンド・オプションの実行

$ OUD_ORACLE_HOME/bin/oudExtractMovePlan -javaHome /usr/jdk -help

A.2.10.5 場所

UNIXおよびLinux: OUD_ORACLE_HOME/bin/oudExtractMovePlan
Windows: OUD_ORACLE_HOME\bat\oudExtractMovePlan.bat

A.2.10.6 関連コマンド

第A.2.9項「oudCopyConfig」
第A.2.11項「oudPasteConfig」

A.2.11 oudPasteConfig

oudPasteConfigコマンドは、構成をターゲット環境に貼り付けるために使用します。

テストから本番環境への移動の詳細は、第28章「テストから本番環境への移動」を参照してください。

A.2.11.1 シノプシス

oudPasteConfig [options]

A.2.11.2 説明

ターゲット環境で構成を取得するには、oudPasteConfigコマンドを実行します。

oudPasteConfigコマンドは、アーカイブと修正済の移動計画から取得した構成で新しいサーバー・インスタンスを作成します。

A.2.11.3 オプション

oudPasteConfigコマンドは、オプションを次のフォームで受け入れます:

-javaHome, javaHomePath: JDKの絶対パス。
-al, -archiveLoc archivePath: アーカイブの場所の絶対パス。
-mpl, -movePlanLoc planPath: 計画抽出の操作中に抽出された移動計画への絶対パス。
-tih, -targetInstanceHomeLoc instHomePath: Oracle Unified Directoryの構成がリストアされるインスタンス・ホームの絶対パス。
-toh, -targetOracleHomeLoc oracleHomePath: インスタンス・ホームに関連付けられたOracleホームの絶対パス。
-tin, -targetInstanceName instanceName: ターゲット・インスタンス名。指定された場合は、ターゲット・インスタンス・パスとの整合性が必要になります。このパラメータはオプションです。
-h, -help: このヘルプ・メッセージを表示して終了します。このパラメータはオプションです。
-ldl, -logDirLoc logPath: 既存のログ・ディレクトリの場所。デフォルトの場所は、システムの一時的な場所です。このパラメータはオプションです。

A.2.11.4 例

次の例は、oudPasteConfigコマンドの使用方法を示しています。

例A-36 構成の貼付け

次のコマンドによって、構成を貼り付けることができます。

$ OUD_ORACLE_HOME/bin/oudPasteConfig -javaHome /usr/jdk -al /tmp/oud.jar \
-tih /tmp/asinst_2 -toh /tmp/Oracle_OUD1 \
-mpl /tmp/moveplan.xml -tin asinst_2

例A-37 ヘルプ・コマンド・オプションの実行

$ OUD_ORACLE_HOME/bin/oudPasteConfig -javaHome /usr/jdk -help

A.2.11.5 場所

UNIXおよびLinux: OUD_ORACLE_HOME/bin/oudPasteConfig
Windows: OUD_ORACLE_HOME\bat\oudPasteConfig.bat

A.2.11.6 関連コマンド

第A.2.9項「oudCopyConfig」
第A.2.10項「oudExtractMovePlan」

A.2.12 oud-replication-gateway-setup

oud-replication-gateway-setupコマンドは、レプリケーション・ゲートウェイ・インスタンスの設定に使用します。

A.2.12.1 シノプシス

oud-replication-gateway-setup [options]

A.2.12.2 説明

oud-replication-gateway-setupコマンドは、レプリケーション・ゲートウェイ・インスタンスのインストールと構成を行います。その際、リスニングに使用するポート、初期ルート・ユーザーのDNとパスワード、およびレプリケーション・ゲートウェイ・データのベースDNも指定します。レプリケーション・ゲートウェイにより、一連のOracle Directory Server Enterprise EditionサーバーとOracle Unified Directoryサーバー間でレプリケーションが機能するようにできます。

このユーティリティは次のモードで実行できます:

グラフィカル・ユーザー・インタフェース(GUI)モード。GUIモードはデフォルトであり、推奨のインストール・オプションです。oud-replication-gateway-setupのGUIは、レプリケートされたマルチ・ネットワーク環境でレプリケーション・サーバーをインストールおよび構成する際に簡単なインタフェースとして機能します。GUIモードでは、必要に応じてSSLまたはStartTLSを使用してサーバーを容易に設定することもできます。

このユーティリティはグラフィカル・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。
コマンドライン・インタフェース(CLI)モード。コマンドライン・モードは、インタラクティブと非インタラクティブのどちらでも使用できます。インタラクティブCLIモードでは、構成を開始する前に必須情報を入力するようプロンプトが表示されます。GUIが使用できない場合は、--cliオプションを指定して使用します。

このユーティリティはコマンドライン・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。

非インタラクティブCLIモードでは、ユーザーが介入せずにサーバーを設定できます。--no-promptオプションと--quietオプションを使用すると、インタラクティブに抑止したり、情報を出力したりすることができます。

オプションを指定しないでoud-replication-gateway-setupコマンドを実行すると、このコマンドはGUIモードで開始しますが、GUIが使用できない場合はインタラクティブ・コマンドライン・モードにフォールバックします。インタラクティブ・コマンドライン・モードで設定を実行するには、--cliオプションを使用します。コマンドがGUIモードで実行している場合、オプションの使用は許可されません。

A.2.12.3 オプション

oud-replication-gateway-setupコマンドは、短いフォーム(例: -i)または同等の長いフォーム(例: --cli)のいずれかでオプションを受け入れます。

-i, --cli: コマンドライン・インストールを使用します。指定されていない場合は、グラフィカル・インタフェースが起動されます。その他のオプション(helpとversionを除く)は、このオプションが指定されている場合のみ考慮されます。

A.2.12.4 レプリケーション・ゲートウェイの構成オプション

-h, --hostname hostname: レプリケーション・ゲートウェイがインストールされるホストの完全修飾名。レプリケーション・トポロジ内のOracle Directory Server Enterprise EditionサーバーとOracle Unified Directoryサーバーは、このホスト名にアクセスできる必要があります。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
--adminConnectorPort port: 管理コネクタが管理トラフィックについてリスニングする必要のあるポートを指定します。管理コネクタの詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。構成ツールと管理ツールはこのポートを使用してレプリケーション・ゲートウェイに接続します。デフォルト値は4444です。
--replicationPortForLegacy port: コンテンツをレプリケートするためにレプリケーション・ゲートウェイと通信するOracle Directory Server Enterprise Editionサーバーによって使用されるポートを指定します。
-S, --skipPortCheck: 指定されたポートが使用可能かどうかの判別を試みません。通常、このオプションが指定されていない場合は、oud-replication-gateway-setupコマンドがポートが使用中であるかどうかを検証し、使用中でない場合、コマンドを実行しているユーザーはそのポートにバインドできます。--skipPortCheckオプションを指定した場合、oud-replication-gateway-setupコマンドはポートのチェックをスキップします。
-D, --rootUserDN rootUserDN: レプリケーション・ゲートウェイに対する初期ルート・ユーザーのDN。
-j, --rootUserPasswordFile rootUserPasswordFile: レプリケーション・ゲートウェイに対する初期ルート・ユーザーのパスワードが含まれているファイルへのパス。
-O, --doNotStart: 構成が完了したときに、レプリケーション・ゲートウェイを起動しません。
-b, --baseDN baseDN: Oracle Unified DirectoryとOracle Directory Server Enterprise Editionサーバー間でレプリケートされるデータのベースDNを指定します。このオプションを複数回使用することによって、複数のベースDNを指定できます。

A.2.12.5 Oracle Directory Server Enterprise Editionサーバー・オプション

--hostNameLegacy hostname: レプリケートされるコンテンツのあるOracle Directory Server Enterprise Editionサーバーの完全修飾ホスト名またはIPアドレス。
--portLegacy port: レプリケートされるコンテンツのあるOracle Directory Server Enterprise Editionサーバーのポート番号を指定します。このポートは、コンテンツをレプリケートするレプリケーション・メカニズムにより使用されます。
--bindDNLegacy bindDN: レプリケートされるコンテンツのあるOracle Directory Server Enterprise Editionサーバーのバインドに使用するDNを指定します。
--bindPasswordFileLegacy bindPasswordFile: レプリケートされるコンテンツのあるOracle Directory Server Enterprise Editionサーバーのバインドに使用するパスワードが保存されているファイルを指定します。
--secureReplicationLegacy: Oracle Directory Server Enterprise Editionサーバーとレプリケーション・ゲートウェイ間のレプリケーションの更新が暗号化されて送信されたかどうかを指定します。このオプションを有効にした場合は、レプリケーション・ゲートウェイのセキュリティ・オプションにあるオプションを使用して、サーバーが使用する証明書を指定する必要があり、引数--portLegacyを使用して指定されたポートはLDAPポートである必要があります。
--clientAuthenticationToLegacy: クライアント認証を使用して、レプリケーション・ゲートウェイからOracle Directory Server Enterprise Editionサーバーにレプリケーションの更新を送信します。この引数は、属性--secureReplicationLegacyを使用している場合のみ使用できます。
--certFileForClientAuthenticationToLegacy certificateFile: レプリケーションの更新を送信するためにレプリケーション・ゲートウェイがOracle Directory Server Enterprise Editionサーバーに接続しているときにクライアント認証モードで使用される証明書が含まれているファイルを指定します。このファイルには、X.509形式の証明書が含まれている必要があります。
--doNotSendUpdatesToLegacyServer: Oracle Unified Directoryサーバーでの更新をOracle Directory Server Enterprise Editionサーバーに伝播しません。このオプションを使用する場合、Oracle Unified Directoryサーバーで直接加えられた変更はOracle Directory Server Enterprise Editionサーバーのレプリケーション・トポロジに伝播されません。
--doNotUpdateTrustStoreWithLegacyCertsArg: この引数が指定され、レプリケーション・ゲートウェイが暗号化された通信(--secureReplicationLegacy引数を使用して指定されたもの)を使用してレプリケーションの更新をOracle Directory Server Enterprise Editionサーバーに送信する場合は、レプリケーション・ゲートウェイによって使用されるトラスト・ストアをOracle Directory Server Enterprise Editionサーバーのサーバー証明書で更新して、レプリケーションが機能できるようにする必要があります。
--clientAuthenticationFromLegacy: クライアント認証を使用して、レプリケーションの更新をOracle Directory Server Enterprise Editionサーバーからレプリケーション・ゲートウェイに送信します。この引数は、属性--secureReplicationLegacyを使用している場合のみ使用できます。

A.2.12.6 レプリケーション・ゲートウェイのセキュリティ・オプション

--generateSelfSignedCertificate: Oracle Directory Server Enterprise Editionサーバーから暗号化された接続を受け入れるときにレプリケーション・ゲートウェイがサーバー証明書として使用する自己署名証明書を生成します。
--usePkcs11Keystore: Oracle Directory Server Enterprise Editionサーバーから暗号化された接続を受け入れるときにレプリケーション・ゲートウェイがサーバー証明書として使用するPKCS#11トークンの証明書を使用します。
--useJavaKeystore keyStorePath: Oracle Directory Server Enterprise Editionサーバーから暗号化された接続を受け入れるときにレプリケーション・ゲートウェイがサーバー証明書として使用する証明書が含まれているJavaキーストア(JKS)のパスを指定します。
--useJCEKS keyStorePath: Oracle Directory Server Enterprise Editionサーバーから暗号化された接続を受け入れるときにレプリケーション・ゲートウェイがサーバー証明書として使用する証明書が含まれているJCEKSのパスを指定します。
--usePkcs12keyStore keyStorePath: Oracle Directory Server Enterprise Editionサーバーから暗号化された接続を受け入れるときにレプリケーション・ゲートウェイがサーバー証明書として使用する証明書が含まれているPKCS#12キーストアのパス。
--gatewayKeyStorePasswordFile keyStorePasswordFile: 証明書キーストアPINが含まれているファイルを指定します。レプリケーション・ゲートウェイがサーバー証明書として使用する証明書(JKS、JCEKS、PKCS#12、またはPKCS#11)が含まれているキーストアにアクセスする必要があります。これは、Oracle Directory Server Enterprise Editionサーバーとの暗号化されたレプリケーション通信に対応できるようにレプリケーション・ゲートウェイを構成する場合に必要です。
--gatewayCertNickname nickname: Oracle Directory Server Enterprise Editionサーバーから暗号化された接続を受け入れるときにレプリケーション・ゲートウェイが使用する証明書のニックネームを指定します。

A.2.12.7 Oracle Unified Directoryサーバー・オプション

--hostNameNg hostname: レプリケートされるコンテンツのあるOracle Unified Directoryサーバーの完全修飾ホスト名またはIPアドレス。
--portNg port: レプリケートされるコンテンツのあるOracle Unified Directoryサーバーのポート番号を指定します。
--bindDNNg bindDN: レプリケートされるコンテンツのあるOracle Unified Directoryサーバーのバインドに使用するDNを指定します。この属性が指定されていない場合は、グローバル管理者がバインドに使用されます。
--bindPasswordFileNg bindPasswordFile: レプリケートされるコンテンツのあるOracle Unified Directoryサーバーのバインドに使用するパスワードが保存されているファイルを指定します。このサーバーに対してバインドDNが指定されていない場合は、グローバル管理者のパスワードがバインドに使用されます。
--replicationPortNg port: 他のOracle Unified Directoryサーバーと通信するために、Oracle Unified Directoryサーバーのレプリケーション・メカニズムにより使用されるポートを指定します。このオプションは、指定したOracle Unified Directoryサーバーにレプリケーションを構成していない場合のみ、指定する必要があります。
--secureReplicationNg: Oracle Unified Directoryサーバーのレプリケーション・ポートを介した通信が暗号化されているかどうかを指定します。このオプションは、Oracle Unified Directoryサーバーでレプリケーションが構成されていない場合のみ考慮されます。
-I, --adminUID adminUID: Oracle Unified Directoryサーバーへのバインドに使用するためにグローバル管理者のユーザーIDを指定します。Oracle Unified Directoryでグローバル管理者を定義していない場合は、指定したデータを使用してグローバル管理者が作成されます。デフォルト値はadminです。
--adminPasswordFile bindPasswordFile: グローバル管理者のパスワードが含まれているファイル。

A.2.12.8 セキュアな接続のオプション

-o, --saslOption name=value

これらはSASLバインド・オプションです。

SASLは、プロキシ・インスタンスに対してサポートされていません。

-X, --trustAll

サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

-P, --trustStorePath path

-U, --trustStorePasswordFile path

-K, --keyStorePath path

指定されたパスにクライアント・キーストア証明書を使用します。

-u, --keyStorePasswordFile filename

-N, --certNickname nickname

指定された証明書をSSLクライアント認証に使用します。

--connectTimeout timeout

接続の確立に許容される最長時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、0を使用します。デフォルト値は30000です。

A.2.12.9 コマンド入力/出力オプション

-n, --no-prompt: setupを非インタラクティブ・モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-v, --verbose: 標準出力に診断を表示する冗長モードで実行します。
--noPropertiesFile: このコマンドでは、デフォルトのコマンドライン・オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。

A.2.12.10 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
--version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.12.11 例

次の例は、レプリケーション・サーバー・コマンドの使用方法を示しています。

例A-38 GUIモードでのoud-replication-gateway-setupの実行

次のコマンドは、GUIモードでインストールを実行します:

$ oud-replication-gateway-setup

このユーティリティはグラフィカル・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。別のインスタンス名を指定するには、設定を実行する前にINSTANCE_NAME環境変数を、たとえば次のように設定します:

$ export INSTANCE_NAME=my-oud-instance

GUIが起動して、いくつかの画面が表示されます。これらの画面では、スタンドアロン環境またはレプリケートされた環境でレプリケーション・サーバーを順次設定することができます。また、SSL証明書またはStartTLS証明書を設定するためのオプションもあります。

例A-39 コマンドラインからのインタラクティブ・モードでのoud-replication-gateway-setupの実行

oud-replication-gateway-setupコマンドはインタラクティブ・モードで実行できます。このモードでは、インストール・オプションに関してプロンプトが表示されます。oud-replication-gateway-setupをインタラクティブ・モードで実行するには、次のコマンドを入力します:

$ oud-replication-gateway-setup --cli

このコマンドでは、必須の設定値を入力するようプロンプトが表示されます。プロンプトに対して[Enter]キーまたは[Return]キーを押してデフォルト値を受け入れるか、値を入力します。

このユーティリティはコマンドライン・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。別のインスタンス名を指定するには、設定を実行する前にINSTANCE_NAME環境変数を、たとえば次のように設定します:

$ export INSTANCE_NAME=my-oud-instance

A.2.12.12 終了コード

0: 正常終了または正常なno-opです。
1: 予想外のエラーが生じました。バグの可能性があります。
2: ユーザー・データのエラーです。オプションを解析できないか、ユーザーにより指定されたデータが無効です。
4: サーバーの初期化でエラーが生じました。

A.2.12.13 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、oud-replication-gateway-setupコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

すべてのoud-replication-gateway-setupオプションは、プロパティ・ファイルに保存可能です。プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

oud-replication-gateway-setup.hostname=grevalon:1444

A.2.12.14 ログ・ファイル

oud-replication-gateway-setupコマンドは、oud-setup-IDnumberというログ・ファイルに書き込みます。この場合のIDnumberは10進数です。ログ・ファイルは次のパスに置かれています:

UNIX (Solaris): /var/tmp/
Linux: /tmp/
Windows: %TEMP%

デフォルトでは、このフォルダはC:\Documents and Settings\User\Local Settings\Tempです。

A.2.12.15 場所

oud-replication-gateway-setupコマンドは、次のパスに置かれています:

UNIXおよびLinux: OUD_BASE_LOCATION/OUD_ORACLE_HOME/oud-replication-gateway-setup
Windows: OUD_BASE_LOCATION\OUD_ORACLE_HOME\oud-replication-gateway-setup.bat

A.2.12.16 関連コマンド

第A.2.13項「oud-setup」
第A.2.14項「oud-proxy-setup」

A.2.13 oud-setup

oud-setupコマンドは、ディレクトリ・サーバー・インスタンスのインストールと最小限の構成を行います。

このコマンドは、ディレクトリ・サーバー・インスタンスを設定します。プロキシ・サーバー・インスタンスの設定の詳細は、第A.2.14項「oud-proxy-setup」を参照してください。

A.2.13.1 シノプシス

oud-setup [options]

A.2.13.2 説明

oud-setupコマンドは、ディレクトリ・サーバー・インスタンスのインストールと構成を行います。その際、リスニングに使用するポート、初期ルート・ユーザーのDNとパスワード、ディレクトリ・データのベースDN、およびデータベースの移入方法も指定します。これは次のモードで実行できます:

グラフィカル・ユーザー・インタフェース(GUI)モード。GUIモードはデフォルトであり、推奨のインストール・オプションです。oud-setupのGUIは、レプリケートされたマルチ・ネットワーク環境でスタンドアロンのディレクトリ・サーバーまたはレプリケーション・サーバーをインストールおよび構成する際に簡単なインタフェースとして機能します。GUIモードでは、必要に応じてSSLまたはStartTLSを使用してサーバーを容易に設定することもできます。

このユーティリティはグラフィカル・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。
コマンドライン・インタフェース(CLI)モード。コマンドライン・モードは、インタラクティブと非インタラクティブのどちらでも使用できます。インタラクティブCLIモードでは、構成を開始する前に必須情報を入力するようプロンプトが表示されます。GUIが使用できない場合は、--cliオプションを指定して使用します。

このユーティリティはコマンドライン・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。

非インタラクティブCLIモードでは、ユーザーが介入せずにサーバーを設定できます。--no-promptオプションと--quietオプションを使用すると、インタラクティブに抑止したり、情報を出力したりすることができます。

オプションを指定しないでoud-setupコマンドを実行すると、このコマンドはGUIモードで開始しますが、GUIが使用できない場合はインタラクティブ・コマンドライン・モードにフォールバックします。コマンドライン・モードでoud-setupを実行するには、--cliオプションを使用します。指定可能なオプションを次に示します。コマンドがGUIモードで実行している場合、オプションの使用は許可されません。

A.2.13.3 オプション

oud-setupコマンドは、短いフォーム(例: -a)または同等の長いフォーム(例: --addBaseEntry)のいずれかでオプションを受け入れます。

-a, --addBaseEntry: ディレクトリ・サーバー・データベースにベース・エントリを作成するかどうかを示します。
-i, --cli: setupコマンドは、GUIモードではなく、コマンドラインのインタラクティブ・モードで実行します。--cliオプションを指定しないでsetupを実行すると、他のオプションを受け入ることはできません。
-b, --baseDN baseDN: ディレクトリ・サーバーにあるユーザー情報に対してベースDNを使用します。このオプションのデフォルト値はdc=example,dc=comです。このオプションを複数回指定することによって、複数のベースDNを指定できます。
-l, --ldifFile filename: 指定されたLDIFファイルを使用して、データベースを移入します。このオプションを複数回指定することにより、複数のファイルからデータをインポートできます。この場合、ファイルはオプション・リストに記載される順序で処理されます。このオプションは、--addBaseEntryオプションまたは--sampleDataオプションのいずれかと同時に使用しないでください。このオプションが指定されない場合、データベースは空のままになります。
-R, --rejectFile filename: 却下されたエントリを指定のファイルに書き込みます。-lオプションまたは--ldifFileオプションを使用するインポート中にエントリがデフォルトのスキーマに準拠しない場合、そのエントリは却下されます。
--skipFile filename: スキップされたエントリを指定のファイルに書き込みます。-lオプションまたは--ldifFileオプションを使用するインポート中に指定したベースDN下にエントリを配置できない場合、そのエントリはスキップされます。
-d, --sampleData number-of-entries: サンプルのユーザー・エントリの指定番号を使用してデータベースを移入します。エントリはimportコマンドのMakeLDIFファシリティを使用して生成されます。エントリはデフォルトのexample.templateテンプレートに基づいています。このオプションは、--addBaseEntryオプションまたは--ldifFileオプションのいずれかと同時に使用しないでください。このオプションが指定されない場合、データベースは空のままになります。
--eus: Oracleのエンタープライズ・ユーザー・セキュリティ(EUS)に対応できるようにサーバーを構成します。
-p,--ldapPort port: 指定されたポートでディレクトリ・サーバーに接続します。これが指定されない場合は、デフォルト・ポート1389が非ルートとして、389がルートとして使用されます。
--adminConnectorPort port: 管理コネクタが管理トラフィックについてリスニングする必要のあるポートを指定します。管理コネクタの詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。デフォルト値は4444です。
-x, --jmxPort port: MX MBeansサーバー接続用のポートを指定します。このオプションのデフォルト値は1689です。
-S, --skipPortCheck: 指定されたポートが使用可能かどうかの判別を試みません。通常、このオプションが指定されていない場合、oud-setupコマンドはポートが使用中でないこと、およびsetupコマンドを実行しているユーザーがそのポートにバインドできることを検証します。--skipPortCheckオプションを指定した場合、oud-setupコマンドはポートのチェックをスキップします。
-D, --rootUserDN rootUserDN: 指定したルート・ユーザーDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-j, --rootUserPasswordFile filename: ディレクトリ・サーバーの認証中に初期ルート・ユーザーのパスワードが含まれているファイルを指定します。
-O, --doNotStart: 構成が完了したときに、ディレクトリ・サーバーを起動しません。
-q, --enableStartTLS: LDAPポートを使用することにより、StartTLSがディレクトリ・サーバーとセキュアな通信を実行できるようにします。
-Z, --ldapsPort port: LDAP SSL (LDAPS)通信を行うために指定されたポートでディレクトリ・サーバーに接続します。このオプションが明示的に指定されている場合のみ、LDAPSポートが構成され、SSLが有効になります。デフォルト値は1636です。
--generateSelfSignedCertificate: SSLベースの接続を受け入れたり、StartTLSネゴシエーションを実行するときにディレクトリ・サーバーが使用する必要のある自己署名証明書を生成します。
-h, --hostname host: 自己署名証明書の生成に使用されるディレクトリ・サーバーのホスト名またはIPアドレス。この引数は、自己署名証明書の引数--generateSelfSignedCertificateが指定されている場合のみ考慮されます。
--usePkcs11Keystore: SSLベースの接続を受け入れたり、StartTLSネゴシエーションを実行するときにサーバーが使用する必要のあるPKCS#11形式の証明書を使用します。
--useJavaKeystore path: サーバー証明書が含まれているJavaキーストア(JKS)へのパスを指定します。
--useJCEKS path: サーバー証明書が含まれているJava Cryptography Extensionキーストア(JCEKS)へのパスを指定します。
--usePkcs12Keystore path: サーバー証明書が含まれているPKCS#12キーストアへのパスを指定します。
-u, --keyStorePasswordFile filename: 証明書キーストアにアクセスするために、指定されたファイルでパスワードを使用します。既存の証明書(JKS、JCEKS、PKCS#11、またはPKCS#12)をサーバー証明書として指定する場合は、パスワードが必要です。
-N, --certNickname nickname: 指定された証明書をSSLまたはStartTLSクライアント認証に使用します。
-e, --enableWindowsService: ディレクトリ・サーバーをWindowsサービスとして有効化します。Windowsプラットフォームの場合に限られます。

A.2.13.4 コマンド入力/出力オプション

-n, --no-prompt: setupを非インタラクティブ・モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
--noPropertiesFile: このコマンドでは、デフォルトのコマンドライン・オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-v, --verbose: 標準出力に診断を表示する冗長モードで実行します。

A.2.13.5 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.13.6 例

次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。

例A-40 GUIモードでのoud-setupの実行

次のコマンドは、GUIモードでインストールを実行します:

$ oud-setup

GUIが起動して、いくつかの画面が表示されます。これらの画面では、スタンドアロン環境またはレプリケートされた環境でディレクトリ・サーバーを順次設定することができます。また、SSL証明書またはStartTLS証明書を設定するためのオプションもあります。

このユーティリティは、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。別のインスタンス名を指定するには、設定を実行する前に、INSTANCE_NAME環境変数を、たとえば次のように設定します:

$ export INSTANCE_NAME=my-oud-instance

例A-41 コマンドラインからのインタラクティブ・モードでのoud-setupの実行

oud-setupコマンドはインタラクティブ・モードで実行できます。このモードでは、インストール・オプションに関してプロンプトが表示されます。oud-setupをインタラクティブ・モードで実行するには、次のコマンドを入力します:

$ oud-setup --cli

$ export INSTANCE_NAME=my-oud-instance

例A-42 非インタラクティブCLIモードでのoud-setupの実行

レプリケートされた大規模な環境に対して多数のディレクトリ・サーバー・インスタンスを構成する必要がある場合、非インタラクティブなCLIモードでは、oud-setupコマンドを使用してインストール・スクリプトを作成できます。このモードでは、--no-promptオプションと--quietオプションを指定する必要があります。オプションが指定されていない場合、oud-setupコマンドのデフォルトはインタラクティブ・モードになります。

次のコマンドは、非インタラクティブ(--no-prompt)モードと最小(-Q)モードでインストールを実行します。これはLDAPポート(-p)、管理コネクタ・ポート(--adminConnectorPort)、ルートDN (-D)、ルートDNパスワード(-j)が含まれているファイルを設定し、指定されたベースDN (-b)を使用してベース・エントリ(-a)を追加します。

$ oud-setup --cli --no-prompt -Q -p 1389 --adminConnectorPort 4444 \
  -D "cn=Directory Manager" -j /path/pwd-file -a -b dc=example,dc=com

例A-43 LDIFインポートを指定した非インタラクティブCLIモードでのoud-setupの実行

次のコマンドは、非インタラクティブ(--no-prompt)モードと最小(-Q)モードでインストールを実行します。これはLDAPポート(-p)、管理コネクタ・ポート(--adminConnectorPort)、ルートDN (-D)、ルートDNパスワード(-j)が含まれているファイルを設定し、LDIFファイル(-l)からインポートしたデータを使用してベース・エントリ(-b)を追加します。

$ oud-setup --cli --no-prompt -Q -p 1389 --adminConnectorPort 4444 \
  -D "cn=Directory Manager" -j /path/pwd-file -b dc=example,dc=com \
  -l "/home/ldif/company.ldif"

例A-44 サンプル・エントリの生成を指定した非インタラクティブ・モードでのoud-setupの実行

次のコマンドは、非インタラクティブ(--no-prompt)モードと最小(-Q)モードでインストールを実行します。これはLDAPポート(-p)、管理コネクタ・ポート(--adminConnectorPort)、ルートDN (-D)、ルートDNパスワード(-j)が含まれているファイル、ベースDN(-b)を設定し、2000個のサンプル・エントリ(-d)を生成します。

$ oud-setup --cli --no-prompt -Q -p 1389 --adminConnectorPort 4444 \
  -D "cn=Directory Manager" -j /path/pwd-file -b dc=example,dc=com -d 2000

例A-45 Windowsでのoud-setupの実行

次のコマンドは、ディレクトリ・サーバーがWindowsサービス(-e)として実行できるようにします。これはLDAPポート(-p)、管理コネクタ・ポート(--adminConnectorPort)、JMXポート(-x)、ルートDN(-D)、ルートDNパスワード(-j)が含まれているファイル、ベースDN(-b)を設定し、10000個のサンプル・エントリを生成します。

C:\> oud-setup.bat --cli -e -p 1389 --adminConnectorPort 4444 -x 1689 \
  -D "cn=Directory Manager" -j /path/pwd-file -b dc=example,dc=com -d 10000

このユーティリティはグラフィカル・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにOracle Unified Directoryインスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。別のインスタンス名を指定するには、設定を実行する前にINSTANCE_NAME環境変数を、たとえば次のように設定します:

$ export INSTANCE_NAME=my-oud-instance

A.2.13.7 終了コード

0: 正常終了または正常なno-opです。
1: 予想外のエラーが生じました。バグの可能性があります。
2: ユーザー・データのエラーです。オプションを解析できないか、ユーザーにより指定されたデータが無効です。
4: サーバーの初期化でエラーが生じました。

A.2.13.8 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、oud-setupコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

certNickname
hostname
keyStorePasswordFile

前のoud-setupオプションはすべて、プロパティ・ファイルに保存可能です。プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

oud-setup.hostname=grevalon:1444

A.2.13.9 ログ・ファイル

oud-setupコマンドは、oud-setup-IDnumberというログ・ファイルに書き込みます。この場合のIDnumberは10進数です。ログ・ファイルは次のパスに置かれています:

UNIX (Solaris): /var/tmp/
Linux: /tmp/
Windows: %TEMP%

デフォルトでは、このフォルダはC:\Documents and Settings\User\Local Settings\Tempです。

A.2.13.10 場所

oud-setupコマンドは、次のパスに置かれています:

UNIXおよびLinux: OUD_BASE_LOCATION/OUD_ORACLE_HOME/oud-setup
Windows: OUD_BASE_LOCATION\OUD_ORACLE_HOME\oud-setup.bat

A.2.13.11 関連コマンド

第A.2.12項「oud-replication-gateway-setup」
第A.2.14項「oud-proxy-setup」

A.2.14 oud-proxy-setup

oud-proxy-setupコマンドは、プロキシ・サーバー・インスタンスの設定と構成を管理します。

A.2.14.1 シノプシス

oud-proxy-setup [options]

A.2.14.2 説明

oud-proxy-setupコマンドは、プロキシ・サーバー・インスタンスのインストールと構成を行います。その際、リスニングに使用するポート、初期ルート・ユーザーのDNとパスワード、ディレクトリ・データのベースDN、認証方法を指定し、選択したデプロイメントに応じてロード・バランシング、分散、およびグローバル索引カタログも指定します。

oud-proxy-setupは1回のみ起動できます。これは次のモードで実行できます:

グラフィカル・ユーザー・インタフェース(GUI)モード。GUIモードはデフォルトであり、推奨のインストール・オプションです。設定のGUIは、プロキシ・インスタンスを定義およびデプロイする際に簡単なインタフェースとして機能します。

このユーティリティはグラフィカル・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにプロキシ・インスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。
コマンドライン・インタフェース(CLI)モード。コマンドライン設定では、プロキシ・ポート、ホスト名、およびセキュリティ構成が定義されます。oud-proxy-setupとともに--cliオプションを指定する場合は、必須値をコマンドラインに指定する必要があります。指定しない場合は、デフォルト値が使用されます。デフォルト値が割り当てられていないパラメータに対して値が指定されないと、設定は失敗し、エラー・メッセージが表示されます。

このユーティリティはコマンドライン・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにプロキシ・インスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。

プロキシ設定CLIモードでは、ライセンスを受け入れるためのプロンプトが表示されます。--no-promptオプションを使用すると、ライセンスが自動的に受け入れられます。

A.2.14.3 オプション

oud-proxy-setupコマンドは、短いフォーム(例: -i)または同等の長いフォーム(例: --cli)のいずれかでオプションを受け入れます。

-i, --cli: コマンドライン・インストールを使用します。指定されていない場合は、グラフィカル・インタフェースが起動されます。その他のオプション(helpとversionを除く)は、このオプションが指定されている場合のみ考慮されます。
-p, --ldapPort port: ディレクトリ・サーバーがLDAP通信のリスニングに使用するポート。デフォルト値は389です。
--adminConnectorPort port: 管理コネクタが通信のリスニングに使用するポート。デフォルト値は4444です。
-S, --skipPortCheck: 指定されたポートが使用可能かどうかの判別チェックをスキップします。
-D, --rootUserDN rootUserDN: プロキシ・サーバーに対する初期ルート・ユーザーのDN。
-j, --rootUserPasswordFile rootUserPasswordFile: プロキシ・サーバーに対する初期ルート・ユーザーのパスワードが含まれているファイルへのパス。
-q, --enableStartTLS: LDAPポートを使用することにより、StartTLSがサーバーとセキュアな通信を実行できるようにします。
-Z, --ldapsPort port: ディレクトリ・サーバーがLDAP SSL (LDAPS)通信のリスニングに使用するポート。この引数が明示的に指定されている場合のみ、LDAPSポートが構成され、SSLが有効になります。デフォルト値は636です。
--generateSelfSignedCertificate: SSLベースの接続を受け入れたり、StartTLSネゴシエーションを実行するときにサーバーが使用する必要のある自己署名証明書を生成します。
--usePkcs11keyStore keyStorePath: SSLベースの接続を受け入れたり、StartTLSネゴシエーションを実行するときにサーバーが使用する必要のある証明書が含まれているPKCS#11キーストアのパス。
--useJavaKeystore keyStorePath: サーバー証明書として使用する証明書が含まれているJavaキーストア(JKS)のパス。
--useJCEKS keyStorePath: サーバー証明書として使用する証明書が含まれているJCEKSのパス。
--usePkcs12keyStore keyStorePath: SSLベースの接続を受け入れたり、StartTLSネゴシエーションを実行するときにサーバーが使用する必要のある証明書が含まれているPKCS#12キーストアのパス。
-u, --keyStorePasswordFile keyStorePasswordFile: 証明書キーストアPINファイル。既存の証明書(JKS、JCEKS、PKCS#12、またはPKCS#11)をサーバー証明書として指定する場合は、PINが必要です。
-N, --certNickname nickname: SSLベースの接続を受け入れたり、StartTLSネゴシエーションを実行するときにサーバーが使用する必要のある証明書のニックネーム。
-O, --doNotStart: 構成が完了したときに、サーバーを起動しません。

A.2.14.4 コマンド入力/出力オプション

-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-v, --verbose: 冗長モードを使用します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
-n, --no-prompt: ライセンス受入れの場合のみ、インストールを非インタラクティブ・モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。

A.2.14.5 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.14.6 例

次の例は、oud-proxy-setupコマンドの使用方法を示しています。

例A-46 GUIモードでのoud-proxy-setupの実行

次のコマンドは、GUIモードでインストールを実行します:

$ oud-proxy-setup

このユーティリティはグラフィカル・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにプロキシ・インスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。別のインスタンス名を指定するには、設定を実行する前にINSTANCE_NAME環境変数を、たとえば次のように設定します:

$ export INSTANCE_NAME=my-oud-proxy-instance

例A-47 非インタラクティブCLIモードでのoud-proxy-setupの実行

レプリケートされた大規模な環境に対して多数のプロキシ・サーバー・インスタンスを構成する必要がある場合、非インタラクティブなCLIモードでは、設定コマンドを使用してインストール・スクリプトを作成できます。このモードでは、--no-promptオプションと--quietオプションを指定する必要があります。オプションが指定されていない場合、設定コマンドのデフォルトはインタラクティブ・モードになります。

次のコマンドは、非インタラクティブ(--no-prompt)モードと最小(-Q)モードでインストールを実行します。これはLDAPポート(-p)、管理コネクタ・ポート(--adminConnectorPort)、ルートDN (-D)、およびルートDNパスワード(-j)が含まれているファイルを設定します。

$ oud-proxy-setup --cli --no-prompt -Q -p 1389 --adminConnectorPort 4444 \
  -D "cn=Directory Manager" -j /path/pwd-file

このユーティリティはコマンドライン・インストーラを起動して、OUD_BASE_LOCATION/INSTANCE_DIRにプロキシ・インスタンスを作成します。デフォルトのインスタンス・ディレクトリ名はasinst_1であり、asinst_2、asinst_3などの名前を持つ同じサーバー上に後続のインスタンスが設定されます。別のインスタンス名を指定するには、設定を実行する前にINSTANCE_NAME環境変数を、たとえば次のように設定します:

$ export INSTANCE_NAME=my-oud-proxy-instance

A.2.14.7 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.2.14.8 ログ・ファイル

設定が終了すると、oud-proxy-setupコマンドはoud-proxy-setup.logというログ・ファイルに書き込みます。このログ・ファイルは次のパスに置かれています:

UNIX (Solaris):/var/tmp/
Linux: /tmp/
Windows: %TEMP%フォルダ。デフォルトでは、このフォルダはC:\Documents and Settings\user\Local Settings\Tempです。

A.2.14.9 場所

UNIXおよびLinux: OUD_BASE_LOCATION/OUD_ORACLE_HOME/oud-proxy-setup
Windows: OUD_BASE_LOCATION\OUD_ORACLE_HOME\oud-proxy-setup.bat

A.2.14.10 関連コマンド

第A.2.12項「oud-replication-gateway-setup」

第A.2.17項「stop-ds」

A.2.15 start-ds

start-dsコマンドは、インストールされたサーバー・インスタンスを開始します。

A.2.15.1 シノプシス

start-ds [options]

A.2.15.2 説明

start-dsコマンドは、サーバーの起動と一般的なサーバー情報の指定に使用します。

start-dsは、オプションを指定せずに実行できます。その場合、サーバーはバックグラウンド・プロセスとして起動します。この場合、サーバーが正常に起動するか、起動を妨げるエラーが発生するまで、スクリプトは終了しません。

UNIXシステムでは、INSTANCE_DIR/logs/server.pidでプロセスIDをログに記録できない場合、サーバーは起動しません。サーバーが使用するユーザー・アカウントによってファイルが書込み可能であることを確認します。

A.2.15.3 オプション

start-dsコマンドは、短いフォーム(例: -N)または同等の長いフォーム(例: --nodetach)のいずれかでオプションを受け入れます。

-L, --useLastKnownGoodConfig: 現在アクティブな構成を使用するのではなく、最後に成功した起動時に指定されていた構成が使用可能な場合にこの構成を使用して起動を試行します。
-N, --nodetach: サーバーを、端末から連結解除されないフォアグラウンド・プロセスとして起動します。サーバーがこのモードで実行している場合は、別のウィンドウからstop-dsコマンドを使用して、またはサーバーが実行している端末ウィンドウで[Control]+[C]キーを押してサーバーを停止することができます。
-s, --systemInfo: サーバーがインストールされているシステムの一般情報を、インスタンスとインストール・パスも含めて表示し、その後で、サーバーの起動を試行しないで終了します。
-t, --timeout seconds: コマンドが戻るまで最大時間(単位: 秒)以上は待機しません。(サーバーは、それにかかわらず起動プロセスを続行します)。値0は無限タイムアウトを示し、サーバーの起動が完了したときのみコマンドが戻ることを意味します。デフォルト値は60秒です。このオプションは、-N、--nodetachオプションと同時に使用できません。

A.2.15.4 コマンド入力/出力オプション

-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。

A.2.15.5 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.15.6 例

次の例は、start—dsコマンドの使用方法を示しています。

例A-48 サーバーの起動

次のコマンドによって、サーバーが起動します:

$ start-ds

例A-49 フォアグラウンド・プロセスとしてのサーバーの起動

次のコマンドによって、サーバーがフォアグラウンド・プロセスとして起動します。別のウィンドウからstop-dsコマンドを使用して、またはサーバーが実行している端末ウィンドウで[Control]キーを押しながら[C]キーを押してサーバーを停止することができます。

$ start-ds -N

[25/Jul/2007:10:39:17 -0500] category=CORE severity=NOTICE msgID=458887
msg=The Directory Server has started successfully

A.2.15.7 終了コード

終了コード	説明
`0`	サーバーは正常に起動されました。
`1`	チェック・エラー。互換性のないオプションにより生成されました。
`98`	サーバーはすでに起動しています。
`99`	サーバーは連結解除されたプロセスとして起動する必要があります。
`100`	サーバーは連結解除されないプロセスとして起動する必要があります。
`101`	サーバーはWindowsサービスとして起動する必要があります。
`102`	サーバーは連結解除されたプロセスとして起動する必要があり、Windowsサービスからコールされています。

A.2.15.8 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/start-ds
Windows: INSTANCE_DIR\OUD\bat\start-ds.bat

A.2.15.9 関連コマンド

第A.2.17項「stop-ds」

A.2.16 status

statusコマンドは、基本的なサーバー・ステータス情報を表示します。

A.2.16.1 シノプシス

status [options]

A.2.16.2 説明

statusコマンドは、サーバーのステータス(起動済または停止)、構成された接続ハンドラ、または定義済バックエンドと接尾辞のリストといった基本的なサーバー・ステータス情報の表示に使用できます。

サーバーが起動している場合、statusコマンドは、管理コネクタを介してSSL上のサーバーに接続します。

詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。

サーバーが停止している場合は、構成ファイル(特にconfig.ldifファイル)を読み取るファイルシステム・アクセス権を持つユーザーとしてこのコマンドを実行する必要があります。

注意:

サーバーが実行している場合は、特定の監視データのみ(たとえば、バックエンドにあるエントリ数)を表示できます。

A.2.16.3 LDAP接続オプション

statusコマンドは、管理コネクタを介してSSL上のサーバーに接続します(第14.3項「サーバーへの管理トラフィックの管理」で説明しています)。これらの接続オプションは、サーバーとの接続に使用します。

-D, --bindDN bindDN

バインドDNを使用してサーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。

-j, --bindPasswordFile filename

サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。

-K, --keyStorePath path

指定されたパスにクライアント・キーストア証明書を使用します。

-N, --certNickname nickname

指定された証明書をクライアント認証に使用します。

-o, --saslOption name=value

指定されたオプションをSASL認証に使用します。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-P, --trustStorePath path

-u, --keyStorePasswordFile filename

-U, --trustStorePasswordFile filename

-X, --trustAll

A.2.16.4 コマンド入力/出力オプション

-n, --no-prompt: 非インタラクティブ・モードを使用します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
--noPropertiesFile: このコマンドでは、デフォルトのコマンドライン・オプションを取得するためにプロパティ・ファイルを使用する必要がないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-r, --refresh period: この引数を指定した場合、statusコマンドはコンテンツを周期的に表示します。ステータスの2回の表示の間の期間(単位: 秒)を指定するために使用します。
-s, --script-friendly: スクリプト・フレンドリ・モードで実行します。スクリプトが解析しやすいフォーマットで出力を表示します。

A.2.16.5 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.16.6 例

次の例は、statusコマンドの使用方法を示しています。

例A-50 サーバー・ステータスの表示

次の例では、現在オンラインになっているスタンドアロン・サーバーの現在のステータスが表示されます:

$ status -D "cn=directory manager" -j /path/pwd-file -X -n

          --- Server Status ---
Server Run Status:        Started
Open Connections:         1

          --- Server Details ---
Host Name:                hostname
Administrative Users:     cn=Directory Manager
Installation Path:        /path/OracleUnifiedDirectory
Instance Path:            /path/asinst_1/OUD
Version:                  Oracle Unified Directory 11.1.1.5.0
Java Version:             1.6.0_24
Administration Connector: Port 4444 (LDAPS)

          --- Connection Handlers ---
Address:Port : Protocol    : State
-------------:-------------:---------
--           : LDIF        : Disabled
8989         : Replication : Enabled
0.0.0.0:161  : SNMP        : Disabled
0.0.0.0:636  : LDAPS       : Disabled
0.0.0.0:1389 : LDAP        : Enabled
0.0.0.0:1689 : JMX         : Disabled

          --- Data Sources ---
Base DN:                      dc=example,dc=com
Backend ID:                   userRoot
Entries:                      7
Replication:                  Enabled
Missing Changes:              0
Age Of Oldest Missing Change: not available

A.2.16.7 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.2.16.8 プロパティ・ファイルの使用方法

サーバーでは、statusコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

bindDN
bindPasswordFile
certNickname
hostname
keyStorePasswordFile
keyStorePath
port
saslOption

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
trustAll
trustStorePasswordFile
trustStorePath

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

status.bindPasswordFile=/path/pwd-file

A.2.16.9 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/status
Windows: INSTANCE_DIR\OUD\bat\status.bat

A.2.17 stop-ds

stop-dsは、サービス・インスタンスを停止します。

A.2.17.1 シノプシス

stop-ds [options]

A.2.17.2 説明

stop-dsコマンドは、サーバーの停止または再起動に使用します。これはローカルまたはリモート・サーバー・インスタンスのいずれにおいても操作できます。

サーバーのローカル停止の実行機能は、現在はUNIXベースのシステムのみで使用できます。ローカルで実行している場合、stop-dsはサーバー・プロセスに中断シグナルを送信します。このサーバー停止方法は、stop-dsがオプションを指定せずに実行している場合、およびPIDファイル(INSTANCE_DIR/OUD/logs/server.pid)が存在している場合に使用します。

リモート停止メカニズムにより、サーバーにタスク・エントリを作成するためのLDAPリクエストが発行されます。このコマンドは、サーバー(ローカルまたはリモート)と通信できるすべてのシステムから実行できます。また、これはサーバーの再起動にも使用できます。この場合、サーバーは「インコア」再起動を実行します。つまり、JVMを停止することなくサーバー自身を再初期化します。

リモートで実行している場合、stop-dsコマンドは、管理コネクタを介してSSL上のサーバーと通信します。詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。

A.2.17.3 オプション

stop-dsコマンドは、短いフォーム(例: -D bindDN)または同等の長いフォーム(例: --bindDN bindDN)のいずれかのオプションを受け入れます。

-r,--stopReason reason: 判読可能な停止理由を指定します。理由が指定されている場合、これはサーバーのエラー・ログに表示され、プラグイン停止およびリスナー停止のために指定されます。
-R,--restart: サーバーを停止するかわりに、再起動します。--restartオプションが認証オプションとともに使用されている場合、サーバーはJVMを停止せずにサーバー自身を再初期化します。JVMは停止していないため、JVMの再起動を必要とする構成の変更は有効になりません。--restartオプションを認証なしで使用する場合、サーバーはまず停止し、その後で起動します。新しいプロセスによって元のサーバーが置換されます。
-t,--stopTime time: 停止操作がサーバー・タスクとして開始される日付と時間をYYYYMMDDhhmmssのフォーマットで指定します。値0は、停止を即時実行するようにスケジュールします。このオプションを使用する場合、操作は指定の時間に開始するようスケジュールされ、その直後にこのコマンドが終了します。
-Y,--proxyAs authzID: 停止リクエスト中に認可制御を使用します。このオプションに指定する値は認可IDである必要があります。認可IDには、dn:の後ろにユーザーDNが続くフォーム、またはu:の後ろにユーザー名が続くフォームが使用できます。クライアントはプロキシ認可v2制御を使用します。これについては、RFC 4370 (http://www.ietf.org/rfc/rfc4370.txt)に説明があります。

A.2.17.4 LDAP接続オプション

stop-dsコマンドは、管理コネクタを介してSSL上のサーバーに接続します(第14.3項「サーバーへの管理トラフィックの管理」で説明しています)。これらの接続オプションは、サーバーとの接続に使用します。

-D, --bindDN bindDN

-h, --hostname hostname

指定されたホスト名またはIPアドレスのサーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。

-j, --bindPasswordFile filename

サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。

-K, --keyStorePath path

指定されたパスにクライアント・キーストア証明書を使用します。

-N, --certNickname nickname

指定された証明書をクライアント認証に使用します。

-o, --saslOption name=value

指定されたオプションをSASL認証に使用します。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-p, --port port

指定された管理ポートでサーバーに接続します。このオプションが指定されない場合は、4444というデフォルトの管理ポートが使用されます。

-P, --trustStorePath path

-u, --keyStorePasswordFile filename

-U, --trustStorePasswordFile filename

-X, --trustAll

A.2.17.5 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。

A.2.17.6 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
--version: サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.17.7 例

次の例は、stop-dsコマンドの使用方法を示しています。

例A-51 サーバーのローカルでの停止

次のコマンドによって、サーバーが停止します:

$ stop-ds

例A-52 サーバーのリモートでの停止

次のコマンドによって、リモート・サーバー・インスタンスが停止します。

$ stop-ds -h remotehost -p 4444 -D "cn=directory manager" -j /path/pwd-file -X

例A-53 サーバーのリモートでの再起動

次のコマンドによって、リモート・サーバー・インスタンスが再起動します。

$ stop-ds -R -h remotehost -p 4444 -D "cn=directory manager" -j /path/pwd-file -X

A.2.17.8 終了コード

終了コード	説明
`0`	サーバーは正常に停止しました。
`98`	サーバーはすでに停止しています。
`99`	サーバーを起動する必要があります。
`100`	システム・コールを使用してサーバーを停止する必要があります。
`101`	システム・コールを使用してサーバーを再起動する必要があります。
`102`	プロトコルを使用してサーバーを停止する必要があります。
`103`	サーバーはWindowsサービスとして停止する必要があります。
`104`	サーバーはWindowsサービスとして再起動する必要があります。

A.2.17.9 プロパティ・ファイルの使用方法

サーバーでは、stop-dsコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。

詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

bindDN
bindPasswordFile
certNickname
hostname
keyStorePasswordFile
keyStorePath
saslOption

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
trustAll
trustStorePasswordFile
trustStorePath

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

stop-ds.trustAll=yes

A.2.17.10 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/stop-ds
Windows: INSTANCE_DIR\OUD\bat\stop-ds.bat

A.2.17.11 関連コマンド

第A.2.15項「start-ds」

A.2.18 uninstall

uninstallコマンドは、サーバー・インスタンスのアンインストールに使用します。これはディレクトリ・サーバー、プロキシ・サーバー、およびレプリケーション・ゲートウェイ・サーバーに適用できます。このコマンドは、ソフトウェアではなく、サーバー・インスタンスを削除します。

A.2.18.1 シノプシス

uninstall [options]

A.2.18.2 説明

uninstallコマンドは、サーバー・インスタンスのアンインストールに使用します。これは次のモードで実行できます:

グラフィカル・ユーザー・インタフェース(GUI)モード。GUIモードはデフォルトであり、推奨のアンインストール・オプションです。uninstallのGUIは、インスタンス・ファイルを削除する際の簡単なインタフェースとして機能します。
コマンドライン・インタフェース(CLI)モード。コマンドライン・モードは、インタラクティブと非インタラクティブのどちらでも使用できます。インタラクティブCLIモードでは、アンインストールを開始する前に必須情報を入力するようプロンプトが表示されます。GUIが使用できない場合は、--cliオプションを指定して使用します。

非インタラクティブCLIモードでは、ユーザーが介入せずにインスタンス・ファイルをアンインストールできます。--no-promptオプションと--quietオプションを使用すると、インタラクティブに抑止したり、情報を出力したりすることができます。

GUIモードまたはコマンドライン・モードのいずれで実行しているかに関係なく、削除可能なコンポーネントがリストされます。すべてのインスタンス・ファイルが削除できるとは限らない場合には、まだ存在しているディレクトリをすべてリストしたメッセージが表示されます。

インストールしたサーバーのタイプに応じて、異なるアンインストール・オプションが表示されます。これらのオプションは、次のように大別されます:

第A.2.18.3項「ディレクトリ・サーバーの削除」
第A.2.18.4項「プロキシ・サーバーの削除」
第A.2.18.5項「レプリケーション・ゲートウェイ・サーバーの削除」

注意:

削除すると決定したどのインスタンスのタイプ(ディレクトリ・サーバー、プロキシ、またはレプリケーション・ゲートウェイ)でも、アンインストール手順によってサーバーも停止します。また、レプリケーション・トポロジの一部であるサーバー・インスタンスの場合、そのトポロジから削除中であるサーバーもアンインストール手順によって削除されます。Windowsプラットフォームでは、インスタンスがWindowsサービスとしてインストールされた場合、そのWindowsサービスは登録解除されます。

A.2.18.3 ディレクトリ・サーバーの削除

この項では、ディレクトリ・サーバー・インスタンスを削除するオプションについて説明します。

A.2.18.3.1 オプション

uninstallコマンドは、短いフォーム(例: -i)または同等の長いフォーム(例: --cli)のいずれかでオプションを受け入れます。

-i, --cli: コマンドライン・インストールを使用します。指定されていない場合は、グラフィカル・インタフェースが起動されます。その他のオプション(helpとversionを除く)は、このオプションが指定されている場合のみ考慮されます。
-a, --remove-all: サーバーのすべてのコンポーネントを削除します(このオプションは、その他の削除オプションとの互換性はありません)。
-l, --server-libraries: サーバー・ライブラリと管理ツールを削除します。
-d, --databases: すべてのデータベース・コンテンツを削除します。
-L, --log-files: すべてのログ・ファイルを削除します。
-c, --configuration-files: 構成ファイルを削除します。
-b, --backup-files: すべてのバックアップ・ファイルを削除します。
-e, --ldif-files: LDIFファイルを削除します。
-f, --forceOnError: リモート・サーバー・インスタンスでこのサーバーへの参照の更新中にエラーが発生した場合に、アンインストールを続行するかどうかを指定します。この引数は、--no-prompt引数とのみ同時に使用できます。

A.2.18.3.2 LDAP接続オプション

-I, --adminUID user-ID: サーバーにバインドするためにグローバル管理者のユーザーIDを指定します。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-X, --trustAll: サーバーによって提示されるすべての証明書を信頼します。このオプションはテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-N, --certNickname nickname: SSLクライアント認証に証明書を使用します。
--connectTimeout timeout: 接続の確立に許容される最長時間(ミリ秒)。タイムアウトを指定しない場合は、0を使用します。デフォルト値は30000です。
-h, --referencedHostName host: レプリケーションのためにリモート・サーバーで参照されるこのホストの名前(またはIPアドレス)を指定します。

A.2.18.4 プロキシ・サーバーの削除

この項では、プロキシ・サーバー・インスタンスを削除するオプションについて説明します。

A.2.18.4.1 オプション

uninstallコマンドは、短いフォーム(例: -i)または同等の長いフォーム(例: --cli)のいずれかでオプションを受け入れます。

-i, --cli: コマンドライン・インストールを使用します。指定されていない場合は、グラフィカル・インタフェースが起動されます。その他のオプション(helpとversionを除く)は、このオプションが指定されている場合のみ考慮されます。
-a, --remove-all: サーバーのすべてのコンポーネントを削除します(このオプションは、その他の削除オプションとの互換性はありません)。
-l, --server-libraries: サーバー・ライブラリと管理ツールを削除します。
-L, --log-files: すべてのログ・ファイルを削除します。
-c, --configuration-files: 構成ファイルを削除します。
-b, --backup-files: すべてのバックアップ・ファイルを削除します。
-e, --ldif-files: LDIFファイルを削除します。
-f, --forceOnError: リモート・サーバー・インスタンスでこのサーバーへの参照の更新中にエラーが発生した場合に、アンインストールを続行するかどうかを指定します。この引数は、--no-prompt引数とのみ同時に使用できます。

A.2.18.4.2 LDAP接続オプション

-I, --adminUID user-ID: サーバーにバインドするためにグローバル管理者のユーザーIDを指定します。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-X, --trustAll: サーバーによって提示されるすべての証明書を信頼します。このオプションはテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-N, --certNickname nickname: SSLクライアント認証に証明書を使用します。
--connectTimeout timeout: 接続の確立に許容される最長時間(ミリ秒)。タイムアウトを指定しない場合は、0を使用します。デフォルト値は30000です。
-h, --referencedHostName host: レプリケーションのためにリモート・サーバーで参照されるこのホストの名前(またはIPアドレス)を指定します。

A.2.18.5 レプリケーション・ゲートウェイ・サーバーの削除

この項では、レプリケーション・ゲートウェイ・サーバーのインスタンスを削除するオプションについて説明します。

A.2.18.5.1 オプション

uninstallコマンドは、短いフォーム(例: -i)または同等の長いフォーム(例: --cli)のいずれかでオプションを受け入れます。

-i, --cli: コマンドライン・インストールを使用します。指定されていない場合は、グラフィカル・インタフェースが起動されます。その他のオプション(helpとversionを除く)は、このオプションが指定されている場合のみ考慮されます。
-f, --forceOnError: リモート・サーバー・インスタンスでこのサーバーへの参照の更新中にエラーが発生した場合に、アンインストールを続行するかどうかを指定します。この引数は、--no-prompt引数とのみ同時に使用できます。

A.2.18.5.2 ゲートウェイ接続オプション

-h, --hostname hostname: レプリケーション・ゲートウェイがインストールされているホストの完全修飾名。この名前は、レプリケーション・ゲートウェイの設定時に指定されたものである必要があります。

A.2.18.5.3 Oracle Unified Directoryサーバー接続オプション

-I, --adminUID adminUID: Oracle Unified Directoryサーバーへのバインドに使用するグローバル管理者のユーザーID。以前に新しい生成サーバーでグローバル管理者を定義しなかった場合は、バインドDNを指定します。デフォルト値はadminです。
--adminPasswordFile bindPasswordFile: Oracle Unified Directoryサーバーへのバインドに使用するグローバル管理者(またはバインドDN)のパスワードが含まれているファイル。

A.2.18.5.4 Oracle Directory Server Enterprise Editionサーバー接続オプション

--bindDNLegacy bindDN: レプリケーション・ゲートウェイを介してレプリケートされているコンテンツのあるOracle Directory Server Enterprise Editionサーバーのバインドに使用するDNを指定します。デフォルト値はcn=Directory Managerです。
--bindPasswordFileLegacy bindPasswordFile: レプリケーション・ゲートウェイを介してレプリケートされているコンテンツのあるOracle Directory Server Enterprise Editionサーバーのバインドに使用するパスワードが保存されているファイルを指定します。

A.2.18.5.5 セキュアな接続のオプション

-o, --saslOption name=value

これらはSASLバインド・オプションです。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-X, --trustAll

-P, --trustStorePath path

指定されたパスにトラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。

-U, --trustStorePasswordFile path

トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。

-K, --keyStorePath path

指定されたパスにキーストア証明書を使用します。

-u, --keyStorePasswordFile filename

キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。

-N, --certNickname nickname

指定された証明書をSSLクライアント認証に使用します。

--connectTimeout timeout

接続の確立に許容される最長時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、0を使用します。デフォルト値は30000です。

A.2.18.6 コマンド入力/出力オプション

-n, --no-prompt: setupを非インタラクティブ・モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
-Q, --quiet: 最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-v, --verbose: 標準出力に診断を表示する冗長モードで実行します。
--noPropertiesFile: このコマンドでは、デフォルトのコマンドライン・オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。

A.2.18.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
--version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.18.8 例

次の例は、サーバー・コマンドの使用方法を示しています。

例A-54 グラフィカル・アンインストーラを使用したアンインストール

次のコマンドによりアンインストーラGUIが開いて、削除の必要なコンポーネントを選択するためのプロンプトが表示されます:

$ uninstall

例A-55 コマンドラインを使用したアンインストール

次のコマンドにより、すべてのコンポーネントを削除するか、または特定のコンポーネントを削除するか指定するためのプロンプトが表示され、uninstallコマンドが実行されます。サーバーが実行中の場合は、続行する前にサーバーを停止するためのプロンプトが表示されます。

$ uninstall --cli

例A-56 非インタラクティブCLIモードでのアンインストール

このモードでは、uninstallコマンドを使用してアンインストール・スクリプトを作成できます。--no-prompt (-n)オプションおよび--quiet (-Q)オプションを指定する必要があります。オプションが指定されていない場合、uninstallコマンドのデフォルトはインタラクティブ・モードになります。-nオプションと-QオプションはどちらもCLIモードのみで機能します。

次のコマンドは、非インタラクティブCLIモードですべてのインスタンス・コンポーネントをアンインストールします。

$ uninstall --cli -a -n -Q

A.2.18.9 終了コード

次の終了コードは、ディレクトリ・サーバーとプロキシ・サーバーに適用できます:

0: 成功。
1: ユーザーが操作を取り消しました。
2: ユーザーが無効なデータを指定しました。
3: ファイルシステムへのアクセス(読取り/書込み)中にエラーが発生しました。
5: ディレクトリ・サーバーの構成中にエラーが発生しました。
7: Oracle Unified Directoryサーバーの起動時にエラーが発生しました。
8: Oracle Unified Directoryサーバーの停止時にエラーが発生しました。
9: Windowsサービスの無効化中にエラーが発生しました。
10: アプリケーション固有のエラーです。
11: Oracle Unified Directoryツールの起動時にエラーが発生しました。
12: バグです。
13: Javaバージョンの互換性がありません。
14: ユーザーが無効な入力を指定しました。
50: 印刷バージョン。
51: 印刷の使用状況。
100: 指定されていないエラーのリターン・コード。

次の終了コードは、ゲートウェイ・サーバーに適用できます:

0: 正常にアンインストールしました。
1: 予想外のエラーです(バグの可能性)。
2: 引数を解析できないか、ユーザーにより指定されたデータが無効です。
3: ユーザーがアンインストールを取り消しました。
4: 互換性のないJavaバージョンです。
5: レプリケーション・ゲートウェイ構成の初期化中(管理フレームワークのロード中など)にエラーが発生しました。
6: レプリケーション・ゲートウェイの停止時にエラーが発生しました。
7: Windowsサービスの構成解除中にエラーが発生しました。
8: 入力限度エラーです。
9: ADSコンテンツの更新中にエラーが発生しました。
10: レガシー・サーバーの構成に関するエラーです。レプリカ構成で指定されたベースDNは無効なDNです。
11: 指定されたレガシー(Oracle Directory Server Enterprise Edition)サーバーの1つに互換性がありません。
12: 指定された新しい生成(Oracle Unified Directoryベースの)サーバーの1つに互換性がありません。
13: ユーザーが証明書を受け入れません。
14: いくつかのサーバーの構成のロード時に問題が生じたため、ユーザーは続行するつもりがありません。
15: レプリケーション・ゲートウェイの構成に関するエラーです。
16: ユーザーはインタラクティブ・モードでの最大試行回数を乗り越えました。
17: ユーザーがアンインストールを中止しました。
18: ファイルシステムへのアクセス(たとえば、インストール・ファイルの削除)中にエラーが発生しました。

A.2.18.10 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、uninstallコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

adminUID
bindPasswordFile
certNickname
hostname
keyStorePasswordFile
keyStorePath
saslOption

SASLは、Oracle Unified Directoryに対してサポートされていません。
trustAll
trustStorePasswordFile
trustStorePath

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

uninstall.bindPasswordFile=/path/pwd-file

A.2.18.11 ログ・ファイル

uninstallコマンドは、oud-uninstall-IDnumberというログ・ファイルに書き込みます。この場合のIDnumberは10進数です。ログ・ファイルは次のパスに置かれています:

UNIX (Solaris): /var/tmp/
Linux: /tmp/
Windows: %TEMP%フォルダ。デフォルトでは、このフォルダはC:\Documents and Settings\user\Local Settings\Tempです。

A.2.18.12 場所

uninstallコマンドは、次のパスに置かれています:

UNIXおよびLinux: INSTANCE_DIR/OUD/uninstall
Windows: INSTANCE_DIR\OUD\uninstall.bat

A.2.18.13 関連コマンド

第A.2.12項「oud-replication-gateway-setup」
第A.2.13項「oud-setup」

A.2.19 windows-service

windows-serviceコマンドにより、サーバーをWindowsサービスとして手動で有効または無効にすることができます。

A.2.19.1 シノプシス

windows-service [options]

A.2.19.2 説明

windows-serviceコマンドを使用して、サーバーをWindowsサービスとして手動で有効(または無効)にすることができます。WindowsサービスはUNIXデーモンに類似したバックグラウンドで実行するアプリケーションであり、ユーザーが直接制御することはできません。

A.2.19.3 コマンドのオプション

windows-serviceコマンドは、短いフォーム(例: -d)または同等の長いフォーム(例: --disableService)のいずれかでオプションを受け入れます:

-c,--cleanupService service-name: サービスを無効にして、指定されたサービス名に関連付けられているWindowsレジストリ情報をクリーンアップします。
-d, --disableService: サーバーをWindowsサービスとして無効化します。
-e, --enableService: サーバーをWindowsサービスとして有効化します。
-s, --serviceState: サーバーの状態をWindowsサービスとして表示します。

A.2.19.4 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.2.19.5 例

次の例は、windows-serviceコマンドの使用方法を示しています。

例A-57 サーバーのWindowsサービスとしての有効化

次のコマンドにより、サーバーがWindowsサービスとして有効になります:

$ windows-service -e

例A-58 サーバーのWindowsサービスとしての無効化

次のコマンドにより、サーバーがWindowsサービスとして無効になります:

$ windows-service -d

例A-59 ステータスの表示

次のコマンドにより、Windowsサービスとしてサーバーのステータスが表示されます:

$ windows-service -s

A.2.19.6 終了コード

0: サーバーは正常に起動/停止しました。
1: サービスが見つかりません。
2: サーバー起動エラーです。サーバーはすでに停止しています。
3: サーバー停止エラーです。

A.2.19.7 場所

INSTANCE_DIR\OUD\bat\windows-service.bat

A.2.19.8 関連コマンド

第A.2.13項「oud-setup」

第A.2.14項「oud-proxy-setup」

第A.2.12項「oud-replication-gateway-setup」

A.3 データ管理コマンド

次の各項では、データ管理コマンドについて説明します:

第A.3.1項「backup」
第A.3.2項「base64」
第A.3.3項「dbtest」
第A.3.4項「encode-password」
第A.3.5項「export-ldif」
第A.3.6項「import-ldif」
第A.3.7項「ldif-diff」
第A.3.8項「ldifmodify」
第A.3.9項「ldifsearch」
第A.3.10項「list-backends」
第A.3.11項「make-ldif」
第A.3.12項「manage-account」
第A.3.13項「rebuild-index」
第A.3.14項「restore」
第A.3.15項「split-ldif」
第A.3.16項「verify-index」

A.3.1 backup

backupコマンドは、1つ以上のディレクトリ・サーバー・バックエンドのコンテンツをアーカイブします。

A.3.1.1 シノプシス

backup [options]

A.3.1.2 説明

backupコマンドは、1つ以上のディレクトリ・サーバー・バックエンドのコンテンツをアーカイブします。このコマンドにより、この操作を即時に、またはスケジュールされた時間に実行できます。詳細は、第14.4項「タスクとしてのコマンドの構成」を参照してください。

backupコマンドは、サーバーがオンラインまたはオフラインのときに実行できます。サーバーがオンラインのときにバックアップが実行している場合、このコマンドは管理コネクタを介してSSL上のサーバーに接続し、バックアップ・タスクを登録します。管理コネクタの詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。

A.3.1.3 オプション

backupコマンドは、短いフォーム(例: -B backupID)または同等の長いフォーム(例: --incrementalBaseID backupID)のいずれかのオプションを受け入れます。

-a, --backUpAll

構成済のすべてのバックエンドをバックアップします。このオプションは、--backendIDと同時に使用しないでください。

-A, --hash

バックエンド・アーカイブのコンテンツのハッシュ、またはメッセージ・ダイジェストを生成します。リストア・プロセス中にハッシュをチェックサムとして使用し、バックアップを変更されていないようにすることができます。

-B, --incrementalBaseID backupID

増分バックアップの対象となる既存のバックアップに対してバックアップIDを指定します。このIDが指定されない場合、増分バックアップは最新の増分、またはバックアップ・ディレクトリにある全体バックアップに基づいて行われます。

-c, --compress

バックエンド・アーカイブのコンテンツを圧縮します。使用される圧縮アルゴリズムは、バックエンド・タイプに基づいて異なる場合があります。

-d, --backupDirectory path

指定されたディレクトリにバックアップ・ファイルを書き込みます。複数のバックエンドがアーカイブされる場合は、サブディレクトリがバックエンド別にこのパスの下に作成されます。そうでない場合、バックアップ・ファイルは直接このディレクトリに置かれます。バックエンドが同じである複数のバックアップは同一のディレクトリに置くことができます。増分バックアップを実行する場合は、バックアップ・ディレクトリに少なくとも1つの全体バックアップがすでに含まれている必要があります。これは必須オプションです。

オンライン・バックアップの場合、相対パスのルートは現在の作業ディレクトリではなく、インスタンス・ディレクトリです。たとえば、-d bknov2011を指定した場合、バックアップ・ファイルはinstance-dir/bknov2011に置かれます。

-i, --incremental

完全バックアップではなく、増分バックアップを実行します。増分バックアップには、前回の全体バックアップまたは増分バックアップ以降に変更されたデータのみが含まれます。そのため、増分バックアップは全体バックアップよりも著しく高速に処理されます。増分バックアップをリストアする場合、まず元の全体バックアップをリストアしてから中間の増分バックアップをリストアする必要があります。そのため、このリストア・プロセスは1つの全体バックアップのみのリストアよりも処理に時間がかかる場合があります。バックエンドのタイプによっては、増分バックアップの実行をサポートしていないものがあります。その場合、このオプションは無視されて完全バックアップが実行されます。

-I, --backupID backupID

バックアップに使用する識別子を指定します。指定されない場合は、現在時間に基づいてバックアップIDが生成されます。バックアップIDは、指定されたバックアップ・ディレクトリ内のすべてのバックアップの中で一意である必要があります。

-n, --backendID backendID

保存されるバックエンドのIDを指定します。このオプションを1つのコマンドで複数回使用して、複数のバックエンドをバックアップする必要があることを指定できます。サーバーで使用可能なバックエンドを決定するには、dsconfig list-backendsコマンドを使用します。

-s, --signHash

署名付きハッシュを生成します。これにより、バックアップ・アーカイブとそのコンテンツのハッシュがいずれも変更されていない場合に、より強力な保証が与えられます。このオプションは、オンライン・ディレクトリ・サーバー・インスタンスへの接続が確立されている場合のみ使用できます。その場合は、アーカイブの署名付きハッシュを生成するオンライン・ディレクトリ・サーバーのオプション--hostname、--port、--bindDN、および--bindPasswordFileを指定する必要があります。

-y, --encrypt

バックアップ・アーカイブのコンテンツを暗号化します。このオプションは、オンライン・サーバー・インスタンスへの接続が確立されている場合のみ使用できます。その場合は、アーカイブを暗号化するオンライン・ディレクトリ・サーバーのオプション--hostname、--port、--bindDN、および--bindPasswordFileを指定する必要があります。

A.3.1.4 タスク・バックエンド接続オプション

オンライン・バックエンドを実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。これらの接続オプションは、バックアップをオンラインで実行するときに使用します。

-D, --bindDN bindDN: バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-h, --hostname hostname: 指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: 指定された証明書をクライアント認証に使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-p, --port port: 指定された管理ポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、4444というデフォルトの管理ポートが使用されます。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: ディレクトリ・サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.3.1.5 タスク・スケジュール・オプション

これらのオプションは、バックアップをスケジュール済タスクとして実行すると指定したときに使用します。

--completionNotify emailAddress: タスク終了時に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--dependency taskId: このタスクが依存するタスクのIDを指定します。タスクのすべての依存性が実行を完了するまで、タスクの実行は開始しません。
--errorNotify emailAddress: このタスクの実行時にエラーが発生した場合に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--failedDependencyAction action: 依存タスクの1つが失敗した場合に、このタスクが実行する必要のあるアクションを指定します。この値として、PROCESS、CANCEL、またはDISABLEのいずれか1つが割り当てられている必要があります。値を指定しない場合、デフォルトのアクションはCANCELです。
--recurringTask schedulePattern: タスクは再帰的であり、crontab(5)互換の時間/日付パターンとして表記されるschedulePatternに従ってスケジュールされることを示します。
-t, --start startTime: ディレクトリ・サーバー・タスクとしてスケジュールされている際に、YYYYMMDDhhmmssのフォーマットで表記される操作の開始日付と時間を指定します。値0は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。

A.3.1.6 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されていないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。

A.3.1.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、データのバックアップを試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.1.8 例

次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。

例A-60 すべての構成済バックエンドのバックアップ

次のコマンドは、すべてのディレクトリ・サーバー・バックエンドをアーカイブし(-a)、それらを圧縮し(-c)、指定されたディレクトリに保存します(-d)。

$ backup -a -c -d /tmp/backup

バックエンド別にサブディレクトリを確認するために、バックアップ・ディレクトリのコンテンツを表示します:

$ ls /tmp/backup
config    schema    tasks     userRoot

現在時間に基づいてバックアップIDがシステムに割り当てられていることを確認するために、サブディレクトリのコンテンツを表示します。

$ ls /tmp/backup/userRoot/
backup-userRoot-20081015151640Z  backup.info

-Iオプションを使用して、独自のバックアップIDを割り当てることができます。例:

$ backup -a -c -d /tmp/backup -I October08

割り当てられたバックアップIDを確認するために、userRootサブディレクトリのコンテンツを表示します。

$ ls /tmp/backup/userRoot/
backup-userRoot-October08        backup.info

例A-61 特定のバックエンドのバックアップ

バックアップするバックエンドを指定するには、-nオプションを使用します。次のコマンドは、userRootバックエンドのみをアーカイブします。

$ backup -n userRoot -d /tmp/backup

例A-62 増分バックアップの実行

次のコマンドは、増分バックアップ(-i)を使用してすべてのディレクトリ・サーバー・バックエンドをアーカイブし(-a)、それらを圧縮して(-c)、ディレクトリにデータを保存します(-d)。

$ backup -a -i -c -d /tmp/backup

例A-63 特定のバックエンドでの増分バックアップの実行

現在の構成済バックエンドを表示するには、list-backendsコマンドを使用します。

$ list-backends
Backend ID     : Base DN
---------------:--------------------
adminRoot      : cn=admin data
ads-truststore : cn=ads-truststore
backup         : cn=backups
config         : cn=config
monitor        : cn=monitor
schema         : cn=schema
tasks          : cn=tasks
userRoot       : "dc=example,dc=com"

次のコマンドは、userRootバックエンド(-n)で増分バックアップ(-i)を実行し、そのバックアップを圧縮して(-c)、ディレクトリにデータを保存します(-d)。

$ backup -i -n userRoot -c -d /tmp/backup/userRoot

例A-64 既存のバックアップに対する増分バックアップの実行

-Iオプションまたは--backupIDオプションを使用して2つのアーカイブ済の増分バックアップ・ファイルを作成し、その2つのファイルにID、1234および4898をそれぞれ割り当てているとします:

/tmp/backup/userRoot> ls
./     backup-userRoot-1234   backup.info
../    backup-userRoot-4898   backup.info.save

次のコマンドは、バックアップID 1234に基づいて(-B)すべての構成済バックエンド(-a)で増分バックアップ(-i)を実行し、バックアップID 5438を増分バックアップに割り当てて、ディレクトリにデータを保存します(-d)。

$ backup -a -i -B 1234 -I 5438 -d /tmp/backup

backup.infoのコンテンツは、最新の増分バックアップ(backup_id=5438)がbackup_id=1234に対して依存性を持っていることを示しています:

$ backend_dn=ds-cfg-backend-id=userRoot,cn=Backends,cn=config

backup_id=4898
backup_date=20070727202906Z
incremental=false
compressed=false
encrypted=false
signed_hash=VmBG/VkfMAMMPnR6M8b5kZil7FQ=
property.last_logfile_name=00000000.jdb
property.archive_file=backup-userRoot-4898
property.cipher_algorithm=AES/CBC/PKCS5Padding
property.mac_algorithm=HmacSHA1
property.last_logfile_size=490554

backup_id=1234
backup_date=20070727202934Z
incremental=false
compressed=false
encrypted=false
signed_hash=VmBG/VkfMAMMPnR6M8b5kZil7FQ=
property.last_logfile_name=00000000.jdb
property.archive_file=backup-userRoot-1234
property.cipher_algorithm=AES/CBC/PKCS5Padding
property.mac_algorithm=HmacSHA1
property.last_logfile_size=490554

backup_id=5438
backup_date=20070727203107Z
incremental=true
compressed=false
encrypted=false
dependency=1234
property.last_logfile_name=00000000.jdb
property.archive_file=backup-userRoot-5438
property.last_logfile_size=490554

例A-65 暗号化および署名付きハッシュによるすべての構成済バックエンドのバックアップ

ディレクトリ・サーバーでは、セキュアなアーカイブ済データに対して、バックアップ暗号化(--encryptを使用)、ハッシュの生成(--hashを使用)、および署名付きハッシュ(--signHashを使用)をサポートしています。これらのオプションでは、管理コネクタを介してSSL上でオンライン・サーバー・インスタンスに接続する必要があります。したがって、これらのオプションを使用する場合は、ホスト、管理ポート、バインドDN、およびバインド・パスワード・ファイルも含めた接続の詳細を指定する必要があります。また、SSL接続用に証明書の詳細を指定する必要もあります。

次のコマンドは、すべてのディレクトリ・サーバー・バックエンドをアーカイブし(-a)、それらを圧縮し(-c)、ハッシュを生成し(-A)、そのハッシュに署名し(-s)、データのアーカイブ中にデータを暗号化し(-y)、バックエンドID 123を割り当てて、データをディレクトリに保存します(-d)。自己署名証明書は、-X (--trustAll)オプションを使用して信頼されます。

$ backup -h localhost -D "cn=Directory Manager" -j /path/pwd-file -p 4444 -X \
  -a -c -A -s -y -I 123 -d /tmp/backup
Backup task 2008101609295810 scheduled to start immediately
...

例A-66 バックアップのスケジュール

バックエンドをスケジュールするには、タスク・バックエンドにオンラインでアクセスする必要があります。このバックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。したがって、バックアップをスケジュールする場合は、ホスト、管理ポート、バインドDN、およびバインド・パスワード・ファイルも含めた接続の詳細を指定する必要があります。また、SSL接続用に証明書の詳細を指定する必要もあります。

次のコマンドは、すべてのコンポーネントのバックアップをスケジュールして(-a)、それを/tmp/backupsディレクトリに書き込みます(-d)。開始時間は、--startオプションによって指定されます。バックアップにより、完了通知とエラー通知がadmin@example.comに送信されます。自己署名証明書は、-X (--trustAll)オプションを使用して信頼されます。

$ backup -h localhost -D "cn=Directory Manager" -j /path/pwd-file -p 4444 -X \
  -a -d /tmp/backups --start 20090124121500 --completionNotify admin@example.com \
  --errorNotify admin@example.com
Backup task 2007102914530410 scheduled to start Jan 24, 2009 12:15:00 PM SAST

このスケジュール済タスクを表示するには、manage-tasksコマンドを使用します。詳細は、第14.4項「タスクとしてのコマンドの構成」を参照してください。

A.3.1.9 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.3.1.10 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、backupコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

A.3.1.11 場所

backupコマンドは、次のパスに置かれています:

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/backup
Windows: INSTANCE_DIR\OUD\bat\backup.bat

A.3.1.12 関連コマンド

第A.3.14項「restore」
第A.3.10項「list-backends」
第A.2.8項「manage-tasks」

A.3.2 base64

base64コマンドは、base64エンコーディング・フォーマットを使用してバイナリ文字列をエンコードします。

A.3.2.1 シノプシス

base64 subcommand[options]

A.3.2.2 説明

base64コマンドは、base64エンコーディング・フォーマットを使用してバイナリ文字列をテキスト表現にエンコードします。base64エンコーディングは、非ASCII文字の文字列を表現するためにLDIFファイルで頻繁に使用します。また、証明書の内容や、MD5またはSHAなどのメッセージ・ダイジェストの出力のエンコードにも多用されます。

A.3.2.3 サブコマンド

base64コマンドで使用されるサブコマンドは、次のとおりです。

decode

base64でエンコードされた情報をrawデータにデコードします。サブオプションは次のとおりです:

-d, --encodedData encoded-data.。rawデータにデコードするbase64でエンコードされたデータ。

-f, --encodedDataFile filename。デコード対象のbase64でエンコードされたデータが含まれているファイルへのパス。

-o, --toRawFile filename。rawデータの書き込み先であるファイルへのパス。

encode

raw dataをbase64にエンコードします。サブオプションは次のとおりです:

-d, --rawData raw-data。base64にエンコードするraw data。

-f, --rawDataFile filename。base64でエンコードされるrawデータが含まれているファイルへのパス。

-o, --toEncodedFile filename。base64エンコードされたデータの書込み先であるファイルへのパス。

A.3.2.4 グローバル・オプション

-?, -H, --help: 使用情報を表示します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.3.2.5 例

次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。

例A-67 base64による文字列のエンコード

次のコマンドにより、文字列opendsがbase64でエンコードされます。

$ base64 encode -d opends
b3BlbmRz

例A-68 base64によるファイルのコンテンツのエンコード

次のコマンドにより、ファイル(-f)がbase64でエンコードされ、出力ファイル(-o)に書き込まれます。

$ base64 encode -f myrawdata -o myencodeddata

例A-69 base64でエンコードされた文字列のデコード

次のコマンドにより、base64でエンコードされた文字列がデコードされます。

$ base64 decode -d b3BlbmRz
opends

例A-70 base64でエンコードされたファイルのコンテンツのデコード

次のコマンドにより、base64でエンコードされたファイル(-f)がデコードされ、出力ファイル(-o)に書き込まれます。

$ base64 encode -f myencodeddata -o myoutput

例A-71 Linuxシステムでのbase64によるエンコードおよびデコード

次のコマンドは、Linux上でコマンドラインからエンコードとデコードを実行します。クリアテキスト文字列を入力した後で、[Control]-[D]キーを押してコマンドライン上での入力の終わりのシグナルを送ります。

$ base64 encode
hello world
<CTRL-D>
aGVsbGBqd29ybGQK

$ base64 decode
aGVsbG8gd29ybGQK
<CTRL-D>
hello world

A.3.2.6 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.3.2.7 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/base64
Windows: INSTANCE_DIR\OUD\bat\base64.bat

A.3.3 dbtest

dbtestコマンドは、Oracle Berkeley Java Edition (JE)バックエンドをデバッグします。

A.3.3.1 シノプシス

dbtest subcommands [options]

A.3.3.2 説明

dbtestコマンドは、Oracle Berkeley Java Edition (JE)バックエンドのデバッグに使用します。このコマンドにより、ルート、エントリ、データベース・コンテナ、およびデータベース内の索引のステータスがリストされます。また、デバッグ用にデータベースのダンプも指定されます。

バックエンドは、ディレクトリ・サーバーにデータを格納するためのリポジトリです。バックエンドは特定のタイプのデータベース(DB)を使用してデータを格納し、ディレクトリ内でバックエンドがエントリを検索できるようにする索引セットを維持します。ディレクトリ・サーバーのプライマリ・データベースはBerkeley Java Edition (JE)データベースであり、ここでは、データが鍵付きレコードの単一コレクションとしてBツリー形式で編成されます。

dbtestコマンドを使用して次の情報にアクセスできます:

ルート・コンテナ。バックエンドIDとバックエンド用のディレクトリを指定します。
エントリ・コンテナ。エントリ・コンテナがディスクに格納しているベースDN、データベース名に使用するデータベース接頭辞、およびデータベース内のエントリ数を指定します。JEバックエンドの各ベースDNには、それぞれ専用のエントリ・コンテナが割り当てられています。
データベース・コンテナ。特定のバックエンドIDのデータベース名、タイプ、およびJEデータベース名を指定します。
索引ステータス。索引名、タイプ、ステータス、および関連付けられているJEデータベースを指定します。

現在、dbtestコマンドは読取り専用コマンドであり、データベースを変更することはできません。このコマンドはオンライン・モードまたはオフライン・モードで実行できます。ただし、オンライン・モードでdbtestを実行すると、オフライン・モードでの実行よりもかなり長い時間がかかる場合があります。

A.3.3.3 サブコマンド

dump-database-container

レコードをデータベース・コンテナからダンプします。サブオプションは次のとおりです:

-b, --baseDN baseDN。デバッグするエントリ・コンテナのベースDN。必須。

-d, --databaseName databaseName。デバッグするデータベース・コンテナの名前。必須。

-k, --minKeyValue value。データベース・コンテナのコンパレータを使用して指定値の後に順序付けする必要のあるキーを持つレコードのみを表示します。

-K, --maxKeyValue value。データベース・コンテナのコンパレータを使用して指定値の前に順序付けする必要のあるキーを持つレコードのみを表示します。

-n, --backendID backendID。デバッグするローカルDBバックエンドのID。必須。

-p, --skipDecode。ローカル・データベースのデコードを、その適切なタイプに応じてスキップします。

-q, --statsOnly。完全なデータではなく、統計のみを表示します。

-s, --minDataSize size。指定された値以上のデータを持つレコードのみを表示します。

-S, --maxDataSize size。指定された値以下のデータを持つレコードのみを表示します。

list-database-containers

エントリ・コンテナ用のデータベース・コンテナをリストします。サブオプションは次のとおりです:

-b, --baseDN baseDN。デバッグするエントリ・コンテナのベースDN。必須。

-n, --backendID backendID。デバッグするローカルDBバックエンドのID。必須。

list-entry-containers

ルート・コンテナ用のエントリ・コンテナをリストします。サブオプションは次のとおりです:

-n, --backendID backendID。デバッグするローカルDBバックエンドのID。必須。

list-index-status

エントリ・コンテナ内の索引のステータスをリストします。サブオプションは次のとおりです:

-b, --baseDN baseDN。デバッグするエントリ・コンテナのベースDN。必須。

-n, --backendID backendID。デバッグするローカルDBバックエンドのID。必須。

list-root-containers

すべてのローカルDBバックエンドによって使用されるルート・コンテナをリストします。

A.3.3.4 グローバル・オプション

dbtestコマンドは、短いフォーム(例: -H)または同等の長いフォーム(例: --help)のいずれかでオプションを受け入れます。

-?, -H, --help: 使用情報を表示します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.3.3.5 例

次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。

例A-72 ルート・コンテナのリストの表示

次のコマンドにより、すべてのローカルDBバックエンドによって使用されるルート・コンテナがリストされます:

$ dbtest list-root-containers
Backend ID  Database Directory
------------------------------
userRoot    db

Total: 1

例A-73 エントリ・コンテナのリストの表示

次のコマンドにより、ローカルDBバックエンド上のエントリ・コンテナのリストが表示されます:

$ dbtest list-entry-containers -n userRoot
Base DN            JE Database Prefix  Entry Count
--------------------------------------------------
dc=example,dc=com  dc_example_dc_com   102

Total: 1

例A-74 データベース・コンテナのリストの表示

次のコマンドにより、ローカルDBバックエンド上のデータベース・コンテナのリストが表示されます:

$ dbtest list-database-containers -b dc=example,dc=com -n userRoot
Database Name              Database  JE Database Name                       Entry Count
                           Type
---------------------------------------------------------------------------------------
dn2id                      DN2ID     dc_example_dc_com_dn2id                      102
id2entry                   ID2Entry  dc_example_dc_com_id2entry                   102
referral                   DN2URI    dc_example_dc_com_referral                   0
id2children                Index     dc_example_dc_com_id2children                2
id2subtree                 Index     dc_example_dc_com_id2subtree                 2
state                      State     dc_example_dc_com_state                      19
objectClass.equality       Index     dc_example_dc_com_objectClass.equality       6
givenName.equality         Index     dc_example_dc_com_givenName.equality         100
givenName.substring        Index     dc_example_dc_com_givenName.substring        396
member.equality            Index     dc_example_dc_com_member.equality            0
uid.equality               Index     dc_example_dc_com_uid.equality               100
cn.equality                Index     dc_example_dc_com_cn.equality                100
cn.substring               Index     dc_example_dc_com_cn.substring               1137
uniqueMember.equality      Index     dc_example_dc_com_uniqueMember.equality      0
telephoneNumber.equality   Index     dc_example_dc_com_telephoneNumber.equality   100
telephoneNumber.substring  Index     dc_example_dc_com_telephoneNumber.substring  956
sn.equality                Index     dc_example_dc_com_sn.equality                100
sn.substring               Index     dc_example_dc_com_sn.substring               541
ds-sync-hist.ordering      Index     dc_example_dc_com_ds-sync-hist.ordering      0
mail.equality              Index     dc_example_dc_com_mail.equality              100
mail.substring             Index     dc_example_dc_com_mail.substring             525
entryUUID.equality         Index     dc_example_dc_com_entryUUID.equality         102
aci.presence               Index     dc_example_dc_com_aci.presence               0

Total: 23

例A-75 データベースのコンテンツのダンプとデコードのスキップ

次のコマンドによってデータベースのコンテンツがダンプされ、エントリの索引付きの値が表示されますが、デコードはスキップされます。

$ dbtest dump-database-container -b dc=example,dc=com -n userRoot \
  -d objectClass.equality -p

Key (6 bytes):
64 6F 6D 61 69 6E domain

Data (8 bytes):
00 00 00 00 00 00 00 01

Key (18 bytes):
67 72 6F 75 70 6F 66 75 6E 69 71 75 65 6E 61 6D groupofu niquenam
65 73 es

Data (40 bytes):
00 00 00 00 00 00 00 03 00 00 00 00 00 00 00 9C
00 00 00 00 00 00 00 9D 00 00 00 00 00 00 00 9E
00 00 00 00 00 00 00 9F
...

A.3.3.6 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.3.3.7 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/dbtest
Windows: INSTANCE_DIR\OUD\bat\dbtest.bat

A.3.3.8 関連コマンド

第A.2.4項「dsconfig」
第A.3.6項「import-ldif」
第A.3.5項「export-ldif」

A.3.4 encode-password

encode-passwordコマンドは、ユーザー・パスワードのエンコードと比較を行います。

このコマンドはプロキシに対してサポートされていません。

A.3.4.1 シノプシス

encode-password options

A.3.4.2 説明

encode-passwordコマンドは、ディレクトリ・サーバーで定義されたパスワード記憶スキームとの相互作用に使用できます。次の3つの操作モードが使用できます:

スキームのリスト・モード。ディレクトリ・サーバーで使用できるパスワード記憶スキームをリストします。このモードでは、--listSchemesオプションは必須です。
クリアテキストのエンコード・モード。指定されたパスワード記憶スキームを使用して、クリアテキスト・パスワードをエンコードします。このモードでは、ファイル(--clearPasswordFile)から読み取られるクリアテキスト・パスワードとともに、--storageSchemeオプションが必要です。
パスワードの検証モード。指定されたエンコード済パスワードに対して指定されたクリアテキスト・パスワードが正しいかどうかを判別します。このモードでは、クリアテキスト・パスワード(--clearPasswordFileによる)とエンコード済パスワード(--encodedPasswordFileによる)が必要です。

ディレクトリ・サーバーで使用可能な認証パスワードのセットは、ルートDSEエントリのsupportedAuthPasswordSchemes属性から取得できます。ldapsearchを使用して、この情報を表示できます。

A.3.4.3 オプション

encode-passwordコマンドは、短いフォーム(例: -f filename)または同等の長いフォーム(例: --clearPasswordFile filename)のいずれかのオプションを受け入れます。

-a, --authPasswordSyntax: 値をscheme$authInfo$authValueのフォームでエンコードする認証パスワード構文(RFC 3112 (http://www.ietf.org/rfc/rfc3112.txt)に定義されています)を使用します。このオプションが指定されていない場合は、ユーザー・パスワード構文(値をscheme$valueのフォームでエンコードします)が使用されます。
-E, --encodedPasswordFile filename: 指定したファイルからエンコード済パスワードを使用して、指定されたクリアテキスト・パスワードと比較します。--authPasswordSyntaxオプションも指定されている場合、このパスワードは認証パスワード構文を使用してエンコードする必要があります。そうでない場合は、ユーザー・パスワード構文を使用してエンコードします。
-f, --clearPasswordFile filename: クリアテキスト・パスワードをエンコードする場合、またはクリアテキスト・パスワードをエンコード済パスワードと比較する場合は、指定したファイルからクリアテキスト・パスワードを使用します。
-i, --interactivePassword: エンコードするパスワード、またはエンコード済パスワードと比較するパスワードは、ユーザーからインタラクティブにリクエストされます。
-l, --listSchemes: ディレクトリ・サーバーで使用できるパスワード記憶スキームのリストを表示します。このオプションを単独で使用する場合は、ユーザー・パスワード構文をサポートしているパスワード記憶スキームの名前が表示されます。このオプションを--authPasswordSyntaxとともに使用する場合は、認証パスワード構文をサポートしているパスワード記憶スキームの名前が表示されます。
-r, --useCompareResultCode: 指定されたクリアテキスト・パスワードが指定されたエンコード済パスワードと一致したかどうかを示す終了コードを使用します。このオプションが指定されている場合、ディレクトリ・サーバーは終了コード6 (COMPARE_TRUE)または終了コード5 (COMPARE_FALSE)を表示します。その他の終了コードは、コマンドが必要な決定を行うための処理に失敗したことを示します。このオプションが指定されていない場合、ゼロの終了コードを使用してコマンドが処理を正常に終了したことを示すか、エラーが発生した場合には、ゼロ以外の終了コードを使用します。
-s, --storageScheme storageScheme: クリアテキスト・パスワードのエンコードに使用するパスワード記憶スキームの名前を指定します。--authPasswordSyntaxオプションが指定されている場合は、サポートされている認証パスワード記憶スキームの名前を値として指定する必要があります。そうでない場合は、サポートされているユーザー・パスワード記憶スキームの名前を指定します。
-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、その他のアクションを実行しないで即時に終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.3.4.4 例

次の例は、encode-passwordコマンドの使用方法を示しています。

例A-76 サーバーでの記憶スキームのリスト

次のコマンドは、ディレクトリ・サーバーで使用できる記憶スキーム(-l)をリストします。

$ encode-password -l
3DES
AES
BASE64
BLOWFISH
CLEAR
CRYPT
MD5
RC4
SHA
SMD5
SSHA
SSHA256
SSHA384
SSHA512

例A-77 サーバーでの認証済パスコード構文記憶スキームのリスト

次のコマンドは、ディレクトリ・サーバーで認証パスコード構文(-a)をサポートする記憶スキーム(-l)をリストします。

$ encode-password -l -a

MD5
SHA1
SHA256
SHA384
SHA512

例A-78 クリアテキスト・パスワードの別のスキームへのエンコード

次のコマンドにより、指定されたスキーム(-s)を使用して、クリアテキスト・パスワードがファイル(-f)にエンコードされます。

$ encode-password -f /path/clear-pwd-file -s MD5

Encoded Password:  "{MD5}AjxHKRFkRwxx3j9lM2HMow=="

例A-79 認証パスワード構文を使用したクリアテキスト・パスワードの別のスキームへのエンコード

次のコマンドにより、指定されたスキーム(-s)と認証パスワード構文(-a)を使用して、クリアテキスト・パスワードがファイル(-f)にエンコードされます。

$ encode-password -f /path/clear-pwd-file -s MD5 -a

Encoded Password:  "MD5$/imERhcEu3U=$AFqmpZi8EiTIvMFwkcrf8A=="

例A-80 クリアテキスト・パスワードとエンコード済パスワードの比較

次のコマンドにより、ファイル内のクリアテキスト・パスワード(-f)が、ファイル内のエンコード済パスワード(-E)と比較されます。エンコード済パスワードには、パスワード・スキーム(たとえば、MD5)を含めないでください。

$ encode-password -f /path/clear-pwd-file -E /path/encoded-pwd-file -s MD5

The provided clear-text and encoded passwords match

例A-81 クリアテキスト・パスワードとエンコード済パスワードの比較および終了コードの返し

次のコマンドにより、スキーム(-s)を使用してファイル内のクリアテキスト・パスワード(-f)がファイル内のエンコード済パスワード(-E)と比較され、終了コード(-r)が返されます(COMPARETRUEの場合は6、COMPAREFALSEの場合は5)。エンコード済パスワードには、パスワード・スキーム(たとえば、MD5)を含めないでください。

$ encode-password -f /path/clear-pwd-file -E /path/encoded-pwd-file -s MD5 -r

The provided clear-text and encoded passwords match

echo $?
6

例A-82 SSHAを使用したファイル内のパスワードのエンコード

次のコマンドにより、指定されたスキーム(-s)を使用して、クリアテキスト・パスワードがファイル(-f)にエンコードされます。Windowsプラットフォームの場合は、クリアテキスト・パスワード・ファイルへのパス(たとえば、-f \temp\testpassword)を指定します:

$ encode-password -s SSHA -f /path/clear-pwd-file

Encoded Password:   "{SSHA}QX2fMu+2N22N9qI+zu6fIZxsBVID3EsUlYYEbQ=="

A.3.4.5 終了コード

表A-3 終了コード

終了コード	説明
`0`	操作は正常に完了しました。
`1`	操作中にエラーが発生しました。
`5`	COMPARE_FALSE。オプション`--r`または`--useCompareCodeResult`とともに使用した場合、終了コード`5`によって、指定されたクリアテキスト・パスワードが指定されたエンコード済パスワードと一致しないことが示されます。
`6`	COMPARE_TRUE。オプション`--r`または`--useCompareCodeResult`とともに使用した場合、終了コード`6`によって、指定されたクリアテキスト・パスワードが指定されたエンコード済パスワードと一致することが示されます。

A.3.4.6 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/encode-password
Windows: INSTANCE_DIR\OUD\bat\encode-password.bat

A.3.5 export-ldif

export-ldifコマンドは、ディレクトリ・サーバー・バックエンドのコンテンツをLDIF形式にエクスポートします。

A.3.5.1 シノプシス

export-ldif [options]

A.3.5.2 説明

export-ldifコマンドは、ディレクトリ・サーバー・バックエンドのコンテンツをLDIF形式にエクスポートします。このコマンドにより、エクスポートを即時に実行するか、または指定された日付と時間で実行するようにスケジュールすることができます。詳細は、第14.4項「タスクとしてのコマンドの構成」を参照してください。

一部のバックエンドはディレクトリ・サーバーへインポートできないため、export-ldifコマンドは、monitor、ads-truststore、backup、config-file-handlerなどのバックエンドをエクスポートしません。

export-ldifコマンドは、オンラインまたはオフラインで実行できます。

オンライン・モード。オンライン・モードでは、export-ldifは管理コネクタを介してSSL上で実行中のディレクトリ・サーバー・インスタンスに接続し、エクスポート・タスクを登録します。タスク・バックエンド接続オプションのいずれかを指定した場合、このコマンドは自動的にオンライン・モードで実行します。管理コネクタの詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。
オフライン・モード。オフライン・モードでは、export-ldifはディレクトリ・サーバー・インスタンスを介さずに、データベースに直接アクセスします。オフライン・エクスポートを実行するには、ディレクトリ・サーバーを停止する必要があります。

A.3.5.3 オプション

export-ldifコマンドは、短いフォーム(例: -b branchDN)または同等の長いフォーム(例: --includeBranch branchDN)のいずれかのオプションを受け入れます。

-a, --appendToLDIF

既存のLDIFファイルを上書きするのではなく、それにエクスポートを追加します。このオプションが指定されない場合、ディレクトリ・サーバーは、指定されたLDIFファイルが存在する場合にそれを上書きします。

-b, --includeBranch branchDN

エクスポートするデータのブランチまたはサブツリーのベースDNを指定します。このオプションを複数回使用して、複数のベースDNを指定できます。このオプションが指定された場合、バックエンド内で指定されたベースDNの1つにないエントリ、またはそれより下のエントリはスキップされます。

-B, --excludeBranch branchDN

エクスポートから除外するデータのブランチまたはサブツリーのベースDNを指定します。このオプションを複数回使用して、複数のベースDNを指定できます。このオプションが指定された場合、バックエンド内で指定されたベースDNの1つにあるエントリ、またはそれより下のエントリはすべてスキップされます。--excludeBranchオプションの使用は、--includeBranchオプションよりも優先されます。含まれるリストと除外されるリストの両方に表示されているDNにあるエントリ、またはそのDNより下にあるエントリは含まれません。この機能によって、ブランチの一部であるデータのみを含めることが可能になります。たとえば、ou=People,dc=example,dc=comより下のエントリを除き、dc=example,dc=comより下のエントリをすべて含めることができます。

-c, --compress

LDIFデータが書き込まれるときに、それを圧縮します。データの圧縮には、import-ldifコマンドの--isCompressedオプションにより使用される形式であるGZIP形式が使用されます。

-e, --excludeAttribute attribute

エクスポート時に、指定された属性名を除外します。このオプションを複数回使用して、複数の属性を指定できます。このオプションが指定された場合、リストされた属性はすべて、エクスポートされるエントリから除外されます。

-E, --excludeFilter filter

エクスポート時に、指定した検索フィルタによって識別されたエントリを除外します。このオプションを複数回使用して、複数のフィルタを指定できます。このオプションが指定された場合、フィルタに一致するバックエンド内のエントリはすべてスキップされます。--excludeFilterオプションの使用は、--includeFilterオプションよりも優先されます。エントリが含まれるリストと除外されるリストの両方でフィルタに一致する場合、そのエントリはスキップされます。

-i, --includeAttribute attribute

指定した属性名をエクスポートに含めます。このオプションを複数回使用して、複数の属性を指定できます。このオプションが指定された場合、リストされない属性はすべて、エクスポートされるエントリから除外されます。

-g, --algorithm algorithm

指定したアルゴリズムがエクスポートで使用されます。このオプションは任意であり、次の値のいずれかを入力できます:

diskOrder: このオプションにより、Oracle Berkeley DB Java Edition (JE)バックエンドから、ディスクに格納されている順序でデータを読み取ることができます。

このオプションの利点は、次のとおりです:

データベースがデータベース・キャッシュにまったく適合しない場合にお薦めします。
実行用にデータベース・キャッシュを一時的に20%使用し、その後でデータベース・キャッシュを解放します。エクスポート時に、データベース・キャッシュ・メモリーが20%減少します。

注意:

このアルゴリズムはJEバックエンドからディスク順序付けという特別の機能を使用するため、サーバーの実行中にサーバーにアクセスしてエクスポートと同時に変更を行った場合、エラーが発生することがあります。読取り操作は実行可能です。

entryIdOrder: このオプションにより、Oracle Berkeley DB Java Edition (JE)バックエンドから、データベース・レベルで論理的に格納されている順序でデータを読み取ることができます。

このオプションの利点は、次のとおりです:
- データベースがデータベース・キャッシュに完全に適合する場合、このオプションはdiskOrderアルゴリズムと比べて高いパフォーマンスを提供します。
- データベース・キャッシュから一時的にメモリーが抽出されることはありません。
- サーバーの実行中にサーバーにアクセスしてエクスポートと同時に変更を行う場合でも、このアルゴリズムは実行可能です。
auto: このオプションは、サーバー停止時にオフライン・モードでdiskOrderを自動的に選択し、サーバー実行時にオンライン・モードでentryIdOrderを自動的に選択します。

-I, --includeFilter filter

指定した検索フィルタによって識別されたエントリをエクスポートに含めます。このオプションを複数回使用して、複数のフィルタを指定できます。このオプションが指定された場合、フィルタに一致しないバックエンド内のエントリはすべてスキップされます。

-l, --ldifFile filename

指定したLDIFファイルにデータをエクスポートします。これは必須オプションです。

オンライン・エクスポートの場合、相対パスのルートは現在の作業ディレクトリではなく、インスタンス・ルートです。したがって、たとえば、この場合のexports/ldif.ldifのパスはinstance-root/exports/ldif.ldifになります。

-n, --backendID backendID

エクスポートされるデータのバックエンドIDを指定します。サーバーで使用可能なバックエンドを決定するには、list-backendsコマンドを使用します。これは必須オプションです。

-O, --excludeOperational

エクスポートにある操作属性を除外します。

--wrapColumn column

LDIFファイルに書き込む際に、長い行を折り返す列を指定します。値0は、データを折り返さないことを指定します。

A.3.5.4 タスク・バックエンド接続オプション

オンライン・エクスポートを実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。これらの接続オプションは、エクスポートをオンラインで実行するときに使用します。

-D, --bindDN bindDN: バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-h, --hostname hostname: 指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: 指定された証明書をクライアント認証に使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-p, --port port: 指定された管理ポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、4444というデフォルトの管理ポートが使用されます。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: ディレクトリ・サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.3.5.5 タスク・スケジュール・オプション

これらのオプションは、エクスポートをスケジュール済タスクとして実行すると指定したときに使用します。

--completionNotify emailAddress: タスク終了時に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--dependency taskId: このタスクが依存するタスクのIDを指定します。タスクのすべての依存性が実行を完了するまで、タスクの実行は開始しません。
--errorNotify emailAddress: このタスクの実行時にエラーが発生した場合に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--failedDependencyAction action: 依存タスクの1つが失敗した場合に、このタスクが実行する必要のあるアクションを指定します。この値として、PROCESS、CANCEL、またはDISABLEのいずれか1つが割り当てられている必要があります。値を指定しない場合、デフォルトのアクションはCANCELです。
--recurringTask schedulePattern: タスクは再帰的であり、crontab(5)互換の時間/日付パターンとして表記されるschedulePatternに従ってスケジュールされることを示します。
-t, --start startTime: ディレクトリ・サーバー・タスクとしてスケジュールされている際に、YYYYMMDDhhmmssのフォーマットで表記される操作の開始日付と時間を指定します。値0は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。

A.3.5.6 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されていないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。

A.3.5.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、エクスポートを試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.5.8 例

次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。

例A-83 オフライン・エクスポートの実行

次のコマンドでは、-bオプションにより指定されたベースDNから開始して、userRootバックエンドをエクスポートします。このコマンドは、-lにより指定されたLDIFファイルにデータをエクスポートします。オフライン・エクスポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ export-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/export.ldif
[17/Oct/2008:12:24:33 +0200] category=JEB severity=NOTICE msgID=8847447 
msg=Exported 102 entries and skipped 0 in 0 seconds (average rate 159.4/sec)

例A-84 オンライン・エクスポートの実行

タスク・バックエンド接続オプションのいずれかを指定した場合、エクスポートは自動的にオンライン・モードで実行します。オンライン・エクスポートはSSL上でサーバーに接続するため、SSLサーバー証明書の信頼方法を指定する必要があります。この例では、-Xオプションを使用してすべての証明書を信頼しています。

$ export-ldif -h localhost -p 4444 -D "cn=Directory Manager" -j /path/pwd-file -X \
  --includeBranch "dc=example,dc=com" --backendID userRoot \
  --ldifFile /usr/tmp/export.ldif

例A-85 エクスポートのスケジュール

エクスポートを後日実行するようにスケジュールするには、-tオプションまたは--startオプションを使用して開始時間を指定します。通常のオンライン・エクスポートと同様、スケジュールされたエクスポートは実行中のディレクトリ・サーバーのタスク・バックエンドに接続するため、関連するタスク・バックエンド接続オプションを指定する必要があります。

この例では、userRootバックエンドのエクスポートを12月24日に開始するようにスケジュールします。

$ export-ldif -h localhost -p 4444 -D "cn=Directory Manager" -j /path/pwd-file -X \
  --includeBranch "dc=example,dc=com" --backendID userRoot \
  --ldifFile /usr/tmp/export.ldif --start 20081224121500
Export task 2008101712361910 scheduled to start Dec 24, 2008 12:15:00 PM SAST

スケジュール済タスクを表示するには、manage-tasksコマンドを使用します。詳細は、第14.4項「タスクとしてのコマンドの構成」を参照してください。

A.3.5.9 終了コード

オフライン・モード。終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
オンライン・モード。-tまたは--startが指定された場合、終了コード0はタスクが正常に作成されたことを示します。ゼロ以外の終了コードは、タスク作成時にエラーが発生したことを示します。-tまたは--startが指定されていない場合、終了コードはオフライン・モードに指定された終了コードと同じです。

A.3.5.10 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、export-ldifコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

A.3.5.11 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/export-ldif
Windows: INSTANCE_DIR\OUD\bat\export-ldif.bat

A.3.5.12 関連コマンド

第A.3.6項「import-ldif」
第A.3.7項「ldif-diff」
第A.3.8項「ldifmodify」
第A.3.9項「ldifsearch」
第A.2.8項「manage-tasks」

A.3.6 import-ldif

import-ldifコマンドは、Oracle Berkeley DB Java Edition (JE)バックエンドにLDIFファイルから読み取ったデータを移入します。

A.3.6.1 シノプシス

import-ldif options

A.3.6.2 説明

import-ldifコマンドは、Oracle Berkeley DB Java Edition (JE)バックエンドに、LDIFファイルから読み取ったデータまたは、MakeLDIFテンプレートに基づいて生成されたデータを移入します。通常、import-ldifを使用すると、ldapmodifyを使用してエントリを追加するよりも非常に速く処理できます。JEバックエンド全体への完全インポートのほうが、JEバックエンドのブランチへの部分インポートよりも高いパフォーマンスが得られます。

import-ldifコマンドにより、インポートを即時に実行するか、または指定された日付と時間でインポートを実行するようにスケジュールできます。詳細は、第14.4項「タスクとしてのコマンドの構成」を参照してください。

import-ldifコマンドは、オンラインまたはオフラインで実行できます。

オンライン・モード。オンライン・モードでは、import-ldifは管理コネクタを介してSSL上で実行中のディレクトリ・サーバー・インスタンスに接続し、インポート・タスクを登録します。タスク・バックエンド接続オプションのいずれかを指定した場合、このコマンドは自動的にオンライン・モードで実行します。管理コネクタの詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。
オフライン・モード。オフライン・モードでは、import-ldifはディレクトリ・サーバー・インスタンスを介さずに、データベースに直接アクセスします。オフライン・インポートを実行するには、ディレクトリ・サーバーを停止する必要があります。

A.3.6.3 オプション

import-ldifコマンドは、短いフォーム(例: -b baseDN)または同等の長いフォーム(例: --includeBranch baseDN)のいずれかのオプションを受け入れます。

-a, --append

インポートの開始前にバックエンドをクリアするのではなく、バックエンドにすでに存在するデータにインポートされたデータを追加します。

-A, --templateFile filename

MakeLDIFテンプレートへのパスを指定して、インポート・データを生成します。

-b, --includeBranch branchDN

インポートに含めるデータのブランチまたはサブツリーのベースDNを指定します。このオプションを複数回使用して、複数のベースDNを指定できます。このオプションが指定された場合、インポート・ソース内で指定されたベースDNの1つにないエントリ、またはそれより下のエントリはスキップされます。指定されたベースDNより上にある既存のエントリはすべて保持されます。

-B, --excludeBranch branchDN

インポートから除外するブランチまたはサブツリーのベースDNを指定します。このオプションを複数回使用して、複数のベースDNを指定できます。このオプションが指定された場合、インポート・ソース内でベースDNの1つにあるエントリ、またはそれより下のエントリはスキップされます。--excludeBranchオプションの使用は、--includeBranchオプションよりも優先されます。含まれるリストと除外されるリストの両方に表示されているDNにあるエントリ、またはそのDNより下にあるエントリはインポートから除外されます。この機能により、ブランチの一部のみのデータ(たとえば、ou=People,dc=example,dc=comより下のエントリを除くdc=example,dc=comより下のすべてのエントリ)を含めることができます。

-c, --isCompressed

LDIFインポート・ファイルが圧縮されていることを指定します。ファイルの圧縮には、export-ldifコマンドの--compressLDIFオプションにより使用される形式であるGZIP形式が使用されます。

--countRejects

インポート時に却下されたエントリ数を返します。却下されたエントリ数が0から255の場合は、その数が返されます。却下されたエントリ数が255より大きい場合は、値255が返されます。たとえば、--countRejectsオプションを指定してimport-ldifを実行し、却下されたエントリが16個であった場合は、値16が返されます。import-ldifを実行して却下されたエントリが300個であった場合は、値255が返されます。このオプションは、オンライン・インポートではサポートされていません。

-e, --excludeAttribute attribute

インポートから除外する属性の名前を指定します。このオプションを複数回使用して、複数の属性を指定できます。

-E, --excludeFilter filter

インポートから除外するエントリを識別するための検索フィルタを指定します。このオプションを複数回使用して、複数のフィルタを指定できます。このオプションが指定された場合、インポート・ソース内でフィルタに一致するエントリはすべてスキップされます。--excludeFilterオプションは、--includeFilterオプションよりも優先されます。エントリが含まれるフィルタと除外されるフィルタの両方でフィルタに一致する場合、そのエントリはインポート時にスキップされます。

-F, --clearBackend

--appendオプションを指定しないでインポートする際、指定したバックエンド内のすべてのベースDNに対する既存のエントリをすべて削除することを確認します。これは、バックエンドIDによって指定された複数のベースDNをインポートする場合のみ適用されます。このオプションは、ベースDNが1つだけであるバックエンドに適用されます。

-i, --includeAttribute attribute

インポートに含める属性を指定します。このオプションを複数回使用して、複数の属性を指定できます。このオプションが使用される場合、このセットにリストされていない属性は、インポートされるエントリから除外されます。

-I, --includeFilter filter

インポートに含めるエントリを識別するための検索フィルタを指定します。このオプションを複数回使用して、複数のフィルタを指定できます。このオプションが指定された場合、インポート・ソース内でフィルタの結果に一致しないエントリはすべてスキップされます。

-l, --ldifFile filename

指定されたパスに置かれているLDIFファイルを読み取ります。このオプションは、--templateFileと同時に使用しないでください。

オンライン・インポートの場合、相対パスのルートは現在の作業ディレクトリではなく、インスタンス・ルートです。したがって、たとえば、この場合のimports/ldif.ldifのパスはinstance-root/imports/ldif.ldifになります。

-n, --backendID backendID

データのインポート先であるバックエンドのIDを指定します。サーバーで使用可能なバックエンドを表示するには、list-backendsコマンドを使用します。

-O, --overwrite

指定したスキップ・ファイルまたは却下ファイルがすでに存在する場合は、それを上書きします。このオプションが指定されていない場合、スキップまたは却下されるエントリは、上書きされるのではなく、対応するファイルに追加されます。このオプションは、--rejectFileオプションまたは--skipFileオプションが指定されている場合のみ適用可能です。

-r, --replaceExisting

既存のデータをインポートからのコンテンツに置換します。このオプションが指定されない場合、既存のエントリは上書きされません。このオプションは、--appendオプションが指定されている場合のみ適用可能です。

-R, --rejectFile filename

指定されたファイルを使用して、インポート時に却下されたエントリをすべて保持します。エントリがデフォルトのスキーマに準拠していない場合、そのエントリは却下されます。エントリが却下された理由を示すコメントがエントリの前に入れられます。このオプションが指定されない場合、却下ファイルは書き込まれません。

-s, --randomSeed seed

MakeLDIFテンプレートからエントリを生成する際、乱数発生ジェネレータに対して指定されたシード番号を使用します。乱数発生ジェネレータに特定の値をシードしておくと、同じテンプレートと乱数シードで常に同じデータが生成されることが保証されます。

--skipDNValidation

LDIFインポートの後半部分で、親としての限定的なDN検証を行います。このオプションが指定された場合、重複するDNチェックは行われません。使用しているLDIFインポート・ファイルが正しいかどうか不確かな場合は、このオプションを使用しないでください。

--skipFile filename

指定されたファイルを使用して、インポート時にスキップされたエントリを識別します。エントリがインポート時に指定されたベースDN下に置けない場合、または--excludeBranch、--excludeAttribute、または--excludeFilterの各オプションが使用された場合、そのエントリはスキップされます。

-S, --skipSchemaValidation

エントリがインポートされているときに、そのエントリに対してスキーマ検証を実行しません。このオプションはインポートのパフォーマンス向上に効果的ですが、インポート・データが有効であることを確信できる場合のみ使用してください。

--threadCount count

LDIFファイルの読取りに使用するスレッドの数を指定します。このオプションが指定されない場合は、CPUごとに2つのスレッドのデフォルトが使用されます。

大容量のLDIFファイルをインポートしている場合は、このオプションを使用してスレッド数を増やすことができますが、パフォーマンスへの影響に確信が持てないかぎり、このオプションは使用しないでください。

--tmpDirectory directory

インポート時に作成された索引スクラッチ・ファイルに対して、指定したディレクトリを使用します。ディレクトリが指定されない場合は、デフォルトのINSTANCE_DIR/OUD/import-tmpが使用されます。

A.3.6.4 タスク・バックエンド接続オプション

オンライン・インポートを実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。これらの接続オプションは、インポートをオンラインで実行するときに使用します。

-D, --bindDN bindDN: バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-h, --hostname hostname: 指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: 指定された証明書をクライアント認証に使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-p, --port port: 指定された管理ポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、6664というデフォルトの管理ポートが使用されます。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: ディレクトリ・サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.3.6.5 タスク・スケジュール・オプション

これらのオプションは、インポートをスケジュール済タスクとして実行すると指定したときに使用します。

--completionNotify emailAddress: タスク終了時に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--dependency taskId: このタスクが依存するタスクのIDを指定します。タスクのすべての依存性が実行を完了するまで、タスクの実行は開始しません。
--errorNotify emailAddress: このタスクの実行時にエラーが発生した場合に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--failedDependencyAction action: 依存タスクの1つが失敗した場合に、このタスクが実行する必要のあるアクションを指定します。この値として、PROCESS、CANCEL、またはDISABLEのいずれか1つが割り当てられている必要があります。値を指定しない場合、デフォルトのアクションはCANCELです。
--recurringTask schedulePattern: タスクは再帰的であり、crontab(5)互換の時間/日付パターンとして表記されるschedulePatternに従ってスケジュールされることを示します。
-t, --start startTime: ディレクトリ・サーバー・タスクとしてスケジュールされている際に、YYYYMMDDhhmmssのフォーマットで表記される操作の開始日付と時間を指定します。値0は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。

A.3.6.6 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されていないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-Q, --quiet: 最小モードで実行します。最小モードを使用すると、インポート・プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-d, --debug: デバッグ・モード(冗長)を使用します。デバッグ・モードを使用すると、詳細メッセージまたはデバッグ・メッセージがすべて出力されます。

A.3.6.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、インポートを試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.6.8 例

次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。

例A-86 オフライン・インポートの実行

この例では、LDIFファイルをuserRootバックエンドにインポートします。LDIFファイル・パスは、すべてのプラットフォームで絶対パスである必要があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif

例A-87 LDIFファイルの一部のオフライン・インポート

この例では、LDIFファイルの一部をuserRootバックエンドにインポートします。このインポートにはベースDN dc=example,dc=comが含まれますが、ブランチou=peopleは除外されます。既存のエントリが置換され(-r)、却下されたエントリに関する情報が/usr/tmp/rejects.ldifに書き込まれます。LDIFファイル・パスは、すべてのプラットフォームで絶対パスである必要があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ import-ldif -b dc=example,dc=com -B "ou=people,dc=example,dc=com" \
  -l /usr/tmp/Example.ldif -n userRoot -r -R /usr/tmp/rejects.ldif

例A-88 MakeLDIFテンプレートからのデータのインポート

この例では、MakeLDIFテンプレートからのサンプル・データをuserRootバックエンドにインポートします。乱数シード(-s)によって、データの乱数度が決定します。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ import-ldif -n userRoot -A example.template -s 0

例A-89 ユーザー属性のみのインポート

この例では、LDIFファイルをuserRootバックエンドにインポートします。-i "*"によって指定されたユーザー属性のみがインポートされます。LDIFファイル・パスは、すべてのプラットフォームで絶対パスである必要があります。システムによっては、アスタリスクを引用符で囲むか("*")、使用しているシェルに適した文字を使用してアスタリスクをエスケープしなければならない場合があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif -i "*"

例A-90 ユーザー属性のみのインポートと属性の除外

この例では、LDIFファイルをuserRootバックエンドにインポートします。-i "*"によって指定されたユーザー属性はすべてインポートされますが、roomnumber属性は除外されます。LDIFファイル・パスは、すべてのプラットフォームで絶対パスである必要があります。システムによっては、アスタリスクを引用符で囲むか("*")、使用しているシェルに適した文字を使用してアスタリスクをエスケープしなければならない場合があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif \
  -i "*" -e "roomnumber"

例A-91 操作属性のみのインポート

この例では、LDIFファイルをuserRootバックエンドにインポートします。-i "+"によって指定された操作属性のみがインポートされます。LDIFファイル・パスは、すべてのプラットフォームで絶対パスである必要があります。システムによっては、プラス記号を引用符で囲むか("+")、使用しているシェルに適した文字を使用してプラス記号をエスケープしなければならない場合があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif -i "+"

例A-92 選択されたユーザーと操作属性のインポート

この例では、LDIFファイルをuserRootバックエンドにインポートします。属性uid、cn、sn、dc、およびcreatorsnameのみがインポートされます。LDIFファイル・パスは、すべてのプラットフォームで絶対パスである必要があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。

$ stop-ds
$ import-ldif -b dc=example,dc=com -n userRoot -l /var/tmp/Example.ldif \
  -i "uid" -i "cn" -i "sn" -i "dc" -i "creatorsname"

例A-93 オンライン・インポートの実行

タスク・バックエンド接続オプションのいずれかを指定した場合、インポートは自動的にオンラインで実行します。オンライン・インポートはSSL上でサーバーに接続するため、SSLサーバー証明書の信頼方法を指定する必要があります。この例では、-Xオプションを使用してすべての証明書を信頼しています。

$ import-ldif -h localhost -p 6664 -D "cn=Directory Manager" -j /path/pwd-file \
  -X -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif

例A-94 インポートのスケジュール

インポートを後日実行するようにスケジュールするには、-tオプションまたは--startオプションを使用して開始時間を指定します。通常のオンライン・インポートと同様、スケジュールされたインポートは実行中のディレクトリ・サーバーのタスク・バックエンドに接続するため、関連するタスク・バックエンド接続オプションを指定する必要があります。

この例では、userRootバックエンドへのインポートを12月24日に開始するようにスケジュールします。

$ import-ldif -h localhost -p 6664 -D "cn=Directory Manager" -j /path/pwd-file \
  -X -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif \
  --start 20081224121500
Import task 2008101712361910 scheduled to start Dec 24, 2008 12:15:00 PM SAST

A.3.6.9 終了コード

オフライン・モード。終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
オンライン・モード。-tまたは--startが指定された場合、終了コード0はタスクが正常に作成されたことを示します。ゼロ以外の終了コードは、タスク作成時にエラーが発生したことを示します。-tまたは--startが指定されていない場合、終了コードはオフライン・モードに指定された終了コードと同じです。

A.3.6.10 プロパティ・ファイルの使用方法

A.3.6.11 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/import-ldif
Windows: INSTANCE_DIR\OUD\bat\import-ldif.bat

A.3.6.12 関連コマンド

第A.3.5項「export-ldif」
第A.3.7項「ldif-diff」
第A.3.8項「ldifmodify」
第A.3.9項「ldifsearch」
第A.2.8項「manage-tasks」

A.3.7 ldif-diff

ldif-diffコマンドは、2つのLDIFファイルの差異を特定します。

A.3.7.1 シノプシス

ldif-diff options

A.3.7.2 説明

ldif-diffコマンドは、2つのLDIFファイルの差異の特定に使用できます。結果の出力は、端末に表示するか、出力ファイルに保存できます。結果の出力には、必要に応じて変更を取り消す場合に必要な情報がすべて含まれています。変更操作では、addおよびdelete変更タイプのセットのみが使用され、replace変更タイプは使用されません。削除操作では、削除されたエントリのコンテンツがコメントのフォームで表示される変更に含まれます。

このコマンドは、小規模のデータ・セットで機能するように作成されています。これは、ソースとターゲットのデータ・セットが同時に、メモリーに完全に適合できる場合のみ適しています。使用可能なメモリーに適合できない大規模なデータ・セットでの使用を対象としていません。

注意:

ldif-diffコマンドは、大規模なファイルを対象としていません。一定のサイズ(Windowsシステムでは約600KB、UNIXシステムではこれよりも大きい)を超えるLDIFファイルに対してldif-diffコマンドを実行すると、次のようなメモリー・エラーが発生することがあります:

Exception in thread "main" java.lang.OutOfMemoryError: Java heap space.

A.3.7.3 オプション

ldif-diffコマンドは、短いフォーム(例: -o outputFile)または同等の長いフォーム(例: --outputLDIF outputFile)いずれかのオプションを受け入れます。

-a, --ignoreAttrs file: 差異を計算するときに無視する属性のリストが含まれているファイルを指定します。
--checkSchema: スキーマで定義された属性の構文を考慮して、値を比較します。指定したLDIFファイルがサーバー・スキーマに準拠している必要があります。
-e, --ignoreEntries file: 差異を計算するときに無視するエントリ(DN)のリストが含まれているファイルを指定します。
-o, --outputLDIF outputLDIF: ソースとターゲットのLDIFファイル間の変更を記録する出力ファイルへのパスを指定します。これが指定されない場合、変更情報は標準出力に書き込まれます。
-O, --overwriteExisting: --outputLDIFオプションで指定された出力ファイルを上書きします。このオプションは、指定した出力ファイルがすでに存在している場合は、ファイルに追加するのではなく、ファイルを上書きするように指定します。このオプションは、--outputLDIFが使用されている場合のみ適用可能です。
-s, --sourceLDIF sourceLDIF: 変更が適用されていない元のデータが含まれているソースLDIFファイルへのパスを指定します。このオプションは必須です。
-S, --singleValueChanges: 単一値変更モードで実行します。このモードでは、各変更操作が属性値ごとに別個の変更に分解されます。たとえば、1回の変更で5つの値が属性に追加される場合、変更は、それぞれ1つの属性を追加する5つの別個の変更として出力に表示されます。
-t, --targetLDIF targetLDIF: ソースLDIFとの差異が含まれているターゲットLDIFファイルへのパスを指定します。このオプションは必須です。
-?, -H, --help: コマンド使用情報を表示し、追加処理を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.7.4 例

次の例は、ldif-diffコマンドの使用方法を示しています。

例A-95 2つのLDIFファイルの比較と標準出力への差異の送信

次のコマンドでは、ソース・ファイル(-s)をターゲット・ファイル(-t)と比較して、差異を出力します。Windowsプラットフォームの場合は、ソース・ファイルのパス(たとえば、-s \temp\quentin.ldif)とターゲット・ファイルのパス(たとえば、-t \temp\quentin.ldif)を指定します:

$ ldif-diff -s /usr/local/quentin.ldif -t /usr/local/quentinr.ldif

dn: uid=qcubbins,ou=People,dc=example,dc=com
changetype: delete
# objectClass: person
# objectClass: organizationalPerson
# objectClass: top
# objectClass: inetOrgPerson
# cn: Quentin Cubbins
# sn: Cubbins
# uid: qcubbins
# userPassword: qcubbins
# givenName: Quentin
# description: This is Quentin's description.
# mail: qcubbins@example.com

dn: uid=qrcubbins,ou=People,dc=example,dc=com
changetype: add
objectClass: person
objectClass: organizationalPerson
objectClass: top
objectClass: inetOrgPerson
cn: Quentin R Cubbins
sn: Cubbins
uid: qrcubbins
userPassword: qrcubbins
givenName: Quentin
description: This is Quentin R's description.
mail: qrcubbins@example.com

例A-96 2つのLDIFファイルの比較とファイルへの差異の送信

次のコマンドでは、ソース・ファイル(-s)をターゲット・ファイル(-t)と比較して、出力をファイルに送信(-o)します。Windowsプラットフォームの場合は、ソース・ファイルのパス(たとえば、-s \temp\quentin.ldif)とターゲット・ファイルのパス(たとえば、-t \temp\quentin.ldif)を指定します:

$ ldif-diff -s /usr/local/quentin.ldif -t /usr/local/quentinr.ldif \
  -o output.ldif

A.3.7.5 終了コード

終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。

A.3.7.6 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldif-diff
Windows: INSTANCE_DIR\OUD\bat\ldif-diff.bat

A.3.7.7 関連コマンド

第A.3.9項「ldifsearch」
第A.3.8項「ldifmodify」
第A.3.11項「make-ldif」

A.3.8 ldifmodify

ldifmodifyコマンドは、LDIFファイルのコンテンツを変更します。

A.3.8.1 シノプシス

ldifmodify options

A.3.8.2 説明

ldifmodifyコマンドは、LDIFファイルのコンテンツの変更に使用できます。ldapmodifyコマンドと類似していますが、ldifmodifyコマンドはディレクトリ・サーバーに接続せず、LDIFファイルでローカルに操作します。また、標準出力での変更情報の受入れも行いません。このコマンドは、1つのファイルからすべての変更を読み取る必要があります。

メモリー容量が限定されている状態で非常に大きいLDIFファイルでの操作を可能にするために、変更可能なタイプに対して次の制約が課せられます:

DNの変更は行いません。DN変更の操作はサポートされていません。追加、削除、変更の操作のみが実行できます。
変更または削除操作の並行処理はできません。追加されるエントリの処理中に、そのエントリを変更または削除することはできません。

A.3.8.3 オプション

すべてのオプション(--helpおよび--versionを除く)が必須です。ldifmodifyコマンドは、短いフォーム(例: -m changeFile)または同等の長いフォーム(例: --changesLDIF changeFile)のいずれかのオプションを受け入れます。

-m, --changesLDIF changeFile: 適用する変更が含まれているファイルへのパスを指定します。このファイルのコンテンツはLDIF変更形式である必要があります。
-s, --sourceLDIF sourceFile: 更新されるデータが含まれているソースLDIFファイルへのパスを指定します。
-t, --targetLDIF targetFile: 指定された変更がすべて適用済のソースLDIFのデータで構成されるターゲットLDIFファイルへのパスを指定します。
-?, -H, --help: コマンド使用情報を表示し、追加処理を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.8.4 例

次の例は、ldifmodifyコマンドの使用方法を示しています。

例A-97 LDIFファイルの変更

ソース・ファイルが次のようであるとします:

dn: uid=qcubbins,ou=People,dc=example,dc=com
objectclass: top
objectclass: person
objectclass: organizationalPerson
objectclass: inetOrgPerson
uid: qcubbins
givenName: Quentin
sn: Cubbins
cn: Quentin Cubbins
mail: qcubbins@example.com
userPassword: qcubbins
description: This is Quentin's description.

また、更新(変更)ファイルが次のようであるとします:

## Add new telephone number for Quentin Cubbins
dn: uid=qcubbins,ou=People,dc=example,dc=com
changetype: modify
add: telephoneNumber
telephoneNumber: 512-401-1241

次のコマンドでは、変更ファイル(-m)にリストした変更が含まれているソース・ファイル(-s)を更新して、ターゲット・ファイル(-t)に出力します。Windowsプラットフォームの場合は、変更ファイルのファイル・パス(たとえば、-m \temp\update.ldif)、ソース・ファイルのファイル・パス(たとえば、-s \temp\quentin.ldif)、およびターゲット・ファイルのファイル・パス(たとえば、-s \temp\quentin_updated.ldif)を使用します:

$ ldifmodify -m /usr/local/update.ldif -s /usr/local/quentin.ldif \
-t /usr/local/quentin_updated.ldif

更新されたファイルは、次のようになります:

dn: uid=qcubbins,ou=People,dc=example,dc=com
objectClass: inetOrgPerson
objectClass: person
objectClass: top
objectClass: organizationalPerson
sn: Cubbins
userPassword: qcubbins
description: This is Quentin's description.
cn: Quentin Cubbins
telephoneNumber: 512-401-1241
givenName: Quentin
uid: qcubbins
mail: qcubbins@example.com

A.3.8.5 終了コード

終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。

A.3.8.6 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldifmodify
Windows: INSTANCE_DIR\OUD\bat\ldifmodify.bat

A.3.8.7 関連コマンド

第A.3.9項「ldifsearch」
第A.3.7項「ldif-diff」
第A.3.11項「make-ldif」

A.3.9 ldifsearch

ldifsearchコマンドは、LDIFファイルの中で検索を実行します。

A.3.9.1 シノプシス

ldifsearch [options]

A.3.9.2 説明

ldifsearchコマンドは、LDIFファイル内での検索の実行に使用できます。ldapsearchコマンドと類似していますが、ldifsearchコマンドはディレクトリ・サーバーとのLDAP通信を実行せず、LDIFファイルでローカルに操作します。

A.3.9.3 オプション

ldifsearchコマンドは、短いフォーム(例: -b baseDN)または同等の長いフォーム(例: --baseDN baseDN)のいずれかのオプションを受け入れます。

-b, -baseDN baseDN

検索操作に使用するbase DNを指定します。このオプションを複数回使用することによって、複数のベースDNを指定できます。複数の値が指定された場合は、エントリが検索ベースの範囲内にあるかどうかが調べられます。検索ベースが指定されていない場合、LDIFファイルに含まれているエントリはいずれも検索範囲内であると見なされます。

-f, --filterFile filterFile

検索操作を処理する際に使用する1つ以上のフィルタが含まれているファイルへのパスを指定します。複数のフィルタが存在する場合は、1行に1つのフィルタが表示されるようにファイルを構成する必要があります。このオプションを使用する場合、後続オプションはすべて別個の属性として処理されます。そうでない場合は、最初の後続オプションを検索フィルタにする必要があります。

-l, -ldifFile ldifFile

検索されるデータが含まれているLDIFファイルへのパスを指定します。このオプションを複数回指定することによって、複数のLDIFファイルを指定できます。このオプションは必須です。

-o, -outputFile outputFile

指定された検索基準に一致するエントリが含まれている出力ファイルへのパスを指定します。このオプションが指定されない場合、一致するエントリは標準出力に書き込まれます。

-O, --overwriteExisting

--outputFileオプションで指定された出力ファイルを上書きします。このオプションは、指定した出力ファイルがすでに存在している場合は、データを既存のデータに追加するのではなく、ファイルを上書きするように指定します。これは、--outputFileオプションが使用されている場合のみ適用可能です。

-s, -searchScope searchScope

検索操作の範囲を指定します。次のいずれかの値を指定する必要があります:

base: --baseDNオプションによって指定されたエントリのみを調べます。
one: --baseDNオプションによって指定されたエントリとその直接の子のみを調べます。
subまたはsubordinate: --baseDNオプションによって指定されたエントリとそのサブツリーを調べます。

このオプションが指定されない場合、デフォルト値はsubです。

-t, --timeLimit numSeconds

検索の実行に費やす最長時間(秒)を指定します。この時間の経過後に検索が終了します。

-z, --sizeLimit sizeLimit

ディレクトリ・サーバーがクライアントに返す一致エントリの最大数を設定します。これが指定されていない場合、クライアントが要求する最大数は存在しません。ディレクトリ・サーバーでは、クライアントにより要求されるサイズ限度よりも低い限度を施行することができます。

-T, --dontWrap

一致エントリを表示するときに、長い行の折り返しを行いません。このオプションが指定されない場合、長い行は80列の端末に収まるように(LDIF仕様と適合する方法で)折り返されます。

-?, -H, --help

コマンド使用情報を表示し、追加処理を試行しないで終了します。

-V, --version

ディレクトリ・サーバーのバージョン情報を表示します。

A.3.9.4 例

次の例は、ldifsearchコマンドの使用方法を示しています。

例A-98 LDIFファイルの検索

次のコマンドでは、ベースDN(-b)を指定し、エントリに関してLDIFファイル(-l)を検索し、検索フィルタcn=Sam Carterに一致するエントリが存在する場合は、その結果を画面に返します。Windowsプラットフォームの場合は、LDIFファイルが常駐しているパス(たとえば、-l \temp\Example.ldif)を使用します。

$ ldifsearch -b dc=example,dc=com -l /usr/local/Example.ldif "(cn=Sam Carter)"

dn: uid=scarter,ou=People,dc=example,dc=com
objectClass: inetOrgPerson
objectClass: person
objectClass: top
objectClass: organizationalPerson
ou: Accounting
ou: People
sn: Carter
facsimiletelephonenumber: +1 408 555 9751
roomnumber: 4600
userpassword: sprain
l: Sunnyvale
cn: Sam Carter
telephonenumber: +1 408 555 4798
uid: scarter
givenname: Sam
mail: scarter@example.com

例A-99 フィルタ・ファイルを使用したLDIFファイルの検索

ファイルfilter.ldifに次の検索フィルタが含まれているとします:

(&(ou=Accounting)(l=Cupertino))

次のコマンドでは、検索フィルタ・ファイル内のフィルタに一致するエントリに関してLDIFファイルを検索し、その結果を出力ファイルに出力します。次のコマンドでは、ベースDN(-b)を指定し、検索フィルタ・ファイル(-f)を使用してLDIFファイル(-l)を検索し、その結果をファイル(-o)に出力します。Windowsプラットフォームの場合は、LDIFファイルのファイル・パス(たとえば、-l \temp\Example.ldif)、フィルタ・ファイルのファイル・パス(たとえば、-f \temp\filter.ldif)、および出力ファイルのファイル・パス(たとえば、-o \temp\results.ldif)を使用します:

$ ldifsearch -b dc=example,dc=com -l /usr/local/Example.ldif -f /usr/local/filter.ldif \
-o /home/local/results.ldif

A.3.9.5 終了コード

終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。

A.3.9.6 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldifsearch
Windows: INSTANCE_DIR\OUD\bat\ldifsearch.bat

A.3.9.7 関連コマンド

第A.3.8項「ldifmodify」
第A.3.7項「ldif-diff」

A.3.10 list-backends

list-backendsコマンドは、使用可能なバックエンドの情報を表示します。

A.3.10.1 シノプシス

list-backends [options]

A.3.10.2 説明

list-backendsコマンドは、ディレクトリ・サーバー・インスタンスで定義されたバックエンドに関する情報の取得に使用できます。バックエンドは、サーバー・データベースへのアクセス提供を実行します。

list-backendsコマンドには、次の3つの操作モードがあります:

オプションなし。オプションを指定せずに起動した場合、サーバー内に構成されているすべてのバックエンドのバックエンドIDが、そのバックエンドのベースDNとともに表示されます。
バックエンドIDを指定。--backendIDとともに使用する場合、バックエンドのすべてのベースDNが、指定されたバックエンドIDとともにリストされます。
ベースDNを指定。--baseDNとともに使用する場合、指定されたDNを持つエントリの保持に使用するバックエンドのバックエンドIDがリストされ、さらに、DNがそのバックエンドに対して構成されたベースDNの1つであるかどうかが示されます。

A.3.10.3 オプション

次のオプションは使用できますが、必須ではありません。list-backendsコマンドは、短いフォーム(例: -b baseDN)または同等の長いフォーム(例: --baseDN baseDN)のいずれかのオプションを受け入れます。

A.3.10.4 コマンドのオプション

-b, --baseDN baseDN: list-backendsコマンドでバックエンドIDのリスト作成の際に使用するベースDNを指定します。また、このオプションは、指定したDNが当該バックエンドのベースDNであるかどうかも指定します。

-n, --backendID backendID: このコマンドが関連付けられたベースDNを表示する際に使用するバックエンドIDを指定します。このオプションを複数回使用して、複数のバックエンドに対するベースDNを表示できます。

A.3.10.5 一般オプション

-?, -H, --help: コマンド使用情報を表示し、その他のアクションを実行しないで即時に終了します。

-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.10.6 例

次の例は、list-backendsコマンドの使用方法を示しています。

例A-100 現在のバックエンドのリスト

次のコマンドは、ディレクトリ・サーバーにある現在のバックエンドをリストします:

$ list-backends

Backend ID  Base DN
----------  -----------------
backup      cn=backups
config      cn=config
monitor     cn=monitor
schema      cn=schema
tasks       cn=tasks
userRoot    dc=example,dc=com

例A-101 バックエンドIDのリスト

次のコマンドは、ディレクトリ・サーバーにあるバックエンドIDをリストします:

$ list-backends --backendID monitor

Backend ID  Base DN
----------  ----------
monitor     cn=monitor

例A-102 ベースDNのリスト

次のコマンドは、ディレクトリ・サーバーにあるベースDNをリストします:

$ list-backends --baseDN cn=backups

The provided DN 'cn=backups' is a base DN for the back end 'backup'

A.3.10.7 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.3.10.8 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/list-backends
Windows: INSTANCE_DIR\OUD\bat\list-backends.bat

A.3.11 make-ldif

make-ldifコマンドは、テンプレート・ファイルに基づいてLDIFデータを生成します。

A.3.11.1 シノプシス

make-ldif [options]

A.3.11.2 説明

make-ldifコマンドは、テンプレート・ファイルに基づいたLDIFデータの生成に使用できます。このコマンドにより、パフォーマンスおよびスケーラビリティのテストなど、アプリケーションでの使用に適した量の現実的なサンプル・データを構築したり、本番環境で確認された問題の再現を試行したりすることができます。

A.3.11.3 オプション

make-ldifコマンドは、短いフォーム(例: -o ldifFile)または同等の長いフォーム(例: --ldifFile ldifFile)のいずれかのオプションを受け入れます。

-o, --ldifFile ldifFile: 生成済データの書き込み先であるLDIFファイルへのパスを指定します。これは必須オプションです。
-s, --randomSeed seed: 乱数発生ジェネレータのシードに使用する整数値を指定します。乱数シードが指定されている場合、同じシードを持つ同じテンプレート・ファイルに基づいてデータを生成すると、常に同じLDIF出力が生成されます。シードが指定されない場合は、同じテンプレート・ファイルを使用するたびに、異なるLDIF出力が生成される可能性があります。
-t, --templateFile templateFile: 生成されるデータを記述したテンプレート・ファイルへのパスを指定します。これは必須オプションです。テンプレート・ファイルへの絶対パスを指定する必要があります。
-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、コマンドの実行を試みないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.3.11.4 例

次の例は、make-ldifコマンドの使用方法を示しています。

例A-103 サンプルLDIFファイルの作成

次のコマンドでは、テンプレート(-t)を使用してLDIFファイルを作成し、出力ファイル(-o)に書き込んで、乱数シード(-s)を指定します。Windowsプラットフォームの場合は、出力LDIFファイルへのファイル・パス(たとえば、-o path\to\Example.ldif)およびテンプレート・ファイルへのファイル・パス(たとえば、-t INSTANCE_DIR\OUD\config\MakeLDIF\example.template)を入力します。

example.templateファイルはINSTANCE_DIR/OUD/config/MakeLDIFディレクトリに置かれています。

$ make-ldif -o /path/to/sample.ldif -s 0 \
-t INSTANCE_DIR/OUD/config/MakeLDIF/example.template

Processed 1000 entries
Processed 2000 entries
Processed 3000 entries
Processed 4000 entries
Processed 5000 entries
Processed 6000 entries
Processed 7000 entries
Processed 8000 entries
Processed 9000 entries
Processed 10000 entries
LDIF processing complete.  10003 entries written

例A-104 大きいサンプルLDIFファイルの作成

example.templateファイル(INSTANCE_DIR/OUD/config/MakeLDIFの下のインストール・ディレクトリに置かれています)には、make-ldifにより生成されるエントリ数を設定する変数が含まれています。この数値を変更して、テスト用に非常に大きいサンプルLDIFファイルを作成できます。

example.templateファイルを開いて、numusers変数を変更します。デフォルトでは、この変数は10001に設定されています。この例では、変数を1000001に設定します:

define suffix=dc=example,dc=com
define maildomain=example.com
define numusers=1000001
...

make-ldifコマンドを再実行します:

$ make-ldif -o /path/to/sample.ldif -s 0 \
-t INSTANCE_DIR/OUD/config/MakeLDIF/example.template
...
Processed 999000 entries
Processed 1000000 entries
LDIF processing complete.  1000003 entries written

A.3.11.5 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.3.11.6 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/make-ldif
Windows: INSTANCE_DIR\OUD\bat\make-ldif.bat

A.3.11.7 関連コマンド

第A.3.9項「ldifsearch」
第A.3.8項「ldifmodify」
第A.3.7項「ldif-diff」

A.3.12 manage-account

manage-accountコマンドは、主にパスワード・ポリシー状態の詳細に関連するユーザー・アカウント情報を管理します。

A.3.12.1 シノプシス

manage-account subcommands options

A.3.12.2 説明

manage-accountコマンドは、主にパスワード・ポリシー状態の詳細に関連するユーザー・アカウント情報を管理します。このコマンドはパスワード・ポリシー状態拡張操作と相互作用して、ユーザーのアカウント、ログイン、およびパスワード情報を返します。パスワード・ポリシー状態拡張操作では1回使用するたびに複数の操作を実行できますが、manage-accountコマンドで一度に実行できるのは1つの操作だけです。ユーザーは、パスワード・ポリシー状態拡張操作を使用するためにpassword-reset権限を持っている必要があります。

すべての時間値は汎用の時間形式で返されます。すべての期間値は秒単位で返されます。

manage-accountコマンドは、管理コネクタを介してSSL上のサーバーに接続します(第14.3項「サーバーへの管理トラフィックの管理」で説明しています)。

A.3.12.3 サブコマンド

clear-account-is-disabled

ユーザー・アカウントの無効な状態をクリアします。これは、アカウントが無効になっている場合に、そのアカウントを有効化する効果をもたらします。

get-account-expiration-time

アカウントの有効期限を返します。

get-account-is-disabled

ユーザー・アカウントの無効な状態を返します。

get-all

ユーザー・アカウントのパスワード・ポリシー状態の情報をすべて返します。

get-authentication-failure-times

ユーザー・アカウントの認証失敗の時刻を返します。

get-grace-login-use-times

ユーザー・アカウントの猶予ログインの使用時刻を返します。

get-last-login-time

ユーザー・アカウントの最終ログイン時刻を返します。

get-password-changed-by-required-time

ユーザーの必要時刻によって変更されたパスワードを返します。

get-password-changed-time

パスワードが最後に変更された時刻を返します。

get-password-expiration-warned-time

今後のパスワード有効期限についてユーザーが最初に警告された時刻を返します。

get-password-history

ユーザー・アカウントのパスワード履歴を返します。

get-password-is-reset

ユーザーのパスワード・リセット状態を返して、次回のログインでユーザーがパスワードの変更を強制されるかどうかを示します。

get-password-policy-dn

指定されたユーザーのパスワード・ポリシーのDNを返します。

get-remaining-authentication-failure-count

ユーザーのアカウントがロックされる前に、ユーザーの残りの認証失敗数を返します。

get-remaining-grace-login-count

ユーザーの残りの猶予ログイン数を返します。

get-seconds-until-account-expiration

アカウントが期限切れになるまでの時間の長さを返します。

get-seconds-until-authentication-failure-unlock

ユーザーのアカウントが自動的にロック解除されるまでの時間の長さを返します。

get-seconds-until-idle-lockout

アカウントがアイドル・ロックされるまでの時間の長さを返します。

get-seconds-until-password-expiration

パスワードが期限切れになるまでの時間の長さを返します。

get-seconds-until-password-expiration-warning

今後のパスワード有効期限についてユーザーが最初に警告されるまでの時間の長さを返します。

get-seconds-until-password-reset-lockout

パスワード・リセット・ロックアウトが発生するまでの時間の長さを返します。

get-seconds-until-required-change-time

必須の変更時間によりユーザーがパスワード変更を要求されるまでの時間の長さを返します。

set-account-is-disabled

アカウントを無効にします。必要なサブオプションは、次のとおりです:

--operationValue true/false。TRUEに設定した場合、ユーザーを無効にします。FALSEに設定した場合、ユーザーを有効にします。

A.3.12.4 オプション

manage-accountコマンドは、短いフォーム(例: -b targetDN)または同等の長いフォーム(例: --targetDN targetDN)のいずれかのオプションを受け入れます。

-b, --targetDN targetDN: パスワード・ポリシー状態情報の取得と設定の対象となるユーザー・エントリのDNを指定します。

A.3.12.5 LDAP接続オプション

manage-accountコマンドは、管理コネクタを介してSSL上のディレクトリ・サーバーに接続します。これらの接続オプションは、ディレクトリ・サーバーとの接続に使用します。

-D, --bindDN bindDN: バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-h, --hostname hostname: 指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: 指定された証明書をクライアント認証に使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-p, --port port: 指定された管理ポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、4444というデフォルトの管理ポートが使用されます。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: ディレクトリ・サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.3.12.6 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、コマンドの実行を試みないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.3.12.7 例

次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。

例A-105 ユーザーのすべてのパスワード・ポリシー状態情報の表示

次のコマンドは、ユーザーのパスワード・ポリシー状態情報を返します:

$ manage-account get-all -h localhost -p 4444 -D "cn=Directory Manager" \
  -j /path/pwd-file -X -b "uid=scarter,ou=People,dc=example,dc=com" \

Password Policy DN:  cn=Default Password Policy,cn=Password Policies,cn=config
Account Is Disabled:  false
Account Expiration Time:
Seconds Until Account Expiration:
Password Changed Time:  19700101000000.000Z
Password Expiration Warned Time:
Seconds Until Password Expiration:
Seconds Until Password Expiration Warning:
Authentication Failure Times:
Seconds Until Authentication Failure Unlock:
Remaining Authentication Failure Count:
Last Login Time:
Seconds Until Idle Account Lockout:
Password Is Reset:  false
Seconds Until Password Reset Lockout:
Grace Login Use Times:
Remaining Grace Login Count:  0
Password Changed by Required Time:
Seconds Until Required Change Time:

例A-106 ユーザー・アカウントの無効化

次のコマンドにより、ユーザーのアカウントuid=scarterが無効になります:

$ manage-account set-account-is-disabled --operationValue true \
  -h localhost -p 4444 -D "cn=Directory Manager" -j /path/pwd-file -X \
  -b "uid=scarter,ou=People,dc=example,dc=com"

Account Is Disabled:  true

例A-107 ユーザー・アカウントの有効化

次のコマンドにより、ユーザーの無効化されたアカウントが再度有効になります:

$ manage-account clear-account-is-disabled \
  -h localhost -p 4444 -D "cn=Directory Manager" -j /path/pwd-file -X \
  -b "uid=scarter,ou=People,dc=example,dc=com"

Account Is Disabled:  false

A.3.12.8 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.3.12.9 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/manage-account
Windows: INSTANCE_DIR\OUD\bat\manage-account.bat

A.3.12.10 関連コマンド

第A.3.16項「verify-index」

A.3.13 rebuild-index

rebuild-indexコマンドは、ディレクトリ・サーバーの索引を再作成します。

A.3.13.1 シノプシス

rebuild-index options

A.3.13.2 説明

rebuild-indexコマンドは、ディレクトリ・サーバーの索引の再作成に使用します。索引は値のリストが含まれているファイルであり、ここでは、それぞれの値がディレクトリ・サーバー・データベース内で接尾辞に対するエントリ識別子のリストに関連付けられています。ディレクトリ・サーバーで検索リクエストを処理する場合、索引内のエントリ識別子のリストを使用してデータベースを検索するため、検索の高速化が図れます。索引が存在しない場合、ディレクトリ・サーバーはデータベース内の各エントリを調べる必要があるため、パフォーマンスが著しく低下します。

rebuild-indexコマンドは次の場合に効果的です:

索引のindex-entry-limitプロパティを変更する場合
索引を新規に作成する場合

rebuild-indexコマンドは、サーバーをオンラインにして実行できます。ただし、rebuild-indexの実行中はバックエンド・データベースは使用できません。また、rebuild-indexコマンドは通常、サーバーがオフラインになっていて、特に--rebuildAllオプションが指定されている場合に実行速度が上がります。

注意:

時間がたつにつれて、エントリ識別子リストの整然さが失われていきます。このようになると、rebuild-indexコマンドのパフォーマンスは徐々に低下していきます。

大規模なデータベースの索引付けの再実行は、できるだけ避けるようにしてください。あるいは、rebuild-indexコマンドのパフォーマンスが著しく劣化した場合は、データベースを再インポートして、新しい、整然としたエントリ識別子リストで開始してください。

A.3.13.3 オプション

rebuild-indexコマンドは、短いフォーム(例: -b baseDN)または同等の長いフォーム(例: --baseDN baseDN)のいずれかのオプションを受け入れます。

A.3.13.4 コマンドのオプション

-b, --baseDN baseDN: 索引付けをサポートしているバックエンドのベースDNを指定します。再作成操作は、指定されたベースDNの範囲内にある索引に対して実行されます。
-i, --index index: 再作成する索引の名前を指定します。属性索引の場合、これは属性名になります。再作成する索引を少なくとも1つ指定する必要があります。
--rebuildAll: ベースDNにより指定されたバックエンド内にあるすべての索引を再作成します。このオプションでは、すべての属性索引の索引付けが再実行されるだけでなく、dn2idシステム索引、拡張索引とVLV索引、およびdn2uri索引も再作成されます。rebuildAllオプションは-iオプションと同時に使用できません。
--tmpDirectory: スクラッチ索引ファイル用に一時作業ディレクトリの場所を指定します。デフォルトの一時作業ディレクトリはINSTANCE_DIR/OUD/import-tmpです。

A.3.13.5 タスク・バックエンド接続オプション

索引をオンラインで再作成するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。これらの接続オプションは、再作成をオンラインで実行するときに使用します。

-D, --bindDN bindDN: バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-h, --hostname hostname: 指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: 指定された証明書をクライアント認証に使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-p, --port port: 指定された管理ポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、4444というデフォルトの管理ポートが使用されます。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: ディレクトリ・サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.3.13.6 タスク・スケジュール・オプション

これらのオプションは、索引の再作成をスケジュール済タスクとして実行すると指定したときに使用します。

--completionNotify emailAddress: タスク終了時に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--dependency taskId: このタスクが依存するタスクのIDを指定します。タスクのすべての依存性が実行を完了するまで、タスクの実行は開始しません。
--errorNotify emailAddress: このタスクの実行時にエラーが発生した場合に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--failedDependencyAction action: 依存タスクの1つが失敗した場合に、このタスクが実行する必要のあるアクションを指定します。この値として、PROCESS、CANCEL、またはDISABLEのいずれか1つが割り当てられている必要があります。値を指定しない場合、デフォルトのアクションはCANCELです。
--recurringTask schedulePattern: タスクは再帰的であり、crontab(5)互換の時間/日付パターンとして表記されるschedulePatternに従ってスケジュールされることを示します。
-t, --start startTime: ディレクトリ・サーバー・タスクとしてスケジュールされている際に、YYYYMMDDhhmmssのフォーマットで表記される操作の開始日付と時間を指定します。値0は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。

A.3.13.7 ユーティリティ入力/出力オプション

--propertiesFilePath propertiesFilePath: コマンドラインに使用されるデフォルトのプロパティ値が含まれているファイルへのパス。
--noPropertiesFile: デフォルトのコマンドライン引数値を取得する際に、プロパティ・ファイルを使用しません。
-v, --verbose: 冗長モードを使用します。

A.3.13.8 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、ディレクトリ・サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.13.9 例

次の例は、rebuild-indexコマンドの使用方法を示しています。

例A-108 索引の再作成

まず、次のようにdsconfigコマンドを使用して索引リストを表示します:

$ dsconfig -h localhost -p 4444 -D "cn=Directory Manager" -j /path/pwd-file -X \
  -n list-local-db-indexes --element-name userRoot

Local DB Index    : Type    : index-type
------------------:---------:--------------------
aci               : generic : presence
cn                : generic : equality, substring
displayName       : generic : equality, substring
ds-sync-conflict  : generic : equality
ds-sync-hist      : generic : ordering
entryUUID         : generic : equality
givenName         : generic : equality, substring
mail              : generic : equality, substring
member            : generic : equality
objectClass       : generic : equality
orclMTTenantGuid  : generic : equality
orclMTTenantUName : generic : equality, substring
orclMTUid         : generic : equality
sn                : generic : equality, substring
telephoneNumber   : generic : equality, substring
uid               : generic : equality
uniqueMember      : generic : equality

次のコマンドでは、ベースDN(-b)を指定して索引(-i)を再作成します。

このコマンドはオフラインで実行するため、コマンドを実行する前にディレクトリ・サーバーを停止する必要があります。

$ rebuild-index -b dc=example,dc=com -i uid -i mail
[15/Dec/2011:15:28:01 +0100] category=JEB severity=NOTICE msgID=8847497 
  msg=Rebuild of index(es) uid started with 202 total entries to process
...
[15/Dec/2011:15:28:02 +0100] category=JEB severity=NOTICE msgID=8847493 
  msg=Rebuild complete. Processed 202 entries in 1 seconds (average rate 135.2/sec)

例A-109 すべての索引の再作成

この例では、--rebuildAllオプションを使用してすべての索引を再作成します。

$ rebuild-index -b "dc=example,dc=com" --rebuildAll

例A-110 拡張索引の再作成

拡張索引は、次の3つのいずれの方法でも再作成できます:

--rebuildAllオプションを指定してすべての索引を再作成します。
-iオプションを指定して、拡張索引のベースとなる属性索引を再作成します。例: -i cn。

この属性に基づいている索引は、属性に関連付けられている拡張索引も含めてすべて再作成されます。
特定の拡張索引を-iオプションと同時に指定することにより再作成します。例: -i cn.es.lteまたは-i sn.en.sub。

A.3.13.10 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.3.13.11 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/rebuild-index
Windows: INSTANCE_DIR\OUD\bat\rebuild-index.bat

A.3.13.12 関連コマンド

第A.3.16項「verify-index」
第A.2.4項「dsconfig」

A.3.14 restore

restoreコマンドは、ディレクトリ・サーバーのバックエンドのバックアップを復元します。

A.3.14.1 シノプシス

restore options

A.3.14.2 説明

restoreコマンドは、ディレクトリ・サーバーのバックエンドのバックアップを復元します。一度に復元できるバックエンドは1つだけです。このコマンドを使用して、復元操作を即時に実行することも、復元を後日実行するようにスケジュールすることもできます。詳細は、第14.4項「タスクとしてのコマンドの構成」を参照してください。

サーバーがオフラインのときにバックエンドを復元するか、サーバーがオンラインのときにバックエンドを後日復元するタスクをスケジュールすることができます。サーバーがオンラインの場合、restoreコマンドは、管理コネクタを介してSSL上のサーバーに接続します。管理コネクタの詳細は、第14.3項「サーバーへの管理トラフィックの管理」を参照してください。

A.3.14.3 オプション

restoreコマンドは、短いフォーム(例: -I backupID)または同等の長いフォーム(例: --backupID backupID)のいずれかのオプションを受け入れます。

-d, --backupDirectory path: バックアップ・アーカイブが含まれているディレクトリを使用して復元します。このディレクトリが存在していて、1つのバックアップ・ディスクリプタ・ファイルと、指定されたバックエンドに対して1つ以上のバックアップが含まれている必要があります。バックアップ・ディスクリプタ・ファイルは、使用可能なバックアップと、その作成に使用するオプションについての情報を取得するために読み取られます。これは必須オプションです。
-I, --backupID backupID: 復元するバックアップのバックアップIDを指定します。このオプションが指定されない場合は、バックアップ・ディレクトリに含まれている最新のバックアップが復元されます。
-l, --listBackups: バックアップ・ディレクトリに含まれている使用可能なバックアップに関する情報を表示します。このオプションを指定すると、コマンドは復元を実行しないで終了します。
-n, --dry-run: 指定したバックアップが有効であることを検証します(つまり、指定したバックアップが有効なアーカイブとして表示され、ハッシュまたは署名、またはその両方がバックアップのコンテンツと一致していることを確認します)。このオプションは、実際にはバックアップの復元を試行しません。

A.3.14.4 タスク・バックエンド接続オプション

オンライン復元を実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。これらの接続オプションは、復元をオンラインで実行するときに使用します。

-D, --bindDN bindDN: バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。
-h, --hostname hostname: 指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。このオプションが指定されない場合は、localhostのデフォルトが使用されます。
-j, --bindPasswordFile filename: ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。
-K, --keyStorePath path: 指定されたパスにクライアント・キーストア証明書を使用します。
-N, --certNickname nickname: 指定された証明書をクライアント認証に使用します。
-o, --saslOption name=value: 指定されたオプションをSASL認証に使用します。
-p, --port port: 指定された管理ポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、4444というデフォルトの管理ポートが使用されます。
-P, --trustStorePath path: 指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。
-u, --keyStorePasswordFile filename: クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。
-U, --trustStorePasswordFile filename: クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。
-X, --trustAll: ディレクトリ・サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

A.3.14.5 タスク・スケジュール・オプション

--completionNotify emailAddress: タスク終了時に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--dependency taskId: このタスクが依存するタスクのIDを指定します。タスクのすべての依存性が実行を完了するまで、タスクの実行は開始しません。
--errorNotify emailAddress: このタスクの実行時にエラーが発生した場合に通知される受信者の電子メール・アドレスを指定します。このオプションは、1つのコマンドで複数回指定できます。
--failedDependencyAction action: 依存タスクの1つが失敗した場合に、このタスクが実行する必要のあるアクションを指定します。この値として、PROCESS、CANCEL、DISABLEのいずれか1つが指定されている必要があります。指定されていない場合、バックアップのデフォルトはCANCELになります。
--recurringTask schedulePattern: タスクは再帰的であり、crontab(5)互換の時間/日付パターンとして表記されるschedulePatternに従ってスケジュールされることを示します。
-t, --start startTime: ディレクトリ・サーバー・タスクとしてスケジュールされている際に、YYYYMMDDhhmmssのフォーマットで表記される操作の開始日付と時間を指定します。値0は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。

A.3.14.6 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath path: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。

A.3.14.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.14.8 例

次の例は、restoreコマンドの使用方法を示しています。

例A-111 バックアップ情報の表示

次のコマンドにより、バックアップ・ディスクリプタ・ファイル(backup.info)内のバックアップ情報がディレクトリ・サーバーに対してリストされます(-l)。このオプションを使用すると、サーバーが実行しているか停止しているかに関係なく、バックアップ情報を表示できます。

$ restore -l -d /tmp/backup/userRoot
Backup ID:          20081016050258Z
Backup Date:        16/Oct/2008:09:30:00 +0200
Is Incremental:     false
Is Compressed:      true
Is Encrypted:       true
Has Unsigned Hash:  false
Has Signed Hash:    true
Dependent Upon:     none

例A-112 バックアップの復元

次のコマンドにより、バックエンドがバックアップ・ディレクトリから復元されます。一度に復元できるバックエンドは1つだけです。このコマンドを実行する前に、サーバーを停止する必要があります。

$ stop-ds
$ restore -d /tmp/backup/userRoot
[16/Oct/2008:10:32:52 +0200] category=JEB severity=NOTICE msgID=8847445 
msg=Restored: 00000000.jdb (size 321954)

例A-113 暗号化されたバックアップの復元

ハッシュされたバックアップまたは暗号化されたバックアップを復元するには、管理コネクタを介してSSL上でオンライン・サーバー・インスタンスに接続する必要があります。したがって、暗号化されたバックアップを復元する場合は、ホスト、管理ポート、バインドDN、およびバインド・パスワードも含めた接続の詳細を指定する必要があります。また、SSL接続用に証明書の詳細を指定する必要もあります。

次のコマンドにより、暗号化され、ハッシュされたバックアップが復元されます。自己署名証明書は、-X (--trustAll)オプションを使用して信頼されます。

$ restore -h localhost -p 4444 -D "cn=directory manager" -j /path/pwd-file -X \
  -d /tmp/backup/userRoot/
Restore task 2008101610403710 scheduled to start immediately
[16/Oct/2008:10:40:38 +0200] severity="NOTICE" msgCount=0 msgID=9896306 
 message="The backend userRoot is now taken offline"
[16/Oct/2008:10:40:39 +0200] severity="NOTICE" msgCount=1 msgID=8847445 
 message="Restored: 00000000.jdb (size 331434)"
[16/Oct/2008:10:40:40 +0200] severity="NOTICE" msgCount=2 msgID=8847402 
 message="The database backend userRoot containing 102 entries has started"
Restore task 2008101610403710 has been successfully completed

例A-114 復元のスケジュール

復元をスケジュールするには、タスク・バックエンドにオンラインでアクセスする必要があります。このバックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。したがって、復元をスケジュールする場合は、ホスト、管理ポート、バインドDN、およびバインド・パスワードも含めた接続の詳細を指定する必要があります。また、SSL接続用に証明書の詳細を指定する必要もあります。

次のコマンドでは、--startオプションを使用して特定の開始時間にuserRootバックエンドを復元するタスクをスケジュールします。このコマンドにより、完了通知とエラー通知がadmin@example.comに送信されます。自己署名証明書は、-X (--trustAll)オプションを使用して信頼されます。

このスケジュール済タスクを表示するには、manage-tasksコマンドを使用します。詳細は、第14.4項「コマンドのタスクとしての構成」を参照してください。スケジュールされた復元の日付と時刻の前にサーバーが実行していることを確認する必要があります。

$ restore -h localhost -p 4444 -D "cn=directory manager" -j /path/pwd-file -X \
  -d /backup/userRoot --start 20081025121500 --completionNotify admin@example.com \
  --errorNotify admin@example.com
Restore task 2008101610442610 scheduled to start Oct 25, 2008 12:15:00 PM SAST

A.3.14.9 終了コード

終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。

A.3.14.10 プロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、restoreコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

A.3.14.11 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/restore
Windows: INSTANCE_DIR\OUD\bat\restore.bat

A.3.14.12 関連コマンド

第A.3.3項「dbtest」
第A.2.8項「manage-tasks」

A.3.15 split-ldif

split-ldifコマンドは、指定された分散ワークフロー要素に従って、1つのLDIFファイルを複数のLDIFファイルに分割します。生成されたLDIFファイルは、分散デプロイメントのパーティションの移入に使用されます。

A.3.15.1 シノプシス

split-ldif options

A.3.15.2 説明

split-ldifコマンドは、指定された分散ワークフロー要素に従って、1つのLDIFファイルを複数のLDIFファイルに分割します。LDIFファイル内のデータは、指定された属性と定義された分散タイプに基づいて分割されます。その後、生成されたLDIFファイルはパーティションの移入に使用されます。split-ldifコマンドは次のように、パーティションごとにパーティション・ファイルを作成します:

outputDirectory/outputFilenamePrefix-partitionID.ldif

分散アルゴリズムがエントリの送り先となるパーティションを決定できない場合がありますが、これは、アルゴリズムが必要とするすべてのパラメータがエントリに含まれていないか、必要なパラメータは存在していても、どのパーティションにも一致しないためです。このようなシナリオでは、出力はエラー・ファイルに書き込まれます。

すべての必須パラメータが指定されていないエントリはすべて、次のエラー・ファイルに書き込まれます:

outputDirectory/outputFilenamePrefix-missingrequired-param.ldif

必須パラメータが指定されていても、そのパラメータがどの構成済パーティションにも一致しないエントリはすべて、次のエラー・ファイルに書き込まれます:

outputDirectory/outputFilenamePrefix-partition-not-found.ldif

ただし、グローバル索引の初期化のために、グローバル索引形式と互換性のあるファイルが含まれているディレクトリを使用してください。split-ldifコマンドは、索引付けする属性ごとにディレクトリを1つ作成し、各ディレクトリにはグローバル索引を初期化するためのファイルが含まれます。

グローバル索引カタログは、ディレクトリ内に作成された、LDIF形式ではないファイルを使用して移入されます。詳細は、第A.2.7項「gicadm」を参照してください。

A.3.15.3 オプション

split-ldifコマンドは、短いフォーム(例: -i ldifFile)または同等の長いフォーム(例: --ldifFile ldifFile)のいずれかのオプションを受け入れます。

-i, --ldifFile ldifFile

分割するLDIFファイルの名前。「グローバル索引オプション」および「分割オプション」を使用して動作をカスタマイズすることができます。

-l, --listDistributionNames

ディレクトリ・サーバーの構成から有効化された分散ワークフロー要素をリストします。

注意:

-l, --listDistributionNamesオプションでは、無効になった分散を使用してldifファイルを分割できないため、有効化された分散のみがリストされます。

A.3.15.4 グローバル索引オプション

-x, --index attributeTypeName: リストされた属性タイプに対して、グローバル索引オプションに使用する索引ファイルを生成します。
-c, --onlyCatalog: 索引ファイルのみを生成します。

A.3.15.5 分割オプション

-d, --distributionName distributionName: データを分割する分散ワークフロー要素の名前。
-p, --forcePartitionId partitionId: リストされたpartitionIdが設定されているすべてのエントリが同一のパーティションに分散される索引ファイルを生成します。
-o, --outputDirectory outputDirectory: 出力LDIFファイルが生成されるディレクトリ。
-O, --outputFilenamePrefix outputFilePrefix: 生成するファイル名の接頭辞(これには、パーティションIDと.ldif拡張子が含まれます)。
-f, --force: 以前に使用してすでに存在している可能性のある生成済ファイルを上書きします。

A.3.15.6 一般オプション

-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。
-e, --help-examples: 使用例を表示します。
-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、ディレクトリ・サーバーの停止または再起動を試行しないで終了します。

A.3.15.7 例

例A-115 split-ldifを使用したグローバル索引への1つの索引付け属性の移入

次のコマンドでは、既存のデータベース・ファイル(-i)を使用します。このファイルは、プロキシ・デプロイメントですでに定義されている分散情報に基づいて複数のファイルに分割されます。このコマンドによって、分散ワークフロー要素名(-d)、分割するデータベース・ファイル(-i)、およびグローバル索引ファイル内で索引付けされる属性(-x)が定義されます。-fを指定すると、既存のLDIFファイルが上書きされます。

このコマンドを実行する前に、分散を使用してプロキシ・インスタンスをデプロイしておく必要があります。

$ split-ldif -d "distrib-we" -i database.ldif -x employeenumber -f

この例では、使用している分散アルゴリズムが数値であり、境界1-1000および1000-2000を割り当てた2つのパーティションが設定されているものと想定しています。上記のコマンドを実行すると、次のディレクトリとLDIFファイルが作成されます:

database-1.ldif: このファイルには従業員番号1-999を示すデータベースのエントリがすべて含まれており、これを使用してパーティション1を移入します。
database-2.ldif: このファイルには従業員番号1000-1999を示すデータベースのエントリがすべて含まれており、これを使用してパーティション2を移入します。
catalog\employeenumber: このディレクトリには、従業員番号属性に関するグローバル索引ファイルが含まれています。

例A-116 split-ldifを使用したグローバル索引への複数の索引付け属性の移入

このコマンドを実行する前に、分散を使用してプロキシ・インスタンスをデプロイしておく必要があります。

$ split-ldif -d "distrib-we" -i database.ldif \
-x employeenumber -x uid -f

この例では、使用している分散アルゴリズムが数値であり、境界1-50000および50000-100001を割り当てた2つのパーティションが設定されているものと想定しています。上記のコマンドを実行すると、次のLDIFファイルとディレクトリが作成されます:

database-1.ldif: このファイルには従業員番号1-49999を示すデータベースのエントリがすべて含まれており、これを使用してパーティション1を移入します。
database-2.ldif: このファイルには従業員番号50000-100000を示すデータベースのエントリがすべて含まれており、これを使用してパーティション2を移入します。
catalog\employeenumber: このディレクトリには、従業員番号属性に関するグローバル索引ファイルが含まれています。
catalog\uid: このディレクトリには、uid属性に関するグローバル索引ファイルが含まれています。

A.3.15.8 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/split-ldif
Windows: INSTANCE_DIR\OUD\bat\split-ldif.bat

A.3.15.9 関連コマンド

gicadm

A.3.16 verify-index

verify-indexコマンドは、ディレクトリ索引データを検証します。

A.3.16.1 シノプシス

verify-index options

A.3.16.2 説明

verify-indexコマンドは、ディレクトリ・サーバー・データベース内の索引とエントリ・データ間の一貫性のチェックに使用します。このコマンドは、索引エントリの限度に達した索引キー数に関する情報も提供します。

このコマンドによって、次の情報がチェックされます:

すべてのエントリが適切に索引付けされている
索引データ参照エントリがすべて存在している
データは対応する索引データに一致している

現時点では、このコマンドは情報の保存にOracle Berkeley DB Java Editionを使用しているディレクトリ・サーバー・バックエンドのみで使用可能です。現在使用可能なその他のバックエンド・タイプでは、ディスク上の索引は保持されません。したがって、索引の一貫性を検証できるコマンドを使用する必要はありません。

ディレクトリ管理者は、ディレクトリ・サーバーの起動時または停止時でもこのコマンドを使用できます。ただし、サーバーが実行しているときにverify-indexを使用すると、ディレクトリ・サーバーとコマンドの全体的なパフォーマンスに影響が出ることに注意してください。たとえば、稼働率の非常に高いオンライン・サーバーでverify-indexコマンドを実行した場合は、オフラインの、または停止しているサーバーでこのコマンドを実行する場合よりも処理時間が非常に長くなることがあります。

このコマンドを使用するには、--baseDNオプションを使用して、検証が実行されるバックエンドのベースDNを指定する必要があります。

A.3.16.3 オプション

verify-indexコマンドは、短いフォーム(例: -b baseDN)または同等の長いフォーム(例: --baseDN baseDN)のいずれかのオプションを受け入れます。

A.3.16.4 コマンドのオプション

-b, --baseDN baseDN

検証の実行の対象となるベースDNを指定します。指定値は、Berkeley DB Java EditionをベースとしたバックエンドのベースDNである必要があります。これは必須オプションであり、1つのベースDNのみが指定可能です。

-c, --clean

索引が「クリーン」であること、つまり、すべての索引キーにあるすべてのエントリIDが参照するエントリは実際に存在し、その索引キーの基準に一致していることを検証します。このオプションを指定した場合は、--indexオプションを使用して索引を1つだけ指定する必要があります。このオプションを指定しない場合は、検証プロセスによってid2entryデータベース(各エントリIDをそのエントリの実データにマッピングしたもの)がクリーンになり、すべてのエントリ・コンテンツが適切に索引付けされていることが確認されます。

--countErrors

検証中に検出されたエラー数をカウントし、その値を終了コードとして返します。255を超える値は、終了コードの制約のため、255として返されます。

-i, --index index

検証の実行の対象となる索引の名前を指定します。--cleanオプションを指定した場合は、この引数を1回だけ指定する必要があります。そうでない場合、この引数はゼロ回、または複数回指定できます。このオプションが指定されない場合は、すべての索引がチェックされます。属性索引の場合、索引名に属性の名前を使用し、関連付けられたバックエンドでその属性に対して索引を構成する必要があります。また、サーバーで内部使用される次の内部索引を指定することもできます:

dn2id: エントリDNとそれに対応するエントリIDのマッピング。

id2children: エントリのエントリIDとその直接の子のエントリIDのマッピング。

id2subtree: エントリのエントリIDとそのすべての下位エントリのエントリIDのマッピング。

-v, --verbose

冗長モードを使用します。

A.3.16.5 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、サーバーの停止または再起動を試行しないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。

A.3.16.6 例

次の例は、verify-indexコマンドの使用方法を示しています。

例A-117 索引の検証

次のコマンドにより、dc=example,dc=com (-b dc=example,dc=com)下にあるuid索引(-i uid)が「クリーン」である(-c)ことを検証します。この「クリーン」オプションは、uid索引にある各エントリがuid属性を持つ実際のデータベース・エントリにマップしていることをチェックします。

$ verify-index -b dc=example,dc=com -c -i uid

[26/Jul/2007:16:42:31 -0500] category=BACKEND severity=NOTICE msgID=8388709
msg=Checked 150 records and found 0 error(s) in 0 seconds (average rate 331.1/sec)

例A-118 索引の検証とエラー件数のカウント

次のコマンドにより、dc=example,dc=com base DN (-b dc=example,dc=com)下にあるsn (surname)索引(-i sn)内の不一致(--countErrors)の件数をカウントします:

$ verify-index -b dc=example,dc=com -c -i sn --countErrors

[31/Jul/2007:02:23:52 -0500] category=BACKEND severity=NOTICE msgID=8388709 msg=
Checked 466 records and found 0 error(s) in 0 seconds (average rate 1298.1/sec)
[31/Jul/2007:02:23:52 -0500] category=BACKEND severity=NOTICE msgID=8388710 msg=
Number of records referencing more than one entry: 225
[31/Jul/2007:02:23:52 -0500] category=BACKEND severity=NOTICE msgID=8388711 msg=
Number of records that exceed the entry limit: 0
[31/Jul/2007:02:23:52 -0500] category=BACKEND severity=NOTICE msgID=8388712 msg=
Average number of entries referenced is 2.59/record
[31/Jul/2007:02:23:52 -0500] category=BACKEND severity=NOTICE msgID=8388713 msg=
Maximum number of entries referenced by any record is 150

A.3.16.7 終了コード

終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。

A.3.16.8 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/verify-index
Windows: INSTANCE_DIR\OUD\bat\verify-index.bat

A.3.16.9 関連コマンド

第A.3.13項「rebuild-index」

A.4 LDAPクライアントのコマンド

次の各項では、LDAPクライアントのユーティリティについて説明します:

第A.4.1項「ldapcompare」
第A.4.2項「ldapdelete」
第A.4.3項「ldapmodify」
第A.4.4項「ldappasswordmodify」
第A.4.5項「ldapsearch」

A.4.1 ldapcompare

ldapcompareコマンドは、LDAPエントリを比較します。

A.4.1.1 シノプシス

ldapcompare options

A.4.1.2 説明

ldapcompareコマンドは、ディレクトリ・サーバーに対するLDAP比較リクエストの発行に使用します。比較リクエストを使用して、指定されたエントリ、またはエントリのセットに特定の属性と値の組合せがあるかどうかを判別できます。比較操作が正常に行われた結果として返される情報は、比較の評価がtrueまたはfalseであるかどうかのみを示します。エントリに関するその他の情報は示されません。

コマンドライン上のldapcompareツールの構文として、次のいずれのフォームでも使用できます:

ldapcompare [ options ] attribute:value [ "targetDN" ... | -f DNfile]
ldapcompare [ options ] attribute::base64value [ "targetDN" ... | -f DNfile ]
ldapcompare [ options ] attribute:fileURL [ "targetDN" ... | -f DNfile ]

説明:

optionsは、次の項で説明するコマンドライン・オプションです。
attributeは属性タイプの名前であり、この後ろに比較値を指定する3つの方法のいずれか1つが続きます。属性タイプの名前と値の文字列は、シェルに対応できるように一重引用符(")で囲む必要があります。
targetDNは、指定された属性の検索とその値の比較に使用される識別名(DN)またはDNのリストです。
DNfileは、指定された属性を検索してその値を比較するための、1行ごとに1つずつDNのリストを含むファイルです。

A.4.1.3 オプション

ldapcompareコマンドは、短いフォーム(例: -D bindDN)または同等の長いフォーム(例: --bindDN bindDN)のいずれかのオプションを受け入れます。

A.4.1.4 コマンドのオプション

--assertionFilter filter

LDAPアサーション制御(RFC 4528に定義しています)を使用して検索を実行し、指定されたフィルタに含まれているアサーションがtrueである場合のみ操作を処理することを示します。

-c, --continueOnError

エラーが発生した場合でも処理を続行します。これは、複数のエントリDNが後続オプションとして、または--filenameオプションによって指定されたファイルの中に設定されている場合に当てはまります。比較リクエストの処理中にエラーが発生した場合、クライアントは、--continueOnErrorオプションが指定されていれば、次のエントリDNを使用して処理を続行し、このオプションが指定されていない場合はエラーを示して終了します。

-f, --filename filename

検索操作を処理する際に使用する1つ以上のフィルタが含まれているファイルへのパスを指定します。複数のエントリDNが存在する場合は、1行に1つのDNが表示されるようにファイルを構成する必要があります。すべての比較は、同じディレクトリ・サーバーとの接続を使用して、ファイルに表示される順序で実行されます。このオプションが指定されない場合は、少なくとも1つのエントリDNが属性と値のアサーションの後に続く必要があります。このオプションを使用する場合、必要な後続オプションは属性と値のアサーションのみです。--filenameオプションは、追加のコマンドライン・オプションとして指定されたどのDNよりも優先されます。追加のDNは無視されるだけです。

-J, --control controloid[criticality[:value|::b64value|:<fileurl]]

ディレクトリ・サーバーに送信された検索リクエストに指定されているコントロールを使用して、検索を実行します。このオプションを使用すると、クライアントが直接サポートできない任意のリクエスト・コントロールを含めることができます。このオプションの値には、次のフォームを使用する必要があります:

oid[:criticality[:value|::b64value|:<fileurl]]

この値の要素は次のとおりです:

oid: コントロールにOIDを使用します。特定のタイプのコントロールについては、数値OIDのかわりにテキスト名を使用することもできます(検索操作の場合は、DSA IT管理のコントロールに対するmanagedsaitも含まれます)。この要素は必須です。-Jオプションまたはcontrolオプションを使用すると、OIDのかわりに判読可能な名前を使用して、値を必要としないコントロールを参照することができます。これらのOID名は次のとおりです:
- accountusableまたはaccountusability: アカウント・ユーザビリティ・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.8のかわりに使用(値なし)
- authzidまたはauthorizationidentity: 認可IDリクエスト・コントロールOID: 2.16.840.1.113730.3.4.16のかわりに使用(値なし)
- effectiverights: 有効な権限の取得コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.2のかわりに使用(値=認可ID)
- managedsait: DSA ITの管理コントロールOID: 2.16.840.1.113730.3.4.2のかわりに使用(値なし)
- noopまたはno-op: LDAP No-opコントロールOID: 1.3.6.1.4.1.4203.1.10.2のかわりに使用(値なし)
- pwpolicyまたはpassword policy: パスワード・ポリシー・リクエストOID: 1.3.6.1.4.1.42.2.27.8.5.1のかわりに使用(値なし)
- subtreedeleteまたはtreedelete: サブツリー削除リクエスト・コントロールOID: 1.2.840.113556.1.4.805のかわりに使用(値なし)
criticality: trueの場合、コントロールをクリティカルとマークする必要があります(つまり、操作がこのコントロールの要件を満たさないかぎり、ディレクトリ・サーバーは操作を処理しません)。falseの場合は、コントロールをクリティカルとマークする必要はありません。このサブコマンドが指定されていない場合、コントロールはクリティカルとマークされません。
value: コントロールの値を指定します。このフォームは、値を文字列として表記できる場合のみ使用します。これは、::b64valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
b64value: コントロールの値をbase64でエンコードされたフォームで指定します。このサブコマンドは、:valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
fileurl: 取り込むコントロールの値のあるファイルを参照するURLを指定します。これは、:valueフォームまたは::b64valueフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。

たとえば、値1.3.6.1.4.1.42.2.27.9.5.2:true:dn:uid=dmiller,ou=people,dc=example,dc=comには、OIDが1.3.6.1.4.1.42.2.27.9.5.2であり、クリティカル(true)とマークされ、認可ID dn:uid=dmiller,ou=people,dc=example,dc=comの文字列値のあるクリティカルなコントロールが含まれます。または、次のOID名、effectiverights:true:dn:uid=dmiller、ou=people、dc=example、dc=comが使用できます。

-n, --dry-run

no-opモードで実行します。つまり、発生する内容を報告しますが、実際に検索を実行したり、どの方法でもサーバーと通信することはありません。

A.4.1.5 LDAP接続オプション

-D, --bindDN bindDN

バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは簡易認証の実行時に使用されます。SASL認証を使用する場合、このオプションは必要ありません。このオプションのデフォルト値はcn=Directory Managerです。

-h, --hostname address

指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。これが指定されない場合は、localhostのデフォルトのアドレスが使用されます。

-j, --bindPasswordFile bindPasswordFile

ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。このオプションは、簡易認証と、パスワードに基づくSASLメカニズム(CRAM-MD5、DIGEST-MD5、およびPLAINなど)に使用します。認可が実行されない場合、これは必要ありません。このオプションは、--bindPasswordと同時に使用しないでください。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-K, --keyStorePath keyStorePath

SSLまたはStartTLS拡張操作を使用する場合は、セキュアな通信のために、指定されたパスにクライアント・キーストア証明書を使用します。このオプションは、SASL EXTERNAL認証を使用する場合など、クライアントがディレクトリ・サーバーに証明書を提示する必要がある場合のみ必要です。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-N, --certNickName certNickName

証明書ベースのクライアント認証に対して指定された証明書を使用します。

-o, --saslOption name=value

SASL認証を実行するときに、指定されたオプションを使用します。複数のSASLオプションを指定するには、オプションごとに1回ずつ、このオプションを複数回使用します。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-p, --port port

指定されたポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、デフォルトのポート389が使用されます。

-P, --trustStorePath trustStorePath

SSLまたはStartTLS拡張操作を使用する場合は、セキュアな通信のために、指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、--trustAllを使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。

-q, --useStartTLS

ディレクトリ・サーバーと通信する際、StartTLS拡張操作を使用します。このオプションは、--useSSLと同時に使用しないでください。

-r, --useSASLExternal

認証に対してSASL EXTERNALメカニズムを使用します。このメカニズムでは、クライアントがディレクトリ・サーバーに提示したSSL証明書を使用してクライアントを識別しようと試行されます。このオプションを使用する場合は、--keyStorePathオプションも同時に使用してクライアント・キーストアへのパスを指定し、--useSSLオプションまたは--useStartTLSオプションを使用してサーバーとのセキュアな通信チャネルを確立する必要があります。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

--trustStorePassword trustStorePassword

クライアント・トラスト・ストアの証明書へのアクセスに必要なパスワードを使用します。このオプションは、--trustStorePathを使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。このオプションは、--trustStorePasswordFileと同時に使用しないでください。

-u, --keyStorePasswordFile keyStorePasswordFile

クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。このオプションは、--keyStorePasswordと同時に使用しないでください。

-U, --trustStorePasswordFile trustStorePasswordFile

-V, --ldapVersion version

クライアントがディレクトリ・サーバーと通信する際に使用する必要のあるLDAPプロトコルのバージョンを設定します。この値には、2 (LDAPv2通信の場合)または3 (LDAPv3の場合)のいずれかを設定する必要があります。このオプションが指定されない場合、クライアントはLDAPv3を使用します。

-w, --bindPassword bindPassword

ディレクトリ・サーバーに対して認証を受ける際、バインド・パスワードを使用します。このオプションは、簡易認証と、パスワードに基づくSASLメカニズムに使用できます。このオプションは、--bindPasswordFileと同時に使用しないでください。パスワードの入力を要求するには、-w -を入力します。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-W, --keyStorePassword keyStorePassword

クライアント・キーストアの証明書へのアクセスに必要なパスワードを使用します。このオプションは、--keyStorePathを使用する場合のみ必須です。このオプションは、--keyStorePasswordFileと同時に使用しないでください。

-X, --trustAll

SSLまたはStartTLSのネゴシエーション中にディレクトリ・サーバーによって提示される可能性のある証明書をすべて信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。

-Z, --useSSL

ディレクトリ・サーバーと通信する際、Secure Sockets Layerを使用します。SSLを使用する場合は、--portオプションを使用してサーバーのセキュア・ポートを指定する必要があります。

A.4.1.6 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath propertiesFilePath: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-v, --verbose: 冗長モードで実行して、プロセス情報と診断情報を標準出力で表示します。

A.4.1.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、コマンドの実行を試みないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.4.1.8 例

次の例は、ldapcompareコマンドの使用方法を示しています。

例A-119 グループ・メンバーシップに関するエンティティの比較

次のコマンドでは、ポート1389 (-p)に接続するホスト名(-h)を指定し、従業員(uid=scarter)がグループ(cn=Accounting Managers)のメンバーであるかどうかを検証します。

$ ldapcompare -h hostname -p 1389 \
"uniquemember:uid=scarter,ou=People,dc=example,dc=com" \
"cn=Accounting Managers,ou=groups,dc=example,dc=com"

Comparing type uniquemember with value uid=scarter,ou=People,dc=example,dc=com 
in entry cn=Accounting Managers,ou=groups,dc=example,dc=com 
Compare operation returned true for entry
cn=Accounting Managers,ou=groups,dc=example,dc=com

例A-120 属性値とエントリの比較

次のコマンドでは、ポート1389 (-p)に接続するホスト名(-h)を指定し、属性(ou=Accounting)がエンティティ(cn=Sam Carter)のレコードに存在するかどうかを検証します。

$ ldapcompare -h hostname -p 1389 "ou:Accounting" \
"uid=scarter,ou=People,dc=example,dc=com"

Comparing type ou with value Accounting in entry uid=scarter,ou=People,dc=example,dc=com
Compare operation returned true for entry uid=scarter,ou=People,dc=example,dc=com

例A-121 サーバー認証でのldapcompareの使用

次のコマンドでは、サーバー認証を使用して、ホスト名(-h)、SSLポート(-p)、ベースDN (-b)、バインドDN (-D)、バインド・パスワード(-w)、トラスト・ストア・ファイル・パス(-P)を指定し、属性がエントリに存在するかどうかをチェックします。Windowsプラットフォームの場合は、トラスト・ストア・ファイルが常駐しているパス(たとえば、-P \temp\certs\cert.db)を使用します。

$ ldapcompare -h hostname -p 1636 -D "cn=Directory Manager" \
-j pwd-file -P /home/kwinters/certs/cert.db \
'givenname:Sam' "uid=scarter,ou=People,dc=example,dc=com"

Comparing type givenname with value Sam in entry uid=scarter,ou=People,dc=example,dc=com
Compare operation returned true for entry uid=scarter,ou=People,dc=example,dc=com

例A-122 クライアント認証でのldapcompareの使用

次のコマンドでは、比較とともにクライアント認証を使用します。このコマンドは、SSLポート(-p)を指定してSSL (-Z)を使用し、トラスト・ストア・ファイル・パス(-P)、証明書ニックネーム(-N)、キーストア・ファイル・パス(-K)、キーストア・パスワード(-W)を指定して、エンティティに指定された名前givenname=Samがエントリに存在しているかどうかをチェックします。Windowsプラットフォームの場合は、トラスト・ストア・ファイルが常駐しているパス(たとえば、-P \temp\certs\cert.db)と、キーストア・ファイルが常駐しているパス(-K \temp\security\key.db)を使用します。

$ ldapcompare -h hostname -p 1636 -Z \
-P /home/kwinters/security/cert.db -N "kwcert" \
-K /home/kwinters/security/key.db -W KeyPassword \
'givenname:Sam' "uid=scarter,ou=People,dc=example,dc=com"

Comparing type givenname with value Sam in entry uid=scarter,ou=People,dc=example,dc=com
Compare operation returned true for entry uid=scarter,ou=People,dc=example,dc=com

A.4.1.9 終了コード

終了コード6は、比較が成功したことを示します。終了コード5は、比較が成功していないことを示します。その他のすべての終了コードは、処理中にエラーが発生したことを示します。

A.4.1.10 CLIプロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、ldapcompareコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

assertionFilter
bindDN
bindPassword
bindPasswordFile
certNickname
continueOnError
control
dry-run
filename
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
ldapVersion
port
saslOption
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
useSASLExternal
useSSL
useStartTLS
verbose

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

ldapcompare.ldapport=12345

A.4.1.11 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldapcompare
Windows: INSTANCE_DIR\OUD\bat\ldapcompare.bat

A.4.1.12 関連コマンド

第A.4.2項「ldapdelete」
第A.4.3項「ldapmodify」
第A.4.4項「ldappasswordmodify」
第A.4.5項「ldapsearch」

A.4.2 ldapdelete

ldapdeleteコマンドは、エントリを削除するために、LDAP削除リクエストをディレクトリ・サーバーに対して発行します。

A.4.2.1 シノプシス

ldapdelete [option] [DN]

A.4.2.2 説明

ldapdeleteコマンドは、エントリを削除するために、LDAP削除リクエストをディレクトリ・サーバーに対して発行します。--filenameオプションが指定されないかぎり、削除するエントリを指定するために、エントリDNを唯一の後続オプションとして指定する必要があります。

A.4.2.3 開始する前に

多くのUNIXまたはLinuxオペレーティング・システムには共通のLDAPクライアント・コマンドのインストール済バージョンが用意されており、たとえば、/usr/binディレクトリのldapsearch、ldapmodify、およびldapdeleteなどがあります。使用しているシステムにバージョンがインストールされているかどうかをチェックするには、コマンドwhich ldapdeleteを入力します。このコマンドが値(以下に示します)を返す場合は、$PATHをINSTANCE_DIR/OUD/binディレクトリに更新するか、ディレクトリ・サーバー・インスタンスの別名を作成する必要があります。

$ which ldapdelete (UNIX/Linux)
/usr/bin/ldapdelete

A.4.2.4 オプション

ldapdeleteコマンドは、短いフォーム(例: -D bindDN)または同等の長いフォーム(例: --bindDN bindDN)のいずれかのオプションを受け入れます。

A.4.2.5 コマンドのオプション

-c, --continueOnError

エラーが発生した場合でも処理を続行します。この操作は、複数のエントリDNが後続オプションとして、または--filenameオプションによって指定されたファイルの中に設定されている場合に当てはまります。比較リクエストの処理中にエラーが発生した場合、クライアントは、--continueOnErrorオプションが指定されていれば、次のエントリDNを使用して処理を続行し、このオプションが指定されていない場合はエラーを示して終了します。

-f, --filename filename

検索操作を処理する際に使用する1つ以上のフィルタが含まれているファイルへのパスを指定します。複数のエントリDNが存在する場合は、1行に1つのDNが表示されるようにファイルを構成する必要があります。このオプションを使用する場合は、後続オプションを追加しません。削除するエントリのDNを唯一の後続オプションとします。

-J, --control controloid[:criticality[:value|::b64value|:<fileurl]]

oid[:criticality[:value|::b64value|:<fileurl]]

この値の要素は次のとおりです:

oid。コントロールのOIDを使用します。特定のタイプのコントロールについては、数値OIDのかわりにテキスト名を使用することもできます(検索操作の場合は、DSA IT管理のコントロールに対するmanagedsaitも含まれます)。この要素は必須です。-Jオプションまたはcontrolオプションを使用すると、OIDのかわりに判読可能な名前を使用して、値を必要としないコントロールを参照することができます。これらのOID名は次のとおりです:

accountusableまたはaccountusability: アカウント・ユーザビリティ・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.8のかわりに使用(値なし)。

authzidまたはauthorizationidentity: 認可IDリクエスト・コントロールOID: 2.16.840.1.113730.3.4.16のかわりに使用(値なし)。

effectiverights: 有効な権限の取得コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.2のかわりに使用(値=認可ID)。

managedsait: DSA ITの管理コントロールOID: 2.16.840.1.113730.3.4.2のかわりに使用(値なし)。

noopまたはno-op: LDAP No-opコントロールOID: 1.3.6.1.4.1.4203.1.10.2のかわりに使用(値なし)。

pwpolicyまたはpassword policy: パスワード・ポリシー・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.8.5.1のかわりに使用(値なし)。

subtreedeleteまたはtreedelete: サブツリー削除リクエスト・コントロールOID: 1.2.840.113556.1.4.805のかわりに使用(値なし)。
criticality。trueの場合、コントロールをクリティカルとマークする必要があります(つまり、操作がこのコントロールの要件を満たさないかぎり、ディレクトリ・サーバーは操作を処理しません)。falseの場合は、コントロールをクリティカルとマークする必要はありません。このサブコマンドが指定されていない場合、コントロールはクリティカルとマークされません。
value。コントロールの値を指定します。このフォームは、値を文字列として表記できる場合のみ使用します。これは、::b64valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
b64value。コントロールの値をbase64でエンコードされたフォームで指定します。このサブコマンドは、:valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
fileurl。取り込むコントロールの値のあるファイルを参照するURLを指定します。これは、:valueフォームまたは::b64valueフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。

たとえば、値1.3.6.1.4.1.42.2.27.9.5.2:true:dn:uid=dmiller,ou=people,dc=example,dc=comには、OIDが1.3.6.1.4.1.42.2.27.9.5.2であり、クリティカル(true)とマークされ、認可ID dn:uid=dmiller,ou=people,dc=example,dc=comの文字列値のあるクリティカルなコントロールが含まれます。または、次のOID名、effectiverights:true:dn:uid=dmiller、ou=people、dc=example、dc=comが使用できます。

-n, --dry-run

no-opモードで実行します。つまり、発生する内容を報告しますが、実際に検索を実行したり、どの方法でもサーバーと通信することはありません。

-x, --deleteSubtree

指定されたエントリと、その下のエントリをすべて削除します。

A.4.2.6 LDAP接続オプション

-D, --bindDN bindDN

-h, --hostname address

-j, --bindPasswordFile bindPasswordFile

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-K, --keyStorePath keyStorePath

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-N, --certNickName certNickName

証明書ベースのクライアント認証に対して指定された証明書を使用します。

-o, --saslOption name = value

SASL認証を実行するときに、指定されたオプションを使用します。複数のSASLオプションを指定するには、オプションごとに1回ずつ、このオプションを複数回使用します。詳細は、第20.6項「SASL認証の使用方法」を参照してください。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-p, --port port

指定されたポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、デフォルトのポート389が使用されます。

-P, --trustStorePath trustStorePath

-q, --useStartTLS

ディレクトリ・サーバーと通信する際、StartTLS拡張操作を使用します。このオプションは、--useSSLと同時に使用しないでください。

-r, --useSASLExternal

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

--trustStorePassword trustStorePassword

-u, --keyStorePasswordFile keyStorePasswordFile

-U, --trustStorePasswordFile trustStorePasswordFile

-V, --ldapVersion version

-w, --bindPassword bindPassword

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-W, --keyStorePassword keyStorePassword

-X, --trustAll

-Z, --useSSL

A.4.2.7 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath propertiesFilePath: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-v, --verbose: 冗長モードで実行して、プロセス情報と診断情報を標準出力で表示します。

A.4.2.8 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、コマンドの実行を試みないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.4.2.9 例

次の例は、ldapdeleteコマンドの使用方法を示しています。

例A-123 コマンドラインからのエントリの削除

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、単一エントリを削除します:

$ ldapdelete -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file \
"uid=mgarza,ou=People,dc=example,dc=com"

例A-124 DNファイルを使用した複数エントリの削除

次のファイルには、削除するDNのリストが含まれています。このファイルでは、各DNをそれぞれ別の行にリストする必要があります。

uid=mgarza,ou=People,dc=example,dc=com
uid=wsmith,ou=People,dc=example,dc=com
uid=jarrow,ou=People,dc=example,dc=com
uid=mbean,ou=People,dc=example,dc=com

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、削除するエントリをファイルに読み取ります。エラーが発生した場合、このコマンドは次の検索項目で処理を続行(-c)します。Windowsプラットフォームの場合は、削除ファイルが常駐しているパス(たとえば、-f \temp\delete.ldif)を使用します:

$ ldapdelete -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file \
-c -f /usr/local/delete.ldif

例A-125 サーバー認証を使用したエントリの削除

次のコマンドでは、サーバー認証を使用してエントリを削除します。次のコマンドでは、ホスト名(-h)、SSLポート(-p)、バインドDN (-D)、バインド・パスワード(-w)、トラスト・ストア・ファイル・パス(-P)、および削除が含まれているLDIFファイル(-f)を指定します。エラーが発生した場合、このコマンドは次の検索項目で処理を続行(-c)します。Windowsプラットフォームの場合は、削除ファイルが常駐しているパス(たとえば、-f \temp\delete.ldif)およびトラスト・ストア・パスワードが常駐しているファイル(たとえば、-P \temp\certs\cert.db)を使用します:

$ ldapdelete -h hostname -p 1636 -c -f /usr/local/delete.ldif \
-D "cn=Directory Manager" -j pwd-file \
-P /home/kwinters/certs/cert.db

例A-126 クライアント認証を使用したエントリの削除

次のコマンドは、クライアント認証を使用して削除オプションを実行します。このコマンドは、SSLポート(-p)を指定してSSL (-Z)を使用し、トラスト・ストア・ファイル・パス(-P)、証明書ニックネーム(-N)、キーストア・ファイル・パス(-K)、キーストア・パスワード(-W)および削除が含まれているLDIFファイル(-f)を指定します。エラーが発生した場合、このコマンドは次の検索項目で処理を続行(-c)します。Windowsプラットフォームの場合は、削除ファイルが常駐しているパス(たとえば、-f \temp\delete.ldif)、トラスト・ストア・パスワードが常駐しているファイル(たとえば、-P \temp\certs\cert.db)およびキーストア・パスワードが常駐しているファイル(たとえば、-K \temp\security\key.db)を使用します。

$ ldapdelete -h hostname -p 1636 -c -f /usr/local/delete.ldif \
-Z -P /home/kwinters/security/cert.db -N "kwcert" \
-K /home/kwinters/security/key.db -W keypassword

A.4.2.10 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.4.2.11 CLIプロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、ldapdeleteコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

bindDN
bindPassword
bindPasswordFile
certNickname
continueOnError
control
deleteSubtree
dry-run
filename
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
ldapVersion
port
saslOption

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
useSASLExternal

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
useSSL
useStartTLS
verbose

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

ldapdelete.ldapport=12345

A.4.2.12 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldapdelete
Windows: INSTANCE_DIR\OUD\bat\ldapdelete.bat

A.4.2.13 関連コマンド

第A.4.1項「ldapcompare」
第A.4.3項「ldapmodify」
第A.4.4項「ldappasswordmodify」
第A.4.5項「ldapsearch」

A.4.3 ldapmodify

ldapmodifyコマンドは、ディレクトリ・エントリを変更します。

A.4.3.1 シノプシス

ldapmodify [options] [filter] [attributes]

A.4.3.2 説明

ldapmodifyコマンドを使用して、ディレクトリ・サーバーでLDAP変更、追加、削除、およびDN変更操作を実行できます。ディレクトリ・サーバーで実行する操作は、RFC 2849 (http://www.ietf.org/rfc/rfc2849.txt)に説明するように、LDIF変更形式で指定する必要があります。この変更構文では、changetypeキーワードを使用して変更のタイプを示します。

add変更レコードは、LDIFフォームでaddというchangetype値を持つ完全なエントリであるため、わかりやすい例です。例:

dn: uid=john.doe,ou=People,dc=example,dc=com
changetype: add
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
uid: john.doe
givenName: John
sn: Doe
cn: John Doe
mail: john.doe@example.com
userPassword: password

delete変更レコードは、add変更レコードよりもさらに簡単です。addレコードは、エントリDNを示す1行と、その後のdeleteというchangetypeを示す1行で構成されています。例:

dn: uid=john.doe,ou=People,dc=example,dc=com
changetype: delete

modify変更レコードは、バリアント数のために最も複雑な操作です。modify変更レコードはすべてエントリDNで始まり、その後にmodifyというchangetypeが続きます。次の行は、add、delete、またはreplaceのいずれかと、その後に続く属性名(これは変更のタイプと、変更の対象となる属性を示します)で構成されます。変更レコードにはオプションとして、属性値と、その後に変更に使用する値(つまり、属性に追加する値、属性から削除する値、既存の値セットの置換に使用する値)が続く行を1行以上続けることもできます。変更をダッシュのみを含む行で区分し、次の行を新しいadd、delete、またはreplaceのタグで開始し、その後にコロン1つと次の属性名を続け、さらに属性の値を設定することにより、同じmodify操作において1つのエントリに複数の属性変更を加えることができます。例:

dn: uid=john.doe,ou=People,dc=example,dc=com
changetype: modify
replace: description
description: This is the new description for John Doe
-
add: mailAlternateAddress
mailAlternateAddress: jdoe@example.com

DN変更の変更レコードには常にnewRDN要素とdeleteOldRDN要素が含まれている必要があり、オプションとして、ターゲット・エントリに新しい親を指定するためにnewSuperiorコンポーネントを含めることができます。例:

dn: uid=john.doe,ou=People,dc=example,dc=com
changetype: moddn
newRDN: uid=jdoe
deleteOldRDN: 1

ldapmodifyコマンドに引数が指定されていない場合、このコマンドはポート389のループバック・アドレスを使用する未認証の接続を使用してディレクトリ・サーバー・インスタンスとの相互作用を試行し、リクエストされる変更に関する情報が標準入力から読み取られます。この場合はサーバーの認証方法の指定に使用される引数を少なくとも指定する必要があるため、この処理が成功する可能性はほとんどありません。

A.4.3.3 開始する前に

多くのUNIXおよびLinuxオペレーティング・システムには共通のLDAPクライアント・コマンドのインストール済バージョンが用意されており、たとえば、/usr/binディレクトリのldapsearch、ldapmodify、およびldapdeleteなどがあります。使用しているシステムにバージョンがインストールされているかどうかをチェックするには、コマンドwhich ldapmodifyを入力します。このコマンドが値(以下に示します)を返す場合は、$PATHをINSTANCE_DIR/OUD/binディレクトリに更新するか、ディレクトリ・サーバー・インスタンスの別名を作成する必要があります。

$ which ldapmodify (Unix/Linux)
/usr/bin/ldapmodify

A.4.3.4 オプション

ldapmodifyコマンドは、短いフォーム(例: -D bindDN)または同等の長いフォーム(例: --bindDN bindDN)のいずれかのオプションを受け入れます。

A.4.3.5 コマンドのオプション

-a, --defaultAdd

エントリを追加します。changetype要素のないレコードを追加リクエストとして処理します。このオプションは、LDIF変更形式による情報が含まれていない標準LDIFファイルからのエントリの追加に使用できます。

--assertionFilter filter

LDAPアサーション制御(RFC 4528 (http://www.ietf.org/rfc/rfc4528.txt)に定義しています)を使用して検索を実行し、指定されたフィルタに含まれているアサーションがtrueである場合のみ操作を処理することを示します。

-c, --continueOnError

エラーが発生した場合でも処理を続行します。このオプションは、ファイル--filename内で複数の検索フィルタを使用する場合に使用します。処理中にエラーが発生した場合、ディレクトリ・サーバーは次の検索フィルタの処理を続行します。そうでない場合、このコマンドはすべての検索が完了しないうちに終了します。

-f, --filename filename

変更操作中に使用する1つ以上のフィルタが含まれている指定ファイルから変更を読み取ります。LDIFファイルにあるレコードはLDIF変更形式である必要があります(つまり、changetype要素が含まれていること)。ディレクトリ・サーバーに追加するエントリのみがLDIFファイルに含まれている場合、そのファイルは、エントリがchangetype要素を持っていない場合でも、--defaultAddオプションを指定して使用できます。変更レコード間に少なくとも1つの空白行があるかぎり、指定されたファイルに複数の変更を含めることができます。

このオプションが指定されない場合、ldapmodifyコマンドは標準入力から変更情報を読み取ろうとします。これによって、コマンドライン上でターゲット・ユーザーが変更レコードをインタラクティブに指定するか、変更レコードを他のソースからコマンドにパイプ入力することができます。

-J, --control controloid[:criticality[:value|::b64value|:<fileurl]]

oid[: criticality[:value|::b64value|:<fileurl]]

この値の要素は次のとおりです:

oid。コントロールのOIDを使用します。特定のタイプのコントロールについては、数値OIDのかわりにテキスト名を使用することもできます(検索操作の場合は、DSA IT管理のコントロールに対するmanagedsaitも含まれます)。この要素は必須です。-Jオプションまたはcontrolオプションを使用すると、OIDのかわりに判読可能な名前を使用して、値を必要としないコントロールを参照することができます。これらのOID名は次のとおりです:

accountusableまたはaccountusability: アカウント・ユーザビリティ・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.8のかわりに使用(値なし)。

authzidまたはauthorizationidentity: 認可IDリクエスト・コントロールOID: 2.16.840.1.113730.3.4.16のかわりに使用(値なし)。

effectiverights: 有効な権限の取得コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.2のかわりに使用(値=認可ID)。

managedsait: DSA ITの管理コントロールOID: 2.16.840.1.113730.3.4.2のかわりに使用(値なし)。

noopまたはno-op: LDAP No-opコントロールOID: 1.3.6.1.4.1.4203.1.10.2のかわりに使用(値なし)。

pwpolicyまたはpassword policy: パスワード・ポリシー・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.8.5.1のかわりに使用(値なし)。

subtreedeleteまたはtreedelete: サブツリー削除リクエスト・コントロールOID: 1.2.840.113556.1.4.805のかわりに使用(値なし)。
criticality。trueの場合、コントロールをクリティカルとマークする必要があります(つまり、操作がこのコントロールの要件を満たさないかぎり、ディレクトリ・サーバーは操作を処理しません)。falseの場合は、コントロールをクリティカルとマークする必要はありません。このサブコマンドが指定されていない場合、コントロールはクリティカルとマークされません。
value。コントロールの値を指定します。このフォームは、値を文字列として表記できる場合のみ使用します。これは、::b64valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
b64value。コントロールの値をbase64でエンコードされたフォームで指定します。このサブコマンドは、:valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
fileurl。取り込むコントロールの値のあるファイルを参照するURLを指定します。これは、:valueフォームまたは::b64valueフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。

たとえば、値1.3.6.1.4.1.42.2.27.9.5.2:true:dn:uid=dmiller,ou=people,dc=example,dc=comには、OIDが1.3.6.1.4.1.42.2.27.9.5.2であり、クリティカル(true)とマークされ、認可ID dn:uid=dmiller,ou=people,dc=example,dc=comの文字列値のあるクリティカルなコントロールが含まれます。または、次のOID名、effectiverights:true:dn:uid=dmiller、ou=people、dc=example、dc=comが使用できます。

-n, --dry-run

no-opモードで実行します。つまり、発生する内容を報告しますが、実際に検索を実行したり、どの方法でもサーバーと通信することはありません。

--postReadAttributes attrList

LDAP ReadEntry読込み後制御(RFC 4527 (http://www.ietf.org/rfc/rfc4527.txt)に定義するとおり)を使用して、更新直後であるためディレクトリ・サーバーがターゲットのコピーを返すことを指定します。これは、追加、変更、およびDN変更の操作のみに該当します。このオプションの値には、読込み前エントリの表示に含める属性のカンマ区切りリストを指定する必要があります。このリストには、ldapsearchコマンドで返される属性のリストと同じ規則が適用されます(つまり、すべてのユーザー属性に*が使用でき、すべての操作属性に+が使用でき、指定されたオブジェクト・クラス内のすべての属性に@ocnameが使用できるなど)。属性が指定されない場合は(空の引用符で示されます)、すべてのユーザー属性が返されます。

--preReadAttributes attrList

LDAP ReadEntry読込み前制御(RFC 4527 (http://www.ietf.org/rfc/rfc4527.txt)に定義するとおり)を使用して、更新直後であるためディレクトリ・サーバーがターゲットのコピーを返すことを指定します。これは、削除、変更、およびDN変更の操作のみに該当します。このオプションの値には、読込み前エントリの表示に含める属性のカンマ区切りリストを指定する必要があります。このリストには、ldapsearchコマンドで返される属性のリストと同じ規則が適用されます(つまり、すべてのユーザー属性に*が使用でき、すべての操作属性に+が使用でき、指定されたオブジェクト・クラス内のすべての属性に@ocnameが使用できるなど)。属性が指定されない場合は(空の引用符で示されます)、すべてのユーザー属性が返されます。

-Y, --proxyAs authzID

プロキシ設定された認可制御を使用して、操作の対象となるユーザーのIDを指定します。これは、RFC 4370 (http://www.ietf.org/rfc/rfc4370.txt)に定義するとおり、プロキシ認可制御v2を使用します。このオプションの値には、認可IDをdn:の後にターゲット・ユーザーのDNが続くフォーム(たとえば、dn:uid=john.doe,ou=People,dc=example,dc=com)、またはu:の後にユーザー名が続くフォーム(たとえば、u:john.doe)で指定する必要があります。このオプションが指定されない場合、プロキシ認可は使用されません。

A.4.3.6 LDAP接続オプション

-D, --bindDN bindDN

バインドDNを使用してディレクトリ・サーバーを認証します。このオプションは、簡易認証の実行時に使用します。このオプションのデフォルト値はcn=Directory Managerです。SASL認証を使用している場合、または認証が実行されない場合、これは必要ありません。

-E, --reportAuthzID

バインド・リクエストに認可IDリクエスト・コントロール(RFC 3829 (http://www.ietf.org/rfc/rfc3829.txt)に定義するとおり)を使用して、認証完了時にディレクトリ・サーバーが対応する認可IDをクライアントに返すようにします。(認可IDが含まれている行には接頭辞として#文字が使われ、出力をLDIFとして解釈されるようにする場合のコメントにします。)

-h, --hostname address

-j, --bindPasswordFile bindPasswordFile

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-K, --keyStorePath keyStorePath

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-N, --certNickName certNickName

証明書ベースのクライアント認証に対して指定された証明書を使用します。

-o, --saslOption name = value

SASL認証を実行するときに、指定されたオプションを使用します。複数のSASLオプションを指定するには、オプションごとに1回ずつ、このオプションを複数回使用します。クライアントでのSASL認証の使用方法の詳細は、第20.7項「SASL認証の構成」を参照してください。

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-p, --port port

指定されたポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、デフォルトのポート389が使用されます。

-P, --trustStorePath trustStorePath

-q, --useStartTLS

ディレクトリ・サーバーと通信する際、StartTLS拡張操作を使用します。このオプションは、--useSSLと同時に使用しないでください。

-r, --useSASLExternal

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

--trustStorePassword trustStorePassword

-u, --keyStorePasswordFile keyStorePasswordFile

-U, --trustStorePasswordFile trustStorePasswordFile

-V, --ldapVersion version

-w, --bindPassword bindPassword

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-W, --keyStorePassword keyStorePassword

-X, --trustAll

-Z, --useSSL

ディレクトリ・サーバーと通信する際、SSLを使用します。SSLを使用する場合は、--portオプションを使用してサーバーのセキュア・ポートを指定する必要があります。

A.4.3.7 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath propertiesFilePath: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-v, --verbose: 冗長モードで実行して、プロセス情報と診断情報を標準出力で表示します。

A.4.3.8 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、コマンドの実行を試みないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.4.3.9 例

次の例は、ldapmodifyコマンドの使用方法を示しています。

例A-127 エントリの追加

次のLDIFファイルには従業員のエントリが含まれています:

dn: uid=Marcia Garza,ou=People,dc=example,dc=com
cn: Marcia Garza
sn: Garza
givenName: Marcia
objectClass: person
objectClass: inetOrgPerson
objectClass: top
objectClass: organizationalPerson
ou: Accounting
ou: People

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、ファイル(-f)から変更を読み取り、エントリ(-a)をデータベースに追加します。Windowsプラットフォームの場合は、LDIFファイルへのパス(たとえば、-f \temp\add_entry.ldif)を指定します。

$ ldapmodify -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file \
-a -f /usr/local/add_entry.ldif

例A-128 属性のエントリへの追加

次のLDIFファイルでは、telephonenumber属性を追加してエントリを変更します:

dn: uid=Marcia Garza,ou=People,dc=example,dc=com
changetype: modify
add: telephonenumber
telephonenumber: +1 408 555 8283

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、ファイル(-f)から変更を読み取り、属性をエントリに追加します。Windowsプラットフォームの場合は、LDIFファイルへのパス(例:

-f \temp\add_attribute.ldif)を指定します。

$ ldapmodify -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file \
-f /usr/local/add_attribute.ldif

例A-129 属性値の変更

次のLDIFファイルでは、telephonenumber属性の値を変更します:

dn: uid=Marcia Garza,ou=People,dc=example,dc=com
changetype: modify
replace: telephonenumber
telephonenumber: +1 408 555 6456

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、ファイル(-f)から変更を読み取り、属性の値を変更します。Windowsプラットフォームの場合は、LDIFファイルへのパス(たとえば、-f \temp\modify_attribute.ldif)を指定します。

$ ldapmodify -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file \
-f /usr/local/modify_attribute.ldif

例A-130 複数の属性の変更

次のLDIFファイルには、エントリに対する複数の変更が含まれています:

dn: uid=Marcia Garza,ou=People,dc=example,dc=com
changetype: modify
replace: telephonenumber
telephonenumber: +1 408 555 6465
-
add: facsimiletelephonenumber
facsimiletelephonenumber: +1 408 222 4444
-
add: l
l: Sunnyvale

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、ファイル(-f)から変更を読み取り、データベースに加えられた変更を処理します。Windowsプラットフォームの場合は、LDIFファイルへのパス(たとえば、-f \temp\mod_attribute.ldif)を指定します:

$ ldapmodify -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file \
-f /usr/local/mod_attribute.ldif

例A-131 コマンドラインからの属性の削除

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、エントリのfacsimiletelephonenumber属性を削除します。このコマンドはコマンドラインから実行されているため、dn、changetype、変更操作を入力し、[Control]キーと[D]キー(UNIX、Linux)または[Control]キーと[Z]キー(Windows)を押して処理します:

$ ldapmodify -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file
dn: uid=Marcia Garza,ou=People,dc=example,dc=com
changetype: modify
delete: facsimiletelephonenumber
(Press Control-D for Unix, Linux)
(Press Control-Z for Windows)

例A-132 コマンドラインからのエントリの削除

次のコマンドでは、ホスト名(-h)、ポート(-p)、バインドDN (-D)、バインド・パスワード(-w)を指定して、エントリを削除します。このコマンドはコマンドラインから実行されているため、dn、changetypeを入力し、[Control]キーと[D]キー(UNIX、Linux)または[Control]キーと[Z]キー(Windows)を押して処理します:

$ ldapmodify -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file
dn: uid=Marcia Garza,ou=People,dc=example,dc=com
changetype: delete
(Press Control-D for Unix, Linux)
(Press Control-Z for Windows)

例A-133 サーバー認証でのldapmodifyの使用

次のコマンドは、-P SSLオプションを使用してサーバー認証による変更を実行します。次のコマンドでは、ホスト名(-h)、SSLポート(-p)、ベースDN (-b)、バインドDN (-D)、バインド・パスワード(-w)、トラスト・ストア・ファイル・パス(-P)、および変更が含まれているLDIFファイル(-f)を指定します。Windowsプラットフォームの場合は、変更ファイルのパス(たとえば、-f \temp\myldif.ldif)とトラスト・ストア・ファイルのパス(たとえば、-P \temp\certs\cert.db)を指定します:

$ ldapmodify -h hostname -p 1636 -f /home/local/myldif.ldif \
-D "cn=Directory Manager" -j pwd-file \
-P /home/scarter/certs/cert.db

例A-134 クライアント認証でのldapmodifyの使用

次のコマンドは、-P SSLオプションを使用してクライアント認証による変更を実行します。このコマンドは、SSLポート(-p)を指定してSSL (-Z)を使用し、トラスト・ストア・ファイル・パス(-P)、証明書ニックネーム(-N)、キーストア・ファイル・パス(-K)、キーストア・パスワード(-W)および変更が含まれているLDIFファイル(-f)を指定します。Windowsプラットフォームの場合は、変更ファイルのパス(たとえば、-f \temp\myldif.ldif)、トラスト・ストア・ファイルのパス(たとえば、-P \certs\cert.db)、およびキーストア・ファイルのパス(たとえば、-K \security\key.db)を指定します:

$ ldapmodify -h hostname -p 1636 -f /home/local/myldif.ldif \
-Z -P /home/scarter/security/cert.db -N "sccert" \
-K /home/scarter/security/key.db -W keypassword

A.4.3.10 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.4.3.11 CLIプロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、ldapmodifyコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

assertionFilter
bindDN
bindPassword
bindPasswordFile
certNickname
continueOnError
control
dry-run
filename
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
ldapVersion
port
postReadAttributes
preReadAttributes
proxyAs
reportAuthzID
saslOption

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
useSASLExternal

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
useSSL
useStartTLS
verbose

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

ldapmodify.ldapport=12345

A.4.3.12 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldapmodify
Windows: INSTANCE_DIR\OUD\bat\ldapmodify.bat

A.4.3.13 関連コマンド

第A.4.1項「ldapcompare」
第A.4.2項「ldapdelete」
第A.4.4項「ldappasswordmodify」
第A.4.5項「ldapsearch」

A.4.4 ldappasswordmodify

ldappasswordmodifyコマンドは、LDAPパスワードを変更します。

A.4.4.1 シノプシス

ldappasswordmodify options

A.4.4.2 説明

ldappasswordmodifyコマンドは、RFC 3062 (http://www.ietf.org/rfc/rfc3062.txt)に定義するように、LDAPパスワード変更拡張操作を使用したユーザー・パスワードの変更またはリセットに使用できます。

このメカニズムによるユーザー・パスワードの変更は、パスワード属性を対象とした単純なLDAP変更操作に比べて、次に示すように多くの利点を備えています:

自分のパスワードの変更。この機能がユーザーのパスワード・ポリシーで使用可能である場合に、このコマンドによってユーザーは自分のパスワードを、有効期限後であっても変更することができます。
クリアテキスト・パスワードの指定。このコマンドは、ユーザーのIDをさらに検証するために、現在のパスワードのクリアテキスト・バージョンを提供するメカニズムとして機能します。
認可IDの使用。ユーザーのパスワードを変更する際、フルDNに加えて認可ID(接頭辞dn:またはu:が付きます)を使用することでユーザーを指定できます。
パスワードの生成。新しいパスワードが指定されない場合、この機能がユーザーのパスワード・ポリシーで使用可能になっていると、サーバーはユーザーに対して新しいパスワードを生成できます。

A.4.4.3 オプション

ldappasswordmodifyコマンドは、短いフォーム(例: -D bindDN)または同等の長いフォーム(例: --bindDN bindDN)のいずれかのオプションを受け入れます。

A.4.4.4 コマンドのオプション

-a, --authzID authzID

変更するパスワードを持つユーザーに対して認可IDを指定します。認可IDには、dn:の後にターゲット・ユーザーのDNが続くフォーム、またはu:の後にターゲット・ユーザーのユーザー名が続くフォームが使用できます。このオプションが指定されない場合、認可IDはリクエストに含まれず、認証ユーザーのパスワードが変更されます。このオプションは、--provideDNForAuthzIDオプションと同時に使用しないでください。

-A, --provideDNForAuthzID

バインドDNをパスワード変更操作の認可IDとして使用することを指定します。このオプションは、--authzIDオプションと同時に使用しないでください。

-c, --currentPassword currentPassword

ユーザーの現在のパスワードを指定します。このオプションは、--currentPasswordFileと同時に使用しないでください。認証が実行されない場合、たとえば、ユーザーが有効期限の切れた自分のパスワードを変更しようとする場合などは、ユーザーの現在のパスワードを指定する必要があります。バインド・パスワードが指定されている場合でも、パスワード・ポリシー構成に基づいているサーバーでパスワードが必要になることがあります。

-C, --currentPasswordFile currentPasswordFile

指定されたファイルから現在のパスワードを読み取ります。これは、--currentPasswordと同時に使用しないでください。認証が実行されない場合、たとえば、ユーザーが有効期限の切れた自分のパスワードを変更しようとする場合などは、ユーザーの現在のパスワードを指定する必要があります。バインド・パスワードが指定されている場合でも、パスワード・ポリシー構成に基づいているサーバーでパスワードが必要になることがあります。

-J, --control controloid[:criticality[:value|::b64value|:<fileurl]]

oid[:criticality[:value|::b64value|:<fileurl]]

この値の要素は次のとおりです:

oid。コントロールのOIDを使用します。特定のタイプのコントロールについては、数値OIDのかわりにテキスト名を使用することもできます(検索操作の場合は、DSA IT管理のコントロールに対するmanagedsaitも含まれます)。この要素は必須です。-Jオプションまたはcontrolオプションを使用すると、OIDのかわりに判読可能な名前を使用して、値を必要としないコントロールを参照することができます。これらのOID名は次のとおりです:

accountusableまたはaccountusability: アカウント・ユーザビリティ・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.8のかわりに使用(値なし)。

authzidまたはauthorizationidentity: 認可IDリクエスト・コントロールOID: 2.16.840.1.113730.3.4.16のかわりに使用(値なし)。

effectiverights: 有効な権限の取得コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.2のかわりに使用(値=認可ID)。

managedsait: DSA ITの管理コントロールOID: 2.16.840.1.113730.3.4.2のかわりに使用(値なし)。

noopまたはno-op: LDAP No-opコントロールOID: 1.3.6.1.4.1.4203.1.10.2のかわりに使用(値なし)。

pwpolicyまたはpassword policy: パスワード・ポリシー・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.8.5.1のかわりに使用(値なし)。

subtreedeleteまたはtreedelete: サブツリー削除リクエスト・コントロールOID: 1.2.840.113556.1.4.805のかわりに使用(値なし)。
criticality。trueの場合、コントロールをクリティカルとマークする必要があります(つまり、操作がこのコントロールの要件を満たさないかぎり、ディレクトリ・サーバーは操作を処理しません)。falseの場合は、コントロールをクリティカルとマークする必要はありません。このサブコマンドが指定されていない場合、コントロールはクリティカルとマークされません。
value。コントロールの値を指定します。このフォームは、値を文字列として表記できる場合のみ使用します。これは、::b64valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
b64value。コントロールの値をbase64でエンコードされたフォームで指定します。このサブコマンドは、:valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
fileurl。取り込むコントロールの値のあるファイルを参照するURLを指定します。これは、:valueフォームまたは::b64valueフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。

-n, --newPassword newPassword

ターゲット・ユーザーに割り当てる新しいパスワードを指定します。このオプションは、--newPasswordFileと同時に使用しないでください。これらのオプションがいずれも指定されていない場合、パスワード・ジェネレータがユーザーのパスワード・ポリシーで構成されていると、サーバーはユーザーに対して新しいパスワードを自動的に生成します。

-N, --newPasswordFile newPasswordFile

ターゲット・ユーザーに割り当てる指定ファイルから新しいパスワードを読み取ります。このオプションは、--newPasswordと同時に使用しないでください。これらのオプションがいずれも指定されていない場合、パスワード・ジェネレータがユーザーのパスワード・ポリシーで構成されていると、サーバーはユーザーに対して新しいパスワードを自動的に生成します。

A.4.4.5 LDAP接続オプション

--certNickname nickname

証明書ベースのクライアント認証の証明書を使用します。

-D, --bindDN bindDN

簡易認証を介してディレクトリ・サーバーにバインドするときにDNを使用します。このオプションが指定されない場合は、--authzIDオプションを使用してターゲット・ユーザーの認可IDを指定し、--currentPasswordオプションまたは--currentPasswordFileオプションのいずれかを指定してユーザーの現在のパスワードを指定する必要があります。(この使用モードは、ユーザーが自分のパスワードを有効期限後に変更する場合に必要です。)

-h, --hostname address

-j, --bindPasswordFile bindPasswordFile

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-K, --keyStorePath keyStorePath

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-o, --saslOption name=value

-p, --port port

指定されたポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、デフォルトのポート389が使用されます。

-P, --trustStorePath trustStorePath

-q, --useStartTLS

ディレクトリ・サーバーと通信する際、StartTLS拡張操作を使用します。このオプションは、--useSSLと同時に使用しないでください。

--trustStorePassword trustStorePassword

-u, --keyStorePasswordFile keyStorePasswordFile

-U, --trustStorePasswordFile trustStorePasswordFile

-w, --bindPassword bindPassword

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-W, --keyStorePassword keyStorePassword

-X, --trustAll

-Z, --useSSL

A.4.4.6 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath propertiesFilePath: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。

A.4.4.7 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、コマンドの実行を試みないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.4.4.8 例

次の例は、ldappasswordmodifyコマンドの使用方法を示しています。

例A-135 ユーザー・パスワードの変更

次のコマンドでは、ポート1389 (-p)を使用してホスト(-h)に接続し、管理者の認可ID uid=abergin (-a)を指定し、ユーザーの現在のパスワード・ファイル(-C)を指定して、それを新しいパスワード・ファイル(-N)で指定された新しいものに変更します。Windowsプラットフォームの場合は、現在のパスワードと新しいパスワードがそれぞれ存在しているファイル・パスを使用します。たとえば、-C \temp\currentPasswordFileおよび-N \temp\newPasswordFileを使用します。

$ ldappasswordmodify -h hostname -p 1389 \
-a "dn:uid=abergin,ou=People,dc=example,dc=com" \
-C /tmp/currentPasswordFile -N /tmp/newPasswordFile

The LDAP password modify operation was successful

例A-136 別のユーザーのパスワードの変更および生成

次のコマンドでは、ポート1389 (-p)を使用してホスト(-h)に接続し、バインドDN (-D)を指定し、バインド・パスワード・ファイル(-j)を指定して、簡易認証によって接続している別のユーザー(-a)のパスワードを変更および生成します。Windowsプラットフォームの場合は、バインド・パスワード・ファイルが常駐しているファイル(たとえば、-j \temp\bindPasswordFile)を使用します。

$ ldappasswordmodify -h hostname -p 1389 \
-D "cn=Directory Manager" -j /tmp/bindPasswordFile \
-a "dn:uid=abergin,ou=People,dc=example,dc=com"

The LDAP password modify operation was successful
Generated Password:  blb44hjm

例A-137 別のユーザーのパスワードの変更

次のコマンドでは、ポート1389 (-p)を使用してホスト(-h)に接続し、バインドDN (-D)を指定し、バインド・パスワード・ファイル(-j)を指定して、簡易認証によって接続している別のユーザー(-a)のパスワードを新しいパスワード(-N)に変更します。Windowsプラットフォームの場合は、バインド・パスワード・ファイル(たとえば、-j \temp\bindPasswordFile)と新しいパスワード・ファイル(たとえば、-N \temp\newPassword)を指定します。

$ ldappasswordmodify -h hostname -p 1389 \
-D "cn=Directory Manager" -j /tmp/bindPasswordFile \
-a "dn:uid=abergin,ou=People,dc=example,dc=com" -N /tmp/newPassword

The LDAP password modify operation was successful

A.4.4.9 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.4.4.10 CLIプロパティ・ファイルの使用方法

ディレクトリ・サーバーでは、ldappasswordmodifyコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

authzID
bindDN
bindPassword
bindPasswordFile
currentPassword
currentPasswordFile
control
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
newPassword
newPasswordFile
port
provideDNForAuthzID
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
useSSL
useStartTLS

プロパティ・ファイルのエントリのフォーマットは、次のとおりです:

toolname.propertyname=propertyvalue

例:

ldappasswordmodify.ldapport=12345

A.4.4.11 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldappasswordmodify
Windows: INSTANCE_DIR\OUD\bat\ldappasswordmodify.bat

A.4.4.12 関連コマンド

第A.4.1項「ldapcompare」
第A.4.2項「ldapdelete」
第A.4.3項「ldapmodify」
第A.4.5項「ldapsearch」

A.4.5 ldapsearch

ldapsearchコマンドは、ディレクトリ・サーバーのエントリを検索します。

A.4.5.1 シノプシス

ldapsearch [options] [filter] [attributes]

A.4.5.2 説明

ldapsearchコマンドは、ディレクトリ・サーバーへの検索リクエストの入力に使用できます。このコマンドでは、ディレクトリ・サーバーへの接続を開き、それにバインドして、検索フィルタとスコープ要件を満たすすべてのエントリを、指定されたベースDNから順に返します。また、認証、制御、セキュアな通信メカニズムなど、ディレクトリ・サーバーのその他のコンポーネントのテストにも使用できます。

--filenameオプションを使用して1つ以上の検索フィルタが含まれているファイルを指定した場合は、検索フィルタをオプションとして含めないようにしてください。後続オプションはすべて、リクエストされた属性として解釈されます。

エントリの名前と属性にsn、givenName、uid、およびtitleなどの非ASCII文字が使われている場合、ldapsearchコマンドの実行によって返される非ASCII文字は印刷中に抑制されます。base64コマンドを実行して、Base64でエンコードされた文字列をデコードする必要があります。

特定の属性がリクエストされていない場合は、すべてのユーザー属性(つまり、操作属性以外のすべての属性)が返されます。1つ以上の属性名がリストされる場合は、返された属性のみがエントリに含まれます。

A.4.5.3 開始する前に

多くのUNIXおよびLinuxオペレーティング・システムには共通のLDAPクライアント・コマンドのインストール済バージョンが用意されており、たとえば、/usr/binディレクトリのldapsearch、ldapmodify、およびldapdeleteなどがあります。使用しているシステムにバージョンがインストールされているかどうかをチェックするには、コマンドwhich ldapsearchを入力します。このコマンドが値(以下に示します)を返す場合は、$PATHをディレクトリ・サーバーのインストール・ディレクトリに更新するか、ディレクトリ・サーバー・インスタンスの別名を作成する必要があります。

$ which ldapsearch (Unix/Linux)
/usr/bin/ldapsearch

A.4.5.4 オプション

ldapsearchコマンドは、短いフォーム(例: -b baseDN)または同等の長いフォーム(例: --baseDN baseDN)のいずれかのオプションを受け入れます。

A.4.5.5 コマンドのオプション

-a, --dereferencePolicy dereferencePolicy

検索時の別名の間接参照ポリシーを指定します。別名の間接参照により、別のオブジェクトをポイントするようにエントリを設定できます。このオプションが指定されない場合は、デフォルトのneverが使用されます。可能な値は次のとおりです:

always: ベースDNの検出時とベースDNより下の検索時の両方で別名を間接参照します。
find: ベースDNの検出時に別名を間接参照します。
never: 別名の間接参照を行いません(デフォルト)。
search: ベースDNより下の検索時に別名を間接参照しますが、ベースDNの検出時には実行しません。

-A, --typesOnly

一致するエントリに属性名を含める検索を実行しますが、属性値は含めません。このオプションが指定されない場合は、属性名と属性値の両方が一致エントリに含まれます。

--assertionFilter filter

-b, --baseDN baseDN

検索操作に使用するbase DNを指定します。--filenameオプションを使用して複数のフィルタを含むファイルが指定されている場合、このベースDNはすべての検索に使用されます。これは必須オプションです。null値("")を持つベースDNが指定されている場合、サーバーはルートDSEエントリを返します。

-c, --continueOnError

エラーが発生した場合でも処理を続行します。このオプションは、ファイル(--filename)内で複数の検索フィルタを使用する場合に使用します。処理中にエラーが発生した場合、サーバーは次の検索フィルタの処理を続行します。そうでない場合、このコマンドはすべての検索が完了しないうちに終了します。

-C, --persistentSearch ps[:changetype[:changesonly[:entrychangecontrols]]]

検索リクエストに永続検索制御(draft-ietf-ldapext-psearch.txt (https://opends.dev.java.net/public/standards/draft-ietf-ldapext-psearch.txt)に定義)を使用して、指定された検索基準に一致するエントリに加えられた変更に関する情報を取得します。このオプションの値には、次のフォームを使用する必要があります:

ps[:changetype[:changesonly [:entrychangecontrols]]]

この値の要素は次のとおりです:

ps: 必須演算子。
changetype: クライアントが通知の受信を必要とする変更のタイプを指定します。これはadd、del、mod、またはmoddnのいずれでも可能であり、すべての変更タイプを登録するにはallが指定でき、あるいは、複数の特定の変更タイプを登録するにはカンマ区切りリストが指定できます。この要素が指定されない場合、デフォルトとしてall変更タイプが含まれます。
changesonly: trueの場合、クライアントには検索登録後に一致エントリに加えられる変更のみが通知されます。falseの場合、ディレクトリ・サーバーは、ディレクトリ・サーバー内で指定された検索基準に一致する既存のエントリをすべて送信します。この要素が指定されない場合、デフォルトとして、検索が登録された後に生じた更新のエントリのみが返されます。
entrychangecontrols: trueの場合、ディレクトリ・サーバーは、変更の結果としてクライアントに送信されたエントリにエントリ変更通知制御を含めます。falseの場合、エントリ変更通知制御は含まれません。この要素が指定されない場合、デフォルトとしてエントリ変更通知制御が含まれます。

たとえば、値ps:add,del:true:trueは、永続検索が登録された後に追加または削除された、検索基準に一致するエントリのみを返し、これらのエントリにはエントリ変更通知制御が含まれます。

--countEntries

ディレクトリ・サーバーによって返された一致エントリの総数を表示します。--filenameオプションを使用して複数の検索フィルタが含まれているファイルへのパスを指定した場合は、すべての検索に関して一致エントリの総数が表示されます。

-e, --getEffectiveRightsAttribute attribute

指定された属性に対する有効権限を返します。このオプションは、通常であればエントリの検索結果に表示されない属性の指定に使用できます。たとえば、このオプションを使用して、エントリ内に現在存在しない属性を追加する権限をユーザーが持っているかどうかを判別できます。-eオプションには、--getEffectiveRightsAuthzidオプションまたは-gオプションが必須です。

-f, --filename filename

検索操作を処理する際に使用する1つ以上のフィルタが含まれているファイルへのパスを指定します。ファイルに複数のフィルタが含まれている場合は、1行に1つのフィルタが表示されるようにファイルを構成する必要があります。検索は、同じディレクトリ・サーバーとの接続を使用して、ファイルに表示される順序で実行されます。このオプションを使用する場合、後続オプションはすべて別個の属性として処理されます。そうでない場合は、最初の後続オプションを検索フィルタにする必要があります。

-g, --getEffectiveRightsAuthzid authzid

指定されたauthzidでバインドしているユーザーの有効権限を表示します。このオプションは-eオプションを指定して使用できますが、-Jオプションを指定して使用することはできません。

-G, --virtualListView before:after:index:count|before:after:value

検索結果合計の一部を表示する仮想リスト表示を取得します。次の2つのパターンのいずれかを使用して、仮想リスト表示のサイズを指定します:

before:after:index:count: ターゲット・エントリと、ターゲット・エントリの前およびターゲット・エントリの後の指定されたエントリ数を返します。ターゲット・エントリは、indexオプションおよびcountオプションに依存します。countオプションに指定できる値は次のとおりです:

count=0。ターゲット・エントリは、指定されたindexの位置にあるエントリで、1から始まり、ソート結果の全体リストに相対しています。

count=1。ターゲット・エントリは、ソート結果のリストにある最初のエントリです。

count>1。ターゲット・エントリは、分数index/countによって表示されるリストの部分にある最初のエントリです。リスト内の最後の結果をターゲットにするには、countオプションよりも大きいindexオプションを使用します。

たとえば、-G 5:10:2:4を使用すると、全体リストの第2四半分の初めに最も近いindexが指定されます。検索によって100のエントリが検出された場合、ターゲット索引は26となり、このパターンは21から36までのエントリを返します。
before:after:value: ターゲット・エントリと、ターゲット・エントリの前後の指定された数のエントリを返します。ターゲット・エントリは、ソート属性が指定値以上であるソート結果の最初のエントリです。

たとえば、-G 5:10:johnson -S snを使用すると、surname属性からアルファベット順で16のエントリが返されます。その内訳はjohnsonより前の5つ、johnsonに等しいか直後のエントリ、およびjohnsonより後の10のエントリです。

-J, --control controloid[:criticality[:value|::b64value |:<filePath]]

oid[:criticality[:value|::b64value|:<filePath]]

この値の要素は次のとおりです:

oid。コントロールのOIDを使用します。特定のタイプのコントロールについては、数値OIDのかわりにテキスト名を使用することもできます(検索操作の場合は、DSA IT管理のコントロールに対するmanagedsaitも含まれます)。この要素は必須です。-Jオプションまたはcontrolオプションを使用すると、OIDのかわりに判読可能な名前を使用して、値を必要としないコントロールを参照することができます。これらのOID名は次のとおりです:

accountusableまたはaccountusability: アカウント・ユーザビリティ・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.8のかわりに使用(値なし)。

authzidまたはauthorizationidentity: 認可IDリクエスト・コントロールOID: 2.16.840.1.113730.3.4.16のかわりに使用(値なし)。

effectiverights: 有効な権限の取得コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.2のかわりに使用(値=認可ID)。

managedsait: DSA ITの管理コントロールOID: 2.16.840.1.113730.3.4.2のかわりに使用(値なし)。

noopまたはno-op: LDAP No-opコントロールOID: 1.3.6.1.4.1.4203.1.10.2のかわりに使用(値なし)。

pwpolicyまたはpassword policy: パスワード・ポリシー・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.8.5.1のかわりに使用(値なし)。

subtreedeleteまたはtreedelete: サブツリー削除リクエスト・コントロールOID: 1.2.840.113556.1.4.805のかわりに使用(値なし)。
criticality。trueの場合、コントロールをクリティカルとマークする必要があります(つまり、操作がこのコントロールの要件を満たさないかぎり、ディレクトリ・サーバーは操作を処理しません)。falseの場合は、コントロールをクリティカルとマークする必要はありません。このサブコマンドが指定されていない場合、コントロールはクリティカルとマークされません。
value。コントロールの値を指定します。このフォームは、値を文字列として表記できる場合のみ使用します。これは、::b64valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
b64value。コントロールの値をbase64でエンコードされたフォームで指定します。このサブコマンドは、:valueフォームまたは:< fileurlフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。
fileurl。取り込むコントロールの値のあるファイルを参照するURLを指定します。これは、:valueフォームまたは::b64valueフォームと連係して使用することはできません。これらのサブコマンドがいずれも指定されていない場合、コントロールには値が設定されません。

-l, --timeLimit numSeconds

ディレクトリ・サーバーが検索リクエストの処理に費やす最長時間(秒)を指定します。このオプションが指定されない場合、クライアントは時間限度を要求しません。ディレクトリ・サーバーでは、クライアントにより要求される時間限度よりも低い限度を施行することができます。

--matchedValuesFilter filter

LDAPの一致した値の制御(RFC 3876 (http://www.ietf.org/rfc/rfc3876.txt)に定義)を使用して、指定されたフィルタに一致する属性値のみを検索結果に含めることを指定します。このオプションを複数回指定して、複数の一致した値フィルタを指定できます。

-n, --dry-run

no-opモードで実行します。つまり、発生する内容を報告しますが、実際に検索を実行したり、どの方法でもサーバーと通信することはありません。

-s, --searchScope scope

検索操作の範囲を設定します。範囲の値には、次のいずれか1つを指定する必要があります:

base: --baseDNオプションまたは-bオプションによって指定されたエントリのみを検索します。
one: --baseDNオプションまたは-bオプションによって指定されたエントリとその直接の子のみを検索します。
subまたはsubordinate: --baseDNオプションまたは-bオプションによって指定されたエントリがベースであるサブツリーを検索します。これは、--searchScopeが指定されない場合のデフォルトのオプションです。

-S, --sortOrder sortOrder

結果をソートした後で、クライアントに結果を返します。ソート順はソート・キーのカンマ区切りリストであり、各ソート・キーは次の要素で構成されます:

+/- (プラス記号またはマイナス記号): ソートを昇順(+)にするか、または降順(-)にするかを指定します。この要素が省略された場合は、昇順でソートされます。
attribute name: データをソートする際に使用する属性の名前。この要素は常に指定する必要があります。
nameまたはOID Matching Rule: オプションのコロン1つの後に、ソートの実行に使用する一致ルールの名前またはOIDが続きます。この要素が指定されない場合は、指定された属性タイプのデフォルトの順序付け一致ルールが使用されます。たとえば、ソート順序文字列sn,givenNameでは、まずsnによってエントリが昇順でソートされ、次にgivenNameによってソートされます。また、値--modifyTimestampを指定すると、結果は最新の値から順にソートされます。

--simplePageSize numEntries

単純なページ結果制御を指定されたページ・サイズで使用します。

--subEntries

サブエントリ制御を使用して、サブエントリが表示され、通常のエントリは表示されないことを指定します。

-Y, --proxyAsauthzID

-z, --sizeLimit numEntries

ディレクトリ・サーバーがクライアントに返す一致エントリの最大数を設定します。このオプションが指定されていない場合、クライアントが要求する最大数は存在しません。ディレクトリ・サーバーでは、クライアントにより要求されるサイズ限度よりも低い限度を施行することができます。

A.4.5.6 LDAP接続オプション

-D, --bindDN bindDN

-E, --reportAuthzID

-h, --hostname address

-j, --bindPasswordFile bindPasswordFile

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-K, --keyStorePath keyStorePath

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-N, --certNickName certNickName

証明書ベースのクライアント認証に対して指定された証明書を使用します。

-o, --saslOption name=value

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-p, --port port

指定されたポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、デフォルトのポート389が使用されます。

-P, --trustStorePath trustStorePath

-q, --useStartTLS

ディレクトリ・サーバーと通信する際、StartTLS拡張操作を使用します。このオプションは、--useSSLと同時に使用しないでください。

-r, --useSASLExternal

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

--trustStorePassword trustStorePassword

-u, --keyStorePasswordFile keyStorePasswordFile

--usePasswordPolicyControl

バインド・リクエストにパスワード・ポリシー・リクエスト制御を使用して、ディレクトリ・サーバーがバインド・レスポンスで対応する結果制御を返すようにします。これは、クライアントのアカウントの状態に関連した警告またはエラーに関する情報の取得に使用できます。

-U, --trustStorePasswordFile trustStorePasswordFile

-V, --ldapVersion version

-w, --bindPassword bindPassword

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。

-W, --keyStorePassword keyStorePassword

-X, --trustAll

-Z, --useSSL

A.4.5.7 コマンド入力/出力オプション

--noPropertiesFile: デフォルトのコマンドライン・オプションの取得にプロパティ・ファイルが使用されないことを示します。
--propertiesFilePath propertiesFilePath: デフォルトのコマンドライン・オプションが含まれているプロパティ・ファイルへのパスを指定します。
-T, --dontWrap: 一致エントリを表示するときに、長い行の折り返しを行いません。このオプションが指定されない場合、長い行は80列の端末に収まるように(LDIF仕様と適合する方法で)折り返されます。
-v, --verbose: 冗長モードで実行して、プロセス情報と診断情報を標準出力で表示します。

A.4.5.8 一般オプション

-?, -H, --help: このコマンドに対するコマンドライン使用情報を表示し、コマンドの実行を試みないで終了します。
-V, --version: ディレクトリ・サーバーのバージョン情報を表示します。

A.4.5.9 例

次の例は、ldapsearchコマンドの使用方法を示しています。その他の例については、第17.4項「ディレクトリ・データの検索」を参照してください。

例A-138 すべてのエントリを返す

次のコマンドは、ディレクトリ・サーバー上のすべてのエントリを返します。このコマンドは、ホスト(-h)上のデフォルトのポート1389 (-p)に接続し、ベースDNをexample.com (-b)として指定し、検索フィルタ(objectclass=*)を使用してすべてのエントリを返します。範囲(-s)が指定されていないため、範囲はデフォルト値であるsub、ベースDNの完全なサブツリーに設定されます。属性が指定されていないため、すべての属性と値が返されます。

$ ldapsearch -h hostname -p 1389 -b dc=example,dc=com "(objectclass=*)"

dn: dc=example,dc=com
objectClass: domain
objectClass: top
dc: example

dn: ou=Groups,dc=example,dc=com
objectClass: organizationalunit
objectClass: top
ou: Groups

dn: cn=Directory Administrators,ou=Groups,dc=example,dc=com
objectClass: groupofuniquenames
objectClass: top
ou: Groups
cn: Directory Administrators
uniquemember: uid=kvaughan, ou=People, dc=example,dc=com
uniquemember: uid=rdaugherty, ou=People, dc=example,dc=com
uniquemember: uid=hmiller, ou=People, dc=example,dc=com

例A-139 値を除く属性名を返す

次のコマンドは、属性名(-A)を返しますが、値は返しません。このコマンドは、ホスト(-h)上のデフォルトのポート1389 (-p)に接続し、ベースDNをdc=example,dc=com (-b)として指定し、検索フィルタobjectclass=*を使用してすべてのエントリを一致させ、3つのエントリ(-z)を返します。属性がデータベースに存在するかどうかをチェックする場合は、-Aオプションを使用すると便利です。

$ ldapsearch -h hostname -p 1389 -b dc=example,dc=com -A -z 3 "(objectclass=*)"

dn: dc=example,dc=com
objectClass
dc

dn: ou=Groups,dc=example,dc=com
objectClass
ou

dn: cn=Directory Administrators,ou=Groups,dc=example,dc=com
objectClass
ou
cn
uniquemember

例A-140 特定の属性値を返す

次のコマンドは、特定の属性とその値を返します。このコマンドは、ホスト(-h)上のポート1389 (-p)に接続し、ベースDNをdc=example,dc=com (-b)として指定し、検索フィルタcn=Sam Carterを使用してすべてのエントリを一致させ、属性(telephonenumber)の値を返します。

$ ldapsearch -h hostname -p 1389 -b dc=example,dc=com "(cn=Sam Carter)" telephoneNumber

dn: uid=scarter,ou=People,dc=example,dc=com
telephonenumber: +1 408 555 4798

例A-141 ルートDSEを返す

ルートDSEは、ディレクトリ・サーバーの名前、バージョン、ネーミング・コンテキスト、およびサポートされる機能についての情報を提供する特殊なエントリです。ルートDSEを指定するには、null値を持つベースDN(例: -b "")を使用します。このベースDNは、デフォルトではすべてのパブリック・ネーミング・コンテキストの下をディレクトリ・サーバーが検索する際の基準となります。デフォルトのnullのベースDNをオーバーライドするには、dsconfigコマンドを使用して、subordinate-base-dnプロパティが指定されている特定のベースDNのセットを指定します。次の例では、ホスト(-h)上のデフォルトのポート1389 (-p)に接続し、ルートDSEを空のベース・エントリ(-b)として指定し、検索の範囲をbase (-s)に指定し、検索フィルタobjectclass=*を使用してすべてのエントリを一致させ、サポートされる制御に対してディレクトリ・サーバーのルートDSE情報を返します:

$ ldapsearch -h hostname -p 1389 -b "" -s base "(objectclass=*)" supportedControl

dn:
supportedControl: 1.2.826.0.1.3344810.2.3
supportedControl: 1.2.840.113556.1.4.319
supportedControl: 1.2.840.113556.1.4.473
supportedControl: 1.2.840.113556.1.4.805
...

例A-142 サーバー認証を使用した検索

次のコマンドは、SSLオプションを使用してサーバー認証による検索を実行します。次のコマンドでは、ホスト名(-h)、SSLポート1636 (-p)、ベースDN (-b)、バインドDN (-D)、バインド・パスワード(-w)、トラスト・ストア・ファイル・パス(-P)、およびエンティティの名を指定します。Windowsプラットフォームの場合は、トラスト・ストア・ファイルのパス(たとえば、-P \certs\cert.db)を指定します。

$ ldapsearch -h hostname -p 1636 -b "dc=example,dc=com" \
-D "uid=scarter,ou=people,dc=example,dc=com" -w bindPassword \
-P /home/scarter/certs/cert.db "(givenname=Sam)"

例A-143 クライアント認証を使用した検索

次のコマンドは、SSLオプションを使用してクライアント認証による検索を実行します。このコマンドはSSLポート(-p)を指定してSSL (-Z)を使用し、トラスト・ストア・ファイル・パス(-P)、証明書ニックネーム(-N)、キーストア・ファイル・パス(-K)、キーストア・パスワード(-W)およびエンティティの名(givenname=Sam)を指定します。Windowsプラットフォームの場合は、トラスト・ストア・ファイルのパス(たとえば、-P \certs\cert.db)およびキーストア・ファイルのパス(たとえば、-K \security\key.db)を指定します:

$ ldapsearch -h hostname -p 1636 -b "dc=example,dc=com" \
-Z -P /home/scarter/security/cert.db -N "sccert" \
-K /home/scarter/security/key.db -W KeyPassword \
"(givenname=Sam)"

例A-144 ユーザーの有効権限を返す

次のコマンドは、ユーザーの属性エントリのほかに、ユーザーに付与されている有効権限を返します。ディレクトリ管理者のみが、別のユーザーに関してこの情報にアクセスできます。このコマンドでは、ホスト名(-h)、ポート1389 (-p)、bindDN (-D)、bindDNパスワード(-w)、ベースDN (-b)、OID名effectiverightsを含むコントロール・スペック・オプション(または、同等のOID: 1.3.6.1.4.1.42.2.27.9.5.2が入力可能)、検索フィルタobjectclass=*、およびaclRights属性を指定します。

$ ldapsearch -h hostname -p 1389 -D "cn=Directory Manager" -j pwd-file \
-b dc=example,dc=com -J "1.3.6.1.4.1.42.2.27.9.5.2"  "(objectclass=*)" \
aclRights

dn: dc=example,dc=com
aclRights;entryLevel: add:0,delete:0,read:1,write:0,proxy:0

dn: ou=Groups, dc=example,dc=com
aclRights;entryLevel: add:0,delete:0,read:1,write:0,proxy:0

dn: ou=People, dc=example,dc=com
aclRights;entryLevel: add:0,delete:0,read:1,write:0,proxy:0

dn: cn=Accounting Managers,ou=groups,dc=example,dc=com
aclRights;entryLevel: add:0,delete:0,read:1,write:0,proxy:0

dn: cn=HR Managers,ou=groups,dc=example,dc=com
aclRights;entryLevel: add:0,delete:0,read:1,write:0,proxy:0

dn: uid=bjensen,ou=People, dc=example,dc=com
aclRights;entryLevel: add:0,delete:0,read:1,write:0,proxy:0

dn: uid=cfuente, ou=People, dc=example,dc=com
aclRights;entryLevel: add:0,delete:0,read:1,write:1,proxy:0

例A-145 スキーマを返す

次のコマンドは、ディレクトリ・インスタンスで定義されたオブジェクト・クラスと属性に関してcn=schemaエントリを検索します。このコマンドは、ホスト(-h)上のポート1389 (-p)に接続し、検索の範囲をbase (-s)に設定し、検索フィルタ(objectclass=\*)を使用してすべてのエントリを一致させ、スキーマ・エントリcn=schemaにあるobjectClassの定義を返します。+記号を使用してスキーマを表示することもできます。プラス記号は検索フィルタの後ろに入れます。

$ ldapsearch -h hostname -p 1389 -b cn=schema -s base "(objectclass=*)" objectClasses

dn: cn=schema
objectClasses: ( 2.5.6.0 NAME 'top' ABSTRACT MUST objectClass X-ORIGIN 'RFC 4512
' )
objectClasses: ( 2.5.6.1 NAME 'alias' SUP top STRUCTURAL MUST aliasedObjectName
X-ORIGIN 'RFC 4512' )
objectClasses: ( 2.5.6.2 NAME 'country' SUP top STRUCTURAL MUST c MAY ( searchGu
ide $ description ) X-ORIGIN 'RFC 4519' )
objectClasses: ( 2.5.6.3 NAME 'locality' SUP top STRUCTURAL MAY ( street $ seeAl
so $ searchGuide $ st $ l $ description ) X-ORIGIN 'RFC 4519' )
...

例A-146 永続検索の実行

ldapsearchコマンドは、永続検索(-C)を実行するオプションを指定します。このオプションにより、接続はオープンのまま維持され、変更(add、delete、mod、またはall)が発生した場合でも常に範囲とフィルタに一致するエントリが表示されます。このコマンドは、ポート1389 (-p)に接続し、検索の範囲をbase (-s)に設定し、検索フィルタ(objectclass=\*)を使用してすべてのエントリを一致させます。検索を終了するには、[Control]-[C]キーを押します。

$ ldapsearch -b dc=example,dc=com -p 1389 -D "cn=Directory Manager" \
-j pwd-file -C ps:add:true:true "(objectclass=*)"

例A-147 ACI属性の表示

次のコマンドは、指定されたベースDNからアクセス制御指示(ACI)の属性を表示します。このコマンドは、ポート1389 (-p)に接続し、検索の範囲をbase (-s)に設定し、検索フィルタ(objectclass=\*)を使用してすべてのエントリを一致させて、aci属性を指定します。

$ ldapsearch -p 1389 -D "cn=Directory Manager" -j pwd-file -b dc=example,dc=com \
-s base "(objectclass=*)" aci

dn: dc=example,dc=com
aci: (target ="ldap:///dc=example,dc=com")(targetattr h3.="userPassword")(version
3.0;acl "Anonymous read-search access";allow (read, search, compare)(userdn = "
ldap:///anyone");)
aci: (target="ldap:///dc=example,dc=com") (targetattr = "*")(version 3.0; acl "a
llow all Admin group"; allow(all) groupdn = "ldap:///cn=Directory Administrator
s,ou=Groups,dc=example,dc=com";)

例A-148 監視情報の表示

次のコマンドは、ディレクトリ・サーバーでのアクティビティの情報に関してcn=monitorエントリを検索します。次のコマンドでは、ホスト名(-h)、ポート(-p)、cn=monitorのベースDN (-b)を指定し、バインドDN(-D)およびバインド・パスワード(-w)を使用して認証し、フィルタ(objectclass=\*)を指定します。

$ ldapsearch --useSSL -X -h hostname -p 4444 -b cn=monitor -D "cn=Directory Manager" \
-j pwd-file "(objectclass=*)"

dn: cn=monitor
objectClass: top
objectClass: extensibleObject
objectClass: ds-monitor-entry
currentTime: 20070803161832Z
startTime: 20070803132044Z
productName: Oracle Unified Directory
...

例A-149 プロパティ・ファイルを使用した検索

ディレクトリ・サーバーでは、ldapsearchコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、第A.1.2項「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。

プロパティ・ファイルに保存可能なオプションは次のとおりです:

assertionFilter
bindDN
bindPassword
bindPasswordFile
certNickname
continueOnError
control
countEntries
dereferencePolicy
dry-run
dontWrap
filename
getEffectiveRightsAttribute
getEffectiveRightsAuthzid
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
ldapVersion
matchedValuesFilter
persistentSearch
port
proxyAs
reportAuthzID
saslOption

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
searchScope
simplePageSize
sizeLimit
sortOrder
timeLimit
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
typesOnly
usePasswordPolicyControl
useSASLExternal

SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
useSSL
useStartTLS
verbose
virtualListView

A.4.5.10 プロパティ・ファイルを使用して検索するには

任意のテキスト・エディタでプロパティ・ファイルを作成します。ここでは、ファイルをtools.propertiesとして保存します。
```
hostname=host
port=1389
bindDN=cn=Directory Manager
bindPassword=password
baseDN=dc=example,dc=com
searchScope=sub
sortOrder=givenName
virtualListView=0:2:1:0
```
--propertiesFilePathオプションを指定してldapsearchを使用します。$ldapsearch --propertiesFilePath tools.properties "(objectclass=*)"

A.4.5.11 検索属性

多数の特殊な検索属性を、次に示すように様々な目的で使用することもできます:

*: この記号は、ディレクトリ・サーバーから返されたエントリにすべてのユーザー属性を含める必要があることを示します。

$ ldapsearch -h hostname -p 1389 -b dc=example,dc=com "(objectclass=*)" *

+: この記号は、ディレクトリ・サーバーから返されたエントリにすべての操作属性が含まれることを示します。デフォルトでは、操作属性は返されません。これが指定された場合でも、たとえば、値の構成に使用される計算量が多い場合などの理由で、自動的に返されない操作属性が存在する可能性があることに注意してください。)システムによっては、+記号を引用符で囲むか("+")、バックスラッシュ\+を使用してプラス記号をエスケープしなければならない場合があります。

$ ldapsearch -h hostname -p 1389 -b dc=example,dc=com "(objectclass=*)" "+"

1.1: これは、一致するエントリに属性値を含められないことを示します。システムによっては、1.1文字を引用符で囲むか("1.1")、バックスラッシュ\1.1を使用してエスケープしなければならない場合があります。

$ ldapsearch -h hostname -p 1389 -b dc=example,dc=com "(objectclass=*)" "1.1"

@_objectclass_: これは、指定されたオブジェクト・クラスに関連付けられているすべての属性を、ディレクトリ・サーバーから返されたエントリに含める必要があることを示します。たとえば、@personは、サーバーがpersonオブジェクト・クラスに関連付けられているすべての属性を含める必要があることを示します。

$ ldapsearch -h hostname -p 1389 -b dc=example,dc=com "(objectclass=*)" @person

A.4.5.12 終了コード

終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。

A.4.5.13 場所

UNIXおよびLinux: INSTANCE_DIR/OUD/bin/ldapsearch
Windows: INSTANCE_DIR\OUD\bat\ldapsearch.bat

A.4.5.14 関連コマンド

第A.4.1項「ldapcompare」
第A.4.2項「ldapdelete」
第A.4.3項「ldapmodify」
第A.4.4項「ldappasswordmodify」

A Oracle Unified Directoryコマンドライン・インタフェース

A.1 一般的なコマンドラインの使用方法に関する情報

A.1.1 サーバー・コマンドとその使用のサマリー

A.1.2 サーバー・コマンドによるプロパティ・ファイルの使用方法

A.1.2.1 プロパティ・ファイルの検索

A.1.2.2 オプションおよびプロパティの優先順位

A.2 サーバー管理コマンド

A.2.1 create-rc-script

A.2.1.1 シノプシス

A.2.1.2 説明

A.2.1.3 オプション

A.2.1.4 一般オプション

A.2.1.5 例

A.2.1.6 create-rc-scriptコマンドにより生成されるコード

A.2.1.7 終了コード

A.2.1.8 場所

A.2.1.9 関連コマンド

A.2.2 dps2oud

A.2.2.1 シノプシス

A.2.2.2 説明

A.2.2.3 オプション

A.2.2.4 LDAP接続オプション

A.2.2.5 一般オプション

A.2.2.6 例

A.2.2.7 終了コード

A.2.2.8 場所

A.2.2.9 関連コマンド

A.2.3 ds2oud

A.2.3.1 シノプシス

A.2.3.2 説明

A.2.3.3 オプション

A.2.3.4 Oracle Directory Server Enterprise EditionのLDAP接続オプション

A.2.3.5 Oracle Unified DirectoryのLDAP接続オプション

A.2.3.6 コマンド入力/出力オプション

A.2.3.7 一般オプション

A.2.3.8 例

A.2.3.9 終了コード

A.2.3.10 場所

A.2.3.11 関連コマンド

A.2.4 dsconfig

A.2.4.1 シノプシス

A.2.4.2 説明

A.2.4.3 ヘルプ・サブコマンド

A.2.4.4 一般サブコマンド

A.2.4.5 分散サブコマンド

A.2.4.6 一般構成サブコマンド

A.2.4.7 ロード・バランシング・サブコマンド

A.2.4.8 ローカル記憶域サブコマンド

A.2.4.9 その他のワークフロー要素サブコマンド

A.2.4.10 リモート記憶域サブコマンド

A.2.4.11 レプリケーション・サブコマンド

A.2.4.12 スキーマ・サブコマンド

A.2.4.13 セキュリティ・サブコマンド

A.2.4.14 仮想化サブコマンド

A.2.4.15 オプション

A.2.4.16 LDAP接続オプション

A.2.4.17 コマンド入力/出力オプション

A.2.4.18 一般オプション

A.2.4.19 例

A.2.4.20 終了コード

A.2.4.21 プロパティ・ファイルの使用方法

A.2.4.22 場所

A.2.4.23 関連コマンド

A.2.5 dsjavaproperties

A.2.5.1 シノプシス

A.2.5.2 説明

A.2.5.3 オプション

A.2.5.4 例

A.2.5.5 終了コード

A.2.5.6 場所

A.2.6 dsreplication

A.2.6.1 シノプシス

A.2.6.2 説明

A.2.6.3 サーバー・サブコマンド

A.2.6.4 オプション

A.2.6.5 構成オプション

A.2.6.6 LDAP接続オプション

A.2.6.7 コマンド入力/出力オプション

A.2.6.8 一般オプション

A.2.6.9 例

A.2.1.6 `create-rc-script`コマンドにより生成されるコード