20.2 リモートローダの環境設定パラメータの理解

Identity Managerアプリケーションシムをホストするドライバインスタンスとリモートローダを連携するには、ドライバインスタンスを設定する必要があります。たとえば、インスタンスの接続およびポートの設定を指定する必要があります。コマンドライン、環境設定ファイル(UNIXまたはLinux)、あるいはリモートローダコンソール(Windows)で設定を指定できます。インスタンスが実行状態になったら、コマンドラインを使用して、環境設定パラメータを変更したり、特定の機能を実行するようリモートローダに命令したりできます。たとえば、トレースウィンドウを開いたり、リモートローダをアンロードしたりできます。

このセクションでは、環境設定パラメータについて説明します。ここでの説明では、インスタンスの実行中にコマンドラインからパラメータを送信してリモートローダを更新できるかどうかを指定します。

新しいドライバインスタンスの設定の詳細については、以下のセクションを参照してください。

20.2.1 リモートローダのドライバインスタンスの環境設定パラメータ

ドライバインスタンスは、コマンドラインまたは環境設定ファイルで設定できます。リモートローダおよびドライバをアプリケーションシム用に設定するのに役立つサンプルファイルconfig8000.txtが用意されています。このサンプルファイルは、デフォルトでは/opt/novell/dirxml/docディレクトリにあります。たとえば、環境設定ファイルに次の行を記述できます。

-commandport 8000
-connection "port=8090 rootfile=/dirxmlremote/root.pem"
-module $DXML_HOME/dirxmlremote/libcskeldrv.so.0.0.0
-trace 3

使用するパラメータは、以下のとおりです。

-description value (-desc value)

(オプション)文字列形式の短い説明を指定します(SAPなど)。この説明は、アプリケーションによってトレースウィンドウのタイトルや監査ログに使用されます。次に例を示します。

-description SAP
-desc SAP
-class name (-cl name)

(状況によって実行) Javaドライバを使用する場合、ホストするIdentity ManagerアプリケーションシムのJavaクラス名を指定します。このオプションにより、Javaキーストアを使用して証明書を読み込むようアプリケーションに指示します。次に例を示します。

-class com.novell.nds.dirxml.driver.ldap.LDAPDriverShim-cl com.novell.nds.dirxml.driver.ldap.LDAPDriverShim

メモ:

  • -moduleオプションを指定した場合、このオプションは使用できません。

  • -classオプションで区切り文字としてタブを使用すると、リモートローダは自動的に起動しません。代わりに、手動で起動する必要があります。リモートローダを適切に起動するには、タブではなくスペースを使用できます。

  • このオプションで指定できる名前の詳細については、Java -classパラメータの名前の理解を参照してください。

-commandport port_number (-cp port_number)

ドライバインスタンスが制御目的で使用するTCP/IPポートを指定します。たとえば、-commandport 8001または-cp 8001と指定します。デフォルトは8000です。

同じサーバ上のリモートローダで複数のドライバインスタンスを使用するには、インスタンスごとに異なる接続ポートとコマンドポートを指定します。

ドライバインスタンスがアプリケーションシムをホストしている場合、コマンドポートは、別のインスタンスが、シムをホストしているインスタンスと通信するポートになります。ドライバインスタンスが、アプリケーションシムをホストしているインスタンスにコマンドを送信する場合、コマンドポートはホストインスタンスがリスンしているポートになります。

このパラメータをコマンドラインから、アプリケーションシムをホストしているインスタンスに送信する場合、コマンドポートはホストインスタンスがリスンしているポートを表します。このコマンドはリモートローダの実行中に送信できます。

-config filename

ドライバインスタンスの環境設定ファイルを指定します。次に例を示します。

-config config.txt

環境設定ファイルには、-config以外のあらゆるコマンドラインオプションを含めることができます。コマンドラインで指定したオプションは、環境設定ファイル内で指定されたオプションよりも優先されます。

このコマンドはリモートローダの実行中に送信できます。

-connection “parameters” (-conn “parameters”)

Identity Managerリモートインタフェースシムを実行するIdentity Managerエンジンをホストしているサーバに接続するための設定を指定します。デフォルトの接続方法は、SSLを使用したTCP/IPです。

同じサーバ上のリモートローダで複数のドライバインスタンスを使用するには、インスタンスごとに異なる接続ポートとコマンドポートを指定します。

次の構文で接続設定を入力します。

-connection "parameter parameter parameter"

次に例を示します。

