LTConfig::Field

Introduced : BIG-IP_v9.4.2
The Field interface enables you to manage fields and field instances in the Loosely-Typed Configuration system.

Methods

Method Description Introduced
get_application_data Gets application data for one or more loosely-typed configuration fields for the specified classes. This is the “back-end application hook”. BIG-IP_v9.4.2
get_clustered_state Gets the clustered state for one or more specified loosely-typed configuration fields for the specified classes. If the field is clustered, that means don&apost use the default. BIG-IP_v9.4.2
get_configsyncd_state Gets the configsyncd state for one or more specified loosely-typed configuration fields for the specified classes. If the field is configsyncd, that means don&apost use the default. BIG-IP_v9.4.2
get_db_variable_mirror_information Gets db variable mirror information for one or more loosely-typed configuration fields for the specified classes. This, if non-empty, indicates which db variable should have its value mirrored with this field. BIG-IP_v9.4.2
get_default Gets default value information for one or more loosely-typed configuration fields for the specified classes. BIG-IP_v9.4.2
get_display_name Gets display name information for one or more loosely-typed configuration fields for the specified classes. BIG-IP_v9.4.2
get_list Gets a list of loosely-typed configuration fields for the specified classes. BIG-IP_v9.4.2
get_required_state Gets the required state for one or more specified loosely-typed configuration fields for the specified classes. If the field is required, that means don&apost use the default. BIG-IP_v9.4.2
get_type_information Gets type information for one or more loosely-typed configuration fields for the specified classes. (This is not to be confused with type; type information gives information relevant to the processing of a basic type, for example, type int might have type information specifying min and max value). BIG-IP_v9.4.2
get_value Gets the value for one loosely-typed configuration field instance for the specified class instance. This is for convenience, when you want to get just one value in just one class instance. Use get_values instead for greater efficiency when getting multiple field values. BIG-IP_v9.4.2
get_values Gets values for one or more loosely-typed configuration field instances for the specified class instances. BIG-IP_v9.4.2
get_version Gets the version information for this interface. BIG-IP_v9.4.2
set_value Sets the value for one loosely-typed configuration field instance for the specified class instance. This is for convenience, when you want to set just one value in just one class instance. Use set_values instead for greater efficiency when setting multiple field values. BIG-IP_v9.4.2
set_values Sets values for one or more loosely-typed configuration field instances for the specified class instances. BIG-IP_v9.4.2

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
EnabledStateSequenceSequence EnabledState [] [] A sequence of sequences of EnabledStates.

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.