AdminTask 对象的 AuditPolicyCommands 命令组

可以使用 Jython 脚本语言，通过 wsadmin 工具来管理安全性审计系统。使用 AuditPolicyCommands 组中的命令和参数来启用和配置安全性审计系统。

使用以下命令来配置、查询以及管理安全性审计系统：

disableAudit
disableVerboseAudit
enableAudit
enableVerboseAudit
getAuditPolicy
getAuditSystemFailureAction
getAuditorId
isAuditEnabled
isVerboseAuditEnabled
mapAuditGroupIDsOfAuthorizationGroup
modifyAuditPolicy
setAuditSystemFailureAction
resetAuditSystemFailureAction
setAuditorId
setAuditorPwd

disableAudit

disableAudit 命令在audit.xmlconfiguration file.

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

目标对象

无。

返回值

该命令返回以下值:true如果系统成功禁用安全性审计。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.disableAudit()
```
使用 Jython 列表：
```
AdminTask.disableAudit()
```

交互方式示例用法

使用 Jython：
```
AdminTask.disableAudit('-interactive')
```

disableVerboseAudit

disableVerboseAudit 命令会禁止对安全性审计系统进行审计数据的详细捕获。

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

目标对象

无。

返回值

该命令返回以下值:true如果系统成功禁用审计数据的详细捕获。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.disableVerboseAudit()
```
使用 Jython 列表：
```
AdminTask.disableVerboseAudit()
```

交互方式示例用法

使用 Jython 字符串：

AdminTask.disableVerboseAudit('-interactive')

enableAudit

enableAudit 命令在audit.xmlconfiguration file. 缺省情况下，安全性审计处于已禁用状态。

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

目标对象

无。

返回值

该命令返回以下值:true如果系统成功启用安全性审计。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.enableAudit()
```
使用 Jython 列表：
```
AdminTask.enableAudit()
```

交互方式示例用法

使用 Jython：
```
AdminTask.enableAudit('-interacive')
```

enableVerboseAudit

enableVerboseAudit 命令会将安全性审计系统设为执行审计数据的详细捕获。

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

目标对象

无。

返回值

该命令返回以下值:true如果系统成功设置安全审计系统以执行审计数据的详细捕获。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.enableVerboseAudit()
```
使用 Jython 列表：
```
AdminTask.enableVerboseAudit()
```

交互方式示例用法

使用 Jython：

AdminTask.enableVerboseAudit('-interactive')

getAuditPolicy

getAudit策略命令将检索与审计策略相关联的每个属性。audit.xmlconfiguration file.

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

目标对象

无。

返回值

此命令会返回安全性审计系统的属性列表，如以下样本输出所示：

