WAS v8.5 > Reference > Commands (wsadmin scripting)

AuditPolicyCommands command group for AdminTask

We can use the Jython scripting language to manage the security auditing system with wsadmin. Use the commands and parameters in the AuditPolicyCommands group to enable and configure the security auditing system.

Use the following commands to configure, query, and manage the security auditing system:

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

disableAudit

The disableAudit command disables security auditing in the audit.xml configuration file.

The user must have the auditor administrative role to run this command.

Target object

None.

Return value

The command returns a value of true if the system successfully disables security auditing.

• Jython string:
  AdminTask.disableAudit()
• Jython list:
  AdminTask.disableAudit()

Interactive mode example usage

• Using Jython:
  AdminTask.disableAudit('-interactive')

disableVerboseAudit

The disableVerboseAudit command disables the verbose capture of audit data for the security auditing system.

The user must have the auditor administrative role to run this command.

Target object

None.

Return value

The command returns a value of true if the system successfully disables the verbose capture of audit data.

Batch mode example usage

• Jython string:
  AdminTask.disableVerboseAudit()
• Jython list:
  AdminTask.disableVerboseAudit()

Interactive mode example usage

• Jython string:
  AdminTask.disableVerboseAudit('-interactive')

enableAudit

The enableAudit command enables security auditing in the audit.xml configuration file. By default, security auditing is disabled.

The user must have the auditor administrative role to run this command.

Target object

None.

Return value

The command returns a value of true if the system successfully enables security auditing.

• Jython string:
  AdminTask.enableAudit()
• Jython list:
  AdminTask.enableAudit()

Interactive mode example usage

• Using Jython:
  AdminTask.enableAudit('-interacive')

enableVerboseAudit

The enableVerboseAudit command sets the security auditing system to perform verbose capture of audit data.

The user must have the auditor administrative role to run this command.

Target object

None.

Return value

The command returns a value of true if the system successfully sets the security auditing system to perform verbose capture of audit data.

• Jython string:
  AdminTask.enableVerboseAudit()
• Jython list:
  AdminTask.enableVerboseAudit()

Interactive mode example usage

• Using Jython:
  AdminTask.enableVerboseAudit('-interactive')

getAuditPolicy

The getAuditPolicy command retrieves each attribute associated with the audit policy in the audit.xml configuration file.

The user must have the monitor administrative role to run this command.

Target object

None.

Return value

The command returns a list of attributes for the security auditing system, as the following sample output displays:

