Log

Introduced : BIG-IP_v9.0
The Log module contains the Logging interfaces that enable you to manage logging on the system, including setting up destinations, filtering logs, and managing destinations.

Interfaces

Interface Description
DestinationArcSight The DestinationArcSight interface enables you to format log messages into ArcSight format and specify a destination to which to forward those messages.
DestinationIPFIX The DestinationIPFIX interface enables you to create and modify remote Internet Protocol Flow Information Export (IPFIX) destinations. A IPFIX log requires you set up a pool of remote log servers via the LocalLB::Pool interface and assign it to the Remote IPFIX destination pool.
DestinationLocalSyslog The DestinationLocalSyslog interface enables you to modify the local syslog destination. This forwarding destination will format messages to be logged on the system. There will be only one local syslog destination, and it cannot be created or deleted. The local syslog destination is named “local-syslog”. Supply this key to the methods in the interface.
DestinationManagementPort The DestinationManagementPort interface enables you to create and modify management port destinations. These are destinations that send logs through the management interface of the BIG-IP. Logs will be ratelimited when sent out the management interface in order to prevent denial of service. A management port log is an unformatted log message which gets sent to a particular IP address and port. If a particular format is needed, use the Remote Syslog, ArcSight, or Splunk destinations and set a management port log destination as its forwarding destination.
DestinationRemoteHighSpeedLog The DestinationRemoteHighSpeedLog interface enables you to create and modify a remote high-speed log (HSL) destination. A high-speed log destination requires you set up a pool of remote log servers via the LocalLB::Pool interface and assign it to the Remote HSL destination pool. A remote high-speed log is an unformatted log message which gets sent to a pool of remote log servers. If a particular format is needed use the Remote Syslog, ArcSight, or Splunk destinations and set a remote high-speed log destination as its forwarding destination.
DestinationRemoteSyslog The DestinationRemoteSyslog interface enables you to create and modify remote syslog destinations which are forwarding destinations. This destination will take unformatted logs and convert them to various syslog formats to other forwarding destinations except other remote syslog destinations.
DestinationSplunk The Splunk destination interface enables you to format messages in the Splunk format then pass them to a destination that will deliver the message.
Filter The filter interface enables you to create and modify filters which are used to select messages for processing by a log publisher.
IPFIXInformationElement The IPFIX Information Element (IE) interface enables you to get, create, modify and delete IEs that are used to define standard IEs or user defined IEs; to be able to filter via iRules the IEs that the customer is interested in when enabling IPFIX destination as a log destination. An Information Element is a protocol and encoding-independent description of an attribute that may appear in an IPFIX Record. The IPFIX information model [RFC5102] defines the base set of Information Elements for IPFIX. The type associated with an Information Element indicates constraints on what it may contain and also determines the valid encoding mechanisms for use in IPFIX.
Publisher The Publisher interface enables you to create and modify publishers. Publishers are simply named collections of logging destinations.

Structures

Structure Description

Enumerations

Enumeration Description
LogProtocol The log protocol indicates the IP protocol that will be used to send logs off of the BIG-IP.
SyslogFacility The facility is used to sort logs sent to the same source.The meaning of each of the facilities is determined by the end user.
SyslogFormat The Syslog Format determines the format of syslog messages sent to remote syslog destinations.
SyslogLevel The syslog severity is the priority given to a syslog message.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
LogProtocolSequence LogProtocol [] A sequence of log protocols.
SyslogFacilitySequence SyslogFacility [] A sequence of Syslog Facilities.
SyslogFormatSequence SyslogFormat [] A sequence of Syslog Formats.
SyslogLevelSequence SyslogLevel [] A sequence of Syslog Levels.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.