LocalLB::Class¶
Introduced : BIG-IP_v9.0
The Class interface enables you to manipulate a local load
balancer&aposs Class attributes. There are 3 different Class types:
Address, String, and Value.
Methods¶
| Method | Description | Introduced |
| add_address_class_member | Incrementally adds address class members. | BIG-IP_v9.0 |
| add_string_class_member | Incrementally adds string class members. | BIG-IP_v9.0 |
| add_value_class_member | Incrementally adds value class members. | BIG-IP_v9.0 |
| create_address_class | Creates address classes. The specified classes must not already exist. | BIG-IP_v9.0 |
| create_external_class | This method is deprecated, since data group files are officially managed as data group file objects via the create_external_class_v2 method and System::DataGroupFile interface. Creates external classes. Note: As of v9.6.0, the validation on the file_name field in external_classes was improved to ensure the class file exists on pain of Common::OperationFailed exception. | BIG-IP_v9.0 |
| create_external_class_v2 | Creates external classes. | BIG-IP_v11.0.0 |
| create_string_class | Creates string classes. The specified classes must not already exist. | BIG-IP_v9.0 |
| create_value_class | Creates value classes. The specified classes must not already exist. | BIG-IP_v9.0 |
| delete_address_class_member | Incrementally deletes address class members. | BIG-IP_v9.0 |
| delete_all_address_classes | Deletes all address classes. | BIG-IP_v9.0 |
| delete_all_string_classes | Deletes all string classes. | BIG-IP_v9.0 |
| delete_all_value_classes | Deletes all value classes. | BIG-IP_v9.0 |
| delete_class | Deletes the specified classes. The specified classes can be of any class type, even external classes. | BIG-IP_v9.0 |
| delete_string_class_member | Incrementally deletes string class members. | BIG-IP_v9.0 |
| delete_value_class_member | Incrementally deletes value class members. | BIG-IP_v9.0 |
| find_address_class_member | Checks to see if the specified class members are in the specified class names. | BIG-IP_v9.0 |
| find_string_class_member | Checks to see if the specified class members are in the specified class names. | BIG-IP_v9.0 |
| find_value_class_member | Checks to see if the specified class members are in the specified class names. | BIG-IP_v9.0 |
| get_address_class | Gets the specified address classes. | BIG-IP_v9.0 |
| get_address_class_list | Gets the list of available address classes. | BIG-IP_v9.0 |
| get_address_class_member_data_value | Gets the data values associated with a set of address class members. This method is effectively the lookup method for using the class as a value map. | BIG-IP_v10.1.0 |
| get_class_meta_information | This method is deprecated, since data group files are officially managed as data group file objects via the get_class_meta_information_v2 method and System::DataGroupFile interface. Gets the meta data information for the specified classes. For external classes, the meta information will indicate the external file and other relevant information. For non-external classes, only applicable information such as class name/type will be of importance. | BIG-IP_v9.0 |
| get_class_meta_information_v2 | Gets the meta data information for the specified classes. For external classes, the meta information will indicate the external file and other relevant information. For non-external classes, only applicable information such as class name/type will be of importance. | BIG-IP_v11.0.0 |
| get_class_type | Gets the class types for the specified classes. | BIG-IP_v9.0 |
| get_data_separator | This has been deprecated, as its functionality has been taken over by the DataGroupFile interface. Note that it is valid only for external classes in 11.0.0 and beyond (it really never was appropriate for other classes, and is deprecated in any case). Gets the strings used to separate a class member value from its optional associated data value for a set of classes. | BIG-IP_v10.1.0 |
| get_description | Gets the descriptions for a set of classes. | BIG-IP_v11.0.0 |
| get_external_class_file_format | Gets the file format for the specified classes. This should only be called for external classes, since it does not make sense for non-external classes. | BIG-IP_v9.0 |
| get_external_class_file_mode | Gets the file modes for the specified classes. This should only be called for external classes, since it does not make sense for non-external classes. | BIG-IP_v9.0 |
| get_external_class_file_name | This method is deprecated, since data group files are officially managed as data group file objects via the get_external_class_file_name_v2 method and System::DataGroupFile interface. Gets the file names for the specified classes. This should only be called for external classes, since it does not make sense for non-external classes. | BIG-IP_v9.0 |
| get_external_class_file_name_v2 | Gets the names of the data group file objects for a set of classes. For non-external classes, an empty name will be returned. | BIG-IP_v11.0.0 |
| get_external_class_list | This method is deprecated, since data group files are officially managed as data group file objects via the get_external_class_list_v2 method and System::DataGroupFile interface. Gets the list of all available external classes. | BIG-IP_v9.0 |
| get_external_class_list_v2 | Gets the list of all available external classes. | BIG-IP_v11.0.0 |
| get_string_class | Gets the specified string classes. | BIG-IP_v9.0 |
| get_string_class_list | Gets the list of available string classes. | BIG-IP_v9.0 |
| get_string_class_member_data_value | Gets the data values associated with a set of string class members. This method is effectively the lookup method for using the class as a value map. | BIG-IP_v10.1.0 |
| get_value_class | Gets the specified value classes. | BIG-IP_v9.0 |
| get_value_class_list | Gets the list of available value classes. | BIG-IP_v9.0 |
| get_value_class_member_data_value | Gets the data values associated with a set of value class members. This method is effectively the lookup method for using the class as a value map. | BIG-IP_v10.1.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| modify_address_class | Modifies address classes. The specified classes must already exist. | BIG-IP_v9.0 |
| modify_string_class | Modifies string classes. The specified classes must already exist. | BIG-IP_v9.0 |
| modify_value_class | Modifies value classes. The specified classes must already exist. | BIG-IP_v9.0 |
| set_address_class_member_data_value | Sets the data values associated with a set of address class members. This data value is an optional arbitrary string, which can be retrieved given the class member information, allowing the class to be used as a value map. | BIG-IP_v10.1.0 |
| set_data_separator | This has been deprecated, as its functionality has been taken over by the DataGroupFile interface. Note that it is valid only for external classes in 11.0.0 and beyond (it really never was appropriate for other classes, and is deprecated in any case). Sets the strings used to separate a class member value from its optional associated data value for a set of classes. This is used for listing and storing both external and internal classes. | BIG-IP_v10.1.0 |
| set_description | Sets the description for a set of classes. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_external_class_file_format | Sets the file format for the specified classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done. | BIG-IP_v9.0 |
| set_external_class_file_mode | Sets the file mode for the specified classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done. | BIG-IP_v9.0 |
| set_external_class_file_name | This method is deprecated, since data group files are officially managed as data group file objects via the set_external_class_file_name_v2 method and System::DataGroupFile interface. Sets the file names for the specified external classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done. | BIG-IP_v9.0 |
| set_external_class_file_name_v2 | Sets the names of the data group file objects for a set of external classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done. | BIG-IP_v11.0.0 |
| set_string_class_member_data_value | Sets the data values associated with a set of string class members. This data value is an optional arbitrary string, which can be retrieved given the class member information, allowing the class to be used as a value map. | BIG-IP_v10.1.0 |
| set_value_class_member_data_value | Sets the data values associated with a set of value class members. This data value is an arbitrary optional string, which can be retrieved given the class member information, allowing the class to be used as a value map. | BIG-IP_v10.1.0 |
Structures¶
Structure
Description
A struct that describes an Address class.
A struct that describes an Address class member.
A struct that describes the meta information of a class.
A struct that describes a String class.
A struct that describes a Value class.
Enumerations¶
| Enumeration | Description |
| ClassType | A list of different class types. |
| FileFormatType | A list of different file format types. |
| FileModeType | A list of different file mode types. |
Aliases¶
| Alias | Type | Description |
| AddressClassSequence | AddressClass [] | A sequence of Address classes. |
| AddressEntrySequence | AddressEntry [] | A sequence of Address class members. |
| AddressEntrySequenceSequence | AddressEntry [] [] | A sequence of Address class entry sequences. |
| ClassTypeSequence | ClassType [] | A sequence of class types. |
| FileFormatTypeSequence | FileFormatType [] | A sequence of file format types. |
| FileModeTypeSequence | FileModeType [] | A sequence of file mode types. |
| MetaInformationSequence | MetaInformation [] | A sequence of external class properties. |
| StringClassSequence | StringClass [] | A sequence of String classes. |
| ValueClassSequence | ValueClass [] | A sequence of Value classes. |
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¶
- pycontrol v2 - Class Management - pycontrol v2 Class Management
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.