ltm rule command ACCESS logΒΆ

iRule(1)		      BIG-IP TMSH Manual		      iRule(1)



ACCESS::log
       Logs a message using APM logging framework.

SYNOPSIS
       ACCESS::log (COMPONENT_LOGLEVEL)? MSG

DESCRIPTION
       ACCESS::log [component.][loglevel] 

       Logs the specified message using the optionally specified APM component
       name and log level as specified in the log setting for the access
       profile that is assigned to the virtual server.	The message is sent to
       the destination specified in the log setting.  If component is
       specified, it must be one of the supported values (see below) and must
       end with a dot character. If not specified, the accesscontrol component
       is assumed.  If log level is specified, it must be one of the supported
       values (see below).  If not specified, notice level is assumed.	If
       there is no access profile assigned on the virtual server, then
       default-log-setting is used.  Requires APM to be provisioned.

       List of supported values for  and corresponding Log Setting:
	   	       | Log Setting
	   --------------------------------------
	   accesscontrol       | Access Policy
	   accessperrequest    | Per-Request Policy
	   apmacl	       | ACL
	   eca		       | ECA
	   mdm		       | Endpoint Management System
	   oauth	       | OAuth
	   paa		       | PingAccess
	   sso		       | SSO
	   swg		       | Secure Web Gateway
	   vdi		       | VDI

       List of supported values for  and their descriptions:
	   	   | description
	   -----------------------------
	   emerg	   | Emergency
	   alert	   | Alert
	   crit 	   | Critical
	   error	   | Error
	   warn 	   | Warning
	   notice	   | Notice
	   info 	   | Informational
	   debug	   | Debug

       Command Syntax

       ACCESS::log . 

	   * Logs the specified message using specified component and log level.
	     The message is logged, however, according to log setting configuration.
	     If a given log level does not match the log level specified in the log setting,
	     the message is not logged.
	     The command uses the log setting of the access profile if one is assigned
	     to the virtual server that runs the command, otherwise default-log-setting is used.

       ACCESS::log . 

	   * Logs the specified message using specified component and default log level (notice).
	     The message is logged, however, according to log setting configuration.
	     If a given log level does not match the log level specified in the log setting,
	     the message is not logged.
	     The command uses the log setting of the access profile if one is assigned
	     to the virtual server that runs the command, otherwise default-log-setting is used.

       ACCESS::log  

	   * Logs the specified message using default component (accesscontrol) and the specified log level.
	     The message is logged, however, according to log setting configuration.
	     If a given log level does not match the log level specified in the log setting,
	     the message is not logged.
	     The command uses the log setting of the access profile if one is assigned
	     to the virtual server that runs the command, otherwise default-log-setting is used.

       ACCESS::log 

	   * Logs the specified message using default component (accesscontrol) and default log level (notice).
	     The message is logged, however, according to log setting configuration.
	     If a given log level does not match the log level specified in the log setting,
	     the message is not logged.
	     The command uses the log setting of the access profile if one is assigned
	     to the virtual server that runs the command, otherwise default-log-setting is used.

RETURN VALUE
VALID DURING
       ANY_EVENT

EXAMPLES
	when HTTP_REQUEST {
	    ACCESS::log debug "an Access Control debug log"
	    ACCESS::log sso.error "an SSO error log"
	    ACCESS::log eca. "an ECA notice log"
	    ACCESS::log "an Access Control notice log"
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-13.0.0 --First introduced the command.



BIG-IP				  2017-01-31			      iRule(1)