-connection "port=8091 fromaddress=198.51.100.0 rootfile=server1.pem keystore=ca.pem localaddress=198.51.100.0 hostname=198.51.100.0 kmo=remote driver cert"

TCP/IP接続の設定を指定するには、次のパラメータを使用します。

address=IP_address

(オプション)リモートローダが特定のローカルIPアドレスをリスンするかどうかを指定します。これは、リモートローダをホストするサーバが複数のIPアドレスを持ち、リモートローダが1つのアドレスのみをリスンしなければならない場合に便利です。有効な値は次のとおりです。

  • address=address number

  • address='localhost'

次に例を示します。

address=198.51.100.0

値を指定しない場合、リモートローダはすべてのローカルIPアドレスをリスンします。

fromaddress=IP_address

リモートローダが接続を受け入れる元のサーバを指定します。アプリケーションは他のアドレスからの接続を無視します。サーバのIPアドレスまたはDNS名を指定します。次に例を示します。

fromaddress=198.51.100.0
fromaddress=testserver1.company.com
handshaketimeout=milliseconds

(状況によって実行) Identity Managerエンジンからの有効な接続でハンドシェークのタイムアウトが発生した場合に適用されます。リモートローダとIdentity Managerエンジン間のハンドシェークのタイムアウト時間(ミリ秒単位)を指定します。次に例を示します。

handshaketimeout=1000

ゼロ以上の整数を指定できます。ゼロは、接続がタイムアウトしないことを意味します。デフォルト値は1000ミリ秒です。

hostname=server

リモートローダを実行するサーバのIPアドレスまたは名前を指定します。次に例を示します。

hostname=198.51.100.0
secureprotocol=TLS version

リモートローダがIdentity Managerエンジンに接続するために使用するTLSプロトコルのバージョンを指定します。次に例を示します。

secureprotocol=TLSv1_2 

Identity Managerは、TLSv1およびTLSv1_2をサポートします。デフォルトで、リモートローダはTLSv1_2を使用します。TLSv1を使用するには、パラメータでこのバージョンを指定します。

enforceSuiteB=true/false

(状況によって実行)リモートローダがSuite B暗号アルゴリズムを使用してIdentity Managerエンジンと通信する場合にのみ適用します。

通信にSuite Bを使用するには、trueを指定します。この通信は、TLS 1.2プロトコルでのみサポートされます。

Suite B対応エンジンを、TLSv1.2をサポートしないリモートローダと接続しようとする場合、ハンドシェークが失敗し、通信が確立されません。たとえば、リモートローダ4.5.3は、TLS v1.2をサポートしません。

useMutualAuth=true/false

(状況によって実行)リモートローダとIdentity Managerエンジンが、信頼する認証局(CA)によって発行された公開鍵証明書やデジタル証明書、または自己署名証明書を検証することにより相互認証する場合にのみ適用します。次に例を示します。

useMutualAuth=true
keystore=filename

リモートインタフェースシムが使用する証明書の発行者のルート認証局証明書を含むJavaキーストアのファイル名を指定します。次に例を示します。

keystore=keystore filename

通常は、リモートインタフェースシムをホストしているツリーの認証局を指定します。

kmo=name

SSL接続に使用するキーと証明書を含む暗号化キーオブジェクトのキー名を指定します。次に例を示します。

kmo=remote driver cert
localaddress=IP_address

クライアント接続用ソケットのバインド先IPアドレスを指定します。次に例を示します。

localaddress=198.51.100.0
port=port_number

リモートローダがリモートインタフェースシムからの接続をリスンするTCP/IPポートを指定します。デフォルトポートを指定するには、「port=8090」と入力します。

rootfile=trusted certname

リモートインタフェースシムが使用する証明書の発行者のルート認証局証明書を含むファイルの名前を指定します。この証明書はBase64形式(PEM)である必要があります。次に例を示します。

rootfile=trustedcert

通常、このファイルはリモートインタフェースシムをホストしているツリーの認証局です。

storepass=password

keystoreパラメータに入力したJavaキーストアのパスワードを指定します。次に例を示します。

storepass=mypassword

リモートローダがJavaドライバと通信するには、次の構文を使用して、キーと値のペアを指定します。

keystore=keystorename storepass=password
-datadir directory (-dd directory)

リモートローダが使用するデータファイルのディレクトリを指定します。次に例を示します。

-datadir /var/opt/novell/dirxml/rdxml/data

