A.1 Oracle Unified Directoryコマンド行インタフェース・リファレンス
この付録では、Oracle Unified Directory 11g リリース2 (11.1.2)で提供されるすべてのコマンドについて説明します。コマンドの中には、ディレクトリ・サーバー・インスタンスに固有であって、プロキシ・サーバーの構成には使用できないものがあります。同様に、プロキシに固有で、ディレクトリ・サーバーの構成に使用できないコマンドもあります。
A.1.1 一般的なコマンド行の使用方法に関する情報
サーバー・コマンドの使用方法に関する一般的な情報は、これらのトピックを参照してください。
A.1.1.1 サーバー・コマンドとその使用のサマリー
この項の各表は、サーバー・コマンドとその使用方法のサマリーを示しています。表で使用する凡例は次のとおりです:
- リモート
-
コマンドはリモート・サーバーで起動できます。
- オフライン
-
コマンドはサーバーが停止しているときに起動できます。
- オンライン
-
コマンドは実行中のサーバー・インスタンスに接続しています。
- 管理ポートのみ
-
コマンドは、管理コネクタを使用してサーバー(デフォルトでは、ポート4444にあります)にアクセスする必要があります。
ノート:
以降の各表に示すすべてのコマンドがプロキシ・サーバー・インスタンス用にサポートされているわけではありません。
次の表に、サーバー管理コマンドを示します。
表A-1 サーバー管理コマンド
コマンド | リモート | オフライン | オンライン | 管理コネクタ |
---|---|---|---|---|
create-rc-script |
||||
dsconfig |
|
|
|
|
dsjavaproperties |
|
|||
dsreplication |
|
|
|
|
gicadm |
|
|
|
|
oudExtractMovePlan |
|
|
||
oudCopyConfig |
|
|
||
oudPasteConfig |
|
|||
start-ds |
|
|||
status |
|
|
|
|
stop-ds |
|
|
|
|
uninstall |
|
|
|
|
upgrade |
|
|||
windows-service |
|
次の表に、データ管理コマンドを示します。
表A-2 データ管理コマンド
コマンド | リモート | オフライン | オンライン | 管理コネクタ |
---|---|---|---|---|
backup |
|
|
|
|
base64 |
|
|||
dbtest |
|
|||
encode-password |
|
|||
export-ldif |
|
|
|
|
import-ldif |
|
|
|
|
ldapcompare |
|
|
||
ldapdelete |
|
|
||
ldapmodify |
|
|
||
ldappasswordmodify |
|
|
||
ldapsearch |
|
|
||
ldif-diff |
|
|||
ldifmodify |
|
|||
ldifsearch |
|
|||
list-backends |
|
|||
make-ldif |
|
|||
manage-account |
|
|
|
|
manage-tasks |
|
|
|
|
purge-backup |
|
|
|
|
rebuild-index |
|
|||
restore |
|
|
|
|
split-ldif |
|
|
||
verify-index |
|
* このコマンドはリモートに起動できますが、データ・ファイルはサーバーが実行しているホスト上にある必要があります。
A.1.1.2 サーバー・コマンドによるプロパティ・ファイルの使用方法
特定のコマンド行ユーティリティは、コマンド・プロパティ・ファイルを使用して、次のようなオプションにデフォルト値を指定できます:
-
サーバーのホスト名およびポート番号
-
サーバーとの通信にSSLまたはStartTLSを使用するかどうか
-
サーバーへの接続時に使用するバインドDN
A.1.1.2.1 プロパティ・ファイルを使用可能なユーティリティ
次のユーティリティはプロパティ・ファイルを使用できます:
-
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
次の相互に排他的なオプションは、プロパティ・ファイルが使用されているかどうかを示すためにコマンド行ユーティリティとともに使用します:
A.1.1.2.2 プロパティ・ファイルの配置方法
共通のプロパティ・ファイルを使用するユーティリティには、次のデフォルトの動作が設定されています:
-
--noPropertiesFile
オプションを指定した場合、コマンド行インタフェースはプロパティ・ファイルの検索を試行しません。コマンド行で指定されたオプションのみが評価されます。 -
--propertiesFilePath
オプションを指定した場合、プロパティ値はこのファイルから読み取られます。 -
--propertiesFilePath
と--noPropertiesFile
がどちらも指定されなかった場合、コマンド行インタフェースは次の場所でプロパティ・ファイルの検索を試行します:-
USERDIRECTORY
/.opends/tools.properties
-
INSTANCE_DIR
/OUD/config/tools.properties
-
-
このいずれの場所でもプロパティ・ファイルが見つからなかった場合は、デフォルト動作が適用されます(コマンド行で指定された引数のみが評価されます)。
A.1.1.2.3 オプションおよびプロパティの優先順位
オプションがコマンド行で指定された場合、そのオプションとそれに対応する値がコマンド行インタフェースによって使用されます。つまり、コマンド行で指定されたオプションが、プロパティ・ファイルで定義されたプロパティよりも優先されます。
プロパティ・ファイルは標準の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.1.1.3 サーバー・コマンドでのパスワード・ファイルの使用
特定のコマンド行ユーティリティでは、実行されるバインドを使用するユーザー・アカウントまたはエントリ(bindDN
)のパスワードのみが含まれるパスワード・ファイルが必要です。クリア・テキストの書式でコマンド行に渡すのではなく、指定したファイルのバインド・パスワードを使用します。
次のステップを実行して、pwd-file
などのテキスト・ファイルを作成し、bindDN
パスワードを保存します。
-
パスワードを格納するためのテキスト・ファイルを作成する場所に移動します。
-
次のように、パスワードのみが含まれるテキスト・ファイルを作成します。
vi pwd-file
-
パスワードを入力します。
-
保存してファイルを閉じます。
このパスワード・ファイルpwd-file
を使用して、-j
または--bindPasswordFile
パラメータをコマンド行ユーティリティに指定します(dsconfig
、dsreplication
、oud-setup
など)。
現在のディレクトリに存在しない場合は、パスワード・ファイルの絶対または相対パスを常に指定する必要があります。
A.1.1.4 サーバー・コマンドのCLIログ構成の管理
dsreplication
やstatus
などの一部のサーバー管理コマンドは、oud- replication- IDnumberおよびoud- status- IDnumberというクライアント側のログ・ファイルを生成します。ここで、IDnumber
は10進数です。
ログ・ファイルは、次の場所にあります:
- UNIX (Solaris):
/var/tmp/
- Linux:
/tmp/
- Windows:
%TEMP%
デフォルトでは、ログ・ファイル・フォルダは
C:\Documents and Settings\User\Local Settings\Temp
です。
次のJVM引数を使用して、ログ・ファイルの生成および場所を構成できます:
次のコンテンツは、OUDバンドル・パッチ12.2.1.3.221009以降のリリースにのみ適用されます。
-Dcli.log.level
:dsreplication
およびstatus
CLIツールのロギング・レベルを設定します。有効な値は、
OFF、SEVERE、WARNING、INFO、CONFIG、FINE、FINER、FINEST、ALL
です。ロギングを無効にするには、レベル値OFF
を使用します。-Dcli.log.location
: デフォルトのログ・ファイルの場所を、ログ・ファイルを書き込む必要があるカスタムの場所に置き換えます。
A.1.2.5 dsjavapPropertyiesの例セクションの手順に従って、status
およびdsreplication
CLI設定を変更します。
例1
status
CLIログを無効にするには、次のようにjava.propertiesを変更します:
status.java-args=-client -Dcli.log.level=OFF
例2
dsreplication
CLIログをカスタムの場所にリダイレクトするには、java.propertiesを次のように変更します:
dsreplication.java-args=-client -Dcli.log.location=/scratch/OUD_CLI_LOGS
A.1.2 サーバー管理コマンド
各サーバー管理コマンドの様々なオプションおよび例を確認できます。
A.1.2.1 create-rc-script
create-rc-script
コマンドは、ディレクトリ・サーバーを起動、停止、および再起動するシェル・スクリプトを生成します。
シノプシス
create-rc-script
[options]
説明
create-rc-script
コマンドは、ディレクトリ・サーバーを起動、停止、および再起動するシェル・スクリプトの生成に使用できます。ディレクトリ・サービスのニーズに適合するように結果のスクリプトを更新できます。このコマンドは、UNIXシステムまたはLinuxシステムのみで使用できます。
create-rc-script
コマンドは、OPENDS_JAVA_*
変数とJAVA_*
変数を使用します。
オプション
create-rc-script
コマンドは、短いフォーム(たとえば、-f
filename)または同等の長いフォーム(たとえば、--outputFile
filename)のいずれかのオプションを受け入れます。
例
この項の例は、create-rc-script
コマンドの使用方法について説明しています。
スクリプトの作成
次のコマンドは、ディレクトリ・サーバーを起動、停止、および再起動するスクリプトを生成します。-f
オプションによって指定されたmyscript
というファイルが作成されます:
$ create-rc-script -f myscript
新規スクリプトを使用したディレクトリ・サーバーの起動
次のコマンドでは、ディレクトリ・サーバーを起動するために、新しく作成されたスクリプト(前の例を参照)を使用しています。
$ myscript start
新規スクリプトを使用したディレクトリ・サーバーの停止
次のコマンドでは、ディレクトリ・サーバーを停止するために、新しく作成されたスクリプト(最初の例を参照)を使用しています。
$ myscript stop
新規スクリプトを使用したディレクトリ・サーバーの再起動
次のコマンドでは、ディレクトリ・サーバーを再起動するために、新しく作成されたスクリプト(最初の例を参照)を使用しています。
$ myscript restart
スクリプトでのJAVA_HOMEおよびJAVA_ARGSの指定
次のコマンドは、-u
(--userName
), -j
(--javaHome
)オプションおよび-J
(--javaArgs
)オプションを使用しています。
$ create-rc-script -f myscript -u sysAdmin -j /usr/java -J "-Xms128m -Xmx128m"
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
終了コード
終了コード0は成功を示します。ゼロ以外の終了コードは、エラーが発生したことを示します。
場所
create-rc-script
コマンドは、次のパスに置かれています:
UNIXおよびLinux: INSTANCE_DIR/OUD/bin
A.1.2.2 dps2oud
dps2oud
コマンドによって、ディレクトリ・プロキシ・サーバー(DPS)構成をOracle Unified Directory構成に移行できます。
シノプシス
dps2oud
[options]
説明
dps2oud
コマンドによって、DPS構成をOracle Unified Directory構成に移行できます。dps2oud
コマンドはDPS構成を入力として取り込み、同等のOracle Unified Directory構成の作成に使用されるdsconfig
コマンドからなるバッチ・ファイルを生成します。dps2oud
コマンドは、ファイルから、または実行中のDPSインスタンス上のLDAPプロトコルを通してDPS構成を読み取ります。
オプション
dps2oud
コマンドは、次のオプションを受け入れます。
LDAP接続オプション
一般オプション
例
次の例は、dps2oud
コマンドの使用方法を示しています。
グローバル・ヘルプ・サブコマンドの表示
次のコマンドは、使用可能なグローバル・ヘルプ・サブコマンドを表示します:
$ dps2oud --help
ディレクトリ・プロキシ・サーバー構成の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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/dps2oud
-
Windows: INSTANCE_DIR
\OUD\bat\dps2oud.bat
関連コマンド
A.1.2.3 ds2oud
ds2oud
コマンドは、Oracle Directory Server Enterprise Editionディレクトリ・サーバー・インスタンスからOracle Unified Directoryへの移行を管理します。
シノプシス
ds2oud
[options]
説明
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インスタンスが接尾辞を使用せずに構成されていることを確認する必要があります。
オプション
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サーバーへ伝播します。
スキーマの移行は、構成を移行する前に行う必要があります。そうしないと、移行によって予測できない結果がもたらされる可能性があるためです。
-
-A, --adaptDseeData {file}
-
Oracle Unified Directoryでのインポートを容易にするために、Oracle Directory Server Enterprise Edition 6.3 LDIFデータ・ファイルを使用し、結果ファイル
{
file}_result.ldif
を生成します -
-w, --uniqueWorkflowElement
-
移行するすべてのネーミング・コンテキストに対して一意のワークフロー要素を使用します。これは
-c
サブコマンドに適用されます。
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がサーバーの証明書を受け入れるかどうかを判別する必要があります。
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
-
Oracle Unified DirectoryのSSL暗号化の接続を確立します。
-
--oudTrustStorePath
trustStorePath -
指定されたパスにOracle Unified Directoryのトラスト・ストア証明書を使用します。
-
--oudTrustStorePasswordFile
filename -
Oracle Unified Directoryのトラスト・ストアの証明書にアクセスするには、指定されたファイルでパスワードを使用します。このオプションは、
--oudTrustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。 -
--oudTrustAll
-
Oracle Unified Directoryサーバーによって提示されるすべての証明書を信頼します。このオプションはテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してOracle Unified Directoryがサーバーの証明書を受け入れるかどうかを判別する必要があります。
コマンド入力/出力オプション
-
-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の構成パラメータを移行するため)。
一般オプション
例
次の例は、ds2oud
コマンドの使用方法を示しています。
グローバル・ヘルプ・サブコマンドの表示
次のコマンドは、使用可能なグローバル・ヘルプ・サブコマンドを表示します:
$ ds2oud --help
コマンド行からの対話モードでの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 the user schema and global configuration parameters 4) Migrate the user schema only 5) Migrate global configuration parameters only 6) Adapt DSEE 6.3 LDIF data file to ease import on OUD c) cancel
前のアクションごとに、まず、接続オプションをOracle Directory Server Enterprise Editionサーバーに対して指定するか(診断の場合)、Oracle Directory Server Enterprise EditionサーバーとOracle Unified Directoryサーバーの両方に対して指定する(移行の場合)必要があります。
データ診断用の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
既存の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
終了コード
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ds2oud
-
Windows: INSTANCE_DIR
\OUD\bat\ds2oud.bat
関連コマンド
A.1.2.4 dsconfig
dsconfig
コマンドにより、Directory Serverの基本構成を定義できます。
シノプシス
dsconfig
[subcommands] [Options]
説明
dsconfig
コマンドにより、サーバー・インスタンスの基本構成を作成、管理、および削除できます。このサーバー構成は、dsconfig
が1つ以上のサブコマンドを使用してアクセスできる一連のコンポーネントとして編成されます。すべてのコンポーネントには、ゼロ個以上の構成プロパティが割り当てられています。これらのプロパティに対して問合せを実行し、コンポーネントの動作を変更するように修正できます。
dsconfig
コマンドは、管理コネクタを介してSSL上のサーバーにアクセスします(「サーバーへの管理トラフィックの管理」で説明しています)。
すべての構成パラメータと-n
(--no-prompt
)オプションを指定した場合を除き、dsconfig
は対話モードで実行します。対話モードは、サーバー構成のすべての局面を1つずつ実行するウィザードのように機能します。詳細は、「対話型モードでのdsconfigの使用」を参照してください。
ヘルプ・サブコマンド
dsconfig
コマンドは、基本構成の管理に必要なコンポーネントのサブコマンドをリストしたヘルプ関数を指定します。
-
--help-distribution
-
分散に関連するサブコマンドを表示します。
-
--help-general-configuration
-
一般構成に関連するサブコマンドを表示します。
-
--help-integration
-
統合に関連するサブコマンドを表示します。
-
--help-load-balancing
-
ロード・バランシングに関連するサブコマンドを表示します。
-
--help-local-datasource
-
ローカル・データ・ソースに関連するサブコマンドを表示します。
-
--help-remote-datasource
-
リモート・データ・ソースに関連するサブコマンドを表示します。
-
--help-replication
-
レプリケーションに関連するサブコマンドを表示します。
-
--help-schema
-
スキーマに関連するサブコマンドを表示します。
-
--help-security
-
認証および認可に関連するサブコマンドを表示します。
-
--help-virtualization
-
仮想化に関連するサブコマンドを表示します。
-
--help-all
-
すべてのサブコマンドを表示します。
一般サブコマンド
次のサブコマンドは、サーバー・インスタンスのオブジェクトとプロパティをリストします。
- list-properties
-
管理対象のオブジェクトとプロパティを表示します。オプション・タイプは次のとおりです:
r
— プロパティ値は読取り可能です。w
— プロパティ値は書込み可能です。m
— プロパティは必須です。s
— プロパティは単一値です。a
— 変更を有効にするには管理アクションが必要です。サブオプションは次のとおりです:
-t, --type
type。コンポーネント・タイプ。-c, --category
category。コンポーネントのカテゴリ。type
の値は、--categoryサブオプションを使用して指定されるcategory
に関連付けられたコンポーネント・タイプの1つである必要があります。--inherited
。コンポーネントの継承プロパティを表示するように表示出力を変更します。--advanced
。コンポーネントの拡張プロパティを表示するように表示出力を変更します。--property
property。表示されるプロパティの名前。
分散サブコマンド
次のサブコマンドにより、ディレクトリ・サーバーの基本構成を定義できます。
-
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。新しい分散パーティションの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する分散パーティションのタイプ。typeの値には、capacity
、dnpattern
、generic、lexico
、またはnumeric
のいずれかを指定できます。 -
create-workflow-element --type distribution
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-global-index
-
グローバル索引を作成します。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--index-name
name。新しいグローバル索引の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-extension
--type
global-index-catalog
-
拡張を作成します。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する拡張のタイプ。タイプの値には、global-index-catalog
、global-index-catalogs-shared-cache、ldap-server
のいずれかを指定できます。 -
create-global-index-catalog-replication-domain
-
グローバル索引カタログ・レプリケーション・ドメインを作成します。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-extension --type global-index-catalogs-shared-cache
-
拡張を作成します。サブオプションは次のとおりです:
--extension-name
name。新しい拡張の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、chema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。 -
create-workflow-element --type global-index-replication-changes-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、chema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。 -
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
-
このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、「gicadm」を参照してください
グローバル索引カタログ・レプリケーション・ドメインを削除します。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。-f,--force
。存在しないグローバル索引カタログ・レプリケーション・ドメインを無視します。 -
delete-workflow-element
-
ワークフロー要素を削除します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。-f,--force
。存在しないワークフロー要素を無視します。 -
get-data-encryption-prop
-
データ暗号化のプロパティを表示します。サブオプションは次のとおりです:
--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-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つのプロパティ値を表示するように変更します。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
get-global-index-catalog-replication-domain-prop
-
このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、「gicadm」を参照してください
グローバル索引カタログ・レプリケーション・ドメインのプロパティを表示します。サブオプションは次のとおりです:
--extension-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-global-index-prop
-
このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、「gicadm」を参照してください
グローバル索引のプロパティを表示します。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--index-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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-distribution-algorithm
-
このコマンドはプロキシのみにサポートされます。
既存の分散アルゴリズムをリストします。サブオプションは次のとおりです:
--element-name
name。分散ワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-distribution-partitions
-
このコマンドはプロキシのみにサポートされます。
既存の分散パーティションをリストします。サブオプションは次のとおりです:
--element-name
name。分散ワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-extensions
-
既存の拡張をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-global-index-catalog-replication-domain
-
このコマンドはプロキシのみにサポートされます。グローバル索引を管理するには、「gicadm」を参照してください
既存のグローバル索引カタログ・レプリケーション・ドメインをリストします。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-global-indexes
-
既存のグローバル索引をリストします。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-data-encryption-prop
-
データ暗号化のプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-distribution-algorithm-prop
-
このコマンドはプロキシのみにサポートされます。
分散アルゴリズムのプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。分散ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-distribution-partition-prop
-
このコマンドはプロキシのみにサポートされます。
分散パーティションのプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。分散ワークフロー要素の名前。--partition-name
name。分散パーティションの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-extension-prop
-
拡張のプロパティを変更します。サブオプションは次のとおりです:
--extension-name name。拡張の名前。
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-global-index-catalog-replication-domain-prop
-
このコマンドはプロキシのみにサポートされます。
グローバル索引カタログ・レプリケーション・ドメインのプロパティを変更します。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-global-index-prop
-
このコマンドはプロキシのみにサポートされます。
グローバル索引のプロパティを変更します。サブオプションは次のとおりです:
--extension-name
name。グローバル索引カタログ拡張の名前。--index-name
name。 グローバル索引の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-workflow-element-prop
-
ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
一般構成サブコマンド
次のサブコマンドによって、コア・サーバーが構成されます。
-
create-alert-handler
-
アラート・ハンドラを作成します。サブオプションは次のとおりです:
--handler-name
name。新しいアラート・ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するアラート・ハンドラのタイプ。typeの値には、custom
、jmx
、またはsmtp
のいずれかを指定できます。 -
create-certificate-mapper
-
証明書マッパーを作成します。サブオプションは次のとおりです:
--mapper-name
name。新しい証明書マッパーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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。新しい接続ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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
)。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
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マッパーの名前。
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するIDマッパーのタイプ。typeの値には、custom,exact-match
、またはmatch-and-replace
のいずれかを指定できます。 -
create-log-publisher
-
ログ・パブリッシャを作成します。サブオプションは次のとおりです:
--publisher-name
name。新しいログ・パブリッシャの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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。新しいログ保持ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するログ保持ポリシーのタイプ。typeの値には、custom,file-count
、free-disk-space
、またはsize-limit
のいずれかを指定できます。 -
create-log-rotation-policy
-
ログ・ローテーション・ポリシーを作成します。サブオプションは次のとおりです:
--policy-name name
。新しいログ・ローテーション・ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するログ・ローテーション・ポリシーのタイプ。typeの値には、custom、fixed-time
、size-limit
、またはtime-limit
のいずれかを指定できます。 -
create-workflow-element --type monitor-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、chema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。 -
create-network-group
-
ネットワーク・グループを作成します。サブオプションは次のとおりです:
--group-name
name。新しいネットワーク・グループの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-network-group-qos-policy
-
ネットワーク・グループのリソース制限を作成します。サブオプションは次のとおりです:
--group-name
name。ネットワーク・グループの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するサービスのクオリティ・ポリシーのタイプ。typeの値には、次のaffinity
、referral
、request-filtering
、またはresource-limits
のいずれかを指定できます。 -
create-workflow
-
ワークフローを作成します。サブオプションは次のとおりです:
--workflow-name
name。新規ワークフローの名前。この名前は、workflow-id
プロパティの値としても使用されます。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
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つのプロパティ値を表示するように変更します。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
get-alert-handler-prop
-
アラート・ハンドラのプロパティを表示します。サブオプションは次のとおりです:
--handler-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-certificate-mapper-prop
-
証明書マッパーのプロパティを表示します。サブオプションは次のとおりです:
--mapper-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-connection-handler-prop
-
接続ハンドラのプロパティを表示します。サブオプションは次のとおりです:
--handler-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-debug-target-prop
-
デバッグ・ターゲットのプロパティを表示します。サブオプションは次のとおりです:
--publisher-name name
。デバッグ・ログ・パブリッシャの名前。--target-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-extended-operation-handler-prop
-
拡張操作ハンドラのプロパティを表示します。サブオプションは次のとおりです:
--handler-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-global-configuration-prop
-
グローバル構成のプロパティを表示します。サブオプションは次のとおりです:
--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-identity-mapper-prop
-
IDマッパーのプロパティを表示します。サブオプションは次のとおりです:
--mapper-name
name。IDマッパーの名前。--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-log-publisher-prop
-
ログ・パブリッシャのプロパティを表示します。サブオプションは次のとおりです:
--publisher-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-log-retention-policy-prop
-
ログ保持ポリシーのプロパティを表示します。サブオプションは次のとおりです:
--policy-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-log-rotation-policy-prop
-
ログ・ローテーション・ポリシーのプロパティを表示します。サブオプションは次のとおりです:
--policy-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-network-group-prop
-
ネットワーク・グループのプロパティを表示します。サブオプションは次のとおりです:
--group-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-network-group-qos-policy-prop
-
ネットワーク・グループのサービスのクオリティ・ポリシーのプロパティを表示します。サブオプションは次のとおりです:
--group-name
name。ネットワーク・グループの名前。--policy-type
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-plugin-root-prop
-
プラグイン・ルートのプロパティを表示します。
--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-root-dse-backend-prop
-
ルートDSEバックエンドのプロパティを表示します。サブオプションは次のとおりです:
--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-work-queue-prop
-
ワーク・キューのプロパティを表示します。サブオプションは次のとおりです:
--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-workflow-prop
-
ワークフローのプロパティを表示します。サブオプションは次のとおりです:
--workflow-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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-alert-handlers
-
既存のアラート・ハンドラをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-certificate-mappers
-
既存の証明書マッパーをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-connection-handlers
-
既存の接続ハンドラをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-debug-targets
-
既存のデバッグ・ターゲットをリストします。サブオプションは次のとおりです:
--publisher-name
name。デバッグ・ログ・パブリッシャの名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-extended-operation-handlers
-
既存の拡張操作ハンドラをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-identity-mappers
-
既存のIDマッパーをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-log-publishers
-
既存のログ・パブリッシャをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-log-retention-policies
-
既存のログ保持ポリシーをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-log-rotation-policies
-
既存のログ・ローテーション・ポリシーをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-network-group-qos-policies
-
既存のネットワーク・グループのQOSポリシーをリストします。サブオプションは次のとおりです:
--group-name
name。ネットワーク・グループの名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-network-groups
-
既存のネットワーク・グループをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-workflows
-
既存のワークフローをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-administration-connector-prop
-
管理コネクタのプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-alert-handler-prop
-
アラート・ハンドラのプロパティを変更します。サブオプションは次のとおりです:
--handler-name
name。アラート・ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-certificate-mapper-prop
-
証明書マッパーのプロパティを変更します。サブオプションは次のとおりです:
--mapper-name
name。証明書マッパーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-connection-handler-prop
-
接続ハンドラのプロパティを変更します。サブオプションは次のとおりです:
--handler-name
name。接続ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-debug-target-prop
-
デバッグ・ターゲットのプロパティを変更します。サブオプションは次のとおりです:
--publisher-name
name。デバッグ・ログ・パブリッシャの名前。--target-name
name。デバッグ・ターゲットの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-extended-operation-handler-prop
-
拡張操作ハンドラのプロパティを変更します。サブオプションは次のとおりです:
--handler-name
name。拡張操作ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-global-configuration-prop
-
グローバル構成のプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-identity-mapper-prop
-
IDマッパーのプロパティを変更します。サブオプションは次のとおりです:
--mapper-name
name。IDマッパーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-log-publisher-prop
-
ログ・パブリッシャのプロパティを変更します。サブオプションは次のとおりです:
--publisher-name
name。ログ・パブリッシャの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-log-retention-policy-prop
-
ログ保持ポリシーのプロパティを変更します。サブオプションは次のとおりです:
--policy-name
name。ログ保持ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-log-rotation-policy-prop
-
ログ・ローテーション・ポリシーのプロパティを変更します。サブオプションは次のとおりです:
--policy-name
name。ログ・ローテーション・ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-network-group-prop
-
ネットワーク・グループのプロパティを変更します。サブオプションは次のとおりです:
--group-name
name。ネットワーク・グループの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--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ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-plugin-root-prop
-
プラグイン・ルートのプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-root-dse-backend-prop
-
ルートDSEバックエンドのプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-work-queue-prop
-
ワーク・キューのプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-workflow-element-prop
-
ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name name。ワークフロー要素の名前。
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-workflow-prop
-
ワークフローのプロパティを変更します。サブオプションは次のとおりです:
--workflow-name
name。ワークフローの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
ロード・バランシング・サブコマンド
次のサブコマンドによって、プロキシ・サーバーのロード・バランシングが構成されます。
-
create-load-balancing-algorithm
-
このコマンドはプロキシのみにサポートされます。
ロード・バランシングのアルゴリズムを作成します。サブオプションは次のとおりです:
--element-name
name。ロード・バランシングのワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するロード・バランシングのアルゴリズムのタイプ。typeの値には、failover
、generic
、optimal
、proportional
、saturation
、またはsearchfilter
のいずれかを指定できます。デフォルト値はgeneric
です。 -
create-load-balancing-route
-
このコマンドはプロキシのみにサポートされます。
ロード・バランシングのルートを作成します。サブオプションは次のとおりです:
--element-name
name。ロード・バランシングのワークフロー要素の名前。--route-name
name。新しいロード・バランシングのルートの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するロード・バランシングのルートのタイプ。typeの値には、failover
、generic
、optimal
、proportional
、saturation
、またはsearchfilter
のいずれかを指定できます。デフォルト値はgeneric
です。 -
create-workflow-element --type load-balancing
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name name。新しいワークフロー要素の名前。
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、作成するワークフロー要素のタイプのいずれかを指定できます。TYPEの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。 -
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つのプロパティ値を表示するように変更します。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
get-load-balancing-route-prop
-
このコマンドはプロキシのみにサポートされます。
ロード・バランシングのルートのプロパティを表示します。サブオプションは次のとおりです:
--element-name
name。ロード・バランシングのワークフロー要素の名前。--route-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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-load-balancing-algorithm
-
このコマンドはプロキシのみにサポートされます。
既存のロード・バランシングのアルゴリズムをリストします。サブオプションは次のとおりです:
--element-name
name。ロード・バランシングのワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-load-balancing-routes
-
このコマンドはプロキシのみにサポートされます。
既存のロード・バランシングのルートをリストします。サブオプションは次のとおりです:
--element-name
name。ロード・バランシングのワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-load-balancing-algorithm-prop
-
このコマンドはプロキシのみにサポートされます。
ロード・バランシングのアルゴリズムのプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ロード・バランシングのワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-load-balancing-route-prop
-
このコマンドはプロキシのみにサポートされます。
ロード・バランシングのルートのプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ロード・バランシングのワークフロー要素の名前。--route-name
name。ロード・バランシングのルートの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-workflow-element-prop
-
ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
ローカル・データ・ソースのサブコマンド
-
create-account-status-notification-handler
-
アカウント・ステータス通知ハンドラを作成します。サブオプションは次のとおりです:
--handler-name
name。新しいアカウント・ステータス通知ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するアカウント・ステータス通知ハンドラのタイプ。typeの値には、custom
、error-log
、またはsmtp
のいずれかを指定できます。 -
create-workflow-element
--type
backup-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。 -
create-workflow-element
--type
db-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。 -
create-entry-cache
-
エントリ・キャッシュを作成します。サブオプションは次のとおりです:
--cache-name
name。新しいエントリ・キャッシュの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するエントリ・キャッシュのタイプ。typeの値には、custom
、fifo、file-system
、またはsoft-reference
のいずれかを指定できます。 -
create-group-implementation
-
このコマンドはプロキシに対してサポートされていません。
グループ実装を作成します。サブオプションは次のとおりです:
--implementation-name
name。新しいグループ実装の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するグループ実装のタイプ。typeの値には、dynamic
、static
、またはvirtual-static
のいずれかを指定できます。 -
create-workflow-element
--type
ldif-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-local-db-index
-
ローカルDB索引を作成します。サブオプションは次のとおりです:
--element-name
name。ローカルDBバックエンドのワークフロー要素の名前。--index-name
name。新しいローカルDB索引の名前で、これはattribute
プロパティの値としても使用できます。これによって、索引が維持される属性の名前が指定されます。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-local-db-vlv-index
-
ローカルDBのVLV索引を作成します。サブオプションは次のとおりです:
--element-name
name。ローカルDBバックエンドのワークフロー要素の名前。--index-name
name。新しいローカルDBのVLV索引の名前で、これはname
プロパティの値としても使用できます。このプロパティによって、このVLV索引に一意の名前が指定されます。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-workflow-element
--type
memory-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element
--type
null-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-password-generator
-
パスワード・ジェネレータを作成します。サブオプションは次のとおりです:
--generator-name
name。新しいパスワード・ジェネレータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するパスワード・ジェネレータのタイプ。typeの値には、custom
またはrandom
のいずれかを指定できます。 -
create-password-policy
-
パスワード・ポリシーを作成します。サブオプションは次のとおりです:
--policy-name
name。新しいパスワード・ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-plugin
--type
password-policy-import
-
プラグインを作成します。サブオプションは次のとおりです:
--plugin-name
name。新しいプラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するプラグインのタイプ。typeの値には、dsee-gateway、password-policy-import、referential-integrity、seven-bit-clean、unique-attribute
のいずれかを指定できます。 -
create-password-storage-scheme
-
パスワード・ストレージ・スキームを作成します。サブオプションは次のとおりです:
--scheme-name name
。新しいパスワード・ストレージ・スキームの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するパスワード記憶スキームのタイプ。typeの値には、aes
、base64
、blowfish
、clear
、crypt
、custom
、md5
、rc4
、salted-md5
、salted-sha1
、salted-sha256
、sha256、salted-sha384
、salted-sha512
、sha512、sha1
、またはtriple-des
のいずれかを指定できます。 -
create-password-validator
-
パスワード・バリデータを作成します。サブオプションは次のとおりです:
--validator-name
name。新しいパスワード・バリデータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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。新しいプラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するプラグインのタイプ。typeの値には、dsee-gateway、password-policy-import、referential-integrity、seven-bit-clean、unique-attribute
のいずれかを指定できます。 -
create-plugin
--type
seven-bit-clean
-
プラグインを作成します。サブオプションは次のとおりです:
--plugin-name
name。新しいプラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するプラグインのタイプ。typeの値には、dsee-gateway、password-policy-import、referential-integrity、seven-bit-clean、unique-attribute
のいずれかを指定できます。 -
create-plugin
--type
unique-attribute
-
プラグインを作成します。サブオプションは次のとおりです:
--plugin-name
name。新しいプラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するプラグインのタイプ。typeの値には、dsee-gateway、password-policy-import、referential-integrity、seven-bit-clean、unique-attribute
のいずれかを指定できます。 -
create-virtual-attribute
-
このコマンドはプロキシに対してサポートされていません。
仮想属性を作成します。サブオプションは次のとおりです:
--name
name。新しい仮想属性の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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つのプロパティ値を表示するように変更します。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
get-entry-cache-prop
-
エントリ・キャッシュのプロパティを表示します。サブオプションは次のとおりです:
--cache-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-group-implementation-prop
-
このコマンドはプロキシに対してサポートされていません。
グループ実装のプロパティを表示します。サブオプションは次のとおりです:
--implementation-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-local-db-index-prop
-
ローカルDB索引のプロパティを表示します。サブオプションは次のとおりです:
--element-name
name。ローカルDBバックエンドのワークフロー要素の名前。--index-name
name。ローカルDB索引の名前。--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-local-db-vlv-index-prop
-
ローカルDBのVLV索引のプロパティを表示します。サブオプションは次のとおりです:
--element-name
name。ローカルDBバックエンドの名前。--index-name
name。ローカルDBのVLV索引の名前。--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-password-generator-prop
-
パスワード・ジェネレータのプロパティを表示します。サブオプションは次のとおりです:
--generator-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-password-policy-prop
-
パスワード・ポリシーのプロパティを表示します。サブオプションは次のとおりです:
--policy-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-password-storage-scheme-prop
-
パスワード・ストレージ・スキームのプロパティを表示します。サブオプションは次のとおりです:
--scheme-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-password-validator-prop
-
パスワード・バリデータのプロパティを表示します。サブオプションは次のとおりです:
--validator-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-virtual-attribute-prop
-
このコマンドはプロキシに対してサポートされていません。
仮想属性のプロパティを表示します。サブオプションは次のとおりです:
--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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-account-status-notification-handlers
-
既存のアカウント・ステータス通知ハンドラをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-entry-caches
-
既存のエントリ・キャッシュをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-group-implementations
-
このコマンドはプロキシに対してサポートされていません。
既存のグループ実装をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-local-db-indexes
-
既存のローカルDB索引をリストします。サブオプションは次のとおりです:
--element-name
name。DBローカル・バックエンドのワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-local-db-vlv-indexes
-
既存のローカルDBのVLV索引をリストします。サブオプションは次のとおりです:
--element-name
name。DBローカル・バックエンドのワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-generators
-
既存のパスワード・ジェネレータをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-policies
-
既存のパスワード・ポリシーをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-storage-schemes
-
既存のパスワード・ストレージ・スキームをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-validators
-
既存のパスワード・バリデータをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-plugins
-
既存のプラグインをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-virtual-attributes
-
このコマンドはプロキシに対してサポートされていません。
既存の仮想属性をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-account-status-notification-handler-prop
-
アカウント・ステータス通知ハンドラのプロパティを変更します。サブオプションは次のとおりです:
--handler-name
name。アカウント・ステータス通知ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-entry-cache-prop
-
エントリ・キャッシュのプロパティを変更します。サブオプションは次のとおりです:
--cache-name
name。エントリ・キャッシュの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-group-implementation-prop
-
このコマンドはプロキシに対してサポートされていません。
グループ実装のプロパティを変更します。サブオプションは次のとおりです:
--implementation-name
name。グループ実装の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--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索引の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--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索引の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-generator-prop
-
パスワード・ジェネレータのプロパティを変更します。サブオプションは次のとおりです:
--generator-name
name。パスワード・ジェネレータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-policy-prop
-
パスワード・ポリシーのプロパティを変更します。サブオプションは次のとおりです:
--policy-name
name。パスワード・ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-storage-scheme-prop
-
パスワード・ストレージ・スキームのプロパティを変更します。サブオプションは次のとおりです:
--scheme-name
name。パスワード・ストレージ・スキームの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-validator-prop
-
パスワード・バリデータのプロパティを変更します。サブオプションは次のとおりです:
--validator-name
name。パスワード・バリデータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-plugin-prop
-
プラグインのプロパティを変更します。サブオプションは次のとおりです:
--plugin-name
name。プラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-virtual-attribute-prop
-
このコマンドはプロキシに対してサポートされていません。
仮想属性のプロパティを変更します。サブオプションは次のとおりです:
--name
name。仮想属性の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-workflow-element-prop
-
ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
統合サブコマンド
この項では、様々なワークフロー操作のサブコマンドについて説明します。
-
create-workflow-element
--type ad-paging
-
このコマンドにより、ADページングのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element
--type ad-password
-
このコマンドにより、パスワードのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element --type eus-context
-
このコマンドにより、EUSコンテキストのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element --type eus
-
このコマンドにより、EUSのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element --type fa
-
このコマンドにより、FAのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element --type kerberos-auth-provider
-
このコマンドにより、Kerberos認証プロバイダのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element --type pass-through-authentication
-
このコマンドにより、パススルー認証のワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
create-workflow-element --type plugin
-
このコマンドにより、プラグインのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
delete-workflow-element
-
このコマンドにより、ワークフロー要素が削除されます。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。-f,
--force
。存在しないワークフロー要素を無視します。 -
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-workflow-element-prop
-
ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
リモート・データ・ソースのサブコマンド
この項では、様々なリモート・データ・ソースのサブコマンドについて説明します。
-
create-extension --type ldap-server
-
このコマンドにより、LDAPサーバー拡張が作成されます。サブオプションは次のとおりです:
--extension-name
name。新しい拡張の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成する拡張のタイプ。typeの値には、global-index-catalog、global-index-catalogs-shared-cache、ldap-server
のいずれかを指定できます。 -
create-workflow-element --type proxy-ldap
-
このコマンドにより、プロキシLDAPのワークフロー要素が作成されます。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t, --type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-contex、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations,trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます -
delete-extension
-
拡張を削除します。サブオプションは次のとおりです:
--extension-name
name。拡張の名前。-f,--force
。存在しない拡張を無視します。 -
delete-workflow-element
-
ワークフロー要素を削除します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。-f,--force
。存在しないワークフロー要素を無視します。 -
list-extensions
-
既存の拡張をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-extension-prop
-
このコマンドにより、拡張のプロパティが変更されます。サブオプションは次のとおりです:
--extension-name
name。拡張の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-workflow-element-prop
-
このコマンドにより、ワークフロー要素のプロパティが変更されます。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
レプリケーション・サブコマンド
この項では、様々なレプリケーション操作のサブコマンドについて説明します。
-
create-plugin
--type
dsee-gateway
-
プラグインを作成します。サブオプションは次のとおりです:
--plugin-name
name。プラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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。ゲートウェイ・ドメインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-replication-domain
-
レプリケーション・ドメインを作成します。サブオプションは次のとおりです:
--provider-name
name。マルチマスター同期化プロバイダの名前。--domain-name
name。新しいレプリケーション・ドメインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-replication-server
-
レプリケーション・サーバーを作成します。サブオプションは次のとおりです:
--provider-name
name。マルチマスター同期化プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-synchronization-provider
-
同期化プロバイダを作成します。サブオプションは次のとおりです:
--provider-name
name。新しい同期化プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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つのプロパティ値を表示するように変更します。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
get-gateway-domain-prop
-
ゲートウェイ・ドメインのプロパティを表示します。
--plugin-name
name。DSEEゲートウェイ・プラグインの名前。--domain-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-replication-domain-prop
-
レプリケーション・ドメインのプロパティを表示します。サブオプションは次のとおりです:
--provider-name
name。マルチマスター同期化プロバイダの名前。--domain-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-replication-server-prop
-
レプリケーション・サーバーのプロパティを表示します。サブオプションは次のとおりです:
--provider-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-synchronization-provider-prop
-
同期化プロバイダのプロパティを表示します。サブオプションは次のとおりです:
--provider-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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-plugins
-
既存のプラグインをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-gateway-domains
-
既存のゲートウェイ・ドメインをリストします。サブオプションは次のとおりです。
--plugin-name
name。DSEEゲートウェイ・プラグインの名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-replication-domains
-
既存のレプリケーション・ドメインをリストします。サブオプションは次のとおりです:
--provider-name
name。レプリケーション同期化プロバイダの名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-replication-server
-
既存のレプリケーション・サーバーをリストします。サブオプションは次のとおりです:
--provider-name
name。レプリケーション同期化プロバイダの名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-synchronization-providers
-
既存の同期化プロバイダをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-external-changelog-domain-prop
-
外部変更ログ・ドメインのプロパティを変更します。サブオプションは次のとおりです:
--provider-name
name。レプリケーション同期化プロバイダの名前。--domain-name
name。レプリケーション・ドメインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-gateway-domain-prop
-
ゲートウェイ・ドメインのプロパティを変更します。サブオプションは次のとおりです:
--plugin-name
name。DSEEゲートウェイ・プラグインの名前。--domain-name
name。ゲートウェイ・ドメインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-plugin-prop
-
プラグインのプロパティを変更します。サブオプションは次のとおりです:
--plugin-name
name。プラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-replication-domain-prop
-
レプリケーション・ドメインのプロパティを変更します。サブオプションは次のとおりです:
--provider-name
name。レプリケーション同期化プロバイダの名前。--domain-name
name。レプリケーション・ドメインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-replication-server-prop
-
レプリケーション・サーバーのプロパティを変更します。サブオプションは次のとおりです:
--provider-name
name。レプリケーション同期化プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-synchronization-provider-prop
-
同期化プロバイダのプロパティを変更します。サブオプションは次のとおりです:
--provider-name
name。同期化プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
スキーマ・サブコマンド
この項では、様々なスキーマ操作のサブコマンドについて説明します。
-
create-attribute-syntax
-
このコマンドはプロキシに対してサポートされていません。
属性構文を作成します。サブオプションは次のとおりです:
--syntax-name
name。新しい属性構文の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する属性構文のタイプ。typeの値には、attribute-type-description
、directory-string
、generic
、またはtelephone-number
のいずれかを指定できます。 -
create-matching-rule
-
このコマンドはプロキシに対してサポートされていません。
一致ルールを作成します。サブオプションは次のとおりです:
--rule-name
name。新しい一致ルールの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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つのプロパティ値を表示するように変更します。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
get-matching-rule-prop
-
このコマンドはプロキシに対してサポートされていません。
一致ルールのプロパティを表示します。サブオプションは次のとおりです:
--rule-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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-attribute-syntaxes
-
このコマンドはプロキシに対してサポートされていません。
既存の属性構文をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-matching-rules
-
このコマンドはプロキシに対してサポートされていません。
既存の一致ルールをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-attribute-syntax-prop
-
このコマンドはプロキシに対してサポートされていません。
属性構文のプロパティを変更します。サブオプションは次のとおりです:
--syntax-name
name。属性構文の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-matching-rule-prop
-
このコマンドはプロキシに対してサポートされていません。
一致ルールのプロパティを変更します。サブオプションは次のとおりです:
--rule-name
name。一致ルールの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
セキュリティ・サブコマンド
-
create-access-control-group
-
アクセス制御グループを作成します。
--group-name
name。新しいアクセス制御グループの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-key-manager-provider
-
キー・マネージャ・プロバイダを作成します。サブオプションは次のとおりです:
--provider-name
name。新しいキー・マネージャ・プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type type
。作成するキー・マネージャ・プロバイダのタイプ。typeの値には、file-based
、custom
、またはpkcs11
のいずれかを指定できます。PKCS#11は、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
create-key-manager-provider-key-pin
-
キー・マネージャ・プロバイダのキーPINを作成します。サブオプションは次のとおりです:
--provider-name
name。キー・マネージャ・プロバイダの名前。--pin-name
name。"ssl-cert-nickname"プロパティの値としても使用される新しいキー・マネージャ・プロバイダのキーPINの名前。このキー・マネージャ・プロバイダのキーPINが適用される証明書のニックネームを指定します。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-password-generator
-
パスワード・ジェネレータを作成します。サブオプションは次のとおりです:
--generator-name
name。新しいパスワード・ジェネレータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type type
。作成するパスワード・ジェネレータのタイプ。typeの値には、custom
またはrandom
のいずれかを指定できます。 -
create-password-policy
-
パスワード・ポリシーを作成します。サブオプションは次のとおりです:
--policy-name
name。新しいパスワード・ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-plugin --type password-policy-import
-
パスワード・ポリシー・インポート・プラグインを作成します。サブオプションは次のとおりです:
--plugin-name
name。新しいプラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type type
。作成するプラグインのタイプ。typeの値には、dsee-gateway、last-mod、password-policy-import、referential-integrity、seven-bit-clean、unique-attribute
のいずれかを指定できます。 -
create-password-storage-scheme
-
パスワード・ストレージ・スキームを作成します。サブオプションは次のとおりです:
--scheme-name
name。新しいパスワード・ストレージ・スキームの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type type
。作成するパスワード記憶スキームのタイプ。typeの値には、aes、base64、blowfish、clear、crypt、custom、euspbkdf2sha512、md5、pbkdf2hmacsha1、pbkdf2hmacsha256、pbkdf2hmacsha512、rc4、salted-md5、salted-sha1、salted-sha256、salted-sha384、salted-sha512、sha1、sha256、sha512、triple-des、user-defined
のいずれかを指定できます。 -
create-password-validator
-
パスワード・バリデータを作成します。サブオプションは次のとおりです:
--validator-name
name。新しいパスワード・バリデータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type type
。作成するパスワード・バリデータのタイプ。typeの値には、character-set、custom、dictionary、length-based、repeated-characters、similarity-based、unique-characters
のいずれかを指定できます。 -
create-sasl-mechanism-handler
-
このコマンドはプロキシに対してサポートされていません。
SASLメカニズム・ハンドラを作成します。サブオプションは次のとおりです:
--handler-name
name。新しいSASLメカニズム・ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するSASLメカニズム・ハンドラのタイプ。typeの値には、anonymous
、cram-md5
、digest-md5
、external
、custom
、gssapi
、またはplain
のいずれかを指定できます。 -
create-trust-manager-provider
-
信頼マネージャ・プロバイダを作成します。サブオプションは次のとおりです:
--provider-name
name。新しい信頼マネージャ・プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する信頼マネージャ・プロバイダのタイプ。typeの値には、blind
、file-based
、またはcustom
のいずれかを指定できます。 -
create-trust-store-key-pin
-
トラスト・ストアのキーPINを作成します。サブオプションは次のとおりです:
--element-name
name。トラスト・ストア・ローカル・バックエンドのワークフロー要素の名前。--pin-name
string。"ssl-cert-nickname"プロパティの値としても使用される新しいトラスト・ストアのキーPINの名前。このトラスト・ストアのキーPINが適用される証明書のニックネームを指定します。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
create-workflow-element
--type
trust-store-local-backend
-
ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-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-access-control-group
-
アクセス制御グループを削除します。サブオプションは次のとおりです:
--group-name
name。アクセス制御グループの名前。-f,--force
。存在しないアクセス制御グループを無視します。 -
delete-key-manager-provider
-
キー・マネージャ・プロバイダを削除します。サブオプションは次のとおりです:
--provider-name
name。キー・マネージャ・プロバイダの名前。-f,--force
。存在しないキー・マネージャ・プロバイダを無視します。 -
delete-key-manager-provider-key-pin
-
キー・マネージャ・プロバイダのキーPINを削除します。サブオプションは次のとおりです:
--provider-name
name。キー・マネージャ・プロバイダの名前。--pin-name
name。キー・マネージャ・プロバイダのキーPINの名前。-f,--force
。存在しないキー・マネージャ・プロバイダのキーPINを無視します。 -
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-sasl-mechanism-handler
-
このコマンドはプロキシに対してサポートされていません。
SASLメカニズム・ハンドラを削除します。サブオプションは次のとおりです:
--handler-name name。SASLメカニズム・ハンドラの名前。
-f,--force
。存在しないSASLメカニズム・ハンドラを無視します。 -
delete-trust-manager-provider
-
信頼マネージャ・プロバイダを削除します。サブオプションは次のとおりです:
--provider-name
name。信頼マネージャ・プロバイダの名前。-f,--force
。存在しない信頼マネージャ・プロバイダを無視します。 -
delete-trust-store-key-pin
-
信頼マネージャ・プロバイダを削除します。サブオプションは次のとおりです:
--element-name
name。トラスト・ストア・ローカル・バックエンドのワークフロー要素の名前。--pin-name
name。トラスト・ストアのキーPINの名前。-f,--force
。存在しないトラスト・ストアのキーPINを無視します。 -
delete-workflow-element
-
ワークフロー要素を削除します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。-f,--force
。存在しないワークフロー要素を無視します。 -
get-access-control-group-prop
-
アクセス制御グループのプロパティを表示します。サブオプションは次のとおりです:
--group-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-access-control-handler-prop
-
アクセス制御ハンドラのプロパティを表示します。サブオプションは次のとおりです:
--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-crypto-manager-prop
-
暗号化マネージャのプロパティを表示します。サブオプションは次のとおりです:
--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-data-encryption-prop
-
データ暗号化のプロパティを表示します。サブオプションは次のとおりです:
--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-key-manager-provider-key-pin-prop
-
キー・マネージャ・プロバイダのキーPINのプロパティを表示します。サブオプションは次のとおりです:
--provider-name
name。キー・マネージャ・プロバイダの名前。--pin-name
name。キー・マネージャ・プロバイダのキーPINの名前。--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-key-manager-provider-prop
-
キー・マネージャ・プロバイダのプロパティを表示します。サブオプションは次のとおりです:
--provider-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-password-generator-prop
-
パスワード・ジェネレータのプロパティを表示します。サブオプションは次のとおりです:
--generator-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-password-policy-prop
-
パスワード・ポリシーのプロパティを表示します。サブオプションは次のとおりです:
--policy-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-password-storage-scheme-prop
-
パスワード・ストレージ・スキームのプロパティを表示します。サブオプションは次のとおりです:
--scheme-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-password-validator-prop
-
パスワード・バリデータのプロパティを表示します。サブオプションは次のとおりです:
--validator-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-root-dn-prop
-
ルートDNのプロパティを表示します。サブオプションは次のとおりです:
--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-sasl-mechanism-handler-prop
-
SASLメカニズム・ハンドラのプロパティを表示します。サブオプションは次のとおりです:
--handler-name
name。SASLメカニズム・ハンドラの名前。--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-trust-manager-provider-prop
-
信頼マネージャ・プロバイダのプロパティを表示します。サブオプションは次のとおりです:
--provider-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-trust-store-key-pin-prop
-
トラスト・ストアのキーPINのプロパティを表示します。サブオプションは次のとおりです:
--element-name
name。トラスト・ストア・ローカル・バックエンドのワークフロー要素の名前。--pin-name
name。トラスト・ストアのキーPINの名前。--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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-access-control-groups
-
既存のアクセス制御グループをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-key-manager-provider-key-pins
-
既存のキー・マネージャ・プロバイダのキーPINをリストします。サブオプションは次のとおりです:
--provider-name
name。キー・マネージャ・プロバイダの名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-key-manager-providers
-
既存のキー・マネージャ・プロバイダをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-generators
-
既存のパスワード・ジェネレータをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-policies
-
既存のパスワード・ポリシーをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-storage-schemes
-
既存のパスワード・ストレージ・スキームをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-password-validators
-
既存のパスワード・バリデータをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-plugins
-
既存のプラグインをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-sasl-mechanism-handlers
-
このコマンドはプロキシに対してサポートされていません。
既存のSASLメカニズム・ハンドラをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-trust-manager-providers
-
既存の信頼マネージャ・プロバイダをリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-trust-store-key-pins
-
既存のトラスト・ストアのキーPINをリストします。サブオプションは次のとおりです:
--element-name
name。トラスト・ストア・ローカル・バックエンドのワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。 -
set-access-control-group-prop
-
アクセス制御グループのプロパティを変更します。サブオプションは次のとおりです:
--group-name
name。アクセス制御グループの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-access-control-handler-prop
-
アクセス制御ハンドラのプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-crypto-manager-prop
-
暗号化マネージャのプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-data-encryption-prop
-
データ暗号化のプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-key-manager-provider-key-pin-prop
-
キー・マネージャ・プロバイダのキーPINのプロパティを変更します。サブオプションは次のとおりです:
--provider-name
name。キー・マネージャ・プロバイダの名前。--pin-name
name。キー・マネージャ・プロバイダのキーPINの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-key-manager-provider-prop
-
キー・マネージャ・プロバイダのプロパティを変更します。サブオプションは次のとおりです:
--provider-name
name。キー・マネージャ・プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-generator-prop
-
パスワード・ジェネレータのプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。パスワード・ジェネレータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-policy-prop
-
パスワード・ポリシーのプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。パスワード・ポリシーの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-storage-scheme-prop
-
パスワード・ストレージ・スキームのプロパティを変更します。サブオプションは次のとおりです:
--scheme-name
name。パスワード・ストレージ・スキームの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-password-validator-prop
-
パスワード・バリデータのプロパティを変更します。サブオプションは次のとおりです:
--validator-name
name。パスワード・バリデータの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-plugin-prop
-
プラグインのプロパティを変更します。サブオプションは次のとおりです:
--plugin-name
name。プラグインの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-root-dn-prop
-
ルートDNのプロパティを変更します。サブオプションは次のとおりです:
--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-sasl-mechanism-handler-prop
-
このコマンドはプロキシに対してサポートされていません。
SASLメカニズム・ハンドラのプロパティを変更します。サブオプションは次のとおりです:
--handler-name
name。SASLメカニズム・ハンドラの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-trust-manager-provider-prop
-
信頼マネージャ・プロバイダのプロパティを変更します。サブオプションは次のとおりです:
--provider-name
name。信頼マネージャ・プロバイダの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-trust-store-key-pin-prop
-
トラスト・ストアのキーPINのプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。トラスト・ストア・ローカル・バックエンドのワークフロー要素の名前。--pin-name
name。トラスト・ストアのキーPINの名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。 -
set-workflow-element-prop
-
ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
仮想化サブコマンド
この項では、仮想化のサブコマンドについて説明します。
-
create-transformation --type add-inbound-attribute
-
インバウンド属性追加の変換を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。各変換の詳細は、「dsconfigを使用した変換の構成」を参照してください。
-
create-transformation --type add-outbound-attribute
-
アウトバウンドの属性追加の変換を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。各変換の詳細は、「dsconfigを使用した変換の構成」を参照してください。
-
create-workflow-element --type dn-renaming
-
DNリネーム・ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-workflow-element --type dynamic-entry-tree
-
動的エントリ・ツリー・ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-workflow-element --type dynamic-groups
-
動的グループ・ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-transformation --type filter-inbound-attribute
-
インバウンドのフィルタ属性の変換を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。各変換の詳細は、「dsconfigを使用した変換の構成」を参照してください。
-
create-transformation --type filter-outbound-attribute
-
アウトバウンドのフィルタ属性の変換を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。各変換の詳細は、「dsconfigを使用した変換の構成」を参照してください。
-
create-workflow-element --type flat-tree
-
フラット・ツリー・ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-workflow-element --type fork-join
-
分岐結合ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-workflow-element --type get-rid-of-duplicate
-
重複削除ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-workflow-element --type hide-entries-by-filter
-
フィルタによるエントリの非表示化ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-join-participant
-
結合参加要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--participant-name
name。新しい結合参加要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。
-
create-workflow-element --type join
-
結合ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-transformation --type map-attribute
-
属性のマップの変換を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。各変換の詳細は、「dsconfigを使用した変換の構成」を参照してください。
-
create-transformation --type map-object-class
-
オブジェクト・クラスのマップ変換を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。各変換の詳細は、「dsconfigを使用した変換の構成」を参照してください。
-
create-primary-fork-join-participant
-
プライマリ分岐結合参加要素を作成します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。
-
create-workflow-element --type rdn-changing
-
RDN変更ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-workflow-element --type saml-xasp
-
SAML XASPワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-secondary-fork-join-participant
-
セカンダリ分岐結合参加要素を作成します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。
-
create-transformation --type tokenize-attribute
-
属性変換のトークン化を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。
-
create-transformation
-
変換を作成します。サブオプションは次のとおりです:
--transformation-name
name。新しい変換の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成する変換のタイプ。typeの値には、add-inbound-attribute、add-outbound-attribute、filter-inbound-attribute、filter-outbound-attribute、map-attribute、map-object-class、tokenize-attribute
のいずれかを指定できます。
-
create-workflow-element --type transformations
-
変換ワークフロー要素を作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
create-workflow-element --type virtual-member-of
-
ワークフロー要素の仮想メンバーを作成します。サブオプションは次のとおりです:
--element-name
name。新しいワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。-t,--type
type。作成するワークフロー要素のタイプ。typeの値には、ad-paging、ad-password、backup-local-backend、db-local-backend、distribution、dn-renaming、dynamic-entry-tree、dynamic-groups、eus、eus-alias-resolution、eus-context、fa、flat-tree、fork-join、get-rid-of-duplicate、global-index-local-backend、global-index-replication-changes-local-backend、hide-entries-by-filter、join、kerberos-auth-provider、ldif-local-backend、load-balancing、memory-local-backend、monitor-local-backend、null-local-backend、pass-through-authentication、plugin、proxy-ldap、rdbms、rdn-changing、saml-xasp、schema-local-backend、transformations、trust-store-local-backend、union、virtual-member-of
のいずれかを指定できます。
-
delete-join-participant
-
結合参加要素を削除します。サブオプションは次のとおりです:
--element-name
name。結合ワークフロー要素の名前。--participant-name
name。結合参加要素の名前。-f, --force
。存在しない結合参加要素を無視します。
-
delete-primary-fork-join-participant
-
プライマリ分岐結合参加要素を削除します。サブオプションは次のとおりです:
--element-name
name。分散結合ワークフロー要素の名前。-f, --force
。存在しないプライマリ分岐結合参加要素を無視します。
-
delete-secondary-fork-join-participant
-
セカンダリ分岐結合参加要素を削除します。サブオプションは次のとおりです:
--element-name
name。分散結合ワークフロー要素の名前。-f, --force
。存在しないセカンダリ分岐結合参加要素を無視します。
-
delete-transformation
-
変換を削除します。サブオプションは次のとおりです:
--transformation-name
name。変換名。-f, --force
。存在しない変換を無視します。
-
delete-workflow-element
-
ワークフロー要素を削除します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。-f, --force
。存在しないワークフロー要素を無視します。
-
get-join-participant-prop
-
結合参加要素のプロパティを表示します。サブオプションは次のとおりです:
--element-name
name。結合ワークフロー要素の名前。--participant-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-primary-fork-join-participant-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-secondary-fork-join-participant-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-transformation-prop
-
変換のプロパティを表示します。サブオプションは次のとおりです:
--transformation-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
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。
-
list-join-participants
-
既存の結合参加要素をリストします。サブオプションは次のとおりです:
--element-name
name。結合ワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。
-
list-primary-fork-join-participant
-
既存のプライマリ分岐結合参加要素をリストします。サブオプションは次のとおりです:
--element-name
name。分散結合ワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。
-
list-secondary-fork-join-participant
-
既存のセカンダリ分岐結合参加要素をリストします。サブオプションは次のとおりです:
--element-name
name。分散結合ワークフロー要素の名前。--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。
-
list-transformations
-
既存の変換をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。
-
list-workflow-elements
-
既存のワークフロー要素をリストします。サブオプションは次のとおりです:
--property
property。表示されるプロパティの名前。-z,--unit-size
unit。指定された単位を使用してサイズ・データを表示します。unitの値には、b
、kb
、mb
、gb
、またはtb
(バイト、キロバイト、メガバイト、ギガバイト、またはテラバイト)のいずれかを指定できます。-m,--unit-time
unit。指定された単位を使用して時間データを表示します。unitの値には、ms
、s
、m
、h
、d
、またはw
(ミリ秒、秒、分、時、日、または週)のいずれかを指定できます。
-
set-join-participant-prop
-
結合参加要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。結合ワークフロー要素の名前。--participant-name
name。結合参加要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
-
set-primary-fork-join-participant-prop
-
プライマリ分岐結合参加要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。分散結合ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
-
set-secondary-fork-join-participant-prop
-
セカンダリ分岐結合参加要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。分散結合ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
-
set-transformation-prop
-
変換のプロパティを変更します。サブオプションは次のとおりです:
--transformation-name
name。変換要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
-
set-workflow-element-prop
-
ワークフロー要素のプロパティを変更します。サブオプションは次のとおりです:
--element-name
name。ワークフロー要素の名前。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。--reset
property。プロパティをデフォルト値にリセットします。ここで、propertyはリセットされるプロパティの名前です。--add
property:
value。プロパティに単一値を追加します。ここで、propertyはプロパティの名前、valueは追加される単一の値です。--remove
property:
value。プロパティから単一値を削除します。ここで、propertyはプロパティの名前、valueは削除される単一の値です。
オプション
dsconfig
コマンドは、短いフォーム(たとえば、-h hostname
)または同等の長いフォーム(たとえば、--hostname hostname
)のいずれかでオプションを受け入れます。
LDAP接続オプション
dsconfig
コマンドは、管理コネクタを介してSSL上のディレクトリ・サーバーに接続します(「サーバーへの管理トラフィックの管理」で説明しています)。これらの接続オプションは、ディレクトリ・サーバーとの接続に使用します。
-
-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
です。
コマンド入力/出力オプション
-
--commandFilePath
path
-
このコマンドが対話モードで実行されているときに同等の非インタラクティブ・コマンドの書込み先となるファイルへのフルパスを指定します。
-
--displayCommand
-
このコマンドが対話モードで実行されているときに、同等の非インタラクティブ・オプションを標準出力に表示します。
-
-F, --batchFilePath batchFilePath
-
実行される一連の
dsconfig
コマンドが含まれているファイルへのパスを指定します。このオプションでは、行分割、バックスラッシュ('\')、引用文字列内での引用符(")とエスケープ付引用符(\")、およびコメント用ハッシュ('#')をサポートしています。 -
-n, --no-prompt
-
非対話モードを使用します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
-
--noPropertiesFile
-
このコマンドでは、デフォルトのコマンド行オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
-
--sortMenuItems
-
対話モードを使用しているときに、メニュー・アイテムをソートできるようにします。ソート順序は、ユーザー・ロケールのアルファベット順です。
-
--propertiesFilePath
path
-
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
-
-Q, --quiet
-
最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-
-s, --script-friendly
-
スクリプト・フレンドリ・モードで実行します。スクリプトが解析しやすいフォーマットで出力を表示します。
-
-v, --verbose
-
標準出力に診断を表示する冗長モードで実行します。
一般オプション
例
次の例は、dsconfig
コマンドの使用方法を示しています。その他のdsconfig
の例は、「dsconfigを使用したサーバー構成の管理」を参照してください。
グローバル・ヘルプ・サブコマンドとグローバル・オプションの表示
次のコマンドは、サーバーに対して使用可能なグローバル・ヘルプ・サブコマンドとグローバル・オプションを表示します:
$ dsconfig --help
コンポーネントのサブコマンドとヘルプ情報の表示
次のコマンドは、認証および認可に関連するサブコマンドを表示します:
$ dsconfig --help-security
個別サブコマンドのヘルプの表示
次のコマンドは、set-distribution-partition-prop
サブコマンドのヘルプ情報を表示します:
$ dsconfig set-distribution-partition-prop --help
コンポーネントのプロパティの表示
次のコマンドは、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
-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
終了コード
終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。
プロパティ・ファイルの使用方法
サーバーでは、dsconfigコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
bindDN
-
bindPasswordFile
-
certNickname
-
hostname
-
keyStorePasswordFile
-
keyStorePath
-
port
-
saslOption
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
trustAll
-
trustStorePasswordFile
-
trustStorePath
-
useSSL
-
useStartTLS
プロパティ・ファイルのエントリのフォーマットは、次のとおりです:
toolname.propertyname=propertyvalue
たとえば:
dsconfig.trustAll=Yes
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/dsconfig
-
Windows: INSTANCE_DIR
\OUD\bat\dsconfig.bat
関連コマンド
A.1.2.5 dsjavaproperties
dsjavaproperties
コマンドは、各サーバー・コマンドで使用するJVMバージョンおよびJava引数を指定します。
シノプシス
dsjavaproperties
[options]
説明
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環境変数が優先されます。
オプション
dsjavaproperties
コマンドは、短いフォーム(たとえば、-Q
)または同等の長いフォーム(たとえば、--quiet
)のいずれかでオプションを受け入れます。
例
次の例は、export—ldif
コマンドの使用方法を示しています。
スクリプトの変更
この例は、コマンドがサーバー・オンラインで実行されるときに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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/dsjavaproperties
-
Windows: INSTANCE_DIR
\OUD\bat\dsjavaproperties.bat
A.1.2.6 dsreplication
dsreplication
コマンドは、ディレクトリ・サーバー間でレプリケーションを構成して、サーバーのデータが同期化されるようにします。
シノプシス
dsreplication
[subcommands] [options]
説明
dsreplication
コマンドを使用してディレクトリ・サーバー間でレプリケーションを構成し、サーバーのデータを同期化することができます。まず、enable
サブコマンドを使用してレプリケーションを有効にし、次にinitialize
サブコマンドを使用して一方のディレクトリ・サーバーのコンテンツをもう一方のサーバーのコンテンツで初期化します。
dsreplication
コマンドは、管理コネクタを使用してSSL上のサーバーに接続します(「サーバーへの管理トラフィックの管理」を参照)。
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 12) Verify Server Configuration 13) List the Certificates Used for Replication 14) Regenerate the Certificate Used for Replication 15) Set the Certificate Used for Replication c) cancel Enter choice: 1 ...
同等の非インタラクティブ・コマンドを表示するには、--displayCommand
オプションまたは--commandFilePath
オプションを使用します。
サーバー・サブコマンド
dsreplication
コマンドで使用されるサブコマンドは、次のとおりです。
-
disable
-
指定されたベースDNに対して、指定されたディレクトリ・サーバーのレプリケーションを無効にします。このサブコマンドは、このサーバーがデータをレプリケートしているサーバーの構成内で、指定されたサーバーへの参照を削除します。サブオプションは次のとおりです:
-D, --bindDN
bindDN。レプリケーションが無効になるサーバーへのバインドに使用されるDN。サーバーでグローバル管理者が定義されていない場合、またはレプリケートされる他のサーバーで参照を削除したくない場合には、このオプションを使用する必要があります。このオプションを指定すると、グローバル管理者に対して指定されたパスワードが使用されます。-a, --disableAll
。指定されたサーバーのレプリケーション構成を無効にします。サーバーのコンテンツはレプリケートされなくなり、レプリケーション・サーバー(変更ログとレプリケーション・ポート)が構成されている場合はそれが無効になります。--disableReplicationServer
。レプリケーション・サーバーを無効にします。指定されたサーバーで、レプリケーション・ポートと変更ログが無効になります。-h, --hostname
host。ディレクトリ・サーバーのホスト名またはIPアドレス。-p, --port
port。ディレクトリ・サーバーの管理ポート番号。 -
disable-changelog
-
一連のベースDNの外部変更ログを無効にします。レプリケートするデータが存在しない場合、関連付けられたレプリケーション構成がすべて削除されます。外部変更ログの詳細は、「外部変更ログの使用」を参照してください。サブオプションは次のとおりです:
-h, --hostname
hostディレクトリ・サーバーのホスト名またはIPアドレス。
-p, --port
portディレクトリ・サーバーの管理ポート番号。
-D, --bindDN
bindDN外部変更ログの構成場所であるサーバーとのバインドに使用するDN。デフォルト値は
cn=Directory Manager
です。 -
enable-changelog
-
一連のベースDNに対して外部変更ログを作成します。外部変更ログの機能により、特定のベースDNで実行された変更を取得できます。外部変更ログの詳細は、「外部変更ログの使用」を参照してください。サブオプションは次のとおりです:
-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。ソース・サーバーのディレクトリ・サーバー管理ポート番号。 -
list-certs
-
レプリケーションのためにサーバーで使用される証明書をリストします。サブオプションは次のとおりです:
-h, --hostname
host
ディレクトリ・サーバーのホスト名またはIPアドレス。
-p, --port
port
ディレクトリ・サーバーの管理ポート番号。デフォルト値: 4444
-
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です。 -
regenerate-cert
-
レプリケーションのために指定されたサーバー(またはすべてのサーバー)で使用される証明書を再生成します。サブオプションは次のとおりです:
-a, --all
(接続のために指定されたサーバーだけでなく)レプリケーションのために構成されたすべてのサーバーの証明書を再生成します。
-h, --hostname
host
ディレクトリ・サーバーのホスト名またはIPアドレス。
-p, --port
port
ディレクトリ・サーバーの管理ポート番号。デフォルト値: 4444
-
set-cert
-
レプリケーションのためにキーストア内の証明書を使用するようにサーバーを構成します。サブオプションは次のとおりです:
--replCertNickName
nickname
レプリケーションのためにサーバーで使用される証明書のニックネームを指定します。
--replKeyStoreType
type
キーストアのタイプを指定します。値には、JKS、JCEKS、PKCS12、PKCS11などのキーストアのタイプを指定できます。サーバーで使用されるJava仮想マシンは次のキーストア・タイプをサポートする必要があります(デフォルトで、ほとんどのJVMがサポートするキーストア・タイプJKS、JCEKSおよびPKCS12)。デフォルト値はJKSです。
--replKeyStorePath
path
レプリケーションのためにサーバーで使用される証明書を含むキーストアのパスを指定します。この値は、Java cardなどのハードウェア・デバイスに証明書が格納されている場合は必要ありません。サーバーにはこのパスに対する読取りアクセス権が必要です。サーバーの場所に対して相対的なパスを指定できます(たとえば、
config/my-keystore
)。--replKeyStorePasswordFile
path
キーストアへのアクセスに必要なパスワード(PIN)を含むファイルへのパスを指定します。パスワードはファイルにクリア・テキストで格納する必要があります。また、サーバーにはこのファイルに対する読取りアクセス権が必要です。サーバーでファイルのコンテンツを暗号化する場合、サーバーには書込みアクセス権も必要です。サーバーの場所に対して相対的なパスを指定できます(たとえば、
config/my-keystore.pin
)。--replKeyPasswordFile
keyPasswordFile
キーストア内の証明書の秘密キーへのアクセスに必要なパスワード(PIN)を含むファイルを指定します。このオプションは、
--replKeyStorePasswordFile
オプションで指定したキーストア・パスワードを使用して秘密キーを読み取れない場合に必要です。パスワードはファイルにクリア・テキストで格納する必要があります。また、サーバーにはこのファイルに対する読取りアクセス権が必要です。サーバーの場所に対して相対的なパスを指定できます(たとえば、config/my-key.pin
)。--skipLocalChecks
サーバーと同じマシンからコマンドを実行中に、指定されたデータを検証するデフォルトのチェックをスキップする必要があることを指定します。
--encryptKeyStorePasswordFile
暗号化されたパスワードを指定するパスワード(PIN)ファイルのコンテンツをサーバーで上書きする必要があることを指定します。パスワード・ファイルにはクリア・テキストでパスワードを格納する必要があります。また、サーバーには
--replKeyStorePasswordFile
オプションで指定したファイルに対する書込みアクセス権が必要です。-h, --hostname
host
ディレクトリ・サーバーのホスト名またはIPアドレス。
-p, --port
port
ディレクトリ・サーバーの管理ポート番号。デフォルト値: 4444
-
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ディレクトリ・サーバーの管理ポート番号。デフォルト値:
4444
-D, --bindDN
bindDNグローバル管理者が定義されていない場合にサーバーへのバインドに使用するDN。これを使用して、外部変更ログのステータスを確認できます(この場合に、サーバー間のレプリケーションが構成されている必要はありません)。デフォルト値:
cn=Directory Manager
-e, --expanded
レプリケーション・ドメイン(レプリケートされたデータ)とレプリケーション・サーバー(変更ログおよびレプリケーション・ポート)が別のエンティティとして表示される、レプリケーション・ステータスの展開された表示を使用します。
-s, --script-friendly
スクリプト・フレンドリ・モードを使用します。
-d, --dataToDisplay {dataToDisplay}
表示するレプリケーション・データ情報を指定します。たとえば、次を入力するとします。
--dataToDisplay entry-number --dataToDisplay missing-changes
エントリの数と欠落している変更の数が表示されます。指定できる様々な値の詳細を確認するには、次を実行してください。
dsreplication status --listDataToDisplay
--listDataToDisplay
引数
--dataToDisplay
に使用できる様々な値のリスト。値の完全なリストを表示する場合は、--advanced
引数も指定します。 -
verify
-
レプリケートされた別のサーバーのレプリケーション構成を検証します。
対話モードで
verify
サブコマンド(--no-prompt
オプションなし)を実行することをお薦めします。そうすると、レプリケーション構成に非一貫性が見つかった場合は表示され、対話形式で修正できます。たとえば、次の
verify
サブコマンドを使用できます。-
到達不能なサーバーへの参照を削除する場合(たとえば、クラッシュしてリカバリ不能または正常にアンインストールされなかったため)。
-
レプリケーション・システムで使用される証明書に関連する構成の問題を修正する場合。
-
レプリケーション構成で使用されるホスト名を更新する場合。
サブオプションは次のとおりです:
-r, --replicationServer
hostName
:replicationPort
レプリケーション・サーバーを参照するために構成で使用されるホスト名およびレプリケーション・ポートを指定します。これらの値は、レプリケートされるすべてのサーバーに適用されます。たとえば:
replicationhost1.example.com:8989
--noReplicationDomainUpdate
--replicationServer
引数を使用してレプリケーション・サーバーのリストを指定するときに指定された場合、変更はレプリケーション・ドメインには適用されません。-a, --serverToAdd
hostName
:administrationPort
誤って登録情報から削除されたサーバーを指定し、再度追加する必要があります(たとえば、
--serverToRemove
オプションを誤って使用して削除されたサーバー)。サーバーで定義されているネットワーク・インタフェースが複数ある場合は、カンマを使用してこれらを区切ります。たとえば:host1-interface1.domain1.com,host2-interface2.domain2.com:4444
-s, --serverToRemove
hostName
:administrationPort
到達不能なサーバー(たとえば、アンインストールされたサーバー)を指定しますが、これらのサーバーはまだ他のサーバーによって参照されており、
dsreplication status
の実行時に示されます。これらのサーバーへの参照は削除されます。たとえば:replicationhost3.example.com:4444
--updateAddress
oldHostName
/
newHostName1
,
newHostName2
指定されたサーバーに対して登録情報で使用する必要がある新しいアドレスを指定します。ネットワーク・インタフェースが変更された、またはレプリケーションの構成時にアドレスの完全なリストが指定されなかった場合は、この引数を使用します。この場合、
dsreplication status
の実行時に行が重複する可能性があります。現在サーバーに使用しているアドレスおよびこれから使用する新しいサーバーを指定する必要があります。たとえば:
oldhost/newhost1,newhost2
--fixCertificates
サーバー間の通信のためにレプリケーションによって使用される証明書の問題を修正します。
-h, --hostname
host
ディレクトリ・サーバーのホスト名またはIPアドレス。
-p, --port
port
ディレクトリ・サーバーの管理ポート番号。デフォルト値: 4444
-
オプション
dsreplication
コマンドは、短いフォーム(たとえば、-H
)または同等の長いフォーム(たとえば、--help
)のいずれかでオプションを受け入れます。
LDAP接続オプション
-
-I, --adminUID
adminUID -
サーバーにバインドするためにグローバル管理者のユーザーIDを指定します。どのサーバーに対しても以前にグローバル管理者が定義されていない場合は、このオプションによって、指定されたデータを使用してグローバル管理者が作成されます。
-
-j, --adminPasswordFile
bindPasswordFile -
ディレクトリ・サーバーに対して認証を受ける際、指定したファイルでグローバル管理者パスワードを使用します。
-
-o, --saslOption
name=
value -
指定されたオプションをSASL認証に使用します。
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
-X, --trustAll
-
SSLまたはStartTLSのネゴシエーション中にサーバーによって提示される可能性のある証明書をすべて信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
-
-P, --trustStorePath
trustStorePath -
指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、
--trustAll
を使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。 -
-U, --TrustStorePasswordFile
path -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。 -
-K, --keyStorePath
keyStorePath -
指定されたパスにクライアント・キーストア証明書を使用します。
-
-u, --keyStorePasswordFile
keyStorePasswordFile -
クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。 -
-N, --certNickname
nickname -
指定された証明書を認証に使用します。
-
--connectTimeout
timeout -
接続の確立に許容される最長時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、
0
を使用します。デフォルト値は30000です。
コマンド入力/出力オプション
-
--commandFilePath
path -
このコマンドが対話モードで実行されているときに同等の非インタラクティブ・コマンドの書込み先となるファイルへのフルパスを指定します。
-
--displayCommand
-
コマンドが対話モードで実行されているときに、同等の非インタラクティブ・コマンドを標準出力に表示します。
-
-n, --no-prompt
-
非対話モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
-
--noPropertiesFile
-
このコマンドでは、デフォルトのコマンド行オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
-
--propertiesFilePath
propertiesFilePath -
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
-
-Q, --quiet
-
最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
一般オプション
例
次の例では、2つのディレクトリ・サーバー、host1
およびhost2
がインストールされていることが前提となります。両方のサーバーがデフォルトの管理ポート(4444)を使用して構成されています。ベースDN dc=example,dc=com
に、host1
のデータが移入されます。ベースDNはhost2
に存在していますが、空です。この例では、2つのサーバー間でレプリケーションを構成し、host2
をデータで初期化しています。
ノート:
dsreplication
の最も簡単な使用方法は対話モードで使用することです。その場合、すべての関連引数に関してプロンプトが表示されます。対話モードと--displayCommand
オプションを使用すると、スクリプトの実行に関する非インタラクティブ・コマンドを取得できます。
構成される引数を示すために、これらの例では対話モードを使用していません。
ディレクトリ・サーバー・レプリケーションの有効化
次のコマンドによって、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
ディレクトリ・サーバー・レプリケーションの初期化
あるレプリカを別のレプリカから初期化するには、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
サブコマンドを使用します。このサブコマンドはソース・ディレクトリ・サーバーの詳細をオプションとして取り、レプリケーションが有効になっているその他のすべてのレプリカを初期化します。
ディレクトリ・サーバーのレプリケーション・ステータスの取得
次のコマンドにより、トポロジ内のディレクトリ・サーバーのレプリケーション・ステータスが取得されます。
bin/dsreplication status -X --adminPasswordFile /tmp/password.txt -n Establishing connections .......... Done. dc=example,dc=com - Replication Enabled ======================================= Server : Entries : M.C. [1] : A.O.M.C. [2] : Port [3] : Status [4] -------------------:---------:----------:--------------:----------:------------- host1:4444 : 200000 : 0 : N/A : 8989 : Normal host2:5444 : 200000 : 0 : N/A : 9989 : Normal [1] The number of changes that are still missing on this element (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 element. [3] The replication port used to communicate between the servers whose contents are being replicated. [4] The status of the replication on this element. To have the same output as in previous versions, the user must use the --dataToDisplay argument with the 'compat-view' value: bin/dsreplication status -X --adminPasswordFile /tmp/password.txt -n --dataToDisplay compat-view Establishing connections ......... Done. dc=example,dc=com - Replication Enabled ======================================= Server : Entries : M.C. [1] : A.O.M.C. [2] : Port [3] : SSL [4] : Trust [5] : U.C. [6] : Status [7] : ChangeLog [8] : Group ID [9] : Connected To [10] -----------:---------:----------:--------------:----------:----------:-----------:----------:--------------:---------------:--------------:--------------------------- host1:4444 : 200000 : 0 : N/A : 8989 : Disabled : Trusted : -- : Normal : Enabled : 1 : host1:8989 (GID=1) host2:5444 : 200000 : 0 : N/A : 9989 : Disabled : Trusted : -- : Normal : Enabled : 1 : host2:9989 (GID=1) [1] The number of changes that are still missing on this element (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 element. [3] The replication port used to communicate between the servers whose contents are being replicated. [4] Whether the replication communication initiated by this element is encrypted or not. [5] Whether the 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 on this element. [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 server this element is connected to with its group ID between brackets.
ディレクトリ・サーバー・レプリケーションの無効化
次のコマンドによって、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.
レプリケートされないサーバーでの外部変更ログの構成
次の例は、変更ログが有効化される前のレプリケーション・ステータスを示しています。
bin/dsreplication status -X --adminPasswordFile /tmp/password.txt -n --bindDN "cn=directory manager" --port 4444 Establishing connections ..... Done. dc=example,dc=com - Replication Disabled ======================================== Server : Entries : ChangeLog [1] --------------:-----------:-------------- host1:4444 : 200000 : Disabled
次のコマンドによって、レプリケートされないサーバーで外部変更ログが有効になります。
bin/dsreplication enable-changelog -X --adminPasswordFile /tmp/password.txt -n --bindDN "cn=directory manager" -b dc=example,dc=com Establishing connections ..... Done. Configuring Replication port on server host1:4444 ..... Done. Enabling Changelog on base DN dc=example,dc=com ..... Done
次の例は、変更ログが有効化された後のレプリケーション・ステータスを示しています。
bin/dsreplication status -X --adminPasswordFile /tmp/password.txt -n --bindDN "cn=directory manager" --port 4444 Establishing connections ...... Done. dc=example,dc=com - Replication Disabled ======================================== Server : Entries : ChangeLog [1] --------------:-----------:-------------- host1:4444 : 200000 : Enabled [1] Whether the external change log is enabled for the base DN on this server or not.
終了コード
-
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
-
指定されたホストが構成に見つかりませんでした。
-
39
-
レプリケーションを有効にするために使用可能なベースDNがありません。これは、2つのサーバー間でレプリケーションを有効にするリクエストを行い、その2つのサーバーがレプリケーションを構成するための共通のベースDNを持たないときに発生します。すでにレプリケートされているか、単に定義されていない可能性があります。
-
40
-
ベースDNがレプリケートされていません。サーバーにレプリケートされたベースDNが含まれていません。したがって、レプリケートされたベースDNに必要な操作(たとえば、
initialize
)は、サーバーに適用できません。 -
41
-
初期化のソースが指定されていますが、宛先サーバーが見つかりません。ソースとして選択されたサーバーにベースDNをレプリケートしている他のサーバーはありません。
-
42
-
同じレプリケーションIDを持つレプリケーション・サーバーまたはレプリケーション・ドメインがあります。これは、たとえば2つのレプリケーション・トポロジをマージしようとしたときに発生します。
-
43
-
識別できないエラー。
-
44
-
暗号化マネージャの構成エラー(レプリケーションのセキュアな接続構成の更新)。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、dsreplicationコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
adminUID
-
baseDN
-
certNickname
-
keyStorePasswordFile
-
keyStorePath
-
saslOption
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
trustAll
-
trustStorePasswordFile
-
trustStorePath
toolname.propertyname=propertyvalue
プロパティ・ファイルのエントリのフォーマットは、次のとおりです:
たとえば:
dsreplication.baseDN=dc=example,dc=com
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/dsreplication
-
Windows: INSTANCE_DIR
\OUD\bat\dsreplication.bat
関連コマンド
A.1.2.7 dstune
dstune
ユーティリティでは、Oracle Unified Directoryサーバーをチューニングできます。
シノプシス
dstune
[subcommand] [options]
説明
dstune
ユーティリティを使用すると、メモリー制限またはメモリーに格納されるデータなどの基準に基づいたOracle Unified Directoryサーバーのチューニングに役立ちます。サーバーをチューニングするには、Oracle Java Standard EditionなどのJava HotSpot(TM)を使用するJava仮想マシンを使用する必要があります。
サブコマンド
dstune
ユーティリティでは、この項で説明したサブコマンドを使用できます。
ノート:
dstune automatic
サブコマンドは使用できなくなりました(automatic
サブコマンドは後方互換性のために引き続き使用できます)。
以前のバージョンのOracle Unified Directoryと同様の自動チューニングを指定するには、--value autotune
サブオプションを指定してdstune set-runtime-options
サブコマンドを使用します。
-
data-based
-
ディレクトリ・サーバーに含まれるデータについての情報を使用して、サーバーをチューニングします。LDIFファイルのコンテンツに基づいてチューニングするには、
--ldifFile
を使用します。エントリ数やサイズに基づいてチューニングするには、--entryNumber
および--entrySize
を使用します。これらのオプションのいずれも指定しない場合は、サーバーに現在格納されているデータを使用してサーバーはチューニングされます。
サブオプションは次のとおりです:
-l, --ldifFile
path
サーバーのチューニングにコンテンツが使用されるLDIFファイルのパスを指定します。
--entryNumber
entrynumber
Oracle Unified Directoryサーバーに含まれるエントリ数を指定します。この値と
--entrySize
に指定された値が、サーバーのチューニングに使用されます。デフォルト値は100000
です。--entrySize
entrysize
Oracle Unified Directoryサーバーに含まれるエントリの平均サイズをKB単位で指定します。この値と
--entryNumber
に指定された値が、サーバーのチューニングに使用されます。デフォルト値は4
です。 -
list
-
サーバーのチューニング設定をリストします。
-
mem-based
-
チューニングするツールに使用するメモリーを指定します。
サブオプションは次のとおりです:
--memory {
heap-size
| system memory | system memory percentage }
チューニングされるツールに使用するメモリーを指定します。
各Javaプロセスのヒープ・サイズに基づいてツールをチューニングするには、メモリーの値を指定します(たとえば、
768m
)。GBの場合は、値の後ろにg
を使用します(たとえば、2.5g
)。値の後ろに単位が指定されていない場合は、MBが使用されます。サーバーをチューニングしている場合は、量または割合のいずれかでシステム・メモリー(
systemMemory
)を指定できます。-
量: たとえば、2 GBを使用するには、
systemMemory:2g
を指定します。dstune
ユーティリティは、指定された値を次の2つの部分に分割します。サーバーのJava仮想マシンが使用するヒープ・サイズと、必要なファイルシステム・キャッシュの見積りの2つです。 -
割合: たとえば、サーバーにシステム・メモリーの50%を割り当てる場合は、
systemMemory:50.0%
を指定します。サーバーにマシンを完全に割り当てるには、systemMemory:100%
を指定します。
メモリーのデフォルト値はユーザー固有の構成および
dstune
が実行されているシステムの使用可能な空きメモリーに基づいて計算されます。--targetTool { server | import-ldif | export-ldif | rebuild-index | verify-index | all }
チューニングが必要なツールを指定します。デフォルトは
server
です。 -
-
set-runtime-options
-
指定された実行時設定を使用してツールをチューニングします。実行時設定の値を指定するには
--value
を使用し、値を適用するツールを指定するには--targetTool
を使用します。サブオプションは次のとおりです:
--value { autotune | jvm-default |
JVM arguments
}
ツールのチューニング・パラメータを指定します。ツールは、マシンの使用可能なメモリーに基づいて起動のたびに自動的にチューニング(値
autotune
を指定)することも、システムのデフォルトのJava仮想マシンを使用して実行時の設定を選択(値jvm-default
を指定)することも、ツールで使用する必要のあるJava引数(-server -Xmx1024m
など)を直接指定することもできます。デフォルトはautotune
です。--targetTool { server | import-ldif | export-ldif | rebuild-index | verify-index | all }
チューニングが必要なツールを指定します。デフォルトは
server
です。
ユーティリティ入力/出力オプション
-
-Q, --quiet
-
非出力操作を実行します(進捗情報は標準出力に出力されない)。
-
-n, --no-prompt
-
非対話モードでユーティリティを実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
-
-v, --verbose
-
冗長モードを使用します。
-
--displayCommand
-
このコマンドが対話モードで実行されているときに、同等の非インタラクティブ・オプションを標準出力に表示します。
-
--commandFilePath
path -
このコマンドが対話モードで実行されているときに同等の非インタラクティブ・コマンドの書込み先となるファイルへのフルパスを指定します。
-
--propertiesFilePath
propertiesFilePath -
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
-
--noPropertiesFile
-
このコマンドでは、デフォルトのコマンド行オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
一般オプション
例
この項の例では、dstune
ユーティリティを使用してOracle Unified Directoryサーバーおよびツールをチューニングする方法を示します(import-ldif
、export-ldif
、verify-index
およびrebuild-index
)。
ノート:
Oracle Unified Directory 11g リリース2 (11.1.2.3)以降では、dstune automatic
サブコマンドは使用できなくなりました(automatic
サブコマンドは後方互換性のために引き続き使用できます)。
以前のバージョンのOracle Unified Directoryと同様の自動チューニングを指定するには、--value autotune
サブオプションを指定してdstune set-runtime-options
サブコマンドを使用します。
「dstune」を参照してください
メモリーベース・チューニング
次のサブコマンドは、ヒープ・サイズに2 GBを指定するサーバーおよびすべてのツールをチューニングします。
$ dstune mem-based --memory 2g --targetTool all Calculating Tuning Settings ..... Done. Updating the tuning properties ..... Done. Updating scripts ..... Done.
データベース・チューニング
次のサブコマンドは、サーバーに平均サイズが20
KBの10000000
エントリが含まれるという前提に基づいて、サーバーをチューニングします。
$ dstune data-based --entryNumber 10000000 --entrySize 20 Calculating Tuning Settings ..... Done. Updating the tuning properties ..... Done. Updating scripts ..... Done.
実行時チューニング
次のサブコマンドは、自動チューニングを使用するサーバーおよびimport-ldif
ツールのみをチューニングします。サーバーおよびimport-ldif
ツールを実行するたびに、システム・リソースに基づいてチューニングが行われます。
$ dstune set-runtime-options --targetTool server --targetTool import-ldif \ --value autotune Updating the tuning properties ..... Done. The server will be automatically tuned the next time it will be restarted.
現在のチューニング・モードの表示
次のサブコマンドは、Oracle Unified Directoryサーバー・インスタンスの現在のチューニング設定を表示します。
$ dstune list Tool : Tuning Value --------------:------------------ server : -server import-ldif : -Xmx2048m -server export-ldif : Automatic Tuning rebuild-index : Automatic Tuning verify-index : -Xmx2048m -server
終了コード
-
0
-
操作は正常に完了しました。これには、エラーなしで操作が実行されなかった場合も含まれます(たとえば、使用率が表示された場合)。
-
1
-
引数を初期化できません。
-
2
-
ユーザーが指定したデータが正しくありません(たとえば、無効な値や競合する属性)。
-
3
-
相互作用中にユーザーが操作を取り消しました。
- 4
-
java.propertiesファイルへの書込み時のエラー。
-
5
-
チューニング設定を更新するための
dsjavaproperties
コマンド行実行時のエラー。 -
6
-
JVMチューニング設定の取得でエラーが発生しました。これは、
dstune
で使用するアルゴリズムが有効な設定を見つけることができないときに発生します。 -
7
-
現在のチューニング設定の表示中にjava.propertiesファイルの読込みでエラーが発生しました。
-
8
-
識別できないエラー。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/dstune
-
Windows: INSTANCE_DIR
\OUD\bat\dstune.bat
関連コマンド
A.1.2.8 gicadm
gicadm
コマンドは、グローバル索引とグローバル索引カタログを管理します。
このコマンドはプロキシのみにサポートされます。
シノプシス
gicadm
[subcommand] [options]
説明
gicadm
コマンドにより、グローバル索引カタログの作成と削除、グローバル索引カタログ内でのグローバル索引の追加、変更、および削除と、グローバル索引カタログのレプリケーションの管理を実行できます。また、グローバル索引と分散との関連付けも実行できます。
gicadm
コマンドは、管理コネクタを介してSSL上のサーバーにアクセスします。
オプション
gicadm
コマンドは、次のオプションを受け入れます。
-
add-index
-
新しいグローバル索引をグローバル索引カタログに追加します。サブオプションは次のとおりです:
-c, --catalogName
name。グローバル索引カタログの一意の識別子。これは必須の引数です。--attributeName attribute-name
。グローバル索引属性の識別子。この識別子はグローバル索引カタログのコンテキストにおいて一意である必要があり、グローバル索引の識別に使用されます。--set
property:
value。プロパティに値を割り当てます。ここで、propertyはプロパティの名前、valueは割り当てられる単一の値です。同一のプロパティに複数の値を割り当てるには、そのプロパティを複数回指定します。 -
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
-
グローバル索引カタログの分散ワークフロー要素への関連付けを解除します。サブオプションは次のとおりです:
-d, --distributionWorkflowElement
distribution-workflow-element。このグローバル索引カタログを使用する分散ワークフロー要素のオブジェクト名であり、グローバル索引カタログはこの関連付けを解除されます。 -
enable-replication
-
グローバル索引カタログとそのグローバル索引がすべてレプリケートされるようにサーバー構成を更新します。指定したサーバーの1つが指定されたグローバル索引に対してグローバル索引カタログをすでにレプリケートしている場合は、このサブコマンドを実行することによってトポロジ内の全サーバーの構成が更新されます。したがって、レプリケーション・トポロジに追加されるサーバーごとに1回、このコマンドを実行するだけで十分です。サブオプションは次のとおりです:
-c, --catalogName
name。グローバル索引カタログの一意の識別子。これは必須の引数です。--adminUID
adminUID。サーバーへのバインドに使用するグローバル管理者のユーザーID。enable-replication
サブコマンドについては、以前にグローバル管理者が定義されていない場合は、指定されたデータを使用してグローバル管理者が作成されます。--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。グローバル索引カタログの一意の識別子。これは必須の引数です。--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
です。 -
post-external-initialization
-
このサブコマンドは、このツールのimportサブコマンドを使用してレプリケートされたすべてのグローバル索引のコンテンツを初期化した後で、コールする必要があります。これは、有効なインスタンスとしてターゲットとなるインスタンスの生成IDを使用します。サブオプションは次のとおりです:
-c, --catalogName
name。グローバル索引カタログの一意の識別子。これは必須の引数です。-a, --attributeName
attribute-name。グローバル索引属性の識別子。このオプションを複数回使用して、複数の索引付き属性を指定できます。このオプションが指定された場合、インポート・ソース内の一致しない索引付き属性はすべてスキップされます。 -
pre-external-initialization
-
このサブコマンドは、このツールのimportサブコマンドを使用してレプリケートされたすべてのサーバーのコンテンツを初期化する前にコールできます。レプリケーション・サーバーに保存されているレプリケーション変更ログを削除します。サブオプションは次のとおりです:
-c, --catalogName
name。グローバル索引カタログの一意の識別子。これは必須の引数です。-a, --attributeName
attribute-name。グローバル索引属性の識別子。このオプションを複数回使用して、複数の索引付き属性を指定できます。このオプションが指定された場合、インポート・ソース内の一致しない索引付き属性はすべてスキップされます。 -
remove-index
-
グローバル索引をグローバル索引カタログから削除します。サブオプションは次のとおりです:
-c, --catalogName
name。グローバル索引カタログの一意の識別子。これは必須の引数です。--attributeName
attribute-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。グローバル索引カタログの一意の識別子。これは必須の引数です。--attributeName attribute-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
です。--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
です。 -
status-replication
-
グローバル索引カタログの基本的なレプリケーション構成を含むリストを表示します。グローバル索引カタログが指定されない場合は、レプリケートされたすべてのグローバル索引カタログの情報が表示されます。サブオプションは次のとおりです:
-c, --catalogName
name。グローバル索引カタログの一意の識別子。これは必須の引数です。--adminUID
adminUID。サーバーへのバインドに使用するグローバル管理者のユーザーID。status-replication
サブコマンドについては、以前にグローバル管理者が定義されていない場合は、指定されたデータを使用してグローバル管理者が作成されます。-s, --scriptFriendly
。スクリプト・フレンドリ・モードを使用します。
LDAP接続オプション
gicadm
コマンドは、管理コネクタを介してSSL上のディレクトリ・サーバーに接続します(「サーバーへの管理トラフィックの管理」で説明しています)。これらの接続オプションは、ディレクトリ・サーバーとの接続に使用します。
-
-h, --hostname
host -
ディレクトリ・サーバーのホスト名またはIPアドレス。
-
-D, --bindDN
bindDN -
サーバーへのバインドに使用するDN。
-
-j, --bindPasswordFile
filename -
バインド・パスワードが含まれているファイルへのフルパス。
-
-K, --keyStorePath
path -
指定されたパスにクライアント・キーストア証明書を使用します。
-
-N, --certNickname
nickname -
SSLクライアント認証に証明書を使用します。
-
-o, --saslOption
name=value -
SASLバインド・オプション。
-
-p, --port
port -
ディレクトリ・サーバーの管理ポート番号。
-
-P, --trustStorePath
path -
指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、
--trustAll
を使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。 -
-u, --keyStorePasswordFile
filename -
クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。 -
-U, --trustStorePasswordFile
filename -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。 -
-X, --trustAll
-
サーバーによって提示されるすべての証明書を信頼します。このオプションはテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
-
--connectTimeout
timeout -
接続の確立に許容される最大継続時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、
O
を使用します。デフォルト値は、 30000 ミリ秒です。
コマンド入力/出力オプション
一般オプション
例
次の例は、gicadm
コマンドの使用方法を示しています。
ノート:
グローバル索引カタログの作成、グローバル索引の追加、グローバル索引カタログの分散への関連付けに関する次の例は、分散デプロイメントでグローバル索引カタログを使用するために必要な3つのステップです。
グローバル・ヘルプ・サブコマンドとグローバル・オプションの表示
次のコマンドは、グローバル索引カタログの管理に使用可能なグローバル・ヘルプ・サブコマンドとグローバル・オプションを表示します:
$ gicadm --help
個別サブコマンドのヘルプの表示
次のコマンドは、create-catalog
サブコマンドのヘルプ情報を表示します:
$ gicadm create-catalog --help
gicadmを使用したグローバル索引カタログの作成
このコマンドを実行する前に、分散を使用してプロキシをデプロイしておく必要があります。
$ gicadm -h localhost -p 4444 -D "cn=Directory Manager" -j /path/pwd-file -X \ create-catalog --catalogName myCatalog
gicadmを使用したグローバル索引カタログへのグローバル索引の追加
このコマンドを実行する前に、分散を使用してプロキシをデプロイしておく必要があります。さらに、このコマンドを実行する前に、グローバル索引カタログを作成しておく必要があります。
$ gicadm -h localhost -p 4444 -D "cn=Directory Manager" -j /tmp-pwd-file -X \ add-index --catalogName myCatalog --attributeName telephoneNumber
gicadmを使用したグローバル索引カタログの分散への関連付け
このコマンドを実行する前に、分散を使用してプロキシをデプロイしておく必要があります。さらに、このコマンドを実行する前に、グローバル索引カタログを作成しておく必要があります。
$ gicadm -h localhost -p 4444 -D "cn=Directory Manager" -j /tmp-pwd-file -X \ associate --catalogName myCatalog --distributionWorkflowElement myDistributionName
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/gicadm
-
Windows: INSTANCE_DIR
\OUD\bat\gicadm.bat
関連コマンド
A.1.2.9 manage-tasks
manage-tasks
コマンドは、ディレクトリ・サーバーでの実行がスケジュールされているタスクの管理とモニターを行います。
このコマンドはプロキシに対してサポートされていません。
シノプシス
manage-tasks
[options]
説明
manage-tasks
コマンドを使用して、ディレクトリ・サーバーでの実行がスケジュールされているタスクを管理およびモニターできます。タスクを起動するときに適切なスケジュール情報を指定することにより、タスクがスケジュールされます(「タスクとしてのコマンドの構成」を参照)。manage-tasks
コマンドを使用して、現在スケジュールされているタスク、またはすでに実行されているタスクをリストすることができます。さらに、タスクのスケジュール済時間と実行時間、タスクのログ・メッセージ、およびオプションについて詳細情報を取得できます。
manage-tasks
コマンドはオンライン・サーバー・インスタンスでのみ実行でき、管理コネクタを介してSSL上のタスク・バックエンドにアクセスします(「サーバーへの管理トラフィックの管理」で説明しています)。
オプション
manage-tasks
コマンドは、短いフォーム(たとえば、-c
taskID)または同等の長いフォーム(たとえば、--cancel
taskID)のいずれかのオプションを受け入れます。
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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
コマンド入力/出力オプション
一般オプション
例
次の例は、manage-tasks
コマンドの使用方法を示しています。
スケジュール済タスクのサマリーの表示
次のコマンドは、スケジュール済タスクのリストを表示します:
$ 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
タスク情報の取得
次のコマンドは、特定のタスクに関する情報を返します:
$ 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
スケジュール済タスクのキャンセル
次のコマンドは、スケジュール済タスクを取り消します。このコマンドは、--no-prompt
オプションを使用して非対話モードで実行します。
$ manage-tasks -h localhost -p 4444 -D "cn=directory manager" -j /path/pwd-file \ -X -c 2008101610442610 Task 2008101610442610 canceled
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、manage-tasksコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
場所
-
UNIXおよびLinux: OUD_ORACLE_HOME
/bin/manage-tasks
-
Windows: OUD_ORACLE_HOME
\bat\manage-tasks.bat
関連コマンド
A.1.2.10 oudCopyConfig
oudCopyConfig
コマンドは、既存の構成のコピーをソース環境から取得するために使用します。
テストから本番環境への移動の詳細は、「テスト環境から本番環境への移行」を参照してください。
シノプシス
oudCopyConfig
[options]
説明
既存の構成のコピーを取得するには、ソース環境でoudCopyConfig
コマンドを実行します。
oudCopyConfig
コマンドは、次のアクションを実行します。
-
テスト・インスタンス(
instHomePath
)の本番環境への移動に必要な構成データが含まれているアーカイブ(archivePath
)を作成します。-archiveLoc
オプションは、アーカイブへのフルパスを指定します。 -
アーカイブに移動計画を作成します。
-
すべてのメッセージをlog_directory.に記録します。指定されない場合、記録されたメッセージのデフォルト場所はシステムの一時ディレクトリになります。
オプション
oudCopyConfig
コマンドは、オプションを次のフォームで受け入れます。
-
-javaHome,
javaHomePath -
JDKの絶対パス。
-
-al, -archiveLoc
archivePath -
アーカイブの場所の絶対パス。これには、テスト・インスタンス(
instHomePath
)の本番環境への移動に必要な構成データが含まれています。 -
-sih, -sourceInstanceHomeLoc
instHomePath -
本番環境にコピーする既存のインスタンスの絶対パス。
-
-h, -help
-
このヘルプ・メッセージを表示して終了します。このパラメータはオプションです。
-
-ldl, -logDirLoc
logPath -
既存のログ・ディレクトリの場所。デフォルトの場所は、システムの一時的な場所です。このパラメータはオプションです。
例
次の例は、oudCopyConfig
コマンドの使用方法を示しています。
既存の構成のコピーの取得
次のコマンドは、既存の構成のコピーを取得します。
$ OUD_ORACLE_HOME/bin/oudCopyConfig -javaHome /usr/jdk \
-sourceInstanceHomeLoc /local/asinst_1 -archiveLoc /tmp/oud.jar \
-logDirLoc /tmp/logs
ヘルプ・コマンド・オプションの実行
次のコマンドは、ヘルプ・コマンド・オプションを実行します。
$ OUD_ORACLE_HOME/bin/oudCopyConfig -javaHome /usr/jdk -help
場所
-
UNIXおよびLinux: OUD_ORACLE_HOME
/bin/oudCopyConfig
-
Windows: OUD_ORACLE_HOME
\bat\oudCopyConfig.bat
関連コマンド
A.1.2.11 oudExtractMovePlan
oudExtractMovePlan
コマンドは、-planDirLoc
引数により指定された場所にあるmoveplan.xmlというファイル内の構成の編集可能バージョンを作成するために使用します。このディレクトリが存在していて、書込み可能である必要があります。
テストから本番環境への移動の詳細は、「テスト環境から本番環境への移行」を参照してください。
シノプシス
oudExtractMovePlan
[options]
説明
移動計画を編集することによって、特定の構成パラメータを変更できます。移動計画とは、環境にまたがっての移動中にカスタマイズ可能なパラメータを公開するXMLファイルです。
移動計画は、oudCopyConfig
コマンドを実行するときに生成され、構成を複製するためにoudPasteConfig
コマンドによって使用されます。
オプション
oudExtractMovePlan
コマンドは、オプションを次のフォームで受け入れます:
例
次の例は、oudExtractMovePlan
コマンドの使用方法を示しています。
構成の編集
次のコマンドによって、構成を編集できます。
$ OUD_ORACLE_HOME/bin/oudExtractMovePlan -javaHome /usr/jdk \
-al /tmp/oud.jar -pdl /tmp -logDirLoc /tmp/logs
ヘルプ・コマンド・オプションの実行
次のコマンドは、ヘルプ・コマンド・オプションを実行します。
$ OUD_ORACLE_HOME/bin/oudExtractMovePlan -javaHome /usr/jdk -help
場所
-
UNIXおよびLinux: OUD_ORACLE_HOME
/bin/oudExtractMovePlan
-
Windows: OUD_ORACLE_HOME
\bat\oudExtractMovePlan.bat
関連コマンド
A.1.2.12 oudPasteConfig
oudPasteConfig
コマンドは、構成をターゲット環境に貼り付けるために使用します。
テストから本番環境への移動の詳細は、「テスト環境から本番環境への移行」を参照してください。
シノプシス
oudPasteConfig
[options]
説明
ターゲット環境で構成を取得するには、oudPasteConfig
コマンドを実行します。
oudPasteConfig
コマンドは、アーカイブと修正済の移動計画から取得した構成で新しいサーバー・インスタンスを作成します。
オプション
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 -
既存のログ・ディレクトリの場所。デフォルトの場所は、システムの一時的な場所です。このパラメータはオプションです。
例
次の例は、oudPasteConfig
コマンドの使用方法を示しています。
構成の貼付け
次のコマンドによって、構成を貼り付けることができます。
$ 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
ヘルプ・コマンド・オプションの実行
次のコマンドは、ヘルプ・コマンド・オプションを実行します。
$ OUD_ORACLE_HOME/bin/oudPasteConfig -javaHome /usr/jdk -help
場所
-
UNIXおよびLinux: OUD_ORACLE_HOME/
bin/oudPasteConfig
-
Windows: OUD_ORACLE_HOME
\bat\oudPasteConfig.bat
関連コマンド
A.1.2.13 oud-replication-gateway-setup
oud-replication-gateway-setup
コマンドは、レプリケーション・ゲートウェイ・インスタンスの設定に使用します。
シノプシス
oud-replication-gateway-setup
[options]
説明
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モードで実行している場合、オプションの使用は許可されません。
オプション
oud-replication-gateway-setup
コマンドは、短いフォーム(たとえば、-i
)または同等の長いフォーム(たとえば、--cli
)のいずれかでオプションを受け入れます。
レプリケーション・ゲートウェイの構成オプション
-
-h, --hostname
hostname -
レプリケーション・ゲートウェイがインストールされるホストの完全修飾名。レプリケーション・トポロジ内のOracle Directory Server Enterprise EditionサーバーとOracle Unified Directoryサーバーは、このホスト名にアクセスできる必要があります。このオプションが指定されない場合は、
localhost
のデフォルトが使用されます。 -
--adminConnectorPort
port -
管理コネクタが管理トラフィックについてリスニングする必要のあるポートを指定します。管理コネクタの詳細は、「サーバーへの管理トラフィックの管理」を参照してください。構成ツールおよび管理ツールでは、このポートを使用してレプリケーション・ゲートウェイに接続します。デフォルト値は
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を指定できます。
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
を使用している場合のみ使用できます。
レプリケーション・ゲートウェイのセキュリティ・オプション
-
--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サーバーから暗号化された接続を受け入れるときにレプリケーション・ゲートウェイが使用する証明書のニックネームを指定します。
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 -
グローバル管理者のパスワードが含まれているファイル。
セキュアな接続のオプション
-
-o, --saslOption
name=
value -
これらはSASLバインド・オプションです。
SASLは、プロキシ・インスタンスに対してサポートされていません。
-
-X, --trustAll
-
サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
-
-P, --trustStorePath
path -
指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、
--trustAll
を使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。 -
-U, --trustStorePasswordFile
path -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。 -
-K, --keyStorePath
path -
指定されたパスにクライアント・キーストア証明書を使用します。
-
-u, --keyStorePasswordFile
filename -
クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。 -
-N, --certNickname
nickname -
指定された証明書をSSLクライアント認証に使用します。
-
--connectTimeout
timeout -
接続の確立に許容される最長時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、
0
を使用します。デフォルト値は30000です。
コマンド入力/出力オプション
-
-n, --no-prompt
-
setup
を非対話モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。 -
-Q, --quiet
-
最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-
-v, --verbose
-
標準出力に診断を表示する冗長モードで実行します。
-
--noPropertiesFile
-
このコマンドでは、デフォルトのコマンド行オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
-
--propertiesFilePath
path -
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
一般オプション
例
次の例は、レプリケーション・サーバー・コマンドの使用方法を示しています。
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
コマンド行からの対話モードでのoud-replication-gateway-setupの実行
GUIが起動して、いくつかの画面が表示されます。これらの画面では、スタンドアロン環境またはレプリケートされた環境でレプリケーション・サーバーを順次設定することができます。また、SSL証明書またはStartTLS証明書を設定するためのオプションもあります。
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
終了コード
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、oud-replication-gateway-setupコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
すべてのoud-replication-gateway-setup
オプションは、プロパティ・ファイルに保存可能です。プロパティ・ファイルのエントリのフォーマットは、次のとおりです:
toolname.propertyname=propertyvalue
たとえば:
oud-replication-gateway-setup.hostname=grevalon:1444
ログ・ファイル
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
です。
場所
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.1.2.14 oud-setup
oud-setup
コマンドは、ディレクトリ・サーバー・インスタンスのインストールと最小限の構成を行います。
このコマンドは、ディレクトリ・サーバー・インスタンスを設定します。プロキシ・サーバー・インスタンスの設定の詳細は、「oud-proxy-setup」を参照してください
シノプシス
oud-setup
[options]
説明
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モードで実行している場合、オプションの使用は許可されません。
オプション
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
がルートとして使用されます。有効にしない場合は、'disabled'を使用します。 -
--adminConnectorPort
port -
管理コネクタが管理トラフィックについてリスニングする必要のあるポートを指定します。管理コネクタの詳細は、「サーバーへの管理トラフィックの管理」を参照してください。デフォルト値は
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プラットフォームの場合に限られます。
-
--serverTuning
{ jvm-default
|heap-size
|system-memory
|system-memory-percentage
|JVM arguments
} -
サーバーの実行時チューニング・オプションを指定します。
ノート:
Oracle Unified Directory 11g リリース2 (11.1.2.3)では、
autotune
オプションが削除されました。ただし、autotune
は後方互換性のために引き続き使用できます。サーバーの実行時に引数を追加せずにデフォルト(または構成された) Java仮想マシンをシステムで使用するには、値
jvm-default
を指定します。そのJavaプロセスのヒープ・サイズに基づいてサーバーをチューニングするには、使用するメモリーを指定します(たとえば:
768m
)。GBの場合はg
を使用します(たとえば:2.5g
)。値の後ろに単位も%
も指定されていない場合は、MBが使用されます。サーバーには、そのJavaプロセスのメモリーだけでなく、ファイルシステム・キャッシュのメモリーも必要です。サーバーのメモリーは、Javaヒープと必要なファイルシステム・キャッシュの見積りを合計したものです。
システム・メモリーを量または割合のいずれかで指定できます。
-
量: たとえば:
3.0GBを使用するには、
--serverTuning systemMemory:3g
を指定します。1GBを使用するには、
--serverTuning systemMemory:1g
を指定します。512MBを使用するには、
--serverTuning systemMemory:512
を指定します。oud-setup
スクリプトは、指定された値を次の2つの部分に分割します。サーバーのJava仮想マシンが使用するヒープ・サイズと、必要なファイルシステム・キャッシュの見積りの2つです。 -
割合: たとえば:
サーバーにシステム・メモリーの50%を割り当てるには、
--serverTuning systemMemory:50.0%
を指定します。サーバーにシステム・メモリーの25%を割り当てるには、
--serverTuning systemMemory:25%
を指定します。サーバーにマシンを完全に割り当てるには、
--serverTuning systemMemory:100%
を指定します。oud-setup
スクリプトは、指定された割合を次の2つの部分に分割します。サーバーのJava仮想マシンが使用するヒープ・サイズと、必要なファイルシステム・キャッシュの見積りの2つです。
サーバーで使用する必要があるJVM引数を直接指定することもできます。たとえば:
--serverTuning -server -Xmx1024m
サーバーのデフォルト値はシステムの使用可能な空きメモリーに基づいて計算され、設定が実行されているマシンおよびそのマシンで使用されているメモリー量によって異なります。
-
-
--offlineToolsTuning
{ autotune | jvm-default |
JVM arguments
}
-
オフライン・ツールのチューニングを指定します(
import-ldif
、export-ldif
、verify-index
およびrebuild-index
)。ノート:
Oracle Unified Directory 11g リリース2 (11.1.2.3)では、
--importTuning
オプションの名前が--offlineToolsTuning
に変更されました。ただし、--importTuning
は後方互換性のために引き続き使用できます。ツールは、マシンの使用可能なメモリーに基づいて起動のたびに自動的にチューニング(値
autotune
を指定)することも、実行時の設定にシステムのデフォルトのJava仮想マシンを使用(値jvm-default
を指定)することもできます。ツールで使用する必要があるJava引数を直接指定することもできます。たとえば、次のコマンドで
-server
引数を使用します。--offlineToolsTuning -server -Xmx1024m
ツールのデフォルト値はシステムの使用可能な空きメモリーに基づいて計算され、設定が実行されているマシンおよびそのマシンで使用されているメモリー量によって異なります。
コマンド入力/出力オプション
-
-n, --no-prompt
-
setup
を非対話モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。 -
--noPropertiesFile
-
このコマンドでは、デフォルトのコマンド行オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
-
--propertiesFilePath
path -
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
-
-Q, --quiet
-
最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-
-v, --verbose
-
標準出力に診断を表示する冗長モードで実行します。
一般オプション
例
次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。
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
コマンド行からの対話モードでのoud-setupの実行
oud-setup
コマンドは対話モードで実行できます。このモードでは、インストール・オプションに関してプロンプトが表示されます。oud-setup
を対話モードで実行するには、次のコマンドを入力します:
$ oud-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
非インタラクティブ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
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"
サンプル・エントリの生成を指定した非対話モードでの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
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
サーバーをチューニングするための対話モードでのoud-setupの実行
次のコマンドによって、Oracle Unified Directoryサーバーをチューニングできます。
C:\OUD\OracleUnifiedDirectory> oud-setup.bat --cli
OUD Instance location successfully created - C:\OUD\OracleUnifiedDirectory\..\asinst_1"
Oracle Unified Directory 11.1.2.3.0
Please wait while the setup program initializes...
What would you like to use as the initial root user DN for the Directory
Server? [cn=Directory Manager]:
Please provide the password to use for the initial root user: password
Please re-enter the password for confirmation: password
On which port would you like the Directory Server to accept connections from
LDAP clients? [389]:
On which port would you like the Administration Connector to accept
connections? [4444]:
Do you want to create base DNs in the server? (yes / no) [yes]:
Provide the base DN for the directory data: [dc=example,dc=com]:
Options for populating the database:
1) Only create the base entry
2) Leave the database empty
3) Import data from an LDIF file
4) Load automatically-generated sample data
Enter choice [1]: 4
Please specify the number of user entries to generate: [2000]:
Do you want to enable SSL? (yes / no) [no]:
Do you want to enable Start TLS? (yes / no) [no]:
Enable the server to run as a Windows Service? (yes / no) [no]:
Specify the Oracle components with which the server integrates. It is
recommended to choose the option covering only your requirements.
1) No Integration
2) DIP (Directory Integration Platform)
3) Generic: Database Net Services, EBS and DIP
4) EUS (Enterprise User Security), Database Net Services, EBS and DIP
c) cancel
Enter choice [1]:
How do you want the OUD server to be tuned?
1) Use specific Java Virtual Machine arguments
2) Use the default Java Virtual Machine settings
3) Provide the Java heap size to be used by the server
4) Provide the percentage of system memory to be used by the server
5) Provide the size of system memory to be used by the server
Enter choice [2]: 2
How do you want the off-line tools (import-ldif, export-ldif, verify-index and
rebuild-index) to be tuned?
1) Use specific Java Virtual Machine arguments
2) Use the default Java Virtual Machine settings
3) Automatic Tuning
4) Provide the Java heap size to be used by the off-line tools
Enter choice [2]: 3
Do you want to start the server when the configuration is completed? (yes /
no) [yes]:
Setup Summary
=============
LDAP Listener Port: 389
Administration Connector Port: 4444
LDAP Secure Access: disabled
Root User DN: cn=Directory Manager
Directory Data: Create New Base DN dc=example,dc=com
Base DN Data: Import Automatically-Generated
Data (2000 Entries)
Integration with Oracle components: No Integration
Server Runtime Settings: Use the default Java Virtual Machine settings
Off-line Tools Runtime Settings: Use Automatic Tuning
Start Server when the configuration is completed
Do not enable the server to run as a Windows Service
What would you like to do?
1) Set up the server with the parameters above
2) Provide the setup parameters again
3) Print equivalent non-interactive command-line
4) Cancel and exit
Enter choice [1]:
See C:\OUD\asinst_1\OUD\logs\oud-setup for a detailed
log of this operation.
Configuring Directory Server ..... Done.
Importing Automatically-Generated Data (2000 Entries) ........ Done.
Starting Directory Server ....... Done.
To see basic server configuration status and configuration you can launch
C:\OUD\asinst_1\OUD\bat\status.bat
...
終了コード
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、oud-setupコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
certNickname
-
hostname
-
keyStorePasswordFile
前のoud-setup
オプションはすべて、プロパティ・ファイルに保存可能です。プロパティ・ファイルのエントリのフォーマットは、次のとおりです:
toolname.propertyname=propertyvalue
たとえば:
oud-setup.hostname=grevalon:1444
ログ・ファイル
oud-setup
コマンドは、oud-setup-
IDnumberというログ・ファイルに書き込みます。この場合のIDnumberは10進数です。ログ・ファイルは次のパスに置かれています:
-
UNIX (Solaris):
/var/tmp/
-
Linux:
/tmp/
-
Windows:
%TEMP%
デフォルトでは、このフォルダは
C:\Documents and Settings\User\Local Settings\Temp
です。
場所
oud-setup
コマンドは、次のパスに置かれています:
-
UNIXおよびLinux: OUD_BASE_LOCATION/OUD_ORACLE_HOME
/oud-setup
-
Windows: OUD_BASE_LOCATION\OUD_ORACLE_HOME
\oud-setup.bat
A.1.2.15 oud-proxy-setup
oud-proxy-setup
コマンドは、プロキシ・サーバー・インスタンスの設定と構成を管理します。
シノプシス
oud-proxy-setup
[options]
説明
oud-proxy-setup
コマンドは、プロキシ・サーバー・インスタンスのインストールと構成を行います。その際、リスニングに使用するポート、初期ルート・ユーザーの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
オプションを使用すると、ライセンスが自動的に受け入れられます。
オプション
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
-
構成が完了したときに、サーバーを起動しません。
コマンド入力/出力コマンド
-
-Q, --quiet
-
最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-
-v, --verbose
-
冗長モードを使用します
-
--propertiesFilePath
path -
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
-
--noPropertiesFile
-
デフォルトのコマンド行オプションの取得にプロパティ・ファイルが使用されないことを示します。
-
-n, --no-prompt
-
ライセンス受入れの場合のみ、インストールを非対話モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
一般オプション
例
次の例は、oud-proxy-setup
コマンドの使用方法を示しています。
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
非インタラクティブ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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
ログ・ファイル
設定が終了すると、oud-proxy-setup
コマンドはoud-proxy-setup.log
というログ・ファイルに書き込みます。このログ・ファイルは次のパスに置かれています:
-
UNIX (Solaris):
/var/tmp/
-
Linux:
/tmp/
-
Windows:
%TEMP%
フォルダ。デフォルトでは、このフォルダはC:\Documents and Settings\
user\Local Settings\Temp
です。
場所
-
UNIXおよびLinux: OUD_BASE_LOCATION/OUD_ORACLE_HOME/
oud-proxy-setup
-
Windows: OUD_BASE_LOCATION\OUD_ORACLE_HOME\
oud-proxy-setup.bat
A.1.2.16 start-ds
start-ds
コマンドは、インストールされたサーバー・インスタンスを開始します。
シノプシス
start-ds
[options]
説明
start-ds
コマンドは、サーバーの起動と一般的なサーバー情報の指定に使用します。
start-ds
は、オプションを指定せずに実行できます。その場合、サーバーはバックグラウンド・プロセスとして起動します。この場合、サーバーが正常に起動するか、起動を妨げるエラーが発生するまで、スクリプトは終了しません。
UNIXシステムでは、INSTANCE_DIR/logs/server.pid
でプロセスIDをログに記録できない場合、サーバーは起動しません。サーバーが使用するユーザー・アカウントによってファイルが書込み可能であることを確認します。
オプション
start-ds
コマンドは、短いフォーム(たとえば、-N
)または同等の長いフォーム(たとえば、--nodetach
)のいずれかでオプションを受け入れます。
-
-L, --useLastKnownGoodConfig
-
現在アクティブな構成を使用するのではなく、最後に成功した起動時に指定されていた構成が使用可能な場合にこの構成を使用して起動を試行します。
-
-N, --nodetach
-
サーバーを、端末から連結解除されないフォアグラウンド・プロセスとして起動します。サーバーがこのモードで実行している場合は、別のウィンドウから
stop-ds
コマンドを使用して、またはサーバーが実行している端末ウィンドウで[Control]+[C]
キーを押してサーバーを停止することができます。 -
-s, --systemInfo
-
サーバーがインストールされているシステムの一般情報を、インスタンスとインストール・パスも含めて表示し、その後で、サーバーの起動を試行しないで終了します。
-
-t, --timeout
seconds -
コマンドが戻るまで最大時間(単位: 秒)以上は待機しません。(サーバーは、それにかかわらず起動プロセスを続行します)。値
0
は無限タイムアウトを示し、サーバーの起動が完了したときのみコマンドが戻ることを意味します。デフォルト値は60秒です。このオプションは、-N
、--nodetach
オプションと同時に使用できません。
一般オプション
例
次の例は、start—ds
コマンドの使用方法を示しています。
サーバーの起動
次のコマンドによって、サーバーが起動します:
$ start-ds
フォアグラウンド・プロセスとしてのサーバーの起動
次のコマンドによって、サーバーがフォアグラウンド・プロセスとして起動します。別のウィンドウから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
終了コード
終了コード | 説明 |
---|---|
|
サーバーは正常に起動されました。 |
|
チェック・エラー。互換性のないオプションにより生成されました。 |
|
サーバーはすでに起動しています。 |
|
サーバーは連結解除されたプロセスとして起動する必要があります。 |
|
サーバーは連結解除されないプロセスとして起動する必要があります。 |
|
サーバーはWindowsサービスとして起動する必要があります。 |
|
サーバーは連結解除されたプロセスとして起動する必要があり、Windowsサービスからコールされています。 |
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/start-ds
-
Windows: INSTANCE_DIR
\OUD\bat\start-ds.bat
関連コマンド
A.1.2.17 status
status
コマンドは、基本的なサーバー・ステータス情報を表示します。
シノプシス
status
[options]
説明
status
コマンドは、サーバーのステータス(起動済または停止)、構成された接続ハンドラ、または定義済バックエンドと接尾辞のリストといった基本的なサーバー・ステータス情報の表示に使用できます。
サーバーが起動している場合、status
コマンドは、管理コネクタを介してSSL上のサーバーに接続します。
詳細は、「サーバーへの管理トラフィックの管理」を参照してください。
サーバーが停止している場合は、構成ファイル(特にconfig.ldif
ファイル)を読み取るファイル・システム・アクセス権を持つユーザーとしてこのコマンドを実行する必要があります。
ノート:
サーバーが実行している場合は、特定のモニタリング・データのみ(たとえば、バックエンドにあるエントリ数)を表示できます。
LDAP接続オプション
status
コマンドは、管理コネクタを介してSSL上のサーバーに接続します(「サーバーへの管理トラフィックの管理」で説明しています)。これらの接続オプションは、サーバーとの接続に使用します。
-
-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 -
指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、
--trustAll
を使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。 -
-u, --keyStorePasswordFile
filename -
クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。 -
-U, --trustStorePasswordFile
filename -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。 -
-X, --trustAll
-
サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
コマンド入力/出力オプション
-
-n, --no-prompt
-
非対話モードを使用します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。
-
--noPropertiesFile
-
このコマンドでは、デフォルトのコマンド行オプションを取得するためにプロパティ・ファイルを使用する必要がないことを示します。
-
--propertiesFilePath
path -
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
-
-r, --refresh
period -
この引数を指定した場合、statusコマンドはコンテンツを周期的に表示します。ステータスの2回の表示の間の期間(単位: 秒)を指定するために使用します。
-
-s, --script-friendly
-
スクリプト・フレンドリ・モードで実行します。スクリプトが解析しやすいフォーマットで出力を表示します。
一般オプション
例
次の例は、status
コマンドの使用方法を示しています。
サーバー・ステータスの表示
次の例では、現在オンラインになっているスタンドアロン・サーバーの現在のステータスが表示されます:
$ 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.2.3.0
Java Version: 1.7.0_67
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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
プロパティ・ファイルの使用方法
サーバーでは、statusコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
bindDN
-
bindPasswordFile
-
certNickname
-
hostname
-
keyStorePasswordFile
-
keyStorePath
-
port
-
saslOption
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
trustAll
-
trustStorePasswordFile
-
trustStorePath
プロパティ・ファイルのエントリのフォーマットは、次のとおりです:
toolname.propertyname=propertyvalue
たとえば:
status.bindPasswordFile=/path/pwd-file
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/status
-
Windows: INSTANCE_DIR
\OUD\bat\status.bat
A.1.2.18 stop-ds
stop-ds
は、サービス・インスタンスを停止します。
シノプシス
stop-ds
[options]
説明
stop-ds
コマンドは、サーバーの停止または再起動に使用します。これはローカルまたはリモート・サーバー・インスタンスのいずれにおいても操作できます。
サーバーのローカル停止の実行機能は、現在はUNIXベースのシステムのみで使用できます。ローカルで実行している場合、stop-ds
はサーバー・プロセスに中断シグナルを送信します。このサーバー停止方法は、stop-ds
がオプションを指定せずに実行している場合、およびPIDファイル(INSTANCE_DIR/OUD/logs/server.pid
)が存在している場合に使用します。
リモート停止メカニズムにより、サーバーにタスク・エントリを作成するためのLDAPリクエストが発行されます。このコマンドは、サーバー(ローカルまたはリモート)と通信できるすべてのシステムから実行できます。また、これはサーバーの再起動にも使用できます。この場合、サーバーは「インコア」再起動を実行します。つまり、JVMを停止することなくサーバー自身を再初期化します。
リモートで実行している場合、stop-ds
コマンドは、管理コネクタを介してSSL上のサーバーと通信します。詳細は、「サーバーへの管理トラフィックの管理」を参照してください。
オプション
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
)に説明があります。
LDAP接続オプション
stop-ds
コマンドは、管理コネクタを介して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認証に使用します。
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
-p, --port
port -
指定された管理ポートでサーバーに接続します。このオプションが指定されない場合は、
4444
というデフォルトの管理ポートが使用されます。 -
-P, --trustStorePath
path -
指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、
--trustAll
を使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。 -
-u, --keyStorePasswordFile
filename -
クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。 -
-U, --trustStorePasswordFile
filename -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。 -
-X, --trustAll
-
サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
コマンド入力/出力オプション
一般オプション
例
次の例は、stop-ds
コマンドの使用方法を示しています。
サーバーのローカルでの停止
次のコマンドによって、サーバーが停止します:
$ stop-ds
サーバーのリモートでの停止
次のコマンドによって、リモート・サーバー・インスタンスが停止します。
$ stop-ds -h remotehost -p 4444 -D "cn=directory manager" -j /path/pwd-file -X
サーバーのリモートでの再起動
次のコマンドによって、リモート・サーバー・インスタンスが再起動します。
$ stop-ds -R -h remotehost -p 4444 -D "cn=directory manager" -j /path/pwd-file -X
終了コード
終了コード | 説明 |
---|---|
|
サーバーは正常に停止しました。 |
|
サーバーはすでに停止しています。 |
|
サーバーを起動する必要があります。 |
|
システム・コールを使用してサーバーを停止する必要があります。 |
|
システム・コールを使用してサーバーを再起動する必要があります。 |
|
プロトコルを使用してサーバーを停止する必要があります。 |
|
サーバーはWindowsサービスとして停止する必要があります。 |
|
サーバーはWindowsサービスとして再起動する必要があります。 |
プロパティ・ファイルの使用方法
サーバーでは、stop-dsコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。
詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
bindDN
-
bindPasswordFile
-
certNickname
-
hostname
-
keyStorePasswordFile
-
keyStorePath
-
saslOption
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
trustAll
-
trustStorePasswordFile
-
trustStorePath
toolname.propertyname=propertyvalue
たとえば:
プロパティ・ファイルのエントリのフォーマットは、次のとおりです:
stop-ds.trustAll=yes
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/stop-ds
-
Windows: INSTANCE_DIR
\OUD\bat\stop-ds.bat
関連コマンド
A.1.2.19 uninstall
uninstall
コマンドは、サーバー・インスタンスのアンインストールに使用します。これはディレクトリ・サーバー、プロキシ・サーバー、およびレプリケーション・ゲートウェイ・サーバーに適用できます。このコマンドは、ソフトウェアではなく、サーバー・インスタンスを削除します。
シノプシス
uninstall
[options]
説明
uninstall
コマンドは、サーバー・インスタンスのアンインストールに使用します。これは次のモードで実行できます:
-
グラフィカル・ユーザー・インタフェース(GUI)モード。GUIモードはデフォルトであり、推奨のアンインストール・オプションです。
uninstall
のGUIは、インスタンス・ファイルを削除する際の簡単なインタフェースとして機能します。 -
コマンド行インタフェース(CLI)モード。コマンド行モードは、インタラクティブと非インタラクティブのどちらでも使用できます。インタラクティブCLIモードでは、アンインストールを開始する前に必須情報を入力するようプロンプトが表示されます。GUIが使用できない場合は、
--cli
オプションを指定して使用します。非インタラクティブCLIモードでは、ユーザーが介入せずにインスタンス・ファイルをアンインストールできます。
--no-prompt
オプションと--quiet
オプションを使用すると、インタラクティブに抑止したり、情報を出力したりすることができます。
GUIモードまたはコマンド行モードのいずれで実行しているかに関係なく、削除可能なコンポーネントがリストされます。すべてのインスタンス・ファイルが削除できるとは限らない場合には、まだ存在しているディレクトリをすべてリストしたメッセージが表示されます。
インストールしたサーバーのタイプに応じて、異なるアンインストール・オプションが表示されます。これらのオプションは、次のように大別されます:
ノート:
削除すると決定したどのインスタンスのタイプ(ディレクトリ・サーバー、プロキシ、またはレプリケーション・ゲートウェイ)でも、アンインストール手順によってサーバーも停止します。また、レプリケーション・トポロジの一部であるサーバー・インスタンスの場合、そのトポロジから削除中であるサーバーもアンインストール手順によって削除されます。Windowsプラットフォームでは、インスタンスがWindowsサービスとしてインストールされた場合、そのWindowsサービスは登録解除されます。
ディレクトリ・サーバーを削除するオプション
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
引数とのみ同時に使用できます。
次のオプションは、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アドレス)を指定します。
プロキシ・サーバーを削除するオプション
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
引数とのみ同時に使用できます。
次のオプションは、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アドレス)を指定します。
レプリケーション・ゲートウェイ・サーバーを削除するオプション
uninstall
コマンドは、短いフォーム(たとえば、-i
)または同等の長いフォーム(たとえば、--cli
)のいずれかでオプションを受け入れます。
レプリケーション・ゲートウェイ・サーバーのインスタンスを削除する基本的なオプションは、次のとおりです。
-
-i, --cli
-
コマンド行インストールを使用します。指定されていない場合は、グラフィカル・インタフェースが起動されます。その他のオプション(helpとversionを除く)は、このオプションが指定されている場合のみ考慮されます。
-
-f, --forceOnError
-
リモート・サーバー・インスタンスでこのサーバーへの参照の更新中にエラーが発生した場合に、アンインストールを続行するかどうかを指定します。この引数は、
--no-prompt
引数とのみ同時に使用できます。
次のオプションは、ゲートウェイ接続に適用されます。
-
-h, --hostname
hostname -
レプリケーション・ゲートウェイがインストールされているホストの完全修飾名。この名前は、レプリケーション・ゲートウェイの設定時に指定されたものである必要があります。
次のオプションは、Oracle Unified Directoryサーバー接続に適用されます。
-
-I, --adminUID
adminUID -
Oracle Unified Directoryサーバーへのバインドに使用するグローバル管理者のユーザーID。以前に新しい生成サーバーでグローバル管理者を定義しなかった場合は、バインドDNを指定します。デフォルト値は
admin
です。 -
--adminPasswordFile
bindPasswordFile -
Oracle Unified Directoryサーバーへのバインドに使用するグローバル管理者(またはバインドDN)のパスワードが含まれているファイル。
次のオプションは、Oracle Directory Server Enterprise Edition接続に適用されます。
-
--bindDNLegacy
bindDN -
レプリケーション・ゲートウェイを介してレプリケートされているコンテンツのあるOracle Directory Server Enterprise Editionサーバーのバインドに使用するDNを指定します。デフォルト値は
cn=Directory Manager
です。 -
--bindPasswordFileLegacy
bindPasswordFile -
レプリケーション・ゲートウェイを介してレプリケートされているコンテンツのあるOracle Directory Server Enterprise Editionサーバーのバインドに使用するパスワードが保存されているファイルを指定します。
次のオプションは、セキュアな接続に適用されます。
-
-o, --saslOption
name=
value -
これらはSASLバインド・オプションです。
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
-X, --trustAll
-
サーバーによって提示されるすべてのサーバーSSL証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
-
-P, --trustStorePath
path -
指定されたパスにトラスト・ストア証明書を使用します。このオプションは、
--trustAll
を使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。 -
-U, --trustStorePasswordFile
path -
トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。 -
-K, --keyStorePath
path -
指定されたパスにキーストア証明書を使用します。
-
-u, --keyStorePasswordFile
filename -
キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。 -
-N, --certNickname
nickname -
指定された証明書をSSLクライアント認証に使用します。
-
--connectTimeout
timeout -
接続の確立に許容される最長時間(ミリ秒)を指定します。タイムアウトを指定しない場合は、
0
を使用します。デフォルト値は30000です。
コマンド入力/出力オプション
-
-n, --no-prompt
-
setup
を非対話モードで実行します。コマンドのデータが見つからない場合、プロンプトが表示されず、コマンドは失敗します。 -
-Q, --quiet
-
最小モードで実行します。プロセス中に有意なエラーが発生しないかぎり、出力は生成されません。
-
-v, --verbose
-
標準出力に診断を表示する冗長モードで実行します。
-
--noPropertiesFile
-
このコマンドでは、デフォルトのコマンド行オプションを取得するためにプロパティ・ファイルが使用されないことを示します。
-
--propertiesFilePath
path -
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
一般オプション
例
次の例は、サーバー・コマンドの使用方法を示しています。
グラフィカル・アンインストーラを使用したアンインストール
次のコマンドによりアンインストーラGUIが開いて、削除の必要なコンポーネントを選択するためのプロンプトが表示されます:
$ uninstall
コマンド行を使用したアンインストール
次のコマンドにより、すべてのコンポーネントを削除するか、または特定のコンポーネントを削除するか指定するためのプロンプトが表示され、uninstall
コマンドが実行されます。サーバーが実行中の場合は、続行する前にサーバーを停止するためのプロンプトが表示されます。
$ uninstall --cli
非インタラクティブCLIモードでのアンインストール
このモードでは、uninstall
コマンドを使用してアンインストール・スクリプトを作成できます。--no-prompt
(-n
)オプションおよび--quiet
(-Q
)オプションを指定する必要があります。オプションが指定されていない場合、uninstall
コマンドのデフォルトは対話モードになります。-n
オプションと-Q
オプションはどちらもCLIモードのみで機能します。
次のコマンドは、非インタラクティブCLIモードですべてのインスタンス・コンポーネントをアンインストールします。
$ uninstall --cli -a -n -Q
終了コード
次の終了コードは、ディレクトリ・サーバーとプロキシ・サーバーに適用できます:
-
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
-
ファイル・システムへのアクセス(たとえば、インストール・ファイルの削除)中にエラーが発生しました。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、uninstallコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
adminUID
-
bindPasswordFile
-
certNickname
-
hostname
-
keyStorePasswordFile
-
keyStorePath
-
saslOption
SASLは、Oracle Unified Directoryに対してサポートされていません。
-
trustAll
-
trustStorePasswordFile
-
trustStorePath
プロパティ・ファイルのエントリのフォーマットは、次のとおりです:
toolname.propertyname=propertyvalue
たとえば:
uninstall.bindPasswordFile=/path/pwd-file
ログ・ファイル
uninstall
コマンドは、oud-uninstall-
IDnumberというログ・ファイルに書き込みます。この場合のIDnumber
は10進数です。ログ・ファイルは次のパスに置かれています:
-
UNIX (Solaris):
/var/tmp/
-
Linux:
/tmp/
-
Windows:
%TEMP%
フォルダ。デフォルトでは、このフォルダはC:\Documents and Settings\user\Local Settings\Temp
です。
場所
uninstall
コマンドは、次のパスに置かれています:
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/uninstall
-
Windows: INSTANCE_DIR
\OUD\uninstall.bat
A.1.2.20 windows-service
windows-service
コマンドにより、サーバーをWindowsサービスとして手動で有効または無効にすることができます。
シノプシス
windows-service
[options]
説明
windows-service
コマンドを使用して、サーバーをWindowsサービスとして手動で有効(または無効)にすることができます。WindowsサービスはUNIXデーモンに類似したバックグラウンドで実行するアプリケーションであり、ユーザーが直接制御することはできません。
コマンド・オプション
windows-service
コマンドは、短いフォーム(たとえば、-d
)または同等の長いフォーム(たとえば、--disableService
)のいずれかでオプションを受け入れます:
一般オプション
例
次の例は、windows-service
コマンドの使用方法を示しています。
サーバーのWindowsサービスとしての有効化
次のコマンドにより、サーバーがWindowsサービスとして有効になります:
$ windows-service -e
サーバーのWindowsサービスとしての無効化
次のコマンドにより、サーバーがWindowsサービスとして無効になります:
$ windows-service -d
ステータスの表示
次のコマンドにより、Windowsサービスとしてサーバーのステータスが表示されます:
$ windows-service -s
場所
INSTANCE_DIR\OUD\bat\windows-service.bat
A.1.3 データ管理コマンド
各データ管理コマンドの様々なオプションおよび例を確認できます。
A.1.3.1 backup
backup
コマンドは、1つ以上のディレクトリ・サーバー・バックエンドのコンテンツをアーカイブします。
シノプシス
backup
[options]
説明
backup
コマンドは、1つ以上のディレクトリ・サーバー・バックエンドのコンテンツをアーカイブします。このコマンドにより、この操作を即時に、またはスケジュールされた時間に実行できます。詳細は、「タスクとしてのコマンドの構成」を参照してください。
backup
コマンドは、サーバーがオンラインまたはオフラインのときに実行できます。サーバーがオンラインのときにバックアップが実行している場合、このコマンドは管理コネクタを介してSSL上のサーバーに接続し、バックアップ・タスクを登録します。管理コネクタの詳細は、「サーバーへの管理トラフィックの管理」を参照してください。
オプション
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
を指定する必要があります。
タスク・バックエンド接続オプション
オンライン・バックエンドを実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介して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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
タスク・スケジュール・オプション
これらのオプションは、バックアップをスケジュール済タスクとして実行すると指定したときに使用します。
-
--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
)、それらを圧縮し(-c
)、指定されたディレクトリに保存します(-d
)。
$ backup -a -c -d /tmp/backup
バックエンド別にサブディレクトリを確認するために、バックアップ・ディレクトリのコンテンツを表示します:
$ ls /tmp/backup 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
特定のバックエンドのバックアップ
バックアップするバックエンドを指定するには、-n
オプションを使用します。次のコマンドは、userRoot
バックエンドのみをアーカイブします。
$ backup -n userRoot -d /tmp/backup
増分バックアップの実行
次のコマンドは、増分バックアップ(-i
)を使用してすべてのディレクトリ・サーバー・バックエンドをアーカイブし(-a
)、それらを圧縮して(-c
)、ディレクトリにデータを保存します(-d
)。
$ backup -a -i -c -d /tmp/backup
特定のバックエンドでの増分バックアップの実行
現在の構成済バックエンドを表示するには、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
既存のバックアップに対する増分バックアップの実行
-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
暗号化および署名付きハッシュによるすべての構成済バックエンドのバックアップ
ディレクトリ・サーバーでは、セキュアなアーカイブ済データに対して、バックアップ暗号化(--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 ...
バックアップのスケジュール
バックエンドをスケジュールするには、タスク・バックエンドにオンラインでアクセスする必要があります。このバックエンドへのアクセスは、管理コネクタを介して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
コマンドを使用します。詳細は、「タスクとしてのコマンドの構成」を参照してください。
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、backupコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
場所
backup
コマンドは、次のパスに置かれています:
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/backup
-
Windows: INSTANCE_DIR
\OUD\bat\backup.bat
関連コマンド
A.1.3.2 base64
base64
コマンドは、base64エンコーディング・フォーマットを使用してバイナリ文字列をエンコードします。
シノプシス
base64
subcommand[options]
説明
base64
コマンドは、base64エンコーディング・フォーマットを使用してバイナリ文字列をテキスト表現にエンコードします。base64エンコーディングは、非ASCII文字の文字列を表現するためにLDIFファイルで頻繁に使用します。また、証明書の内容や、MD5またはSHAなどのメッセージ・ダイジェストの出力のエンコードにも多用されます。
サブコマンド
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エンコードされたデータの書込み先であるファイルへのパス。
例
次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。
base64による文字列のエンコード
次のコマンドにより、文字列opends
がbase64でエンコードされます。
$ base64 encode -d opends b3BlbmRz
base64によるファイルのコンテンツのエンコード
次のコマンドにより、ファイル(-f
)がbase64でエンコードされ、出力ファイル(-o
)に書き込まれます。
$ base64 encode -f myrawdata -o myencodeddata
base64でエンコードされた文字列のデコード
次のコマンドにより、base64でエンコードされた文字列がデコードされます。
$ base64 decode -d b3BlbmRz opends
base64でエンコードされたファイルのコンテンツのデコード
次のコマンドにより、base64でエンコードされたファイル(-f
)がデコードされ、出力ファイル(-o
)に書き込まれます。
$ base64 encode -f myencodeddata -o myoutput
Linuxシステムでのbase64によるエンコードおよびデコード
次のコマンドは、Linux上でコマンド行からエンコードとデコードを実行します。クリアテキスト文字列を入力した後で、[Control]-[D]
キーを押してコマンド行上での入力の終わりのシグナルを送ります。
$ base64 encode hello world <CTRL-D> aGVsbGBqd29ybGQK $ base64 decode aGVsbG8gd29ybGQK <CTRL-D> hello world
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/base64
-
Windows: INSTANCE_DIR
\OUD\bat\base64.bat
A.1.3.3 dbtest
dbtest
コマンドは、Oracle Berkeley Java Edition (JE)バックエンドをデバッグします。
シノプシス
dbtest
subcommands [options]
説明
dbtest
コマンドは、Oracle Berkeley Java Edition (JE)バックエンドのデバッグに使用します。このコマンドにより、ルート、エントリ、データベース・コンテナ、およびデータベース内の索引のステータスがリストされます。また、デバッグ用にデータベースのダンプも指定されます。
バックエンドは、ディレクトリ・サーバーにデータを格納するためのリポジトリです。バックエンドは特定のタイプのデータベース(DB)を使用してデータを格納し、ディレクトリ内でバックエンドがエントリを検索できるようにする索引セットを維持します。ディレクトリ・サーバーのプライマリ・データベースはBerkeley Java Edition (JE)データベースであり、ここでは、データがキー付きレコードの単一コレクションとしてBツリー形式で編成されます。
dbtest
コマンドを使用して次の情報にアクセスできます:
-
ルート・コンテナ。バックエンドIDとバックエンド用のディレクトリを指定します。
-
エントリ・コンテナ。エントリ・コンテナがディスクに格納しているベースDN、データベース名に使用するデータベース接頭辞、およびデータベース内のエントリ数を指定します。JEバックエンドの各ベースDNには、それぞれ専用のエントリ・コンテナが割り当てられています。
-
データベース・コンテナ。特定のバックエンドIDのデータベース名、タイプ、およびJEデータベース名を指定します。
-
索引ステータス。索引名、タイプ、ステータス、および関連付けられているJEデータベースを指定します。
現在、dbtest
コマンドは読取り専用コマンドであり、データベースを変更することはできません。このコマンドはオンライン・モードまたはオフライン・モードで実行できます。ただし、オンライン・モードでdbtest
を実行すると、オフライン・モードでの実行よりもかなり長い時間がかかる場合があります。
サブコマンド
-
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バックエンドによって使用されるルート・コンテナをリストします。
グローバル・オプション
dbtest
コマンドは、短いフォーム(たとえば、-H
)または同等の長いフォーム(たとえば、--help
)のいずれかでオプションを受け入れます。
例
次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。
ルート・コンテナのリストの表示
次のコマンドにより、すべてのローカルDBバックエンドによって使用されるルート・コンテナがリストされます:
$ dbtest list-root-containers Backend ID Database Directory ------------------------------ userRoot db Total: 1
エントリ・コンテナのリストの表示
次のコマンドにより、ローカル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
データベース・コンテナのリストの表示
次のコマンドにより、ローカル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
データベースのコンテンツのダンプとデコードのスキップ
次のコマンドによってデータベースのコンテンツがダンプされ、エントリの索引付きの値が表示されますが、デコードはスキップされます。
$ 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 ...
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/dbtest
-
Windows: INSTANCE_DIR
\OUD\bat\dbtest.bat
関連コマンド
A.1.3.4 encode-password
encode-password
コマンドは、ユーザー・パスワードのエンコードと比較を行います。
このコマンドはプロキシに対してサポートされていません。
シノプシス
encode-password
options
説明
encode-password
コマンドは、ディレクトリ・サーバーで定義されたパスワード記憶スキームとの相互作用に使用できます。次の3つの操作モードが使用できます:
-
スキームのリスト・モード。ディレクトリ・サーバーで使用できるパスワード記憶スキームをリストします。このモードでは、
--listSchemes
オプションは必須です。 -
クリアテキストのエンコード・モード。指定されたパスワード記憶スキームを使用して、クリアテキスト・パスワードをエンコードします。このモードでは、ファイル(
--clearPasswordFile
)から読み取られるクリアテキスト・パスワードとともに、--storageScheme
オプションが必要です。 -
パスワードの検証モード。指定されたエンコード済パスワードに対して指定されたクリアテキスト・パスワードが正しいかどうかを判別します。このモードでは、クリアテキスト・パスワード(
--clearPasswordFile
による)とエンコード済パスワード(--encodedPasswordFile
による)が必要です。
ディレクトリ・サーバーで使用可能な認証パスワードのセットは、ルートDSEエントリのsupportedAuthPasswordSchemes
属性から取得できます。ldapsearch
を使用して、この情報を表示できます。
オプション
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
-
ディレクトリ・サーバーのバージョン情報を表示します。
例
次の例は、encode-password
コマンドの使用方法を示しています。
サーバーでの記憶スキームのリスト
次のコマンドは、ディレクトリ・サーバーで使用できる記憶スキーム(-l
)をリストします。
$ encode-password -l 3DES AES BASE64 BLOWFISH CLEAR CRYPT MD5 RC4 SHA SMD5 SSHA SSHA256 SSHA384 SSHA512
サーバーでの認証済パスコード構文記憶スキームのリスト
次のコマンドは、ディレクトリ・サーバーで認証パスコード構文(-a
)をサポートする記憶スキーム(-l
)をリストします。
$ encode-password -l -a MD5 SHA1 SHA256 SHA384 SHA512
クリアテキスト・パスワードの別のスキームへのエンコード
次のコマンドにより、指定されたスキーム(-s
)を使用して、クリアテキスト・パスワードがファイル(-f
)にエンコードされます。
$ encode-password -f /path/clear-pwd-file -s MD5 Encoded Password: "{MD5}AjxHKRFkRwxx3j9lM2HMow=="
認証パスワード構文を使用したクリアテキスト・パスワードの別のスキームへのエンコード
次のコマンドにより、指定されたスキーム(-s
)と認証パスワード構文(-a
)を使用して、クリアテキスト・パスワードがファイル(-f
)にエンコードされます。
$ encode-password -f /path/clear-pwd-file -s MD5 -a Encoded Password: "MD5$/imERhcEu3U=$AFqmpZi8EiTIvMFwkcrf8A=="
クリアテキスト・パスワードとエンコード済パスワードの比較
次のコマンドにより、ファイル内のクリアテキスト・パスワード(-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
クリアテキスト・パスワードとエンコード済パスワードの比較および終了コードの返し
次のコマンドにより、スキーム(-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
SSHAを使用したファイル内のパスワードのエンコード
次のコマンドにより、指定されたスキーム(-s
)を使用して、クリアテキスト・パスワードがファイル(-f
)にエンコードされます。Windowsプラットフォームの場合は、クリアテキスト・パスワード・ファイルへのパス(たとえば、-f \temp\password
)を指定します。
$ encode-password -s SSHA -f /path/clear-pwd-file Encoded Password: "{SSHA}QX2fMu+2N22N9qI+zu6fIZxsBVID3EsUlYYEbQ=="
終了コード
表A-3 終了コード
終了コード | 説明 |
---|---|
|
操作は正常に完了しました。 |
|
操作中にエラーが発生しました。 |
|
COMPARE_FALSE。オプション |
|
COMPARE_TRUE。オプション |
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/encode-password
-
Windows: INSTANCE_DIR
\OUD\bat\encode-password.bat
A.1.3.5 export-ldif
export-ldif
コマンドは、ディレクトリ・サーバー・バックエンドのコンテンツをLDIF形式にエクスポートします。
シノプシス
export-ldif
[options]
説明
export-ldif
コマンドは、ディレクトリ・サーバー・バックエンドのコンテンツをLDIF形式にエクスポートします。このコマンドにより、エクスポートを即時に実行するか、または指定された日付と時間で実行するようにスケジュールすることができます。詳細は、「タスクとしてのコマンドの構成」を参照してください。
一部のバックエンドはディレクトリ・サーバーへインポートできないため、export-ldif
コマンドは、monitor
、ads-truststore
、backup
、config-file-handler
などのバックエンドをエクスポートしません。
export-ldif
コマンドは、オンラインまたはオフラインで実行できます。
-
オンライン・モード。オンライン・モードでは、
export-ldif
は管理コネクタを介してSSL上で実行中のディレクトリ・サーバー・インスタンスに接続し、エクスポート・タスクを登録します。タスク・バックエンド接続オプションのいずれかを指定した場合、このコマンドは自動的にオンライン・モードで実行します。管理コネクタの詳細は、「サーバーへの管理トラフィックの管理」を参照してください。 -
オフライン・モード。オフライン・モードでは、
export-ldif
はディレクトリ・サーバー・インスタンスを介さずに、データベースに直接アクセスします。オフライン・エクスポートを実行するには、ディレクトリ・サーバーを停止する必要があります。
オプション
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形式が使用されます。 -
-d, --decrypt
-
LDIFデータをエクスポート時に復号化します。デフォルト値は復号化するものではありません。
-d
オプションが使用されていない場合、暗号化された属性がエクスポートされ、属性値に{ENC}
ヘッダーが存在することで、暗号化された値であることが示されます。{ENC}
ヘッダーの値は、base64
でエンコードされたフォーマットです。次に、暗号化された属性を持つLDIFエントリの例を示します。dn: uid=user87633,ou=Accounting,dc=example,dc=com objectClass: person objectClass: organizationalperson objectClass: inetorgperson objectClass: top uid: user87633 description: An employee of the company userPassword: {SSHA512}VYWWH4FxWtL7xez9Bz3n12Qvr9nnR1rwZa9tSjVk1EbZ8WgX0ay0ywPggQj2KnfABTdl9zYI/gjo+/Z1ODbKVkKoharGfvfP employeeNumber: 87633 pager: {ENC}AQ8F/ppNg0MArph6C+5upN9woi8A7+kPxvISoI+GqDUw mobile: {ENC}AQ8F/ppNg0MArph6C+5upN+D113xXHRk5SPy2smCNyAn mobile: {ENC}AQ8F/ppNg0MArph6C+5upN8RMqemKLxYPG09bkPUjBSk
{ENC}
ヘッダーに続くすべての文字列値は、元の値がCryptoManagerによって暗号化されたbase64エンコーディング・フォーマットです。-d
オプションが使用されている場合、暗号化された属性はクリア・テキストでエクスポートされます。 -
-e, --excludeAttribute
attribute -
エクスポート時に、指定された属性名を除外します。このオプションを複数回使用して、複数の属性を指定できます。このオプションが指定された場合、リストされた属性はすべて、エクスポートされるエントリから除外されます。
-
-E, --excludeFilter
filter -
エクスポート時に、指定した検索フィルタによって識別されたエントリを除外します。このオプションを複数回使用して、複数のフィルタを指定できます。このオプションが指定された場合、フィルタに一致するバックエンド内のエントリはすべてスキップされます。
--excludeFilter
オプションの使用は、--includeFilter
オプションよりも優先されます。エントリが含まれるリストと除外されるリストの両方でフィルタに一致する場合、そのエントリはスキップされます。 -
-i, --includeAttribute
attribute -
指定した属性名をエクスポートに含めます。このオプションを複数回使用して、複数の属性を指定できます。このオプションが指定された場合、リストされない属性はすべて、エクスポートされるエントリから除外されます。
-
-g, --algorithm
algorithm -
指定したアルゴリズムがエクスポートで使用されます。このオプションは任意であり、次の値のいずれかを入力できます。
-
diskOrder
: このオプションにより、Oracle Berkeley DB Java Edition (JE)バックエンドから、ディスクに格納されている順序でデータを読み取ることができます。データベースがデータベース・キャッシュに完全に適合しない場合、
diskOrder
オプションを使用することをお薦めします。このオプションを使用して、エクスポート操作では実行用にデータベース・キャッシュを一時的に20%使用し、その後でメモリーを解放します。こうして、操作時に、データベース・キャッシュ・メモリーが20%減少します。ノート:
このアルゴリズムはJEバックエンドからディスク順序付けという機能を使用するため、サーバーの実行中にサーバーにアクセスしてエクスポート操作中に変更を行った場合、エラーが発生することがあります。読取り操作は実行可能です。
-
entryIdOrder
: このオプションにより、Oracle Berkeley DB Java Edition (JE)バックエンドから、ディスクに論理的に格納されている順序でデータを読み取ることができます。データベースがデータベース・キャッシュに完全に適合する場合、
entryIdOrder
オプションは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
は、データを折り返さないことを指定します。
タスク・バックエンド接続オプション
オンライン・エクスポートを実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介して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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
タスク・スケジュール・オプション
これらのオプションは、エクスポートをスケジュール済タスクとして実行すると指定したときに使用します。
-
--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は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。
コマンド入力/出力オプション
一般オプション
例
次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。
オフライン・エクスポートの実行
次のコマンドでは、-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)
オンライン・エクスポートの実行
タスク・バックエンド接続オプションのいずれかを指定した場合、エクスポートは自動的にオンライン・モードで実行します。オンライン・エクスポートは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
エクスポートのスケジュール
エクスポートを後日実行するようにスケジュールするには、-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
コマンドを使用します。詳細は、「タスクとしてのコマンドの構成」を参照してください。
終了コード
-
オフライン・モード。終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
-
オンライン・モード。
-t
または--start
が指定された場合、終了コード0はタスクが正常に作成されたことを示します。ゼロ以外の終了コードは、タスク作成時にエラーが発生したことを示します。-t
または--start
が指定されていない場合、終了コードはオフライン・モードに指定された終了コードと同じです。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、export-ldifコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/export-ldif
-
Windows: INSTANCE_DIR
\OUD\bat\export-ldif.bat
A.1.3.6 import-ldif
import-ldif
コマンドは、Oracle Berkeley DB Java Edition (JE)バックエンドにLDIFファイルから読み取ったデータを移入します。
シノプシス
import-ldif
options
説明
import-ldif
コマンドは、Oracle Berkeley DB Java Edition (JE)バックエンドに、LDIFファイルから読み取ったデータまたは、MakeLDIFテンプレートに基づいて生成されたデータを移入します。通常、import-ldif
を使用すると、ldapmodify
を使用してエントリを追加するよりも非常に速く処理できます。JEバックエンド全体への完全インポートの方が、JEバックエンドのブランチへの部分インポートよりも高いパフォーマンスが得られます。
import-ldif
コマンドにより、インポートを即時に実行するか、または指定された日付と時間でインポートを実行するようにスケジュールできます。詳細は、「タスクとしてのコマンドの構成」を参照してください。
import-ldif
コマンドは、オンラインまたはオフラインで実行できます。
-
オンライン・モード。オンライン・モードでは、
import-ldif
は管理コネクタを介してSSL上で実行中のディレクトリ・サーバー・インスタンスに接続し、インポート・タスクを登録します。タスク・バックエンド接続オプションのいずれかを指定した場合、このコマンドは自動的にオンライン・モードで実行します。管理コネクタの詳細は、「サーバーへの管理トラフィックの管理」を参照してください。 -
オフライン・モード。オフライン・モードでは、
import-ldif
はディレクトリ・サーバー・インスタンスを介さずに、データベースに直接アクセスします。オフライン・インポートを実行するには、ディレクトリ・サーバーを停止する必要があります。
オプション
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
が使用されます。
タスク・バックエンド接続オプション
オンライン・インポートを実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介して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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
タスク・スケジュール・オプション
これらのオプションは、インポートをスケジュール済タスクとして実行すると指定したときに使用します。
-
--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は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。
コマンド入力/出力オプション
一般オプション
例
次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。
オフライン・インポートの実行
この例では、LDIFファイルをuserRoot
バックエンドにインポートします。LDIFファイル・パスでは、すべてのプラットフォーム上の絶対パスと相対パスの両方がサポートされます。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。
$ stop-ds $ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif
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
MakeLDIFテンプレートからのデータのインポート
この例では、MakeLDIFテンプレートからのサンプル・データをuserRoot
バックエンドにインポートします。乱数シード(-s
)によって、データの乱数度が決定します。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。
$ stop-ds $ import-ldif -n userRoot -A example.template -s 0
ユーザー属性のみのインポート
この例では、LDIFファイルをuserRoot
バックエンドにインポートします。-i "*"
によって指定されたユーザー属性のみがインポートされます。LDIFファイル・パスでは、すべてのプラットフォーム上の絶対パスと相対パスの両方がサポートされます。システムによっては、アスタリスクを引用符で囲むか("*"
)、使用しているシェルに適した文字を使用してアスタリスクをエスケープしなければならない場合があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。
$ stop-ds $ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif -i "*"
ユーザー属性のみのインポートと属性の除外
この例では、LDIFファイルをuserRoot
バックエンドにインポートします。-i "*"
によって指定されたユーザー属性はすべてインポートされますが、roomnumber
属性は除外されます。LDIFファイル・パスでは、すべてのプラットフォーム上の絶対パスと相対パスの両方がサポートされます。システムによっては、アスタリスクを引用符で囲むか("*"
)、使用しているシェルに適した文字を使用してアスタリスクをエスケープしなければならない場合があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。
$ stop-ds $ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif \ -i "*" -e "roomnumber"
操作属性のみのインポート
この例では、LDIFファイルをuserRoot
バックエンドにインポートします。-i "+"
によって指定された操作属性のみがインポートされます。LDIFファイル・パスでは、すべてのプラットフォーム上の絶対パスと相対パスの両方がサポートされます。システムによっては、プラス記号を引用符で囲むか("+"
)、使用しているシェルに適した文字を使用してプラス記号をエスケープしなければならない場合があります。オフライン・インポートの実行前にディレクトリ・サーバーを停止する必要があります。
$ stop-ds $ import-ldif -b dc=example,dc=com -n userRoot -l /usr/tmp/Example.ldif -i "+"
選択されたユーザーと操作属性のインポート
この例では、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"
オンライン・インポートの実行
タスク・バックエンド接続オプションのいずれかを指定した場合、インポートは自動的にオンラインで実行します。オンライン・インポートは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
インポートのスケジュール
インポートを後日実行するようにスケジュールするには、-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
スケジュール済タスクを表示するには、manage-tasks
コマンドを使用します。詳細は、「タスクとしてのコマンドの構成」を参照してください。
終了コード
-
オフライン・モード。終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
-
オンライン・モード。
-t
または--start
が指定された場合、終了コード0はタスクが正常に作成されたことを示します。ゼロ以外の終了コードは、タスク作成時にエラーが発生したことを示します。-t
または--start
が指定されていない場合、終了コードはオフライン・モードに指定された終了コードと同じです。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、export-ldifコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/import-ldif
-
Windows: INSTANCE_DIR
\OUD\bat\import-ldif.bat
A.1.3.7 ldif-diff
ldif-diff
コマンドは、2つのLDIFファイルの差異を特定します。
シノプシス
ldif-diff
options
説明
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.
オプション
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
-
ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。
例
次の例は、ldif-diff
コマンドの使用方法を示しています。
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
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
終了コード
終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldif-diff
-
Windows: INSTANCE_DIR
\OUD\bat\ldif-diff.bat
関連コマンド
A.1.3.8 ldifmodify
ldifmodify
コマンドは、LDIFファイルのコンテンツを変更します。
シノプシス
ldifmodify
options
説明
ldifmodify
コマンドは、LDIFファイルのコンテンツの変更に使用できます。ldapmodify
コマンドと類似していますが、ldifmodify
コマンドはディレクトリ・サーバーに接続せず、LDIFファイルでローカルに操作します。また、標準出力での変更情報の受入れも行いません。このコマンドは、1つのファイルからすべての変更を読み取る必要があります。
メモリー容量が限定されている状態で非常に大きいLDIFファイルでの操作を可能にするために、変更可能なタイプに対して次の制約が課せられます:
-
DNの変更は行いません。DN変更の操作はサポートされていません。追加、削除、変更の操作のみが実行できます。
-
変更または削除操作の並行処理はできません。追加されるエントリの処理中に、そのエントリを変更または削除することはできません。
オプション
すべてのオプション(--help
および--version
を除く)が必須です。ldifmodify
コマンドは、短いフォーム(たとえば、-m
changeFile)または同等の長いフォーム(たとえば、--changesLDIF
changeFile)のいずれかのオプションを受け入れます。
-
-m, --changesLDIF
changeFile -
適用する変更が含まれているファイルへのパスを指定します。このファイルのコンテンツはLDIF変更形式である必要があります。
-
-s, --sourceLDIF
sourceFile -
更新されるデータが含まれているソースLDIFファイルへのパスを指定します。
-
-t, --targetLDIF
targetFile -
指定された変更がすべて適用済のソースLDIFのデータで構成されるターゲットLDIFファイルへのパスを指定します。
-
-?, -H, --help
-
コマンド使用情報を表示し、追加処理を試行しないで終了します。
-
-V, --version
-
ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。
例
次の例は、ldifmodify
コマンドの使用方法を示しています。
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
終了コード
終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldifmodify
-
Windows: INSTANCE_DIR
\OUD\bat\ldifmodify.bat
関連コマンド
A.1.3.9 ldifsearch
ldifsearch
コマンドは、LDIFファイルの中で検索を実行します。
シノプシス
ldifsearch
[options]
説明
ldifsearch
コマンドは、LDIFファイル内での検索の実行に使用できます。ldapsearch
コマンドと類似していますが、ldifsearch
コマンドはディレクトリ・サーバーとのLDAP通信を実行せず、LDIFファイルでローカルに操作します。
オプション
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
-
ディレクトリ・サーバーのバージョン情報を表示します。
例
次の例は、ldifsearch
コマンドの使用方法を示しています。
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
フィルタ・ファイルを使用した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
終了コード
終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldifsearch
-
Windows: INSTANCE_DIR
\OUD\bat\ldifsearch.bat
関連コマンド
A.1.3.10 list-backends
list-backends
コマンドは、使用可能なバックエンドの情報を表示します。
シノプシス
list-backends
[options]
説明
list-backends
コマンドは、ディレクトリ・サーバー・インスタンスで定義されたバックエンドに関する情報の取得に使用できます。バックエンドは、サーバー・データベースへのアクセス提供を実行します。
list-backends
コマンドには、次の3つの操作モードがあります:
-
オプションなし。オプションを指定せずに起動した場合、サーバー内に構成されているすべてのバックエンドのバックエンドIDが、そのバックエンドのベースDNとともに表示されます。
-
バックエンドIDを指定。
--backendID
とともに使用する場合、バックエンドのすべてのベースDNが、指定されたバックエンドIDとともにリストされます。 -
ベースDNを指定。
--baseDN
とともに使用する場合、指定されたDNを持つエントリの保持に使用するバックエンドのバックエンドIDがリストされ、さらに、DNがそのバックエンドに対して構成されたベースDNの1つであるかどうかが示されます。
オプション
次のオプションは使用できますが、必須ではありません。list-backends
コマンドは、短いフォーム(たとえば、-b
baseDN)または同等の長いフォーム(たとえば、--baseDN
baseDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-b, --baseDN
baseDN list-backends
コマンドでバックエンドIDのリスト作成の際に使用するベースDNを指定します。また、このオプションは、指定したDNが当該バックエンドのベースDNであるかどうかも指定します。
-n, --backendID
backendID このコマンドが関連付けられたベースDNを表示する際に使用するバックエンドIDを指定します。このオプションを複数回使用して、複数のバックエンドに対するベースDNを表示できます。
一般オプション
-?, -H, --help
コマンド使用情報を表示し、その他のアクションを実行しないで即時に終了します。
-V, --version
ディレクトリ・サーバーのバージョン情報を表示して、このコマンドの実行を試みるかわりに終了します。
例
次の例は、list-backends
コマンドの使用方法を示しています。
現在のバックエンドのリスト
次のコマンドは、ディレクトリ・サーバーにある現在のバックエンドをリストします:
$ 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
バックエンドIDのリスト
次のコマンドは、ディレクトリ・サーバーにあるバックエンドIDをリストします:
$ list-backends --backendID monitor Backend ID Base DN ---------- ---------- monitor cn=monitor
ベースDNのリスト
次のコマンドは、ディレクトリ・サーバーにあるベースDNをリストします:
$ list-backends --baseDN cn=backups The provided DN 'cn=backups' is a base DN for the back end 'backup'
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/list-backends
-
Windows: INSTANCE_DIR
\OUD\bat\list-backends.bat
A.1.3.11 make-ldif
make-ldif
コマンドは、テンプレート・ファイルに基づいてLDIFデータを生成します。
シノプシス
make-ldif
[options]
説明
make-ldif
コマンドは、テンプレート・ファイルに基づいたLDIFデータの生成に使用できます。このコマンドにより、パフォーマンスおよびスケーラビリティのテストなど、アプリケーションでの使用に適した量の現実的なサンプル・データを構築したり、本番環境で確認された問題の再現を試行したりすることができます。
オプション
make-ldif
コマンドは、短いフォーム(たとえば、-o
ldifFile)または同等の長いフォーム(たとえば、--ldifFile
ldifFile)のいずれかのオプションを受け入れます。
-
-o, --ldifFile
ldifFile -
生成済データの書き込み先であるLDIFファイルへのパスを指定します。これは必須オプションです。
-
-s, --randomSeed
seed -
乱数発生ジェネレータのシードに使用する整数値を指定します。乱数シードが指定されている場合、同じシードを持つ同じテンプレート・ファイルに基づいてデータを生成すると、常に同じLDIF出力が生成されます。シードが指定されない場合は、同じテンプレート・ファイルを使用するたびに、異なるLDIF出力が生成される可能性があります。
-
-t, --templateFile
templateFile -
生成されるデータを記述したテンプレート・ファイルへのパスを指定します。これは必須オプションです。テンプレート・ファイルへの絶対パスを指定する必要があります。
-
-?, -H, --help
-
このコマンドに対するコマンド行使用情報を表示し、コマンドの実行を試みないで終了します。
-
-V, --version
-
ディレクトリ・サーバーのバージョン情報を表示します。
例
次の例は、make-ldif
コマンドの使用方法を示しています。
サンプル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
大きいサンプル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
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/make-ldif
-
Windows: INSTANCE_DIR
\OUD\bat\make-ldif.bat
関連コマンド
A.1.3.12 manage-account
manage-account
コマンドは、主にパスワード・ポリシー状態の詳細に関連するユーザー・アカウント情報を管理します。
シノプシス
manage-account
subcommands options
説明
manage-account
コマンドは、主にパスワード・ポリシー状態の詳細に関連するユーザー・アカウント情報を管理します。このコマンドはパスワード・ポリシー状態拡張操作と相互作用して、ユーザーのアカウント、ログイン、およびパスワード情報を返します。パスワード・ポリシー状態拡張操作では1回使用するたびに複数の操作を実行できますが、manage-account
コマンドで一度に実行できるのは1つの操作だけです。ユーザーは、パスワード・ポリシー状態拡張操作を使用するためにpassword-reset
権限を持っている必要があります。
ノート:
すべての時間値は汎用の時間形式で返されます。すべての期間値は秒単位で返されます。
manage-account
コマンドは、管理コネクタを介してSSL上のサーバーに接続します(「サーバーへの管理トラフィックの管理」で説明しています)。
サブコマンド
-
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
に設定した場合、ユーザーを有効にします。
オプション
manage-account
コマンドは、短いフォーム(たとえば、-b
targetDN)または同等の長いフォーム(たとえば、--targetDN
targetDN)のいずれかのオプションを受け入れます。
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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
一般オプション
例
次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。
ユーザーのすべてのパスワード・ポリシー状態情報の表示
次のコマンドは、ユーザーのパスワード・ポリシー状態情報を返します:
$ 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:
ユーザー・アカウントの無効化
次のコマンドにより、ユーザーのアカウント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
ユーザー・アカウントの有効化
次のコマンドにより、ユーザーの無効化されたアカウントが再度有効になります:
$ 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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/manage-account
-
Windows: INSTANCE_DIR
\OUD\bat\manage-account.bat
関連コマンド
A.1.3.13 rebuild-index
rebuild-index
コマンドは、ディレクトリ・サーバーの索引を再作成します。
シノプシス
rebuild-index
options
説明
rebuild-index
コマンドは、ディレクトリ・サーバーの索引の再作成に使用します。索引は値のリストが含まれているファイルであり、ここでは、それぞれの値がディレクトリ・サーバー・データベース内で接尾辞に対するエントリ識別子のリストに関連付けられています。ディレクトリ・サーバーで検索リクエストを処理する場合、索引内のエントリ識別子のリストを使用してデータベースを検索するため、検索の高速化が図れます。索引が存在しない場合、ディレクトリ・サーバーはデータベース内の各エントリを調べる必要があるため、パフォーマンスが著しく低下します。
rebuild-index
コマンドは次の場合に効果的です:
-
索引の
index-entry-limit
プロパティを変更する場合 -
索引を新規に作成する場合
rebuild-index
コマンドは、サーバーをオンラインにして実行できます。ただし、rebuild-index
の実行中はバックエンド・データベースは使用できません。
ノート:
オンライン・オプションは複数のバックエンドがある場合に便利です。
オンライン・オプションでは、すべてのバックエンドを停止しなくても、異なるバックエンドに対してrebuild-index
を個別に実行できます。
rebuild-index
コマンドは通常、サーバーがオフラインになっていて、特に--rebuildAll
オプションが指定されている場合に実行速度が上がります。
ノート:
時間がたつにつれて、エントリ識別子リストの整然さが失われていきます。このようになると、rebuild-index
コマンドのパフォーマンスは徐々に低下していきます。
大規模なデータベースの索引付けの再実行は、できるだけ避けるようにしてください。あるいは、rebuild-index
コマンドのパフォーマンスが著しく劣化した場合は、データベースを再インポートして、新しい、整然としたエントリ識別子リストで開始してください。
オプション
rebuild-index
コマンドは、短いフォーム(たとえば、-b
baseDN)または同等の長いフォーム(たとえば、--baseDN
baseDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-
-b, --baseDN
baseDN -
索引付けをサポートしているバックエンドのベースDNを指定します。再作成操作は、指定されたベースDNの範囲内にある索引に対して実行されます。
-
-i, --index
index -
再作成する索引の名前を指定します。属性索引の場合、これは属性名になります。再作成する索引を少なくとも1つ指定する必要があります。
-
--rebuildAll
-
ベースDNにより指定されたバックエンド内にあるすべての索引を再作成します。このオプションでは、すべての属性索引の索引付けが再実行されるだけでなく、
dn2id
システム索引、拡張索引とVLV索引、およびdn2uri
索引も再作成されます。rebuildAll
オプションは-i
オプションと同時に使用できません。 -
--tmpDirectory
-
スクラッチ索引ファイル用に一時作業ディレクトリの場所を指定します。デフォルトの一時作業ディレクトリはINSTANCE_DIR
/OUD/import-tmp
です。
タスク・バックエンド接続オプション
索引をオンラインで再作成するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介して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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
タスク・スケジュール・オプション
これらのオプションは、索引の再作成をスケジュール済タスクとして実行すると指定したときに使用します。
-
--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は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。
ユーティリティ入力/出力オプション
一般オプション
例
次の例は、rebuild-index
コマンドの使用方法を示しています。
索引の再構築
まず、次のように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)
すべての索引の再作成
この例では、--rebuildAll
オプションを使用してすべての索引を再作成します。
$ rebuild-index -b "dc=example,dc=com" --rebuildAll
拡張索引の再作成
拡張索引は、次の3つのいずれの方法でも再作成できます:
-
--rebuildAll
オプションを指定してすべての索引を再作成します。 -
-i
オプションを指定して、拡張索引のベースとなる属性索引を再作成します。たとえば、-i cn
。この属性に基づいている索引は、属性に関連付けられている拡張索引も含めてすべて再作成されます。
-
特定の拡張索引を
-i
オプションと同時に指定することにより再作成します。たとえば、-i cn.es.lte
または-i sn.en.sub
。
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/rebuild-index
-
Windows: INSTANCE_DIR
\OUD\bat\rebuild-index.bat
関連コマンド
A.1.3.14 restore
restore
コマンドは、ディレクトリ・サーバーのバックエンドのバックアップを復元します。
シノプシス
restore
options
説明
restore
コマンドは、ディレクトリ・サーバーのバックエンドのバックアップを復元します。一度に復元できるバックエンドは1つだけです。このコマンドを使用して、復元操作を即時に実行することも、復元を後日実行するようにスケジュールすることもできます。詳細は、「タスクとしてのコマンドの構成」を参照してください。
サーバーがオフラインのときにバックエンドを復元するか、サーバーがオンラインのときにバックエンドを後日復元するタスクをスケジュールすることができます。サーバーがオンラインの場合、restoreコマンドは、管理コネクタを介してSSL上のサーバーに接続します。管理コネクタの詳細は、「サーバーへの管理トラフィックの管理」を参照してください。
オプション
restore
コマンドは、短いフォーム(たとえば、-I
backupID)または同等の長いフォーム(たとえば、--backupID
backupID)のいずれかのオプションを受け入れます。
-
-d, --backupDirectory
path -
バックアップ・アーカイブが含まれているディレクトリを使用して復元します。このディレクトリが存在していて、1つのバックアップ・ディスクリプタ・ファイルと、指定されたバックエンドに対して1つ以上のバックアップが含まれている必要があります。バックアップ・ディスクリプタ・ファイルは、使用可能なバックアップと、その作成に使用するオプションについての情報を取得するために読み取られます。これは必須オプションです。
指定されたパスが絶対パスであることを確認する必要があります。
-
-I, --backupID
backupID -
復元するバックアップのバックアップIDを指定します。このオプションが指定されない場合は、バックアップ・ディレクトリに含まれている最新のバックアップが復元されます。
-
-l, --listBackups
-
バックアップ・ディレクトリに含まれている使用可能なバックアップに関する情報を表示します。このオプションを指定すると、コマンドは復元を実行しないで終了します。
-
-n, --dry-run
-
指定したバックアップが有効であることを検証します(つまり、指定したバックアップが有効なアーカイブとして表示され、ハッシュまたは署名、またはその両方がバックアップのコンテンツと一致していることを確認します)。このオプションは、実際にはバックアップの復元を試行しません。
タスク・バックエンド接続オプション
オンライン復元を実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介して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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
タスク・スケジュール・オプション
-
--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は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。
コマンド入力/出力オプション
一般オプション
例
次の例は、restore
コマンドの使用方法を示しています。
バックアップ情報の表示
次のコマンドにより、バックアップ・ディスクリプタ・ファイル(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
バックアップの復元
次のコマンドにより、バックエンドがバックアップ・ディレクトリから復元されます。一度に復元できるバックエンドは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)
暗号化されたバックアップの復元
ハッシュされたバックアップまたは暗号化されたバックアップを復元するには、管理コネクタを介して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
復元のスケジュール
復元をスケジュールするには、タスク・バックエンドにオンラインでアクセスする必要があります。このバックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。したがって、復元をスケジュールする場合は、ホスト、管理ポート、バインドDN、およびバインド・パスワードも含めた接続の詳細を指定する必要があります。また、SSL接続用に証明書の詳細を指定する必要もあります。
次のコマンドでは、--start
オプションを使用して特定の開始時間にuserRoot
バックエンドを復元するタスクをスケジュールします。このコマンドにより、完了通知とエラー通知がadmin@example.com
に送信されます。自己署名証明書は、-X
(--trustAll
)オプションを使用して信頼されます。
このスケジュール済タスクを表示するには、manage-tasks
コマンドを使用します。詳細は、「タスクとしてのコマンドの構成」を参照してください。スケジュール済のリストア日時の前にサーバーが実行されていることを確認する必要があります。
$ 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
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、restoreコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/restore
-
Windows: INSTANCE_DIR
\OUD\bat\restore.bat
関連コマンド
A.1.3.15 split-ldif
split-ldif
コマンドは、指定された分散ワークフロー要素に従って、1つのLDIFファイルを複数のLDIFファイルに分割します。生成されたLDIFファイルは、分散デプロイメントのパーティションの移入に使用されます。
シノプシス
split-ldif
options
説明
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形式ではないファイルを使用して移入されます。詳細は、「gicadm」を参照してください
オプション
split-ldif
コマンドは、短いフォーム(たとえば、-i
ldifFile)または同等の長いフォーム(たとえば、--ldifFile
ldifFile)のいずれかのオプションを受け入れます。
グローバル索引オプション
分割オプション
-
-d, --distributionName
distributionName -
データを分割する分散ワークフロー要素の名前。
-
-p, --forcePartitionId
partitionId -
リストされたpartitionIdが設定されているすべてのエントリが同一のパーティションに分散される索引ファイルを生成します。
-
-o, --outputDirectory
outputDirectory -
出力LDIFファイルが生成されるディレクトリ。
-
-O, --outputFilenamePrefix
outputFilePrefix -
生成するファイル名の接頭辞(これには、パーティションIDと.ldif拡張子が含まれます)。
-
-f, --force
-
以前に使用してすでに存在している可能性のある生成済ファイルを上書きします。
一般オプション
例
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
-
このディレクトリには、従業員番号属性に関するグローバル索引ファイルが含まれています。
split-ldifを使用したグローバル索引への複数の索引付け属性の移入
次のコマンドでは、既存のデータベース・ファイル(-i
)を使用します。このファイルは、プロキシ・デプロイメントですでに定義されている分散情報に基づいて複数のファイルに分割されます。このコマンドによって、分散ワークフロー要素名(-d
)、分割するデータベース・ファイル(-i
)、およびグローバル索引ファイル内で索引付けされる属性(-x
)が定義されます。-f
を指定すると、既存の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属性に関するグローバル索引ファイルが含まれています。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/split-ldif
-
Windows: INSTANCE_DIR
\OUD\bat\split-ldif.bat
関連コマンド
A.1.3.16 verify-index
verify-index
コマンドは、ディレクトリ索引データを検証します。
シノプシス
verify-index
options
説明
verify-index
コマンドは、ディレクトリ・サーバー・データベース内の索引とエントリ・データ間の一貫性のチェックに使用します。このコマンドは、索引エントリの限度に達した索引キー数に関する情報も提供します。
このコマンドによって、次の情報がチェックされます:
-
すべてのエントリが適切に索引付けされている
-
索引データ参照エントリがすべて存在している
-
データは対応する索引データに一致している
現在このコマンドは、Oracle Berkeley DB Java Editionを使用して情報を格納するディレクトリ・サーバー・バックエンドに対してのみ使用可能です。現在使用可能なその他のバックエンド・タイプでは、ディスク上の索引は保持されません。したがって、索引の一貫性を検証できるコマンドを使用する必要はありません。
ディレクトリ管理者は、ディレクトリ・サーバーの起動時または停止時でもこのコマンドを使用できます。ただし、サーバーが実行しているときにverify-index
を使用すると、ディレクトリ・サーバーとコマンドの全体的なパフォーマンスに影響が出ることに注意してください。たとえば、稼働率の非常に高いオンライン・サーバーでverify-index
コマンドを実行した場合は、オフラインの、または停止しているサーバーでこのコマンドを実行する場合よりも処理時間が非常に長くなることがあります。
このコマンドを使用するには、--baseDN
オプションを使用して、検証が実行されるバックエンドのベースDNを指定する必要があります。
オプション
verify-index
コマンドは、短いフォーム(たとえば、-b
baseDN)または同等の長いフォーム(たとえば、--baseDN
baseDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-
-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
-
冗長モードを使用します。
一般オプション
例
次の例は、verify-index
コマンドの使用方法を示しています。
索引の検証
次のコマンドにより、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)
索引の検証とエラー件数のカウント
次のコマンドにより、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
終了コード
終了コード0は、操作が正常に終了したことを示します。1以上の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/verify-index
-
Windows: INSTANCE_DIR
\OUD\bat\verify-index.bat
関連コマンド
A.1.3.17 purge-backup
purge-backup
コマンドは、指定した日数より古いバックアップ・データを1つ以上のディレクトリ・サーバー・バックエンドから削除するために使用されます。
シノプシス
purge-backup
[options]
説明
purge-backup
コマンドは、1つ以上のディレクトリ・サーバー・バックエンドのバックアップ・コンテンツをパージします。このコマンドにより、この操作を即時に、またはスケジュールされた時間に実行できます。詳細は、「タスクとしてのコマンドの構成」を参照してください。
オプション
purge-backup
コマンドは、短い形式(たとえば、-d
backupDir)でも長い形式(たとえば、--backupDirectory
backupDir)でもオプションを受け入れます。
-
-n, --backendID
backendID -
パージに使用するバックエンドのIDを指定します。このオプションは1つのコマンドで複数回使用でき、複数のバックエンドのバックアップ・データをパージする必要があることを示します。サーバーで使用可能なバックエンドを決定するには、
dsconfig list-backends
コマンドを使用します。 -
-A, --purgeAll
-
構成されているすべてのバックエンドのバックアップ・データをパージします。このオプションは、
--backendID
とともに使用しないでください。 -
-k, --purgeDelay
purgeDelay -
パージのために考慮するパージ間隔(日数)。これより古いバックアップ・セットはパージ対象とみなされます。デフォルト値は
120
です。 -
-d, --backupDirectory
backupDir -
バックアップ・ファイルをパージするバックアップ・ディレクトリへのパス。
purge-backup
時に複数のバックエンドがアーカイブされている場合、このディレクトリ内にバックエンドごとにサブディレクトリが存在します。--purgeAll
オプションが指定されている場合、これは様々なバックエンドのすべてのサブディレクトリを含むディレクトリへのパスである必要があります。パージ用に特定のバックエンドが指定されている場合、これは特定のバックエンドのバックアップ・ファイルを含むディレクトリへのパスである必要があります。 -
-F, --force
-
すべてのバックアップを強制的にパージします。デフォルトでは、最新のバックアップ情報セット(親の全体バックアップまでの最新の増分バックアップが含まれます)は削除されません。このオプションを使用すると、上で定義したその他の基準に基づいて、最新のバックアップ情報セットがパージ対象とみなされることもあります。
ノート:
このオプションは、purgeDelay
に基づいてパージの対象となるすべてのバックアップ情報セットを削除するため、注意して使用する必要があることに留意する必要があります。
タスク・バックエンド接続オプション
オンラインpurge-backup
を実行するには、タスク・バックエンドにアクセスする必要があります。タスク・バックエンドへのアクセスは、管理コネクタを介してSSL経由で提供されます。次の接続オプションは、purge-backup
をオンラインで実行するときに使用します。
-
-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証明書を信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
タスク・スケジュール・オプション
次のオプションは、purge-backup
をスケジュール済タスクとして実行すると指定したときに使用します。
-
--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は、タスクを即時実行するようにスケジュールします。このオプションが指定された場合、操作は指定の時間に開始するようスケジュールされ、その直後にコマンドが終了します。
コマンド入力/出力オプション
一般オプション
例
次の例は、ディレクトリ・サーバー・コマンドの使用方法を示しています。
すべての構成済バックエンドのバックアップ・データのパージ
構成されているすべてのバックエンドのバックアップ・データをパージするには、次のステップを実行します。
- バックエンド別のサブディレクトリを確認するために、バックアップ・ディレクトリの内容を表示します:
$ ls /tmp/backup schema tasks userRoot
- 次のコマンドを実行して、サブディレクトリの内容を調べて、backup.infoおよびバックアップ・データファイルが存在することを確認します。
$ls /tmp/backup/userRoot/ backup.info backup-userRoot-20230824134113Z backup-userRoot-20230924134151Z
- 次のコマンドを実行して、指定されたバックアップ・ディレクトリ(
-d
)にある、指定された日数(-k 10
)より古いすべてのディレクトリ・サーバーのバックエンド(-A
)のバックアップ・データをパージします。./purge-backup -d /tmp/backup -k 10 -A
- サブディレクトリの内容をチェックして、バックアップ・データファイルがパージされていること、およびbackup.infoファイルからパージされたセットが削除されていることを確認します。
$ls /tmp/backup/userRoot/ backup.info backup-userRoot-20230924134151Z backup.info contents would look like: backend_id=userRoot backup_id=20230924134151Z backup_date=20230924134155Z incremental=false compressed=true encrypted=false property.archive_file=backup-userRoot-20230924134151Z property.last_logfile_size=37964 property.last_logfile_name=00000000.jdb
特定のバックエンドのバックアップのパージ
バックアップするバックエンドを指定するには、-n
オプションを使用します。次のコマンドは、userRoot
バックエンドのみをアーカイブします。
purge-backup -n userRoot -d /tmp/backup/userRoot -k 10
バックアップのパージのスケジューリング
purge-backup
をスケジュールするには、タスク・バックエンドにオンラインでアクセスする必要があります。このバックエンドへのアクセスは、管理コネクタを介してSSLによって指定されます。したがって、purge-backup
をスケジュールする場合は、ホスト、管理ポート、バインドDN、およびバインド・パスワード・ファイルなどの接続の詳細を指定する必要があります。また、SSL接続用に証明書の詳細を指定する必要もあります。
次のコマンドは、すべてのコンポーネント(--purgeAll
)のpurge-backup
をスケジュールして、それを/tmp/backups
ディレクトリに書き込みます(--backupDirectory
)。開始時間は、--start
オプションによって指定されます。自己署名証明書は、-X
(--trustAll
)オプションを使用して信頼されます。
purge-backup --port 4444 --bindDN "cn=Directory Manager" \ --bindPasswordFile pwd-file -X \ --purgeAll \ --purgeDelay 30 \ --backupDirectory /tmp/backups --start 20230924131502417
このスケジュール済タスクを表示するには、manage-tasks
コマンドを使用します。詳細は、「タスクとしてのコマンドの構成」を参照してください。
終了コード
終了コード0は、操作が正常に終了したことを示します。終了コード1は、処理中にエラーが発生したことを示します。
プロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、uninstallコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
場所
purge-backup
コマンドは、次のパスに置かれています:
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/purge-backup
-
Windows: INSTANCE_DIR
\OUD\bat\purge-backup.bat
関連コマンド
A.1.4 LDAPクライアントのコマンド
各LDAPクライアント・ユーティリティで提供される様々なオプションおよび例を確認できます。
これらのLDAPクライアント・コマンドを使用したSSL通信のSSLプロトコルおよび暗号スイートの上書きの詳細は、「TLS通信のシステム・デフォルトのプロトコルおよび暗号スイートのオーバーライド」を参照してください。
A.1.4.1 ldapcompare
ldapcompare
コマンドは、LDAPエントリを比較します。
シノプシス
ldapcompare
options
説明
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のリストを含むファイルです。
オプション
ldapcompare
コマンドは、短いフォーム(たとえば、-D
bindDN)または同等の長いフォーム(たとえば、--bindDN
bindDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-
--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のかわりにテキスト名を使用することもできます(検索操作の場合は、Manage DSA IT制御に対するmanagedsait
も含まれます)。この要素は必須です。-J
オプションまたはcontrol
オプションを使用すると、OIDのかわりに判読可能な名前を使用して、値を必要としないコントロールを参照することができます。これらのOID名は次のとおりです:-
accountusable
またはaccountusability
。アカウント・ユーザービリティ・リクエスト・コントロールOID: 1.3.6.1.4.1.42.2.27.9.5.8のかわりに使用(値なし) -
authzid
またはauthorizationidentity
。認可アイデンティティ・リクエスト・コントロール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)とマークされ、認可IDdn: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
モードで実行します。つまり、発生する内容を報告しますが、実際に検索を実行したり、どの方法でもサーバーと通信することはありません。
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 -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。このオプションは、--trustStorePassword
とともに使用しないでください。 -
-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
オプションを使用してサーバーのセキュア・ポートを指定する必要があります。
コマンド入力/出力オプション
一般オプション
例
次の例は、ldapcompare
コマンドの使用方法を示しています。
グループ・メンバーシップに関するエンティティの比較
次のコマンドでは、ポート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
属性値とエントリの比較
次のコマンドでは、ポート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
サーバー認証での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
クライアント認証での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
終了コード
終了コード6は、比較が成功したことを示します。終了コード5は、比較が成功していないことを示します。その他のすべての終了コードは、処理中にエラーが発生したことを示します。
CLIプロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、ldapcompareコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
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
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldapcompare
-
Windows: INSTANCE_DIR
\OUD\bat\ldapcompare.bat
A.1.4.2 ldapdelete
ldapdelete
コマンドは、エントリを削除するために、LDAP削除リクエストをディレクトリ・サーバーに対して発行します。
シノプシス
ldapdelete
[option] [DN]
説明
ldapdelete
コマンドは、エントリを削除するために、LDAP削除リクエストをディレクトリ・サーバーに対して発行します。--filename
オプションが指定されないかぎり、削除するエントリを指定するために、エントリDNを唯一の後続オプションとして指定する必要があります。
始める前に
多くのUNIXまたはLinuxオペレーティング・システムには共通のLDAPクライアント・コマンドのインストール済バージョンが用意されており、たとえば、/usr/bin
ディレクトリのldapsearch
、ldapmodify
、およびldapdelete
などがあります。使用しているシステムにバージョンがインストールされているかどうかをチェックするには、コマンドwhich ldapdelete
を入力します。このコマンドが値(以下に示します)を返す場合は、$PATH
をINSTANCE_DIR/OUD/bin
ディレクトリに更新するか、ディレクトリ・サーバー・インスタンスの別名を作成する必要があります。
$ which ldapdelete (UNIX/Linux) /usr/bin/ldapdelete
オプション
ldapdelete
コマンドは、短いフォーム(たとえば、-D
bindDN)または同等の長いフォーム(たとえば、--bindDN
bindDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-
-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のかわりにテキスト名を使用することもできます(検索操作の場合は、Manage 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)とマークされ、認可IDdn: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
-
指定されたエントリと、その下のエントリをすべて削除します。
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認証の使用」を参照してください。
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 -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。このオプションは、--trustStorePassword
とともに使用しないでください。 -
-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
オプションを使用してサーバーのセキュア・ポートを指定する必要があります。
コマンド入力/出力オプション
一般オプション
例
次の例は、ldapdelete
コマンドの使用方法を示しています。
コマンド行からのエントリの削除
次のコマンドでは、ホスト名(-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"
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
サーバー認証を使用したエントリの削除
次のコマンドでは、サーバー認証を使用してエントリを削除します。次のコマンドでは、ホスト名(-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
クライアント認証を使用したエントリの削除
次のコマンドは、クライアント認証を使用して削除オプションを実行します。このコマンドは、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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
CLIプロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、ldapdelete
コマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
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
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldapdelete
-
Windows: INSTANCE_DIR
\OUD\bat\ldapdelete.bat
A.1.4.3 ldapmodify
ldapmodify
コマンドは、ディレクトリ・エントリを変更します。
シノプシス
ldapmodify
[options] [filter] [attributes]
説明
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のループバック・アドレスを使用する未認証の接続を使用してディレクトリ・サーバー・インスタンスとの相互作用を試行し、リクエストされる変更に関する情報が標準入力から読み取られます。この場合はサーバーの認証方法の指定に使用される引数を少なくとも指定する必要があるため、この処理が成功する可能性はほとんどありません。
始める前に
多くのUNIXおよびLinuxオペレーティング・システムには共通のLDAPクライアント・コマンドのインストール済バージョンが用意されており、たとえば、/usr/bin
ディレクトリのldapsearch
、ldapmodify
、およびldapdelete
などがあります。使用しているシステムにバージョンがインストールされているかどうかをチェックするには、コマンドwhich ldapmodify
を入力します。このコマンドが値(以下に示します)を返す場合は、$PATH
をINSTANCE_DIR/OUD/bin
に更新するか、ディレクトリ・サーバー・インスタンスの別名を作成する必要があります。
$ which ldapmodify (Unix/Linux) /usr/bin/ldapmodify
オプション
ldapmodify
コマンドは、短いフォーム(たとえば、-D
bindDN)または同等の長いフォーム(たとえば、--bindDN
bindDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-
-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のかわりにテキスト名を使用することもできます(検索操作の場合は、Manage 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)とマークされ、認可IDdn: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
)で指定する必要があります。このオプションが指定されない場合、プロキシ認可は使用されません。
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 -
指定されたホスト名または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認証の使用方法の詳細は、「SASL認証の構成」を参照してください。
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 -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。このオプションは、--trustStorePassword
とともに使用しないでください。 -
-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
-
ディレクトリ・サーバーと通信する際、SSLを使用します。SSLを使用する場合は、
--port
オプションを使用してサーバーのセキュア・ポートを指定する必要があります。
コマンド入力/出力オプション
一般オプション
例
次の例は、ldapmodify
コマンドの使用方法を示しています。
エントリの追加
次の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
属性のエントリへの追加
次の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
属性値の変更
次の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
複数の属性の変更
次の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
コマンド行からの属性の削除
次のコマンドでは、ホスト名(-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)
コマンド行からのエントリの削除
次のコマンドでは、ホスト名(-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)
サーバー認証での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
クライアント認証での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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
CLIプロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、ldapmodify
コマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
-
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
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldapmodify
-
Windows: INSTANCE_DIR
\OUD\bat\ldapmodify.bat
A.1.4.4 ldappasswordmodify
ldappasswordmodify
コマンドは、LDAPパスワードを変更します。
シノプシス
ldappasswordmodify
options
説明
ldappasswordmodify
コマンドは、RFC 3062 (http://www.ietf.org/rfc/rfc3062.txt
)に定義するように、LDAPパスワード変更拡張操作を使用したユーザー・パスワードの変更またはリセットに使用できます。
このメカニズムによるユーザー・パスワードの変更は、パスワード属性を対象とした単純なLDAP変更操作に比べて、次に示すようにいくつかの利点を備えています。
-
自分のパスワードの変更。この機能がユーザーのパスワード・ポリシーで使用可能である場合に、このコマンドによってユーザーは自分のパスワードを、有効期限後であっても変更することができます。
-
クリアテキスト・パスワードの指定。このコマンドは、ユーザーのIDをさらに検証するために、現在のパスワードのクリアテキスト・バージョンを提供するメカニズムとして機能します。
-
認可IDの使用。ユーザーのパスワードを変更する際、フルDNに加えて認可ID(接頭辞
dn:
またはu:
が付きます)を使用することでユーザーを指定できます。 -
パスワードの生成。新しいパスワードが指定されない場合、この機能がユーザーのパスワード・ポリシーで使用可能になっていると、サーバーはユーザーに対して新しいパスワードを生成できます。
オプション
ldappasswordmodify
コマンドは、短いフォーム(たとえば、-D
bindDN)または同等の長いフォーム(たとえば、--bindDN
bindDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-
-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のかわりにテキスト名を使用することもできます(検索操作の場合は、Manage 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)とマークされ、認可IDdn:uid=dmiller,ou=people,dc=example,dc=com
の文字列値のあるクリティカルなコントロールが含まれます。または、次のOID名、effectiverights:true:dn:uid=dmiller、ou=people、dc=example、dc=com
が使用できます。 -
-
-n, --newPassword
newPassword -
ターゲット・ユーザーに割り当てる新しいパスワードを指定します。このオプションは、
--newPasswordFile
とともに使用しないでください。これらのオプションがいずれも指定されていない場合、パスワード・ジェネレータがユーザーのパスワード・ポリシーで構成されていると、サーバーはユーザーに対して新しいパスワードを自動的に生成します。 -
-N, --newPasswordFile
newPasswordFile -
ターゲット・ユーザーに割り当てる指定ファイルから新しいパスワードを読み取ります。このオプションは、
--newPassword
とともに使用しないでください。これらのオプションがいずれも指定されていない場合、パスワード・ジェネレータがユーザーのパスワード・ポリシーで構成されていると、サーバーはユーザーに対して新しいパスワードを自動的に生成します。
LDAP接続オプション
-
--certNickname
nickname -
証明書ベースのクライアント認証の証明書を使用します。
-
-D, --bindDN
bindDN -
簡易認証を介してディレクトリ・サーバーにバインドするときにDNを使用します。このオプションが指定されない場合は、
--authzID
オプションを使用してターゲット・ユーザーの認可IDを指定し、--currentPassword
オプションまたは--currentPasswordFile
オプションのいずれかを指定してユーザーの現在のパスワードを指定する必要があります。(この使用モードは、ユーザーが自分のパスワードを有効期限後に変更する場合に必要です。) -
-h, --hostname
address -
指定されたホスト名またはIPアドレスのディレクトリ・サーバーに接続します。これが指定されない場合は、
localhost
のデフォルトのアドレスが使用されます。 -
-j, --bindPasswordFile
bindPasswordFile -
ディレクトリ・サーバーに対して認証を受ける際、指定したファイルにバインド・パスワードを使用します。このオプションは、簡易認証と、パスワードに基づくSASLメカニズム(CRAM-MD5、DIGEST-MD5、およびPLAINなど)に使用します。認可が実行されない場合、これは必要ありません。このオプションは、
--bindPassword
とともに使用しないでください。SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
-K, --keyStorePath
keyStorePath -
SSLまたはStartTLS拡張操作を使用する場合は、セキュアな通信のために、指定されたパスにクライアント・キーストア証明書を使用します。このオプションは、SASL EXTERNAL認証を使用する場合など、クライアントがディレクトリ・サーバーに証明書を提示する必要がある場合のみ必要です。
SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
-o, --saslOption
name=
value -
SASL認証を実行するときに、指定されたオプションを使用します。複数のSASLオプションを指定するには、オプションごとに1回ずつ、このオプションを複数回使用します。詳細は、「SASL認証の使用」を参照してください。
-
-p, --port
port -
指定されたポートでディレクトリ・サーバーに接続します。このオプションが指定されない場合は、デフォルトのポート
389
が使用されます。 -
-P, --trustStorePath
trustStorePath -
SSLまたはStartTLS拡張操作を使用する場合は、セキュアな通信のために、指定されたパスにクライアント・トラスト・ストア証明書を使用します。このオプションは、
--trustAll
を使用している場合は必要ありません。ただし、本番環境で作業する場合はトラスト・ストアを使用する必要があります。 -
-q, --useStartTLS
-
ディレクトリ・サーバーと通信する際、StartTLS拡張操作を使用します。このオプションは、
--useSSL
とともに使用しないでください。 -
--trustStorePassword
trustStorePassword -
クライアント・トラスト・ストアの証明書へのアクセスに必要なパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ必須です(ほとんどのトラスト・ストアでは必要とされません)。このオプションは、--trustStorePasswordFile
とともに使用しないでください。 -
-u, --keyStorePasswordFile
keyStorePasswordFile -
クライアント・キーストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。このオプションは、--keyStorePassword
とともに使用しないでください。 -
-U, --trustStorePasswordFile
trustStorePasswordFile -
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。このオプションは、--trustStorePassword
とともに使用しないでください。 -
-w, --bindPassword
bindPassword -
ディレクトリ・サーバーに対して認証を受ける際、バインド・パスワードを使用します。このオプションは、簡易認証と、パスワードに基づくSASLメカニズムに使用できます。このオプションは、
--bindPasswordFile
とともに使用しないでください。パスワードの入力を要求するには、-w -
を入力します。SASLは、プロキシ・サーバー・インスタンスに対してサポートされていません。
-
-W, --keyStorePassword
keyStorePassword -
クライアント・キーストアの証明書へのアクセスに必要なパスワードを使用します。このオプションは、
--keyStorePath
を使用する場合のみ必須です。このオプションは、--keyStorePasswordFile
とともに使用しないでください。 -
-X, --trustAll
-
SSLまたはStartTLSのネゴシエーション中にディレクトリ・サーバーによって提示される可能性のある証明書をすべて信頼します。このオプションは便宜的に、かつテストの目的で使用できますが、セキュリティ上の理由から、トラスト・ストアを使用してクライアントがサーバーの証明書を受け入れるかどうかを判別する必要があります。
-
-Z, --useSSL
-
ディレクトリ・サーバーと通信する際、Secure Sockets Layerを使用します。SSLを使用する場合は、
--port
オプションを使用してサーバーのセキュア・ポートを指定する必要があります。
コマンド入力/出力オプション
一般オプション
例
次の例は、ldappasswordmodify
コマンドの使用方法を示しています。
ユーザー・パスワードの変更
次のコマンドでは、ポート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
別のユーザーのパスワードの変更および生成
次のコマンドでは、ポート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
別のユーザーのパスワードの変更
次のコマンドでは、ポート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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
CLIプロパティ・ファイルの使用方法
ディレクトリ・サーバーでは、ldappasswordmodify
コマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイルの使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
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
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldappasswordmodify
-
Windows: INSTANCE_DIR
\OUD\bat\ldappasswordmodify.bat
A.1.4.5 ldapsearch
ldapsearch
コマンドは、ディレクトリ・サーバーのエントリを検索します。
シノプシス
ldapsearch
[options] [filter] [attributes]
説明
ldapsearch
コマンドは、ディレクトリ・サーバーへの検索リクエストの入力に使用できます。このコマンドでは、ディレクトリ・サーバーへの接続を開き、それにバインドして、検索フィルタとスコープ要件を満たすすべてのエントリを、指定されたベースDNから順に返します。また、認証、制御、セキュアな通信メカニズムなど、ディレクトリ・サーバーのその他のコンポーネントのテストにも使用できます。
--filename
オプションを使用して1つ以上の検索フィルタが含まれているファイルを指定した場合は、検索フィルタをオプションとして含めないようにしてください。後続オプションはすべて、リクエストされた属性として解釈されます。
エントリの名前と属性にsn、givenName、uid、およびtitleなどの非ASCII文字が使われている場合、ldapsearch
コマンドの実行によって返される非ASCII文字は印刷中に抑制されます。base64
コマンドを実行して、Base64でエンコードされた文字列をデコードする必要があります。
特定の属性がリクエストされていない場合は、すべてのユーザー属性(つまり、操作属性以外のすべての属性)が返されます。1つ以上の属性名がリストされる場合は、返された属性のみがエントリに含まれます。
始める前に
多くのUNIXおよびLinuxオペレーティング・システムには共通のLDAPクライアント・コマンドのインストール済バージョンが用意されており、たとえば、/usr/bin
ディレクトリのldapsearch
、ldapmodify
、およびldapdelete
などがあります。使用しているシステムにバージョンがインストールされているかどうかをチェックするには、コマンドwhich ldapsearch
を入力します。このコマンドが値(以下に示します)を返す場合は、$PATH
をディレクトリ・サーバーのインストール・ディレクトリに更新するか、ディレクトリ・サーバー・インスタンスの別名を作成する必要があります。
$ which ldapsearch (Unix/Linux) /usr/bin/ldapsearch
オプション
ldapsearch
コマンドは、短いフォーム(たとえば、-b
baseDN)または同等の長いフォーム(たとえば、--baseDN
baseDN)のいずれかのオプションを受け入れます。
コマンド・オプション
-
-a, --dereferencePolicy dereferencePolicy
-
検索時の別名の間接参照ポリシーを指定します。別名の間接参照により、別のオブジェクトをポイントするようにエントリを設定できます。このオプションが指定されない場合は、デフォルトの
never
が使用されます。可能な値は次のとおりです:-
always
—ベースDNの検出時とベースDNより下の検索時の両方で別名を間接参照します。 -
find
— ベースDNの検出時に別名を間接参照します。 -
never
— 別名の間接参照を行いません(デフォルト)。 -
search
— ベースDNより下の検索時に別名を間接参照しますが、ベースDNの検出時には実行しません。
-
-
-A
,--typesOnly
-
一致するエントリに属性名を含める検索を実行しますが、属性値は含めません。このオプションが指定されない場合は、属性名と属性値の両方が一致エントリに含まれます。
-
--assertionFilter filter
-
LDAPアサーション制御(RFC 4528 (
http://www.ietf.org/rfc/rfc4528.txt
)に定義しています)を使用して検索を実行し、指定されたフィルタに含まれているアサーションがtrueである場合のみ操作を処理することを示します。 -
-b, --baseDN baseDN
-
検索操作に使用するbase DNを指定します。
--filename
オプションを使用して複数のフィルタを含むファイルが指定されている場合、このベースDNはすべての検索に使用されます。これは必須オプションです。null値(""
)を持つベースDNが指定されている場合、サーバーはルートDSEエントリを返します。 -
-c, --continueOnError
-
エラーが発生した場合でも処理を続行します。このオプションは、ファイル(
--filename
)内で複数の検索フィルタを使用する場合に使用します。処理中にエラーが発生した場合、サーバーは次の検索フィルタの処理を続行します。そうでない場合、このコマンドはすべての検索が完了しないうちに終了します。 -
-C, --persistentSearch ps[:changetype[:changesonly[:entrychangecontrols]]]
-
検索リクエストで永続検索制御を使用して、指定した検索基準と一致するエントリに対して実行された変更に関する情報を取得できます。このオプションの値には、次のフォームを使用する必要があります:
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のかわりにテキスト名を使用することもできます(検索操作の場合は、Manage 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)とマークされ、認可IDdn:uid=dmiller,ou=people,dc=example,dc=com
の文字列値のあるクリティカルなコントロールが含まれます。または、次のOID名、effectiverights:true:dn:uid=dmiller、ou=people、dc=example、dc=com
が使用できます。 -
-
-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
-
プロキシ設定された認可制御を使用して、操作の対象となるユーザーの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
)で指定する必要があります。このオプションが指定されない場合、プロキシ認可は使用されません。 -
-z, --sizeLimit numEntries
-
ディレクトリ・サーバーがクライアントに返す一致エントリの最大数を設定します。このオプションが指定されていない場合、クライアントが要求する最大数は存在しません。
ノート:
ディレクトリ・サーバーでは、クライアントにより要求されるサイズ限度よりも低い限度を施行することができます。
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
-
指定されたホスト名または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認証の使用方法の詳細は、「SASL認証の構成」を参照してください。
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
とともに使用しないでください。 -
--usePasswordPolicyControl
-
バインド・リクエストにパスワード・ポリシー・リクエスト制御を使用して、ディレクトリ・サーバーがバインド・レスポンスで対応する結果制御を返すようにします。このオプションを使用して、クライアントのアカウントの状態に関連した警告またはエラーに関する情報を取得します。
-
-U, --trustStorePasswordFile trustStorePasswordFile
-
クライアント・トラスト・ストアの証明書にアクセスするために、指定されたファイルでパスワードを使用します。このオプションは、
--trustStorePath
を使用していて、指定したトラスト・ストアがコンテンツへのアクセスにパスワードを必要とする場合のみ、必須です(ほとんどのトラスト・ストアでは必要とされません)。このオプションは、--trustStorePassword
とともに使用しないでください。 -
-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
-
ディレクトリ・サーバーと通信する際、SSLを使用します。SSLを使用する場合は、
--port
オプションを使用してサーバーのセキュア・ポートを指定します。
コマンド入力/出力オプション
-
--noPropertiesFile
-
デフォルトのコマンド行オプションの取得にプロパティ・ファイルが使用されないことを示します。
-
--propertiesFilePath propertiesFilePath
-
デフォルトのコマンド行オプションが含まれているプロパティ・ファイルへのパスを指定します。
-
-T, --dontWrap
-
一致エントリを表示するときに、長い行の折り返しを行いません。このオプションが指定されない場合、長い行は80列の端末に収まるように(LDIF仕様と適合する方法で)折り返されます。
-
-v, --verbose
-
冗長モードで実行して、プロセス情報と診断情報を標準出力で表示します。
一般オプション
例
次の例は、ldapsearch
コマンドの使用方法を示しています。その他の例は、「ディレクトリ・データの検索について」を参照してください。
すべてのエントリを返す
次のコマンドは、ディレクトリ・サーバー上のすべてのエントリを返します。このコマンドは、ホスト(-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
)を返しますが、値は返しません。このコマンドは、ホスト(-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
特定の属性値を返す
次のコマンドは、特定の属性とその値を返します。このコマンドは、ホスト(-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
ルート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 ...
サーバー認証を使用した検索
次に、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)"
クライアント認証を使用した検索
次のコマンドは、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)"
ユーザーの有効権限を返す
次のコマンドは、ユーザーの属性エントリのほかに、ユーザーに付与されている有効権限を返します。ディレクトリ管理者のみが、別のユーザーに関してこの情報にアクセスできます。このコマンドでは、ホスト名(-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
スキーマを返す
次のコマンドは、ディレクトリ・インスタンスで定義されたオブジェクト・クラスと属性に関して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' ) ...
永続検索の実行
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=*)"
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";)
モニタリング情報の表示
次のコマンドは、ディレクトリ・サーバーでのアクティビティの情報に関して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
...
プロパティ・ファイルを使用した検索
ディレクトリ・サーバーでは、ldapsearchコマンドとともに使用されるデフォルトのオプション値を渡すプロパティ・ファイル
の使用をサポートしています。プロパティ・ファイルは、様々な構成環境、特にスクリプト済アプリケーションまたは埋込みアプリケーションで作業する場合に便利です。詳細は、「サーバー・コマンドによるプロパティ・ファイルの使用方法」を参照してください。
プロパティ・ファイルに保存可能なオプションは次のとおりです:
-
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
プロパティ・ファイルを使用して検索するには
-
任意のテキスト・エディタでプロパティ・ファイルを作成します。ここでは、ファイルを
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=*)"
検索属性
多数の特殊な検索属性を、次に示すように様々な目的で使用することもできます:
*
: この記号は、ディレクトリ・サーバーから返されたエントリにすべてのユーザー属性を含める必要があることを示します。
$ 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
終了コード
終了コード0は、操作が正常に終了したことを示します。ゼロ以外の終了コードは、処理中にエラーが発生したことを示します。
場所
-
UNIXおよびLinux: INSTANCE_DIR
/OUD/bin/ldapsearch
-
Windows: INSTANCE_DIR
\OUD\bat\ldapsearch.bat