LocalLB::ProfileFIX

Introduced : BIG-IP_v11.5.0
The ProfileFIX interface enables you to manipulate a local load balancer&aposs FIX (Financial Information eXchange Protocol) profile.

Methods

Method Description Introduced
create Creates the specified FIX profiles. BIG-IP_v11.5.0
delete_all_profiles Deletes all FIX profiles. BIG-IP_v11.5.0
delete_profile Deletes the specified FIX profiles. BIG-IP_v11.5.0
get_all_statistics Gets the statistics for all FIX profiles. BIG-IP_v11.5.0
get_default_profile Gets the names of the default profiles from which the specified profiles will derive default values for attributes. BIG-IP_v11.5.0
get_description Gets the descriptions for the specified FIX profiles. BIG-IP_v11.5.0
get_error_action Gets the error handling methods for the specified FIX profiles. BIG-IP_v11.5.0
get_full_logon_parsing_state Gets the full logon parsing states for the specified FIX profiles. BIG-IP_v11.5.0
get_list Gets a list of all FIX profiles. BIG-IP_v11.5.0
get_message_log_publisher Gets the publishers for message logging for the specified FIX profiles. BIG-IP_v11.5.0
get_quick_parsing_state Gets the quick parsing states for the specified FIX profiles. BIG-IP_v11.5.0
get_rate_sample_interval Gets the sample intervals of the message rate for the specified FIX profiles. BIG-IP_v11.5.0
get_report_log_publisher Gets the log publishers for error messages and status reports for the specified FIX profiles. BIG-IP_v11.5.0
get_response_parsing_state Gets the response parsing states for the specified FIX profiles. BIG-IP_v11.5.0
get_sender_tag_class Gets the sender tag class information for the specified FIX profiles. See SenderTagClass for an explanation of this mapping feature. BIG-IP_v11.5.0
get_statistics Gets the statistics for the specified FIX profiles. BIG-IP_v11.5.0
get_statistics_by_virtual Gets the statistics for the specified FIX profiles, by virtual server. BIG-IP_v11.5.0
get_version Gets the version information for this interface. BIG-IP_v11.5.0
is_base_profile Determines whether the specified FIX profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). BIG-IP_v11.5.0
is_system_profile Determines whether the specified FIX profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). BIG-IP_v11.5.0
replace_sender_tag_class Replaces the sender tag class information for the specified FIX profiles. BIG-IP_v11.5.0
reset_statistics Resets the statistics for the specified FIX profiles. BIG-IP_v11.5.0
reset_statistics_by_virtual Resets the statistics for the specified FIX profiles, for specified virtual servers. BIG-IP_v11.5.0
set_default_profile Sets the names of the default profiles from which the specified profiles will derive default values for attributes. BIG-IP_v11.5.0
set_description Sets the descriptions for the specified FIX profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.5.0
set_error_action Specifies the error handling methods for the specified FIX profiles. BIG-IP_v11.5.0
set_full_logon_parsing_state Sets the full logon parsing states for the specified FIX profiles. When enabled, the FIX parser performs full parsing on logon messages. Quick parsing checks FIX syntax as defined in the “Common FIX Syntax Rules” section of the FIX standard. Quick parsing also checks message length (tag 9) and checksum (tag 10). In addition to quick parsing checks, full parsing checks every message field. Other messages are parsed according to the configuration of quick parsing state. BIG-IP_v11.5.0
set_message_log_publisher Sets the publishers for message logging for the specified FIX profiles. The FIX parser logs the received messages to the publisher. BIG-IP_v11.5.0
set_quick_parsing_state Sets the quick parsing states for the specified FIX profiles. When enabled, the FIX parser performs quick parsing on non-logon messages. Quick parsing checks FIX syntax as defined in the “Common FIX Syntax Rules” section of the FIX standard. Quick parsing also checks message length (tag 9) and checksum (tag 10). In addition to quick parsing checks, full parsing checks every message field. BIG-IP_v11.5.0
set_rate_sample_interval Specifies the sample intervals of the message rate for the specified FIX profiles. This gives the interval to use to reset the message count for a sample period. For example, if you set the interval to 60 seconds, then the FIX parser counts how many messages it successfully parsed during the last 60 seconds when you poll the statistics. BIG-IP_v11.5.0
set_report_log_publisher Sets the log publishers for error messages and status reports for the specified FIX profiles. The FIX parser logs error messages to the publisher. BIG-IP_v11.5.0
set_response_parsing_state Sets the response parsing states for the specified FIX profiles. Enables or disables response parsing, which parses the messages from the FIX server and applies the same parser configuration and error handling at server side as at client side. If not enabled, server side messages are directly passed through. BIG-IP_v11.5.0

Structures

Structure

Description

FIXProfileStatisticEntry

A struct that describes statistics for a particular profile.

FIXProfileStatistics

A struct that describes FIX profile statistics and timestamp.

ProfileErrorAction

A structure that specifies FIX profile error actions used in profile attributes.

ProfileSenderTagClassArray

A structure that specifies FIX profile sender tag class information used in profile attributes.

SenderTagClass

A structure that specifies FIX profile sender tag class information. For sender tag class information, you provide a structure that specifies a mapping between a sender ID and a tag mapping data group. Sender ID (sender_id) is the value of tag 49. Tag mapping data group (tag_map_class) is an integer type data group (internal or external) which defines a tag substitution mapping. The FIX parser checks the message sender (tag 49 value). If it matches the sender ID of a SenderTagClass structure, the FIX parser will substitute the tags in the message with new tags defined in the data group. For example, if a structure is {“sender_1”, “data_group_1”} and data_group_1 defines that 10001 maps to 20001, then FIX parser substitutes 10001 with 20001 in all the messages sent by “sender_1” (where tag 49 = “sender_1” in the message).


Enumerations

Enumeration Description
ErrorAction A list of FIX profile error actions.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
FIXProfileStatisticEntrySequence FIXProfileStatisticEntry [] A sequence of FIX profile statistics.
ProfileErrorActionSequence ProfileErrorAction [] A sequence of profile error actions.
ProfileSenderTagClassArraySequence ProfileSenderTagClassArray [] A sequence of profile sender tag class information structures.
SenderTagClassSequence SenderTagClass [] A sequence of sender tag class information structures. These provide mapping structures between a sender ID and a tag mapping data group. The FIX parser checks the sender of the incoming message and if it matches the sender ID in a structure in the sequence, the tag mapping defined in the structure&aposs data group is used to substitute tags in the message.

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.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.