このコマンドを使用すると、rdxmlプロセスにより、カレントディレクトリが指定のディレクトリに変更されます。明示的にパスが指定されていないトレースファイルなどのファイルは、このデータディレクトリに作成されます。

-help (-h)

ヘルプを表示するようアプリケーションに命令します。

-java (-j)

(状況によって実行) Javaドライバシムインスタンスのパスワードを設定するよう指定します。

メモ:-classの値を同時に指定しない場合、このオプションは-setpasswordsオプションとともに使用します。

-javadebugport port_number (-jdp port_number)

指定されたポートでJavaデバッグを有効にするようインスタンスに命令します。次に例を示します。

-javadebugport 8080

このコマンドはIdentity Managerアプリケーションシムの開発時に使用します。このコマンドはリモートローダの実行中に送信できます。

-javaparam parameters (-jp parameters)

Java環境の各種パラメータを指定します。次の構文でJava環境パラメータを入力します。

-javaparam parameter
-jp parameter
-jp parameter

メモ:Javaリモートローダと一緒にこのパラメータを使用しないでください。

個々のパラメータに複数の値を指定するには、パラメータを引用符で囲みます。次に例を示します。

-javaparam DHOST_JVM_MAX_HEAP=512M
-jp DHOST_JVM_MAX_HEAP=512M
-jp "DHOST_JVM_OPTIONS=-Dfile.encoding=utf-8 -Duser.language=en"

Java環境を設定するには、次のパラメータを使用します。

DHOST_JVM_ADD_CLASSPATH

JVMがパッケージ(.jar)ファイルおよびクラス(.class)ファイルを検索する追加のパスを指定します。UNIXまたはLinuxの1つのJVMに対して複数のクラスパスを指定するには、各パスの間にコロンを挿入します。Windows JVMの場合はセミコロンを使用します。

DHOST_JVM_INITIAL_HEAP

JVMの初期(最小)ヒープサイズを10進数のバイト単位で指定します。数値を指定し、その後に単位としてバイトタイプを表すG、M、またはKを指定します。次に例を示します。

100M

バイトタイプを指定しない場合、サイズはデフォルトでバイトに設定されます。このパラメータを使用することは、java -Xmsコマンドを使用することと同等です。

このパラメータは、ドライバセット属性オプションよりも優先されます。初期ヒープサイズを大きくすれば、起動時間とスループットのパフォーマンスが改善される場合があります。

DHOST_JVM_MAX_HEAP

JVMの最大ヒープサイズを10進数のバイト単位で指定します。数値を指定し、その後に単位としてバイトタイプを表すG、M、またはKを指定します。次に例を示します。

100M

バイトタイプを指定しない場合、サイズはデフォルトでバイトに設定されます。

このパラメータは、ドライバセット属性オプションよりも優先されます。

DHOST_JVM_OPTIONS

ドライバのJVMインスタンスの起動時に使用する引数を指定します。空白を使用して各オプション文字列を区切ります。次に例を示します。

-Xnoagent -Xdebug -Xrunjdwp: transport=dt_socket,server=y, address=8000

このパラメータよりもドライバセット属性オプションが優先されます。この環境変数は、ドライバセット属性オプションの末尾に付加されます。有効なオプションの詳細については、JVMのマニュアルを参照してください。

-module “name” (-m “name”)

(状況によって実行)ネイティブドライバを使用する場合、ホストするIdentity Managerアプリケーションシムが含まれるモジュールを指定します。このオプションは、rootfile証明書を使用するようアプリケーションに命令します。たとえば、ネイティブドライバに対しては次のいずれかを入力します。

-module "c:\Novell\RemoteLoader\ADDriver.dll"
-m "c:\Novell\RemoteLoader\ADDriver.dll"

または

-module "usr/lib/dirxml/NISDriverShim.so"
-m "usr/lib/dirxml/NISDriverShim.so"

メモ:

  • -classオプションを指定した場合、このオプションは使用できません。

  • -moduleオプションで区切り文字としてタブを使用すると、リモートローダは自動的に起動しません。代わりに、手動で起動する必要があります。リモートローダを適切に起動するには、タブではなくスペースを使用できます。

-password value (-p value)

設定を変更するコマンドやインスタンスの操作に影響するコマンドを発行する場合は、ドライバインスタンスのパスワードを指定する必要があります。コマンドを発行するインスタンスに対してsetpasswordsで指定した最初のパスワードと同じパスワードを指定します。次に例を示します。

-password netiq4