{{auditEventFactories {{{name auditEventFactoryImpl_1}
{properties {}}
{className com.ibm.ws.security.audit.AuditEventFactoryImpl}
{auditServiceProvider auditServiceProviderImpl_1(cells/Node04Cell|audit.xml#AuditServiceProvider_1173199825608)}
{auditSpecifications DefaultAuditSpecification_1(cells/Node04Cell|audit.xml#AuditSpecification_1173199825608)
DefaultAuditSpecification_2(cells/Node04Cell|audit.xml#AuditSpecification_1173199825609)
DefaultAuditSpecification_3(cells/Node04Cell|audit.xml#AuditSpecification_1173199825610)
DefaultAuditSpecification_4(cells/Node04Cell|audit.xml#AuditSpecification_1173199825611)}
{_Websphere_Config_Data_Id cells/Node04Cell|audit.xml#AuditEventFactory_1173199825608}
{_Websphere_Config_Data_Type AuditEventFactory}}}}
{_Websphere_Config_Data_Id cells/Node04Cell|audit.xml#AuditPolicy_1173199825608}
{auditServiceProviders {{{auditSpecifications 
DefaultAuditSpecification_1(cells/Node04Cell|audit.xml#AuditSpecification_1173199825608)
DefaultAuditSpecification_2(cells/Node04Cell|audit.xml#AuditSpecification_1173199825609)
DefaultAuditSpecification_3(cells/Node04Cell|audit.xml#AuditSpecification_1173199825610)
DefaultAuditSpecification_4(cells/Node04Cell|audit.xml#AuditSpecification_1173199825611)}
{name auditServiceProviderImpl_1}
{_Websphere_Config_Data_Id cells/Node04Cell|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}}}}
{securityXmlSignerCertAlias auditSignCert}
{properties {}}
{securityXmlSignerScopeName (cell):Node04Cell:(node):Node04}
{auditorPwd SweetShadowsPwd}
{_Websphere_Config_Data_Type AuditPolicy}
{securityXmlSignerKeyStoreName NodeDefaultSignersStore}
{verbose false}
{auditPolicy WARN}
{encrypt false}
{managementScope {}}
{encryptionCert {}}
{batching false}
{auditorId SweetShadow}
{auditEnabled false}
{sign true}}

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.getAuditPolicy()
```
使用 Jython 列表：
```
AdminTask.getAuditPolicy()
```

交互方式示例用法

使用 Jython：

AdminTask.getAuditPolicy('-interactive')

getAuditSystemFailureAction

getAuditSystemFailureAction 命令会显示安全性审计子系统失败时应用程序服务器所执行的操作。

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

目标对象

无。

返回值

此命令会返回一个字符串，描述安全性审计子系统失败时应用程序服务器所执行的操作。可能的值包括：WARN,NOWARN，或FATAL.

表 1. 安全性审计子系统失败时的应用程序服务器操作。下表描述与安全性审计子系统失败时应用程序服务器所执行的每项操作相关联的行为：
操作	描述
警告	指定应用程序服务器应该通知审计员，停止安全性审计以及继续运行应用程序服务器进程。
NOWARN	指定应用程序服务器不应该通知审计员，但应该停止安全性审计以及继续运行应用程序服务器进程。
致命	指定应用程序服务器应该通知审计员，停止安全性审计以及停止应用程序服务器进程。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.getAuditSystemFailureAction()
```
使用 Jython 列表：
```
AdminTask.getAuditSystemFailureAction()
```

交互方式示例用法

使用 Jython：

AdminTask.getAuditSystemFailureAction('-interactive')

getAuditorId

getAuditorId 命令会检索要指定为审计员的用户的名称。

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

目标对象

无。

返回值

此命令会返回要指定为审计员的用户的名称。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.getAuditorId()
```
使用 Jython 列表：
```
AdminTask.getAuditorId()
```

交互方式示例用法

使用 Jython：
```
AdminTask.getAuditorId('-interactive')
```

isAuditEnabled

isAuditEnabled 命令会确定是否已在配置中启用安全性审计。缺省情况下，未在audit.xmlconfiguration file.

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

目标对象

无。

返回值

该命令返回以下值:true(如果在您的环境中启用了安全性审计)。如果此命令返回以下值:false，安全性审计已禁用。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.isAuditEnabled()
```
使用 Jython 列表：
```
AdminTask.isAuditEnabled()
```

交互方式示例用法

使用 Jython：

AdminTask.isAuditEnabled('-interactive')

isVerboseAuditEnabled

isVerboseAuditEnabled 命令会确定安全性审计系统是否会详细地捕获审计数据。

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

目标对象

无。

返回值

该命令返回以下值:true如果将安全审计系统配置为以实时方式捕获审计数据。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTask.isVerboseAuditEnabled()
```
使用 Jython 列表：
```
AdminTask.isVerboseAuditEnabled()
```

交互方式示例用法

使用 Jython：

AdminTask.isVerboseAuditEnabled('-interactive')

mapAuditGroupIDsOfAuthorizationGroup

mapAuditGroupIDsOfAuthorizationGroup 命令会将特殊主体集映射到注册表中的用户。

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

目标对象

无。

返回值

此命令不会返回输出。

批处理方式示例用法

使用 Jython 字符串：

AdminTask.mapAuditGroupIDsOfAuthorizationGroup()

使用 Jython 列表：

AdminTask.mapAuditGroupIDsOfAuthorizationGroup()

交互方式示例用法

使用 Jython：

AdminTask.mapAuditGroupIDsOfAuthorizationGroup('-interactive')

modifyAuditPolicy

modifyAuditPolicy 命令用于修改audit.xmlconfiguration file. 可以使用此命令来修改一个或多个属性。

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

目标对象

无。

可选参数

-auditEnabled

指定是否已在配置中启用安全性审计。（布尔值，可选）

-auditPolicy

指定安全性审计子系统失败时应用程序服务器所执行的操作。（字符串，可选）

表 2。 auditPolicy 参数值。下表描述了 auditPolicy 参数的有效值：
值	描述
警告	指定应用程序服务器应该通知审计员，停止安全性审计以及继续运行应用程序服务器进程。
NOWARN	指定应用程序服务器不应该通知审计员，但应该停止安全性审计以及继续运行应用程序服务器进程。
致命	指定应用程序服务器应该通知审计员，停止安全性审计以及停止应用程序服务器进程。

-auditorId

指定系统要指定为审计员的用户的名称。（字符串，可选）

-auditorPwd

为审计员标识指定密码。（字符串，可选）

-sign

指定是否要签署审计记录。使用 AuditSigningCommands 命令组来配置签名设置。（布尔值，可选）

-encrypt

指定是否要对审计记录进行加密。使用 AuditEncryptionCommands 命令组来配置加密设置。（布尔值，可选）

-verbose

指定是否要捕获详细的审计数据。（布尔值，可选）

-encryptionCert

指定要用于加密的证书的引用标识。如果将 -encrypt 参数设置为true. （字符串，可选）

返回值

该命令返回以下值:true如果系统成功更新安全性审计系统策略。

批处理方式示例用法

使用 Jython 字符串：

AdminTask.modifyAuditPolicy('-auditEnabled true -auditPolicy NOWARN -auditorId 
testuser -auditorPwd testuserpwd -sign false -encrypt false -verbose false')

使用 Jython 列表：

AdminTask.modifyAuditPolicy(['-auditEnabled', 'true', '-auditPolicy', 'NOWARN', 
'-auditorId', 'testuser', '-auditorPwd', 'testuserpwd', '-sign', 'false', '-encrypt', 
'false', '-verbose', 'false'])

交互方式示例用法

使用 Jython：

AdminTask.modifyAuditPolicy('-interactive')

setAuditSystemFailureAction

setAuditSystemFailureAction 命令会设置安全性审计子系统失败时应用程序服务器所执行的操作。

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

目标对象

无。

必需参数

-action

指定安全性审计子系统失败时所执行的操作。（字符串，必需）

表 3. 操作参数。下表描述了 action 参数的有效值：
值	描述
警告	指定应用程序服务器应该通知审计员，停止安全性审计以及继续运行应用程序服务器进程。
NOWARN	指定应用程序服务器不应该通知审计员，但应该停止安全性审计以及继续运行应用程序服务器进程。
致命	指定应用程序服务器应该通知审计员，停止安全性审计以及停止应用程序服务器进程。

返回值

该命令返回以下值:true如果系统成功更新安全性审计系统策略。

批处理方式示例用法

使用 Jython 字符串：

AdminTask.setAuditSystemFailureAction('-action NOWARN')

使用 Jython 列表：

AdminTask.setAuditSystemFailureAction(['-action', 'NOWARN'])

交互方式示例用法

使用 Jython：

AdminTask.setAuditSystemFailureAction('-interactive')

resetAuditSystemFailureAction

resetAuditSystemFailure操作命令设置在安全性审计系统失败时应用程序服务器执行的操作。NOWARN设置。

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

目标对象

无。

返回值

该命令返回以下值:true如果系统成功更新配置。

批处理方式示例用法

使用 Jython 字符串：

AdminTask.resetAuditSystemFailureAction()

使用 Jython 列表：

AdminTask.resetAuditSystemFailureAction()

交互方式示例用法

使用 Jython：

AdminTask.resetAuditSystemFailureAction('-interactive')

setAuditorId

setAuditorId 命令会设置要指定为审计员的用户的名称。

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

目标对象

无。

必需参数

-name: 指定要分配为审计员的用户的名称。（字符串，必需）

返回值

该命令返回以下值:true如果系统成功更新配置。

批处理方式示例用法

使用 Jython 字符串：
```
AdminTAsk.setAuditorId('-name myAdmin')
```

使用 Jython 列表：

AdminTAsk.setAuditorId(['-name', 'myAdmin'])

交互方式示例用法

使用 Jython 字符串：
```
AdminTAsk.setAuditorId('-interactive')
```

setAuditorPwd

setAuditorPwd 命令会为审计员设置密码。

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

目标对象

无。

必需参数

-password: 指定已指定为审计员的用户的密码。（字符串，必需）

返回值

该命令返回以下值:true如果系统成功更新配置。

批处理方式示例用法

使用 Jython 字符串：

AdminTask.setAuditorPwd('-password myAdminPassword')

使用 Jython 列表：

AdminTask.setAuditorPwd(['-password', 'myAdminPassword'])

交互方式示例用法

使用 Jython：
```
AdminTask.setAuditorPwd('-interactive')
```