エージェントのインストール・パラメーター - twsinst スクリプト
twsinst スクリプトに渡すことができるエージェントのインストール・パラメーター。
このセクションでは、twsinst スクリプトを実行してフォールト・トレラント・エージェントまたは動的エージェントをインストールするときに使用するパラメーターをリストし、説明します。
エージェントのインストール・シナリオの例については、インストールの例と動的エージェント・ゲートウェイ・インストールの例を参照してください。
JAVA_HOME=path_to_JAVA;export JAVA_HOME; twsinst_directory/twsinstこれは、これらのオペレーティング・システムでは IBM® Workload Scheduler を使用する Java がインストールされていないためです。- -acceptlicense yes|no
- ご使用条件に同意するかどうかを指定します。
- -addjruntime true|false
- Java™ ランタイムを追加して、拡張オプションを指定してジョブ・タイプ (製品で提供されたタイプ、およびカスタム・プラグインによって実装された追加タイプの両方) を実行します。 有効な値は true および false です。 フレッシュ・インストールのデフォルトは true です。
sslkeysfolder パラメーターと sslpassword パラメーターを使用して .PEM 形式のカスタム証明書を定義していない場合は、このパラメーターを true に設定します。
このオプションは、フォールト・トレラント・エージェントと動的エージェントの両方に適用できます。
インストール時に Java ランタイムをインストールしないことにした場合でも、機能の追加の説明に従って、後でこの機能を追加することができます。
- -agent dynamic|fta|both
- インストールするエージェントのタイプ。 有効な値は、以下のとおりです。
- dynamic
- IBM Workload Scheduler 動的エージェントをインストールします。 この値と一緒に、-tdwbhostname host_name パラメーターと -tdwbport tdwbport_number パラメーターを使用します。
- fta
- IBM Workload Scheduler フォールト・トレラント・エージェントをインストールします。
- both
- -tdwbhostname host_name パラメーターと -tdwbport tdwbport_number パラメーターを使用する動的エージェントと、フォールト・トレラント・エージェントの両方をインストールします。
- -agentid agent_id
- インストールするエージェントの固有 ID。 このパラメーターはオプションです。
指定されていない場合、インストール・プロセスによって、以下の例のように、英数字のストリングがエージェントに割り当てられます。
エージェントをアンインストール後に再インストールする場合や同じ agent_id を使用する場合は、agent_id を指定すると効果的な場合があります。 これにより、2 つの異なるagent_id の値が同じエージェント・インストールのサーバーに登録されないようにすることができます。893164748CCA4FC6820F12685AECBB07 - -company company_name
- 会社の名前。 会社名にブランク文字を入れることはできません。 この名前は、プログラム・ヘッダーおよびレポートに表示されます。 指定しなければ、デフォルト値は COMPANY です。
- -create_link
- UNIX™ システムのみ。 /usr/bin/at と install_dir/TWS/bin/at との間に symlink を作成します。 詳しくは、表 1を参照してください。
- -data_dir path
- この引数は、UNIX オペレーティング・システムのみに適用されます。 製品データとは別に製品バイナリーをインストールする場合に、製品データ (ログや構成ファイルなど) のパスを指定します。 この引数はオプションです。デフォルト値は INSTALL_DIR/TWSDATA です。
- -displayname display_name
- エージェントに割り当てる名前。 この名前の先頭を数値にすることはできません。 デフォルトは、このコンピューターのホスト名です。
ホスト名が数字で始まる場合、-displayname パラメーターを指定する必要があります。
- -domain user_domain
- Windows™ システムのみ。 IBM Workload Scheduler ユーザーのドメイン・ネーム。 デフォルトでは、製品をインストールするワークステーションの名前になっています。 USERDNSDOMAIN ではなく USERDOMAIN を使用していることを確認します。
- -encryptionpassword default
- 実行時にファイルを暗号化するために使用されるAES-256またはAES-128鍵を格納する鍵ストアのパスワードです。 このパラメーターはオプションです。 デフォルト値はdefault。
- -gateway local|remote|none
- Dynamic Workload Broker と通信するためにゲートウェイを構成するかどうか、およびその構成方法を指定します。 ゲートウェイが動的エージェント・ワークステーションに対してローカルである場合は、local を指定します。 動的エージェントが、その動的エージェントがインストールされているのとは別の動的エージェント・ワークステーション上にインストールされたゲートウェイを介して通信する場合は、remote を指定します。 デフォルト値は none であり、ゲートウェイは構成されません。
- -gweifport gateway_eif_port
- ジョブ・マネージャーの Event Integration Facility (EIF) ポート番号を指定します。 デフォルト値は 31132 です。 有効な値の範囲は、1 から 65535 です。
- -gwid gateway_id
- ゲートウェイの固有 ID。 このパラメーターは、-gateway local を指定する場合に必須です。
デフォルトで割り当てられているゲートウェイ ID は GW1 です。 ゲートウェイ ID は英字または下線文字 (_) で始める必要があり、英字、数字、下線(_)、ハイフン (-)、およびピリオド (.) のみを使用できます。
ゲートウェイは、並列で動作し、それらのゲートウェイに接続しているエージェントへの経路指定通信を相互に引き継ぐこともできます。 ゲートウェイが並列で動作をするようにするには、すべてのゲートウェイに同じ gateway_id を割り当てる必要があります。 この情報は、JobManagerGWURIs プロパティーを設定することにより JobManagerGW.ini ファイルに保管されます。
- -hostname host_name
- Dynamic Workload Broker がエージェントと通信するときに使用する完全修飾ホスト名または IP アドレス。 デフォルトは、このコンピューターのホスト名です。 ホスト名が localhost の場合は、hostname パラメーターを指定する必要があります。
- -inst_dir installation_dir
- IBM Workload Scheduler インストールのディレクトリー。
Windows オペレーティング・システムの場合:- ブランクを含むパスを指定する場合は、それを二重引用符で囲みます。 絶対パスを指定してください。 パスを手動で指定する場合、パスを %ProgramFiles%\IBM\TWA_TWS_USER に設定します。ここで TWS_USER は、-uname オプションで指定した IBM Workload Scheduler のインストール先ユーザーです。
UNIX および Linux™ オペレーティング・システムの場合:- ブランクを含むパスを指定する場合は、それを二重引用符で囲みます。 絶対パスを指定してください。
パスを手動で指定しない場合、パスは以下に設定されます。
- /opt/IBM/TWA_TWS_USER (エージェントをインストールするために root ユーザーとしてログインした場合)。
TWS_USER は -uname オプションで指定するユーザーで、このユーザーに対してエージェントをインストールします (TWS_USER が root の場合、省略できます)。注: -uname username パラメーターで指定する IBM Workload Scheduler ユーザーは、installation_dir インストール・パスの読み取り権限と実行権限を持っていなければなりません。持っていない場合、インストールは失敗します。
- home_dir/TWA (root 以外でログインした場合)。 ディレクトリー許可は home_dir (ユーザー・ログインのホーム・ディレクトリー) に 755 が設定されていること、およびユーザーは home_dir 所有者であることを確認してください。
- /opt/IBM/TWA_TWS_USER (エージェントをインストールするために root ユーザーとしてログインした場合)。
TWS_USER は -uname オプションで指定するユーザーで、このユーザーに対してエージェントをインストールします (TWS_USER が root の場合、省略できます)。
- -jmport port_number
-
IBM Workload Scheduler 動的エージェントに接続するために Dynamic Workload Broker によって使用される JobManager ポート番号。 デフォルト値は 31114 です。 有効範囲は、1 から 65535 です。
- -jmportssl true|false
- IBM Workload Scheduler
動的エージェントに接続するために Dynamic Workload Broker によって使用される JobManager ポート。 -jmportssl が true に設定されている場合、ポート値は ita.ini ファイルの ssl_port パラメーターの値です。 false に設定されている場合は、ポート値は ita.ini ファイルの tcp_port パラメーターの値に対応します。 ita.ini ファイルの場所は、Windows システムの場合は ITA\cpa\ita、UNIX、Linux、および IBM iシステムの場合は ITA/cpa/ita です。
- gateway が local に設定されている場合、この値は「true」に設定します。
- SSL または HTTPS を使用した通信の場合
- jmportssl =true に設定します。 Dynamic Workload Broker と通信するには、この値を true に設定することをお勧めします。 この場合、jmport で指定されるポートが HTTPS で通信します。
- SSL を使用しない HTTP 通信の場合
- jmportssl =false に設定します。 この場合、jmport で指定されるポートが HTTP で通信します。
- -lang lang_id
- twsinst メッセージが表示される言語。 指定しなければ、システム LANG が使用されます。 関連するカタログがない場合、
デフォルトの C 言語カタログが使用されます。 -lang も LANG も使用されない場合、デフォルト・コード・ページは SBCS に設定されます。 これらの変数に対する有効な値のリストについては、以下の表を参照してください。
表 1. -lang および LANG パラメーターの有効な値 言語 値 ブラジル・ポルトガル語 pt_BR 中国語 (繁体字および簡体字) zh_CN, zh_TW 英語 en フランス語 fr ドイツ語 de イタリア語 it 日本語 ja 韓国語 ko ロシア語 ru スペイン語 es 注: これは、インストール・ログの記録に使用される言語であり、 インストールされるエンジン・インスタンスの言語ではありません。 twsinst は、 デフォルトとしてすべての言語をインストールします。 - -master workstation
- マスター・ドメイン・マネージャーのワークステーション名。 この名前は 16 文字を超えてはなりません。また、スペースを含めることはできず、thiscpu パラメーターに入力したワークステーション名と同じにすることはできません。 指定しなければ、デフォルト値は MASTER です。
- -new
- エージェントのフレッシュ・インストール。 エージェントおよびすべてのサポートされている言語パックをインストールします。
- -password user_password
- Windows システムのみ。 IBM Workload Schedulerがインストールされるユーザーのパスワードです。 パスワードには、英数字、ダッシュ(-)、アンダースコア(_)、および ()= ˆ * /〜[] の記号を使用できます。 $`+;:.@. -password パラメーターは新規インストールにのみ使用されます。フィックス・パックやアップグレードの場合は必要ありません。
- -netmansslport SSL_port_number
- netman プロセスがマスターからの通信を listen するために使用する TCP/IP ポート番号です。 デフォルト値は 31113です。 有効範囲は、1 から 65535 です。 また、netmansslportパラメーターを無効に設定することで、暗号化されていない通信を使用することができます。 netmansslportパラメーターを無効に設定した場合、netmanport パラメータに値を指定する必要があります。 このポート番号は、localopts ファイルの nm ssl full port 属性に登録されます。 インストールごとに別の番号を指定する必要があります。
- -port port_number
- マスターからの通信を listen するために Netman プロセスが使用する TCP/IP ポート番号。 デフォルト値は 31111 です。 有効範囲は、1 から 65535 です。このポート番号は localopts ファイルに登録されます。 インストールごとに異なる番号を指定する必要があります。このパラメーターを無効に設定することもできます。 この場合、netmansslportパラメータに値を与えて、SSL通信を可能にする必要があります。
- -reset_perm
- UNIX および IBM i システムのみ。 /usr/ibm ディレクトリー内のライブラリーのアクセス権をリセットします。
- -restore
- このコマンドは、インストール・パスからではなく、eImage のコピー先のフォルダー (TWS_USER のホーム・ディレクトリー以外のフォルダー。ここで、TWS_USER は IBM Workload Scheduler をインストールしたユーザー) から実行します。
- -skip_usercheck
- 社内での認証プロセスが標準的なものではない場合には、このオプションを使用可能にして、それによってデフォルトの認証オプションを使用不可にします。
Windows システムでは、このパラメーターを指定すると、プログラムが -uname username パラメーターで指定されたユーザーを作成しません。 このパラメーターを指定する場合は、スクリプトを実行する前にユーザーを手動で作成する必要があります。
UNIX および Linux システムでは、このパラメーターを指定すると、プログラムが /etc/passwd ファイルでのユーザーの検査、または su コマンドを使用して実行する検査をスキップします。
- -skipcheckprereq
- このパラメーターを指定すると、IBM Workload Scheduler はエージェントをインストールする前にシステム前提条件をスキャンしません。 前提条件チェックについて詳しくは、IBM Workload Scheduler のシステム前提条件のスキャンを参照してください。
- -sslkeysfolder path
- .PEM フォーマットの証明書または鍵ストア
(TWSServerKeyFile.jks)、あるいは
(TWSServerTrustFile.jks) ファイル (UNIX オペレーティング・システムのみ)、およびその両方が入っているフォルダーの名前およびパス:
- .PEM証明書を提供する場合、インストールプログラムは、-sslpasswordパラメータで指定されたパスワードを使用して、鍵ストアとトラストストアのファイルを自動的に生成します。
UNIX系OSの場合のみ、鍵ストアとトラストストアのファイルを提供すると、これらのファイルを使って、それぞれ--keystorepasswordと--truststorepasswordで指定したパスワードでSSL通信が設定されます。
注: 鍵ストアとトラストストアのファイルを使用してインストールする場合、インストールのセットアップの前に、これらのファイルを手動で設定する必要があります。 そのため、この方法はお勧めできません。
- ca.crt
- 認証局(CA)のパブリック証明書。
- tls.key
- インスタンスをインストールするための秘密鍵。
- tls.crt
- 前述の鍵の公開部分。
オプションで 1 つ以上の *.crt ファイルを含むサブフォルダーを作成し、信頼された CA としてサーバーのトラストストアに追加することができます。 これは、LDAP サーバーや Db2 サーバーの証明書を信頼された CA のリストに追加する場合などに使用できます。 さらに、トラストストアに追加する任意の中間証明書をここに保存することもできます。 サブフォルダーの名前を additionalCAs にする必要があります。
このパラメーターは、-dbsslconnection パラメーターを true に設定した場合に必要です。マスター・ドメイン・マネージャー で既に使用可能な証明書のダウンロードとデプロイに使用する wauser パラメーターおよび wapassword パラメーターは、このパラメーターと相互に排他的です。
- -sslpassword password
- インストール・プログラムにより自動的に生成された .PEM 形式の証明書のパスワードを指定します。
このパラメーターを使用する場合、カスタム証明書を定義するのに Java ランタイムが必要なため、addjruntime パラメーターを true に設定します。
- -tdwbhostname host_name
- Dynamic Workload Broker の完全修飾ホスト名。 これは、dynamic または both に設定された -agent パラメーター、および -tdwbport
tdwbport_number パラメーターと共に使用されます。 動的エージェントのインストールが必要です。 このパラメーターを指定しなければ、ワークロードを動的に実行することはできません。このパラメーターのデフォルト値は、localhost です。 この値は、JobManager.ini ファイルの ResourceAdvisorUrl プロパティーに登録されます。
-gateway local または remote が指定されている場合、これは、ゲートウェイが存在し、エージェントが接続する動的エージェント・ワークステーションのホスト名です。 この情報は、JobManager.ini ファイルに保管されます。
- -tdwbport tdwbport_number
- Dynamic Workload Broker の HTTP または HTTPS トランスポート・ポート番号。 これは、dynamic または both に設定された -agent パラメーター、および -tdwbhostname
host_name パラメーターと共に使用されます。 このパラメーターは、エージェントが Dynamic Workload Broker に接続できるように動的エージェントをインストールする場合に必須です。 この番号は、JobManager.ini ファイルの ResourceAdvisorUrl プロパティーに登録されます。 デフォルト値は 31116 です。 インストールごとに別のポート番号を指定する必要があります。 有効範囲は、0 から 65535 です。 0 を指定した場合、またはこのパラメーターを指定しない場合は、ワークロードを動的に実行できません。 -agent の値が dynamic または both の場合は、0 を指定しないでください。 アップグレードの場合のデフォルトは 0 で、この接続が構成されていないことを示します。それ以外の場合は、フレッシュ・インストールの 31116 を指定します。
-gatewayremote が指定されている場合、これは、ゲートウェイが存在し、エージェントが接続する動的エージェント・ワークステーションの HTTP または HTTPS ポート番号です。 フレッシュ・インストールを実行する場合、使用する値は 31114 です。 この情報は、JobManager.ini ファイルに保管されます。
- -thiscpu workstation
- このインストールの IBM Workload Scheduler ワークステーションの名前。 この名前は 16 文字を超えてはならず、先頭を数値にすることができません。また、スペースを含めることはできず、マスター・ドメイン・マネージャーのワークステーション名と同じにすることはできません。 この名前は localopts ファイルに登録されます。 指定しなければ、デフォルト値はワークステーションのホスト名です。
数字で始まるホスト名の場合、-thiscpu パラメーターを指定する必要があります。
- -u
- コマンド使用法の情報を表示して終了します。
- -uname username
- IBM Workload Scheduler エージェントをインストールする対象となるユーザーの名前。 このユーザーは IBM Workload Scheduler インスタンスの所有者であり、デフォルトで、その名前がジョブの実行に使用されます。 このユーザー名は、インストールを実行するユーザーと混同してはなりません。 ユーザー名にはピリオド (.) を含めることはできません。.
UNIX および Linux システムでは、新規インストールの場合、インストールの実行前にこのユーザー・アカウントを手動で作成する必要があります。 ホーム・ディレクトリーを持つユーザーを作成します。 IBM Workload Scheduler は、デフォルトでは指定したユーザーのホーム・ディレクトリーの下にインストールされます。
また、動的エージェントは、root 特権なしのインストーラーによって、UNIX システムおよび Linux システムにインストールすることもできます。 この場合、以下のようにします。- username はデフォルトでインストーラーのログイン名を使用し、uname は省略できます。 uname にインストーラーのログインとは別の値が指定された場合、エラー・メッセージが返されます。
- 結果として、エージェントはインストーラーのユーザー名で一意的にジョブを実行できます。
- インストールに使用したユーザーがアクセス可能なファイルのみをイベント管理によってトリガーできます。
- -useencryption true | false
- 実行時にIBM Workload Schedulerファイルを暗号化するかどうかを指定します。 trueを指定した場合、またはこのパラメーターを設定しなかった場合、Symphony ファイルやメッセージキューなどのファイルは、AES-256 または AES-128 暗号を使用して暗号化されます。 デフォルトでは、新規インストールは自動的に暗号化され、キーストアのパスワードはデフォルトです。 鍵ストアのパスワードを変更するにはencryptionpasswordパラメーターを使用します。 このパラメーターはオプションです。
- -wauser wauser_name
- エージェントの接続先である マスター・ドメイン・マネージャー のインストール対象となるユーザー。 この情報を提供することで、TWA_DATA_DIR/ssl/depot パスの マスター・ドメイン・マネージャー で既に使用可能な .PEM 形式の証明書を IBM Workload Scheduler でダウンロードおよびデプロイできるようになり、安全な通信を実現できます。 証明書の保存先となるエージェントのフォルダーを指定するのに使用する sslkeysfolderパラメーターは、このパラメーターとは相互に排他的です。 このパラメーターは 動的エージェント に適用されます。 フォールト・トレラント・エージェント の証明書を管理するには、sslkeysfolder パラメーターを使用します。
- -wapassword wauser_password
- エージェントの接続先である マスター・ドメイン・マネージャー のインストール対象となるユーザーのパスワード。 この情報を提供することで、マスター・ドメイン・マネージャー の TWA_DATA_DIR/ssl/depot パスで既に使用可能な .PEM 形式の証明書を IBM Workload Scheduler でダウンロードおよびデプロイできるようになり、安全な通信を実現できます。 証明書の保存先となるエージェントのフォルダーを指定するのに使用する sslkeysfolderパラメーターは、このパラメーターとは相互に排他的です。 このパラメーターは 動的エージェント に適用されます。 フォールト・トレラント・エージェント の証明書を管理するには、sslkeysfolder パラメーターを使用します。
- -work_dir working_dir
- インストール・プロセスのファイルをデプロイするためにプログラムによって使用される一時ディレクトリー。
Windows オペレーティング・システムの場合:- ブランクを含むパスを指定する場合は、それを二重引用符で囲みます。 パスを手動で指定しない場合、%temp%\TWA\twsversion_number がパスとして設定されます。ここで
%temp%は、オペレーティング・システムの一時ディレクトリーです。
UNIX および Linux オペレーティング・システムの場合:- パスにブランクを含めることはできません。 パスを手動で指定しない場合、パスは /tmp/TWA/twsversion_number に設定されます。
- -v
- コマンドのバージョンを表示して終了します。