AdminTask 对象的 AuditEmitterCommands

可以使用 Jython 脚本语言，通过 wsadmin 工具来配置审计服务提供程序。 使用 AuditEmitterCommands 组中的命令和参数，在安全性审计系统配置中创建、管理以及移除审计服务提供程序。

使用以下命令来配置审计服务提供程序：
注: 本主题引用一个或多个应用程序服务器日志文件。 作为建议的替代方法，您可以将服务器配置为使用高性能可扩展日志记录 (HPEL) 日志和跟踪基础结构，而不是在分布式系统和 IBM® i 系统上使用 SystemOut.log ， SystemErr.log， trace.log和 activity.log 文件。 您还可以将 HPEL 与本机 z/OS® 日志记录工具结合使用。 如果您正在使用 HPEL，那么可以从服务器概要文件 bin 目录使用 LogViewer 命令行工具来访问所有日志和跟踪信息。 有关使用 HPEL 的更多信息，请参阅 有关使用 HPEL 对应用程序进行故障诊断的信息。

createBinaryEmitter

createBinaryEmitter 命令在audit.xml文件，用于引用审计服务提供程序接口的二进制文件发射器实现的配置。

用户必须具有审计员管理角色才能运行此命令。

目标对象

无。

必需参数

-uniqueName
指定一个名称以唯一地标识审计服务提供程序接口的此实现。 （字符串，必需）
-className
指定对审计服务提供程序接口进行实现的类。 （字符串，必需）
-fileLocation
指定系统在其中写入审计日志的位置。 （字符串，必需）
-auditFilters
指定对预定义审计过滤器的一个引用或一组引用。 使用以下格式来指定多个引用:reference,reference,reference（字符串，必需）
-wrapBehavior
指定表示二进制文件审计日志合并的可定制行为的字符串。 (字符串，必需)。

此参数的三个值为：WRAP、NOWRAP 和 SILENT_FAIL

如果使用 WRAP 选项，那么当达到最大日志数时，将重写最旧的审计日志；不会对审计员发送通知。

NOWRAP 选项不重写最旧的审计日志。 它停止审计服务、将一个通知发送到 SystemOut.log 并停顿应用程序服务器。

SILENT_FAIL 选项不重写最旧的审计日志。 它还会停止审计服务，但允许 WebSphere 进程继续运行。 不会将通知记入 SystemOut.log 中。

注: 如果使用 NOWRAP 或 SILENT_FAIL 选项，那么当服务器由于日志被打出而停止时，将执行 stopserver ，或者由于服务器以某种方式异常终止，您必须先归档二进制审计日志，然后再重新启动服务器。

可选参数

-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 命令会删除系统通过此引用标识进行引用的审计服务提供程序实现。 如果事件工厂正在使用审计服务提供程序，那么系统会生成错误，以指示系统无法移除审计服务提供程序。

用户必须具有审计员管理角色才能运行此命令。

目标对象

无。

必需参数

-emitterRef
指定要删除的审计服务提供程序实现的引用标识。 （字符串，必需）

返回值

该命令返回以下值: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
指定对审计服务提供程序实现的引用。 （字符串，必需）

返回值

此命令会返回以 -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.xmlconfiguration file.

用户必须具有监视员管理角色才能运行此命令。

目标对象

无。

必需参数

-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 命令会返回审计服务提供程序实现的唯一标识。

用户必须具有监视员管理角色才能运行此命令。

目标对象

无。

必需参数

-emitterRef
指定对服务提供程序实现的引用。 （字符串，必需）

返回值

此命令会返回相关审计服务提供程序的唯一标识。

批处理方式示例用法

  • 使用 Jython 字符串：
    AdminTask.getEmitterUniqueId('-emitterRef AuditServiceProvider_1173199825608')
  • 使用 Jython 列表：
    AdminTask.getEmitterUniqueId(['-emitterRef', 'AuditServiceProvider_1173199825608'])

交互方式示例用法

  • 使用 Jython：
    AdminTask.getEmitterUniqueId('-interactive')

getMaxNumBinaryLogs

getMaxNumBinaryLogs 命令返回为所关注的审计服务提供者定义的二进制审计日志的最大数目。audit.xmlconfiguration file.

用户必须具有监视员管理角色才能运行此命令。

目标对象

无。

必需参数

-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. （字符串，可选）
-auditFilters
指定对预定义审计过滤器的一个引用或一组引用。 使用以下格式来指定多个引用:reference,reference,reference（字符串，可选）
-fileLocation
指定系统在其中写入审计日志的位置。 （字符串，可选）
-maxFileSize
指定系统在使用时间戳记来保存审计日志之前，每个日志所达到的最大大小。 请以兆字节为单位指定大小。 缺省值为 10 MB。 （整数，可选）
-maxLogs
指定要在系统重写最旧审计日志之前，创建的最大日志文件数。 缺省值为 100 个日志。 （整数，可选）
-wrapBehavior
指定表示二进制文件审计日志合并的可定制行为的字符串。 （字符串，可选）。

此参数的三个值为：WRAP、NOWRAP 和 SILENT_FAIL

如果使用 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
指定对已定义审计过滤器的一个或多个引用。 使用以下格式指定多个过滤器引用: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')