コマンドの発行時にパスワードを送信しない場合、ドライバインスタンスにより、パスワードを入力するようプロンプトが表示されます。

このコマンドはリモートローダの実行中に送信できます。

-piddir directory (-pd directory)

リモートローダプロセスが使用するプロセスIDファイル(pidfile)のディレクトリのパスを指定します。次に例を示します。

-piddir /var/opt/novell/dirxml/rdxml/data

pidfileは、主にSysV方式のinitスクリプトが使用します。デフォルト値は/var/runです。pidfileを開いて/var/runの読み書きを行うための十分な権限を持たないユーザによってリモートローダが実行されている場合、デフォルト値はカレントディレクトリになります。

このパラメータは-datadirと同様です。

-service value (-serv value)

(Windowsのみ) Windowsコンピュータ上でインスタンスをWin32サービスとして設定するかどうかを指定します。有効な値はinstallおよびuninstallと、アプリケーションシムをホストするのに必要なその他のパラメータです。たとえば、-moduleを記述する必要がある場合に、-commandportと接続設定も記述できます。

このコマンドは単にインスタンスをサービスとしてインストールか、アンインストールします。サービスを起動するものではありません。

このコマンドはリモートローダの実行中に送信できます。ただし、rdxmlまたはJavaリモートローダではこのコマンドを使用できません。

-setpasswords Remote_Loader_pwd optional_pwd (-sp Remote_Loader_pwd optional_pwd)

ドライバインスタンスのパスワード、およびリモートローダが通信するリモートインタフェースシムのIdentity Managerドライバオブジェクトのパスワードを指定します。

パスワードを指定する必要はありません。その代わり、リモートローダによって、パスワードを入力するようプロンプトが表示されます。ただし、リモートローダのパスワードを指定した場合、Identity Managerエンジンサーバでリモートインタフェースシムに関連付けられているIdentity Managerドライバオブジェクトのパスワードも指定する必要があります。パスワードを指定するには、次の構文を使用します。

-setpasswords Remote_Loader_password driver_object_password

次に例を示します。

-setpasswords netiq4 idmobject6

メモ:このオプションを使用すると、指定したパスワードがドライバインスタンスに設定されますが、Identity Managerアプリケーションシムはロードされず、別のインスタンスとも通信しません。

トレースファイルの設定

(状況によって実行) Identity Managerアプリケーションシムをホストする場合、リモートローダとこのインスタンスのドライバの両方からの情報メッセージを記録するトレースファイルの設定を指定します。

環境設定ファイルに次のパラメータを追加します。

-trace integer (-t integer)

トレースウィンドウに表示するメッセージのレベルを指定します。次に例を示します。

-trace 3

リモートローダのトレースレベルは、Identity Managerエンジンをホストしているサーバで使用されているトレースレベルに対応します。

-tracefile filepath (-tf filepath)

トレースメッセージを記録するファイルのパスを指定します。特定のコンピュータで実行されている各ドライバインスタンスに対して固有のトレースファイルを指定する必要があります。次に例を示します。

-tracefile c:\temp\trace.txt

-traceパラメータがゼロより大きい場合、アプリケーションはメッセージをこのファイルに書き込みます。メッセージをファイルに書き込むためにトレースウィンドウが開いている必要はありません。

-tracefilemax size (-tf size)

このインスタンスのトレースファイルのサイズの制限を指定します。キロバイト、メガバイト、またはギガバイト単位の値を、バイトタイプを表す略語を使用して指定します。次に例を示します。

  • -tracefilemax 1000K

  • -tf 100M

  • -tf 10G

メモ:

  • リモートローダの起動時にトレースファイルのデータが指定した最大サイズよりも大きい場合、10ファイルすべてのロールオーバーが完了するまで、トレースファイルのデータは指定した最大値よりも大きいままとなります。

  • 環境設定ファイルにこのオプションを追加した場合、アプリケーションは指定した名前をトレースファイルに使用し、最大9個の「ロールオーバー」ファイルを含めます。ロールオーバーファイルには、メインのトレースファイル名と「_n」に基づいた名前が付けられます。「n」は1~9の値になります。

-tracechange integer (-tc integer)

(状況によって実行)アプリケーションシムをホストしている既存のドライバインスタンスがある場合に、情報メッセージの新しいレベルを指定します。トレースレベルはIdentity Managerサーバで使用されているレベルと同じです。次に例を示します。

-trace 3

このコマンドはリモートローダの実行中に送信できます。

-tracefilechange filepath (-tfc filepath)

