AdminTask オブジェクトの AuditEmitterCommands
Jython スクリプト言語を使用すると、wsadmin ツールで監査サービス・プロバイダーを構成できます。AuditEmitterCommands グループのコマンドおよびパラメーターを使用して、セキュリティー監査システム構成から、監査サービス・プロバイダーを作成、管理、および除去します。
- createBinaryEmitter
- createSMFEmitter
- createThirdPartyEmitter
- deleteAuditEmitterByRef
- deleteAuditEmitterByName
- getAuditEmitter
- getBinaryFileLocation
- getAuditEmitterFilters
- getBinaryFileSize
- getEmitterClass
- getEmitterUniqueId
- getMaxNumBinaryLogs
- listAuditEmitters
- modifyAuditEmitter
- setAuditEmitterFilters
createBinaryEmitter
createBinaryEmitter コマンドは audit.xml ファイルに項目を作成し、監査サービス・プロバイダー・インターフェースのバイナリー・ファイル・エミッター実装の構成を参照します。
このコマンドを実行するには、ユーザーに監査員の管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -uniqueName
- 監査サービス・プロバイダー・インターフェースの実装を一意的に識別する名前を指定します。(ストリング、必須)
- -className
- 監査サービス・プロバイダー・インターフェースを実装するクラスを指定します。 (ストリング、必須)
- -fileLocation
- システムが監査ログを作成するロケーションを指定します。(ストリング、必須)
- -auditFilters
- 事前定義された監査フィルターへの参照または参照のグループを指定します。 複数の参照を指定するには、次のフォーマットを使用します。reference,reference,reference (ストリング、必須)
- -wrapBehavior
- バイナリー監査ログ・ラッピングのカスタマイズ可能動作を示すストリングを指定します。(ストリング、必須)。
このパラメーターには、WRAP、NOWRAP、SILENT_FAIL という 3 つの値があります。
WRAP オプションを使用すると、最大ログ数に達した場合、最も古い監査ログが書き換えられますが、通知は監査員に送信されません。
NOWRAP オプションの場合は、最も古い監査ログの書き換えは行われません。この場合は、監査サービスを停止して、通知を SystemOut.log に送信し、アプリケーション・サーバーは静止します。
SILENT_FAIL オプションの場合は、最も古い監査ログの書き換えは行われません。この場合も監査サービスは停止しますが、WebSphere プロセスは継続が許可されます。SystemOut.log に通知はポストされません。
注: NOWRAP または SILENT_FAIL オプションを使用する場合、ログが最大限度に達した結果、サーバーが停止すると、stopserver が実行されるか、またはサーバーが何らかの方法で異常終了になるため、サーバーを再始動する前に、バイナリー監査ログをアーカイブする必要があります。注: 制御領域 (CR) および各サーバント領域 (SR) には、それぞれ独自のバイナリー監査ログがあります。制御領域に関連付けられたバイナリー監査ログは、末尾が _CR.log 接尾部となり、サーバント領域の監査ログは、末尾が _SR.log 接尾部になります。アーカイブ済みのバイナリー・ログの最大数は、CR および SR 領域の両方に適用されます。例えば、アーカイブ済みバイナリー・ログの最大数が 10 の場合、CR 領域も各 SR 領域も最大 10 のアーカイブ済みバイナリー・ログを収容できます。
アーカイブ済みバイナリー・ログの最大数に達した時に適用される監査動作は、構成された最大値にアーカイブ済みログが達した領域だけに適用されます。例えば、SR 領域がアーカイブ済みログの最大数に達した場合、動作は SR 領域だけに適用されます。CR 領域はまだアーカイブ済みログの最大数に達していない場合、その領域ではそのまま監査が継続されます。
オプション・パラメーター
- -eventFormatterClass
- 出力用にシステムが監査イベントをフォーマットする方法を実装するクラスを指定します。デフォルトの監査サービス・プロバイダーを使用する場合は、このパラメーターは指定しないでください。(ストリング、オプション)
- -maxFileSize
- システムがタイム・スタンプで監査ログを保存するまでの各ログの最大サイズを指定します。サイズをメガバイト単位で指定します。デフォルト値は 10 MB です。 (整数、オプション)
- -maxLogs
- システムが最も古い監査ログに再書き込みするまでに作成されるログ・ファイルの最大数を指定します。ログのデフォルト値は 100 です。(整数、オプション)
戻り値
AuditServiceProvider_1184686384968
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.createBinaryEmitter('-uniqueName mybinaryemitter -className com.ibm.ws.security.audit.BinaryEmitterImpl -fileLocation c:¥wasinstall¥appserver¥profiles¥AppSrv01¥logs¥server1 -maxFileSize 20 -maxLogs 100 –wrapBehavior NOWRAP -auditFilters AuditSpecification_1173199825608')
- Jython リストを使用:
AdminTask.createBinaryEmitter(['-uniqueName', 'mybinaryemitter', '-className', 'com.ibm.ws.security.audit.BinaryEmitterImpl', '-fileLocation', 'c:¥wasinstall¥appserver¥profiles¥AppSrv01¥logs¥server1', '-maxFileSize', '20', '-maxLogs', '100', '–wrapBehavior', 'NOWRAP', '-auditFilters', 'AuditSpecification_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.createBinaryEmitter('-interactive')
createSMFEmitter
createSMFEmitter コマンドは、audit.xml ファイルに項目を作成し、監査サービス・プロバイダー・インターフェースの SMF 実装の構成を参照します。 監査記録の暗号化と署名は、SMF 実装ではサポートされていません。
このコマンドを実行するには、ユーザーに監査員の管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -uniqueName
- 監査サービス・プロバイダー・インターフェースの実装を一意的に識別する名前を指定します。(ストリング、必須)
- -auditFilters
- 事前定義された監査フィルターへの参照または参照のグループを指定します。 複数の参照を指定するには、次のフォーマットを使用します。reference,reference,reference (ストリング、必須)
戻り値
AuditServiceProvider_1184686384968
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.createSMFEmitter('-uniqueName mySMFEmitter -auditFilters AuditSpecification_1173199825608')
- Jython リストを使用:
AdminTask.createSMFEmitter(['-uniqueName', 'mySMFEmitter', '-auditFilters', 'AuditSpecification_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.createSMFEmitter('-interactive')
createThirdPartyEmitter
createThirdPartyEmitter コマンドは、audit.xml 構成ファイルに項目を作成し、監査サービス・プロバイダー・インターフェースのサード・パーティー・エミッター実装の構成を参照します。監査記録の暗号化と署名は、サード・パーティー実装ではサポートされていません。
このコマンドを実行するには、ユーザーに監査員の管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -uniqueName
- 監査サービス・プロバイダー・インターフェースの実装を一意的に識別する名前を指定します。(ストリング、必須)
- -className
- 監査サービス・プロバイダー・インターフェースを実装するクラスを指定します。 (ストリング、必須)
- -auditFilters
- 事前定義された監査フィルターへの参照または参照のグループを指定します。 複数の参照を指定するには、次のフォーマットを使用します。reference,reference,reference (ストリング、必須)
オプション・パラメーター
- -eventFormatterClass
- 出力用にシステムが監査イベントをフォーマットする方法を実装するクラスを指定します。(ストリング、オプション)
- -customProperties
- システムが監査サービス・プロバイダーのサード・パーティー実装を構成する必要のあるカスタム・プロパティーを指定します。カスタム・プロパティーを指定するには、次のフォーマットを使用します。name=value,name=value (ストリング、オプション)
戻り値
AuditServiceProvider_1184686638218
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.createThirdPartyEmitter('-uniqueName myThirdPartyEmitter -className com.mycompany.myemitterclass -eventFormatterClass com.mycompany.myeventformatterclass -auditFilters AuditSpecification_1173199825608')
- Jython リストを使用:
AdminTask.createThirdPartyEmitter(['-uniqueName', 'myThirdPartyEmitter', '-className', 'com.mycompany.myemitterclass', '-eventFormatterClass', 'com.mycompany.myeventformatterclass', '-auditFilters', 'AuditSpecification_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.createThirdPartyEmitter('-interactive')
deleteAuditEmitterByRef
deleteAuditEmitterByRef コマンドは、システムが参照 ID で参照する監査サービス・プロバイダー実装を削除します。イベント・ファクトリーが監査サービス・プロバイダーを使用している場合、システムが監査サービス・プロバイダーを除去できないというエラーが発生します。
このコマンドを実行するには、ユーザーに監査員の管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- 削除する監査サービス・プロバイダー実装の参照 ID を指定します。(ストリング、必須)
戻り値
システムが監査サービス・プロバイダーを正常に除去した場合、このコマンドは true の値を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteAuditEmitterByRef('–emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTask.deleteAuditEmitterByRef(['-emitterRef', 'AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.deleteAuditEmitterByRef('-interactive')
deleteAuditEmitterByName
deleteAuditEmitterByName コマンドは、システムが固有の名前を指定して参照する監査サービス・プロバイダー実装を削除します。イベント・ファクトリーが監査サービス・プロバイダーを使用している場合、システムが監査サービス・プロバイダーを除去できないというエラーが発生します。
このコマンドを実行するには、ユーザーに監査員の管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -uniqueName
- 削除する監査サービス・プロバイダー・インターフェースの実装を一意的に識別する名前を指定します。 (ストリング、必須)
戻り値
システムが監査サービス・プロバイダー実装を正常に削除した場合、このコマンドは true の値を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteAuditEmitterByName('-uniqueName mybinaryemitter')
- Jython リストを使用:
AdminTask.deleteAuditEmitterByName(['-uniqueName', 'mybinaryemitter'])
対話モードの使用例
- Jython の使用:
AdminTask.deleteAuditEmitterByName('-interactive')
getAuditEmitter
getAuditEmitter コマンドは、対象の監査サービス・プロバイダーの属性を戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- 監査サービス・プロバイダーの実装に対する参照を指定します。 (ストリング、必須)
戻り値
{{auditSpecifications myfilter(cells/CHEYENNENode04Cell|audit.xml#AuditSpecification_1184598886859)}
{name auditServiceProviderImpl_1}
{_Websphere_Config_Data_Id cells/CHEYENNENode04Cell|audit.xml#AuditServiceProvider_1173199825608}
{maxFileSize 1}
{_Websphere_Config_Data_Type AuditServiceProvider}
{fileLocation ${PROFILE_ROOT}/logs/server1}
{className com.ibm.ws.security.audit.BinaryEmitterImpl}
{properties {}}
{eventFormatterClass {}}
{maxLogs 100}}
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getAuditEmitter('-emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTask.getAuditEmitter(['-emitterRef AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.getEmitterClass('-interactive')
getBinaryFileLocation
getBinaryFileLocation コマンドは、バイナリー・ファイルの監査ログのファイル・ロケーションを戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- バイナリー・ファイルの監査サービス・プロバイダー実装への参照を指定します。 (ストリング、必須)
戻り値
$profile_root/logs/server1
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getBinaryFileLocation('-emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTask.getBinaryFileLocation(['-emitterRef', 'AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.getBinaryFileLocation('-interactive')
getAuditEmitterFilters
getAuditEmitterFilters コマンドは、対象の監査サービス・プロバイダー実装の定義済みフィルターのリストを戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- 対象の監査サービス・プロバイダー実装を指定します。サービス・プロバイダー・オブジェクトへの参照を指定することができます。(ストリング、必須)
戻り値
AUTHN:SUCCESS,AUTHN:INFO,AUTHZ:SUCCESS,AUTHZ:INFO
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getAuditEmitterFilters('-emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTask.getAuditEmitterFilters(['-emitterRef', 'AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.getAuditEmitterFilters('-interactive')
getBinaryFileSize
getBinaryFileSize コマンドは、audit.xml 構成ファイルの対象の監査サービス・プロバイダー用に定義された、バイナリー監査ログの最大ファイル・サイズを戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- バイナリー・ファイルの監査サービス・プロバイダー実装への参照を指定します。 (ストリング、必須)
戻り値
このコマンドは、最大ファイル・サイズの整数値をメガバイト単位で戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getBinaryFileSize('-emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTask.getBinaryFileSize(['-emitterRef', 'AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.getBinaryFileSize('-interactive')
getEmitterClass
getEmitterClass コマンドは、監査サービス・プロバイダー・エミッター実装のクラス名を戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- 監査サービス・プロバイダーの実装に対する参照を指定します。 (ストリング、必須)
戻り値
このコマンドは、監査サービス・プロバイダー実装のクラス名を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getEmitterClass('-emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTask.getEmitterClass(['-emitterRef', 'AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.getEmitterClass('-interactive')
getEmitterUniqueId
getEmitterUniqueId コマンドは、監査サービス・プロバイダー実装の固有 ID を戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- サービス・プロバイダーの実装に対する参照を指定します。 (ストリング、必須)
戻り値
このコマンドは、対象の監査サービス・プロバイダーの固有 ID を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getEmitterUniqueId('-emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTask.getEmitterUniqueId(['-emitterRef', 'AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.getEmitterUniqueId('-interactive')
getMaxNumBinaryLogs
getMaxNumBinaryLogs コマンドは、audit.xml 構成ファイルの対象の監査サービス・プロバイダー用に定義された、バイナリー監査ログの最大数を戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- バイナリー・ファイルの監査サービス・プロバイダー実装への参照を指定します。 (ストリング、必須)
戻り値
このコマンドは、構成のバイナリー監査ログの最大数を表す整数値を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTaskgetMaxNumBinaryLogs('-emitterRef AuditServiceProvider_1173199825608')
- Jython リストを使用:
AdminTaskgetMaxNumBinaryLogs(['-emitterRef', 'AuditServiceProvider_1173199825608'])
対話モードの使用例
- Jython の使用:
AdminTask.getMaxNumBinaryLogs('-interactive')
listAuditEmitters
listAuditEmitters コマンドは、構成済み監査サービス・プロバイダー実装オブジェクト、およびそれに対応する属性のリストを戻します。
このコマンドを実行するには、ユーザーにモニターの管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
戻り値
{{auditSpecifications myfilter(cells/CHEYENNENode04Cell|audit.xml#AuditSpecifica
tion_1184598886859)}
{name auditServiceProviderImpl_1}
{_Websphere_Config_Data_Id cells/CHEYENNENode04Cell|audit.xml#AuditServiceProvid
er_1173199825608}
{maxFileSize 1}
{_Websphere_Config_Data_Type AuditServiceProvider}
{fileLocation ${PROFILE_ROOT}/logs/server1}
{className com.ibm.ws.security.audit.BinaryEmitterImpl}
{properties {}}
{auditSpecRef1 AuditSpecification_1184598886859}
{eventFormatterClass {}}
{maxLogs 100}
{emitterRef AuditServiceProvider_1173199825608}}
{{auditSpecifications DefaultAuditSpecification_1(cells/CHEYENNENode04Cell|audit
.xml#AuditSpecification_1173199825608)}
{name mythirdpartyemitter}
{_Websphere_Config_Data_Id cells/CHEYENNENode04Cell|audit.xml#AuditServiceProvid
er_1184686638218}
{maxFileSize 0}
{_Websphere_Config_Data_Type AuditServiceProvider}
{fileLocation {}}
{className com.mycompany.myemitterclass}
{properties {}}
{auditSpecRef1 AuditSpecification_1173199825608}
{eventFormatterClass com.mycompany.myeventformatterclass}
{maxLogs 0}
{emitterRef AuditServiceProvider_1184686638218}}
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.listAuditEmitters()
- Jython リストを使用:
AdminTask.listAuditEmitters()
対話モードの使用例
- Jython の使用:
AdminTask.listAuditEmitters('-interactive')
modifyAuditEmitter
modifyAuditEmitter コマンドは、監査サービス・プロバイダー実装オブジェクトの属性を変更します。
このコマンドを実行するには、ユーザーに監査員の管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- 監査サービス・プロバイダーの実装に対する参照を指定します。 (ストリング、必須)
オプション・パラメーター
- -className
- 実装の識別に使用するクラス名を指定します。(ストリング、オプション)
- -eventFormatterClass
- 出力用にシステムが監査イベントをフォーマットする方法を実装するクラスを指定します。デフォルトの監査サービス・プロバイダーを使用する場合は、このパラメーターは指定しないでください。(ストリング、オプション)
- -customProperties
- 次のフォーマットで、名前と値のペアとしてフォーマットされたカスタム・プロパティーのリストを指定します。name=value,name=value(ストリング、オプション)
com.ibm.audit.field.length.limit カスタム・プロパティーを設定して、可変長監査データを切り捨てる長さを指定できます。詳しくは、「セキュリティーのカスタム・プロパティー」に関する 資料を参照してください。
- -auditFilters
- 事前定義された監査フィルターへの参照または参照のグループを指定します。 複数の参照を指定するには、次のフォーマットを使用します。reference,reference,reference (ストリング、オプション)
- -fileLocation
- システムが監査ログを作成するロケーションを指定します。(ストリング、オプション)
- -maxFileSize
- システムがタイム・スタンプで監査ログを保存するまでの各ログの最大サイズを指定します。サイズをメガバイト単位で指定します。デフォルト値は 10 MB です。 (整数、オプション)
- -maxLogs
- システムが最も古い監査ログに再書き込みするまでに作成されるログ・ファイルの最大数を指定します。ログのデフォルト値は 100 です。(整数、オプション)
- -wrapBehavior
- バイナリー監査ログ・ラッピングのカスタマイズ可能動作を示すストリングを指定します。(ストリング、オプション)。
このパラメーターには、WRAP、NOWRAP、SILENT_FAIL という 3 つの値があります。
WRAP オプションを使用すると、最大ログ数に達した場合、最も古い監査ログが書き換えられますが、通知は監査員に送信されません。
NOWRAP オプションの場合は、最も古い監査ログの書き換えは行われません。この場合は、監査サービスを停止して、通知を SystemOut.log に送信し、アプリケーション・サーバーは静止します。
SILENT_FAIL オプションの場合は、最も古い監査ログの書き換えは行われません。この場合も監査サービスは停止しますが、WebSphere プロセスは継続が許可されます。SystemOut.log に通知はポストされません。
戻り値
システムが、対象の監査サービス・プロバイダーを正常に変更した場合、このコマンドは true の値を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.modifyAuditEmitter('-emitterRef AuditServiceProvider_1184686638218 –wrapBehavior NOWRAP -auditFilters AuditSpecification_1173199825608 -fileLocation c:¥wasinstall¥appserver¥profiles¥AppSrv01¥mylogs -maxFileSize 14 -maxLogs 200')
- Jython リストを使用:
AdminTask.modifyAuditEmitter(['-emitterRef', 'AuditServiceProvider_1184686638218', '–wrapBehavior', 'NOWRAP' '-auditFilters', 'AuditSpecification_1173199825608', '-fileLocation', 'c:¥wasinstall¥appserver¥profiles¥AppSrv01¥mylogs', '-maxFileSize', '14', '-maxLogs', '200'])
対話モードの使用例
- Jython の使用:
AdminTask.modifyAuditEmitter('-interactive')
setAuditEmitterFilters
setAuditEmitterFilters コマンドは、監査サービス・プロバイダー実装のフィルターを設定します。
このコマンドを実行するには、ユーザーに監査員の管理ロールがある必要があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -emitterRef
- 監査サービス・プロバイダーの実装に対する参照を指定します。 (ストリング、必須)
- -filtersRef
- 定義済み監査フィルターへの参照を 1 つ以上指定します。複数のフィルター参照を指定するには、次のフォーマットを使用します。reference,reference,reference (ストリング、必須)
戻り値
システムが監査サービス・プロバイダーのフィルターを正常に設定した場合、このコマンドは true の値を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.setAuditEmitterFilters('-emitterRef AuditServiceProvider_1173199825608 -filtersRef AuditSpecification_1184598886859')
- Jython リストを使用:
AdminTask.setAuditEmitterFilters(['-emitterRef', 'AuditServiceProvider_1173199825608', '-filtersRef', 'AuditSpecification_1184598886859'])
対話モードの使用例
- Jython の使用:
AdminTask.setAuditEmitterFilters('-interactive')