LocalLB::ProfileTFTP

Introduced : BIG-IP_v12.0.0
The ProfileTFTP interface enables you to manipulate a local Trivial File Transfer Protocol (TFTP) profile. The TFTP ALG Profile will establish the TFTP flows and listeners and remove them on error or completion of the transfer. UDP flows rely on a timeout expiration to detect the completion. ALGs do not have visibility over the actual data to detect if the transfer has completed.

Methods

Method Description Introduced
create Creates the specified TFTP profiles. BIG-IP_v12.0.0
delete_all_profiles Deletes all TFTP profiles. BIG-IP_v12.0.0
delete_profile Deletes the specified TFTP profiles. BIG-IP_v12.0.0
get_all_statistics Gets the statistics for all the TFTP profiles. BIG-IP_v12.0.0
get_default_profile Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v12.0.0
get_description Gets the descriptions for a set of TFTP profiles. BIG-IP_v12.0.0
get_idle_timeout Gets the idle timeout for the specified TFTP profiles. BIG-IP_v12.0.0
get_list Gets a list of all TFTP profiles. BIG-IP_v12.0.0
get_log_profile Gets the ALG log profiles for a set of TFTP profiles. BIG-IP_v12.0.0
get_log_publisher Gets the log publishers for a set of TFTP profiles. BIG-IP_v12.0.0
get_statistics Gets the statistics for the specified TFTP profiles. BIG-IP_v12.0.0
get_statistics_by_virtual Gets the statistics for the specified profiles, by virtual server. BIG-IP_v12.0.0
get_version Gets the version information for this interface. BIG-IP_v12.0.0
is_base_profile Determines whether the specified TFTP 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_v12.0.0
is_system_profile Determines whether the specified TFTP 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_v12.0.0
reset_statistics Resets the statistics for the specified TFTP profiles. BIG-IP_v12.0.0
reset_statistics_by_virtual Resets the statistics for the specified profiles, for the specified virtual servers. BIG-IP_v12.0.0
set_default_profile Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v12.0.0
set_description Sets the description for a set of TFTP profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v12.0.0
set_idle_timeout Sets the idle timeout for the specified TFTP profiles, which is the number of seconds without traffic before a connection is eligible for deletion. The default is 300 seconds. BIG-IP_v12.0.0
set_log_profile Sets the Application-Level Gateway log profiles for a set of TFTP profiles. The ALG log profile controls the logging of ALG connection events. See LocalLB::ALGLogProfile for more details. BIG-IP_v12.0.0
set_log_publisher Sets the log publishers for a set of TFTP profiles. A log publisher is a set of log destinations for high-speed logging of formatted log messages. See Log::Publisher for more details. BIG-IP_v12.0.0
set_log_settings Sets the log publisher and ALG log profiles for a set of TFTP profiles. This is the convenience function for set_log_publisher and set_log_profile. It is a convenience function to help avoid using a transaction, because a log publisher must be used in conjunction with a log profile. Either a transaction or this method are good ways of satisfying this validation. BIG-IP_v12.0.0

Structures

Structure

Description

ProfileTFTPStatisticEntry

A struct that describes statistics for a particular TFTP profile.

ProfileTFTPStatistics

A struct that describes profile statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ProfileTFTPStatisticEntrySequence ProfileTFTPStatisticEntry [] A sequence of ProfileTFTP statistics.

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.