AdminTask オブジェクトの CAClientCommands コマンド・グループ
Jython スクリプト言語を使用すると、wsadmin ツールで認証局 (CA) クライアント構成を管理することができます。 CAClientCommands グループ内のコマンドおよびパラメーターを使用して、サード・パーティーの CA サーバーへの接続を作成、変更、照会、および除去します。
createCAClient
createCAClient コマンドは、構成内に CA クライアント・オブジェクトを新規作成します。 アプリケーション・サーバーは、CA サーバーとのすべての接続および通信を処理する WSPKIClient() 実装を通じて CA サーバーと接続します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -caClientName
- CA クライアント・オブジェクトを一意的に識別する名前を指定します。(ストリング、必須)
- -pkiClientImplClass
- WSPKIClient インターフェースを実装するクラスパスを指定します。ユーザーが指定した WSPKIClient 実装を使用して、認証局 (CA) と通信します。システムは WSPKIClient 実装を使用して、CA に対して証明書を要求します。
- 認証局との通信で使用する WSPKIClient インターフェースの開発を参照してください。(ストリング、必須)
オプション・パラメーター
- -scopeName
- CA クライアントの管理有効範囲を指定します。デプロイメント・マネージャー・プロファイルの場合、システムはセルの範囲をデフォルト値として使用します。 アプリケーション・サーバー・プロファイルの場合、システムはノードの範囲をデフォルト値として使用します。(ストリング、オプション)
- -host
- システム内の、CA が常駐しているホスト名を指定します。(ストリング、オプション)
- -port
- サーバー上の、CA が listen しているポートを指定します。(ストリング、オプション)
- -userName
- CA に対する認証に使用するユーザー名を指定します。(ストリング、オプション)
- -password
- CA に対する認証に使用するユーザー名のパスワードを指定します。(ストリング、オプション)
- -frequencyCheck
- 証明書が作成済みかどうかを判別するためにシステムが CA と通信する頻度を分単位で指定します。(ストリング、オプション)
- -retryCheck
- 証明書が作成済みかどうかを判別するために CA と通信する回数を指定します。(ストリング、オプション)
- -customProperties
- CA クライアント・オブジェクトに追加する、属性と値のカスタム・プロパティーのペアからなるコンマ区切りのリストを、attribute=value,attribute=value というフォーマットを使用して指定します。(ストリング、オプション)
戻り値
このコマンドは、システムが作成する CA クライアントのオブジェクト名を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.createCAClient('[-caClientName clientObj01 -pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient -host machine011 -port 9022 -userName admin -password pw4admin]')
- Jython リストを使用:
AdminTask.createCAClient(['-caClientName', 'clientObj01', '-pkiClientImplClass', 'com.ibm.wsspi.ssl.WSPKIClient', '-host', 'machine011', '-port', '9022', '-userName', 'admin', '-password', 'pw4admin'])
対話モードの使用例
- Jython の使用:
AdminTask.createCAClient('-interactive')
modifyCAClient
modifyCAClient コマンドは、既存の CA クライアント・オブジェクト構成データを変更します。特定の CA クライアントの 1 つ以上の構成属性を変更することができます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -caClientName
- 対象の CA クライアントの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- CA クライアントの管理有効範囲を指定します。 デプロイメント・マネージャー・プロファイルの場合、セルの範囲がデフォルトとして使用されます。 アプリケーション・サーバー・プロファイルの場合、システムはノードの範囲をデフォルトとして使用します。(ストリング、オプション)
- -pkiClientImplClass
- WSPKIClient インターフェースを実装するクラスパスを指定します。 システムはこのパスを使用して CA に接続し、その CA に要求を送出します。 (ストリング、オプション)
- -host
- システム内の、CA が常駐しているホスト名を指定します。(ストリング、オプション)
- -port
- サーバー上の、CA が listen しているポートを指定します。(ストリング、オプション)
- -userName
- CA に対する認証に使用するユーザー名を指定します。(ストリング、オプション)
- -password
- CA に対する認証に使用するユーザー名のパスワードを指定します。(ストリング、オプション)
- -frequencyCheck
- 証明書が作成済みかどうかを判別するために、システムが CA をチェックする頻度を分単位で指定します。(ストリング、オプション)
- -retryCheck
- 証明書が作成済みかどうかを判別するために、CA をチェックする回数を指定します。(ストリング、オプション)
- -customProperties
- CA クライアント・オブジェクトの変更で使用する、コンマで区切られた属性と値 (属性 = 値) のカスタム・プロパティー・ペアのリストを指定します。 プロパティーの作成、変更、または除去を行うことができます。プロパティーを除去するには、属性および値を attribute= と指定します。(ストリング、オプション)
戻り値
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.modifyCAClient('[-caClientName myCAClient -port 4060 -userName admin -password password4admin]')
- Jython リストを使用:
AdminTask.modifyCAClient(['-caClientName', 'myCAClient', '-port', '4060', '-userName', 'admin', '-password', 'password4admin'])
対話モードの使用例
- Jython の使用:
AdminTask.modifyCAClient('-interactive')
getCAClient
getCAClient コマンドは、特定の CA クライアントの属性のリストを表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -caClientName
- 対象の CA クライアント名を指定します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 対象の CA クライアントの管理有効範囲を指定します。(ストリング、オプション)
戻り値
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementSc
ope_1)] [scopeName (cell):myCell01] [name myCAClient] [baseDn ] [_Websphe
re_Config_Data_Id cells/myCell01|security.xml#CAClient_1181834566882] [por
t 2951] [CACertificate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [u
serId ] [_Websphere_Config_Data_Type CAClient] [retryCheck 0] [properties ] [fre
quencyCheck 0] [password ] [host ] ]'
バッチ・モードの使用例
- Jython ストリングを使用:
print AdminTask.getCAClient('-caClientName myCAClient')
- Jython リストを使用:
print AdminTask.getCAClient('-caClientName', 'myCAClient')
対話モードの使用例
- Jython ストリングを使用:
print AdminTask.getCAClient('-interactive')
deleteCAClient
deleteCAClient コマンドは、対象の CA クライアント・オブジェクトを構成から除去します。削除する CA クライアントを指定するには、-caClientName パラメーターを使用します。 オプションで、scopeName パラメーターを使用して、CA クライアントの管理有効範囲を指定することができます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -caClientName
- 対象の CA クライアントの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 対象の CA クライアントの管理有効範囲を指定します。(ストリング、オプション)
戻り値
このコマンドは、対象の CA クライアントがシステムによって正常に除去された場合には、出力を戻しません。 エラー・メッセージが表示された場合は、対象の CA クライアント・オブジェクトがその構成内に存在すること、およびその CA クライアント・オブジェクトが、セキュリティー構成内の証明書オブジェクトによって参照されていないことを確認してください。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteCAClient('[-caClientName myCAClient]')
- Jython リストを使用:
AdminTask.deleteCAClient(['-caClientName', 'myCAClient'])
対話モードの使用例
- Jython の使用:
AdminTask.deleteCAClient('-interactive')
listCAClients
listCAClients コマンドは、その構成内、または特定の範囲内のすべての CA クライアントをリストします。 -scopeName パラメーターに値を指定しないと、このコマンドは デプロイメント・マネージャー・プロファイルを使用している場合にはセルを照会し、アプリケーション・サーバー・プロファイルを使用している場合にはノードを照会します。 特定の範囲を使用せずに環境の照会を行うには、-all パラメーターを使用します。
ターゲット・オブジェクト
なし。
オプション・パラメーター
- -scopeName
- CA クライアントを検索するには、管理の有効範囲を指定します。(ストリング、オプション)
- -all
- システムが特定の範囲を使用せずに CA クライアントの照会を行うかどうかを指定します。(ブール値、オプション)
戻り値
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementScope_1)
] [scopeName (cell):myCell01] [name jenCAClient] [baseDn ] [_Websphere_Config_Da
ta_Id cells/myCell01|security.xml#CAClient_1181834566881] [port 2950] [CACertifi
cate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [userId ] [_Webspher
e_Config_Data_Type CAClient] [retryCheck 0] [properties ] [frequencyCheck 0] [pa
ssword ] [host ] ]'
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementScope_1)
] [scopeName (cell):myCell01] [name myCAClient] [baseDn ] [_Websphere_Config_Dat
a_Id cells/myCell01|security.xml#CAClient_1181834566882] [port 2951] [CACertific
ate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [userId ] [_Websphere
_Config_Data_Type CAClient] [retryCheck 0] [properties ] [frequencyCheck 0] [pas
sword ] [host ] ]'
バッチ・モードの使用例
- Jython ストリングを使用:
print AdminTask.listCAClients('-all true')
- Jython リストを使用:
print AdminTask.listCAClients('-all', 'true')
対話モードの使用例
- Jython の使用:
print AdminTask.listCAClients('-interactive')