(状況によって実行)アプリケーションシムをホストしている既存のドライバインスタンスがある場合に、そのインスタンスに対し、特定のトレースファイルを使用するか、使用中のファイルを閉じてこの新しいファイルに変更するよう命令します。次に例を示します。

-tracefilechange \temp\newtrace.txt

このコマンドはリモートローダの実行中に送信できます。

-unload (-u)

アンロードするようドライバインスタンスに命令します。リモートローダがWin32サービスとして実行されている場合は、サービスを停止します。

このコマンドはリモートローダの実行中に送信できます。

-window value (-w) value

(Windowsのみ) Windowsコンピュータでドライバインスタンスのトレースウィンドウをオンまたはオフにするようアプリケーションに命令します。有効な値はonおよびoffです。次に例を示します。

-window on

このコマンドはリモートローダの実行中に送信できます。このコマンドはJavaリモートローダでは使用できません。

-wizard (-wiz)

(Windowsのみ) Windowsコンピュータでリモートローダの環境設定ウィザードを起動します。コマンドラインパラメータを指定せずにdirxml_remote.exeを実行してもウィザードを起動できます。

このコマンドを実行する際に環境設定ファイルも指定した場合(-configオプション)、ウィザードは環境設定ファイルの値で起動します。環境設定ファイルを直接編集せずに、ウィザードを使用して設定を変更できます。次に例を示します。

-wizard -config config.txt

このコマンドはJavaリモートローダでは使用できません。

20.2.2 Java -classパラメータの名前の理解

-classパラメータを使用してリモートローダおよびJavaリモートローダのドライバインスタンスを設定する場合、ホストするIdentity ManagerアプリケーションシムのJavaクラス名を指定する必要があります。

Javaクラス名

ドライバ

com.novell.nds.dirxml.driver.dcsshim.DCSShim

データ収集サービス用ドライバ

com.novell.nds.dirxml.driver.delimitedtext.DelimitedTextDriver

区切り付きテキストドライバ

be.opns.dirxml.driver.ars.arsremedydrivershim.ARSDriverShim

Driver for Remedy ARS

com.novell.nds.dirxml.driver.entitlement.EntitlementServiceDriver

エンタイトルメントサービスドライバ

com.novell.gw.dirxml.driver.rest.shim.GWdriverShim

GroupWise 2014ドライバ

com.novell.idm.drivers.idprovider.IDProviderShim

IDプロバイダドライバ

com.novell.nds.dirxml.driver.jdbc.JDBCDriverShim

JDBCドライバ

com.novell.nds.dirxml.driver.jms.JMSDriverShim

JMSドライバ

com.novell.nds.dirxml.driver.ldap.LDAPDriverShim

LDAPドライバ

com.novell.nds.dirxml.driver.loopback.LoopbackDriverShim

Loopback Driver

com.novell.nds.dirxml.driver.ebs.user.EBSUserDriver

Oracleユーザ管理ドライバ

com.novell.nds.dirxml.driver.ebs.hr.EBSHRDriver

Oracle HRドライバ

com.novell.nds.dirxml.driver.ebs.tca.EBSTCADriver

Oracle TCAドライバ

com.novell.nds.dirxml.driver.msgateway.MSGatewayDriverShim

Managed System Gateway Driver

com.novell.nds.dirxml.driver.manualtask.driver.ManualTaskDriver

Manual Task Driver

com.novell.nds.dirxml.driver.nisdriver.NISDriverShim

NIS Driver

com.novell.nds.dirxml.driver.notes.NotesDriverShim

Notes Driver

com.novell.nds.dirxml.driver.psoftshim.PSOFTDriverShim

PeopleSoft Driver

com.netiq.nds.dirxml.driver.pum.PUMDriverShim

特権ユーザ管理ドライバ

com.novell.nds.dirxml.driver.salesforce.SFDriverShim

SalesForceドライバ

com.novell.nds.dirxml.driver.SAPHRShim.SAPDriverShim

SAP HRドライバ

com.novell.nds.dirxml.driver.sap.portal.SAPPortalShim

SAPポータルドライバ

com.novell.nds.dirxml.driver.sapumshim.SAPDriverShim

SAP User Management Driver

com.novell.nds.dirxml.driver.soap.SOAPDriver

SOAPドライバ

com.novell.idm.driver.ComposerDriverShim

ユーザアプリケーション

com.novell.nds.dirxml.driver.workorder.WorkOrderDriverShim

ワークオーダードライバ