{{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 string:
  AdminTask.getAuditPolicy()
• Jython list:
  AdminTask.getAuditPolicy()

Interactive mode example usage

• Using Jython:
  AdminTask.getAuditPolicy('-interactive')

getAuditSystemFailureAction

The getAuditSystemFailureAction command displays the action the application server takes if a failure occurs in the security auditing subsystem.

The user must have the monitor administrative role to run this command.

Target object

None.

Return value

The command returns a string that describes the action the application server takes if the security auditing subsystem fails. Possible values are WARN, NOWARN, or FATAL.

Application server actions if the security auditing subsystem fails. The following table describes the behavior associated with each action the application server takes if the security auditing subsystem fails:

Action	Description
WARN	The application server should notify the auditor, stop security auditing, and continue to run the application server process.
NOWARN	The application server should not notify the auditor, but should stop security auditing and continue to run the application server process
FATAL	The application server should notify the auditor, stop security auditing, and stop the application server process.

• Jython string:
  AdminTask.getAuditSystemFailureAction()
• Jython list:
  AdminTask.getAuditSystemFailureAction()

Interactive mode example usage

• Using Jython:
  AdminTask.getAuditSystemFailureAction('-interactive')

getAuditorId

The getAuditorId command retrieves the name of the user who is assigned as the auditor.

The user must have the monitor administrative role to run this command.

Target object

None.

Return value

The command returns the name of the user who is assigned as the auditor.

• Jython string:
  AdminTask.getAuditorId()
• Jython list:
  AdminTask.getAuditorId()

Interactive mode example usage

• Using Jython:
  AdminTask.getAuditorId('-interactive')

isAuditEnabled

The isAuditEnabled command determines whether the security auditing is enabled in your configuration. By default, auditing is not enabled in the audit.xml configuration file.

The user must have the monitor administrative role to run this command.

Target object

None.

Return value

The command returns a value of true if security auditing is enabled in the environment. If the command returns a value of false, security auditing is disabled.

• Jython string:
  AdminTask.isAuditEnabled()
• Jython list:
  AdminTask.isAuditEnabled()

Interactive mode example usage

• Using Jython:
  AdminTask.isAuditEnabled('-interactive')

isVerboseAuditEnabled

The isVerboseAuditEnabled command determines whether or not the security auditing system verbosely captures audit data.

The user must have the monitor administrative role to run this command.

Target object

None.

Return value

The command returns a value of true if the security auditing system is configured to verbosely capture audit data.

Batch mode example usage

• Jython string:
  AdminTask.isVerboseAuditEnabled()
• Jython list:
  AdminTask.isVerboseAuditEnabled()

Interactive mode example usage

• Using Jython:
  AdminTask.isVerboseAuditEnabled('-interactive')

mapAuditGroupIDsOfAuthorizationGroup

The mapAuditGroupIDsOfAuthorizationGroup command maps the special subjects to users in the registry.

The user must have the monitor administrative role to run this command.

Target object

None.

Return value

The command does not return output.

• Jython string:
  AdminTask.mapAuditGroupIDsOfAuthorizationGroup()
• Jython list:
  AdminTask.mapAuditGroupIDsOfAuthorizationGroup()

Interactive mode example usage

• Using Jython:
  AdminTask.mapAuditGroupIDsOfAuthorizationGroup('-interactive')

modifyAuditPolicy

The modifyAuditPolicy command modifies the audit policy attributes in the audit.xml configuration file. We can use this command to modify one or multiple attributes.

The user must have the auditor administrative role to run this command.

Target object

None.

Optional parameters

-auditEnabled

Whether security auditing is enabled in your configuration. (Boolean, optional)

-auditPolicy

Action the application server takes if the security auditing subsystem fails. (String, optional)

auditPolicy parameter values. The following table describes the valid values for the auditPolicy parameter:

Value	Description
WARN	The application server should notify the auditor, stop security auditing, and continue to run the application server process.
NOWARN	The application server should not notify the auditor, but should stop security auditing and continue to run the application server process
FATAL	The application server should notify the auditor, stop security auditing, and stop the application server process.

-auditorId

Name of the user the system assigns as the auditor. (String, optional)

-auditorPwd

Password for the auditor id. (String, optional)

-sign

Whether to sign audit records. Use the AuditSigningCommands command group to configure signing settings. (Boolean, optional)

-encrypt

Whether to encrypt audit records. Use the AuditEncryptionCommands command group to configure encryption settings. (Boolean, optional)

-verbose

Whether to capture verbose audit data. (Boolean, optional)

-encryptionCert

Specifies the reference ID of the certificate to use for encryption. Specify this parameter if you set the -encrypt parameter to true. (String, optional)

Return value

The command returns a value of true if the system successfully updates the security auditing system policy.

• Jython string:

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

• Jython list:

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

Interactive mode example usage

• Using Jython:
  AdminTask.modifyAuditPolicy('-interactive')

setAuditSystemFailureAction

The setAuditSystemFailureAction command sets the action the application server takes if the security auditing subsystem fails.

The user must have the auditor administrative role to run this command.

Target object

None.

Required parameters

-action

Action to take if the security auditing subsystem fails. (String, required)

Action parameters. The following table describes the valid values for the action parameter:

Value	Description
WARN	The application server should notify the auditor, stop security auditing, and continue to run the application server process.
NOWARN	The application server should not notify the auditor, but should stop security auditing and continue to run the application server process
FATAL	The application server should notify the auditor, stop security auditing, and stop the application server process.

Return value

The command returns a value of true if the system successfully updates the security auditing system policy.

• Jython string:
  AdminTask.setAuditSystemFailureAction('-action NOWARN')
• Jython list:
  AdminTask.setAuditSystemFailureAction(['-action', 'NOWARN'])

Interactive mode example usage

• Using Jython:
  AdminTask.setAuditSystemFailureAction('-interactive')

resetAuditSystemFailureAction

The resetAuditSystemFailureAction command sets the action the application server takes if the security auditing system fails to the NOWARN setting.

The user must have the auditor administrative role to run this command.

Target object

None.

Return value

The command returns a value of true if the system successfully updates your configuration.

• Jython string:
  AdminTask.resetAuditSystemFailureAction()
• Jython list:
  AdminTask.resetAuditSystemFailureAction()

Interactive mode example usage

• Using Jython:
  AdminTask.resetAuditSystemFailureAction('-interactive')

setAuditorId

The setAuditorId command sets the name of the user to assign as the auditor.

The user must have the auditor administrative role to run this command.

Target object

None.

Required parameters

-name

Name of the user to assign as the auditor. (String, required)

Return value

The command returns a value of true if the system successfully updates your configuration.

• Jython string:
  AdminTAsk.setAuditorId('-name myAdmin')
• Jython list:
  AdminTAsk.setAuditorId(['-name', 'myAdmin'])

Interactive mode example usage

• Jython string:
  AdminTAsk.setAuditorId('-interactive')

setAuditorPwd

The setAuditorPwd command sets the password for the auditor.

The user must have the auditor administrative role to run this command.

Target object

None.

Required parameters

-password

Password for the user assigned as the auditor. (String, required)

Return value

The command returns a value of true if the system successfully updates your configuration.

• Jython string:
  AdminTask.setAuditorPwd('-password myAdminPassword')
• Jython list:
  AdminTask.setAuditorPwd(['-password', 'myAdminPassword'])

Interactive mode example usage

• Using Jython:
  AdminTask.setAuditorPwd('-interactive')

Reference:

AuditKeyStoreCommands command group for AdminTask
AuditEmitterCommands for AdminTask
AuditSigningCommands command group for AdminTask
AuditEncryptionCommands command group for AdminTask
AuditEventFactoryCommands for AdminTask
AuditFilterCommands command group for AdminTask
AuditNotificationCommands command group for AdminTask
AuditEventFormatterCommands command group for AdminTask

+

Search Tips   |   Advanced Search