create-audit-module
Adds an audit module.
Synopsis
asadmin [asadmin-options] create-audit-module [--help]
--classname classname
[--property(name=value)[:name=value]*]
[--target target]
audit_module_name
Description
The create-audit-module
subcommand adds the named audit module for the Java class that implements the audit capabilities. Audit modules collect and store information on incoming requests (from, for example, servlets and EJB components) and outgoing responses.
This subcommand is supported in remote mode only.
Options
- asadmin-options
-
Options for the
asadmin
utility. For information about these options, see theasadmin
help page. --classname
-
The name of the Java class that implements this audit module. If not specified, this option defaults to
com.sun.enterprise.security.Audit
. --help
-?
-
Displays the help text for the subcommand.
--property
-
Optional keyword-value pairs that specify additional properties for the audit module.
Audit module properties that are defined by Payara Server are as follows:auditOn
-
If
true
, specifies that the audit module is loaded and called by the Payara Server audit library at audit points.
Other available properties are determined by the implementation of the audit module.
--target
-
Specifies the target on which you are creating the audit module. Valid values are as follows:
server
-
Creates the audit module for the default server instance
server
and is the default value. - configuration_name
-
Creates the audit module for the named configuration.
- cluster_name
-
Creates the audit module for every server instance in the cluster.
- instance_name
-
Creates the audit module for a particular server instance.
Examples
Example 1 Creating an audit module
asadmin> create-audit-module
--classname com.sun.appserv.auditmodule
--property defaultuser=admin:Password=admin sampleAuditModule
Command create-audit-module executed successfully