Management::ApplicationService

Introduced : BIG-IP_v11.0.0
An Application Service is a collection of settings that represent a cohesive unit. It is created from an Application Template which defines which objects should be created for the application. When creating or modifying the application service, you supply values for the variables defined by the application template, and the system runs the application template implementation script with the variables you supply, typically resulting in creation of a tightly bound, related set of objects, as directed by the script. Note: Creation and modifications of application services do not obey normal transaction rules. If an application is modified as part of a transaction, the modification will be committed regardless if the transaction is rolled back.

Methods

Method Description Introduced
add_metadata Adds the metadata for the specified apps. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
convert_to_generic Modifies an existing application service to remove the association with the application template. All objects that were created by the template will continue to be owned by the application service and the application variables will be preserved. The modify method can be used to reassociate a generic application service with a template. BIG-IP_v11.3.0
create Creates a new Application Service. This method first creates a folder named after the application with a “.app” suffix, then executes the application template implementation script to create the objects owned by the application. For example, for an application service named “myapp”, and application template named “myapp_tpl”, the system creates a folder named “myapp.app” in the current folder, perhaps with a pool and virtual in the new folder, if the application template script so directs. BIG-IP_v11.0.0
create_extended Creates a new Application Service with extended variables. Extended variables allows you to specify more than just name and value. This method first creates a folder named after the application with a “.app” suffix, then executes the application template implementation script to create the objects owned by the application. For example, for an application service named “myapp”, and application template named “myapp_tpl”, the system creates a folder named “myapp.app” in the current folder, perhaps with a pool and virtual in the new folder, if the application template script so directs. If a variable is marked as encrypted, then the value will be encrypted by the system. BIG-IP_v11.4.0
create_generic Creates a generic Application service. This method automatically creates a folder named after the application with a “.app” suffix. Any object created in this folder will become owned by the application. BIG-IP_v11.3.0
delete_all_application_services Deletes all application services. Note: To use this method in 11.4.0 and later, you will need to use System::Session::set_recursive_query_state to enable the recursive query/operation state (it applies to delete as well). This is because the application services reside in folders below the active folder. BIG-IP_v11.0.0
delete_application_service Deletes the specified application services. All objects owned by the application and the application folder are also deleted. BIG-IP_v11.0.0
get_description Gets the descriptions for the specified application services. BIG-IP_v11.0.0
get_device_group Gets the name of the device group for the application. Note that if the keyword “default” was used to set the device group, the value returned here will be the actual name of the device group that was inherited. BIG-IP_v11.0.0
get_list Gets the names of all application services. Note that Application Services are always created in a subfolder so if you call get_list immediately after creating an Application Service you will not get the application in the results unless you set the app folder as the active folder or you enable recursive queries. BIG-IP_v11.0.0
get_list_vars Gets the list variables for the application. BIG-IP_v11.0.0
get_list_vars_extended Gets the list variables for the application with extended information. If a variable is marked as encrypted, then it has been encrypted by the system. BIG-IP_v11.4.0
get_metadata Gets the user metadata for the specified apps. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. BIG-IP_v11.2.0
get_metadata_description Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_metadata_persistence Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_metadata_value Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_scalar_vars Gets the scalar variables for the application. BIG-IP_v11.0.0
get_scalar_vars_extended Gets the scalar variables for the application with extended information. If a variable is marked as encrypted, then it has been encrypted by the system. BIG-IP_v11.4.0
get_strict_updates_state Gets the state to enforce strict-update checking for a set of application services. BIG-IP_v11.0.0
get_table_vars Gets the table variables for the application. BIG-IP_v11.0.0
get_table_vars_extended Gets the table variables for the application with extended information. If a variable is marked as encrypted, then it has been encrypted by the system. BIG-IP_v11.4.0
get_template Gets the name of the template used to manage the configuration owned by the specified application services. If the application does not currently have a template an empty string will be returned. BIG-IP_v11.4.0
get_traffic_group Gets the name of the application&aposs traffic group. Note that if the keyword “default” was used to set the traffic group, the value returned here will be the actual name of the traffic group that was inherited. BIG-IP_v11.0.0
get_version Gets the version information for this interface. BIG-IP_v11.0.0
is_device_group_inherited Gets whether the value returned by get_device_group was inherited from the parent folder. BIG-IP_v11.0.0
is_template_modified Gets a booleann indicating whether the template that was used to create the application service has been modified and the application service should be updated using the modify method. BIG-IP_v11.0.0
is_traffic_group_inherited Gets whether the value returned by get_traffic_group was inherited from the parent folder. BIG-IP_v11.0.0
modify Modifies an existing application service. All existing application variables and values are replaced with the given sets of variables. The application template implementation script is also executed which may create new objects as directed by the script. Existing objects owned by the application will be deleted if they are not recreated by the script. BIG-IP_v11.0.0
modify_extended Modifies an existing application service. This causes previous variables to be replaced by any new variables, where specified, and causes the application template implementation script to be rerun, which may create new objects, as directed by the script. Existing objects owned by the application will be deleted if they are not recreated by the script. If a variable is marked as encrypted, then it will be encrypted by the system if it is not already. If a variable is to be changed from encrypted to unencrypted, then a new plain-text value must also be provided. BIG-IP_v11.4.0
remove_all_metadata Removes all the metadata instances for the specified apps. BIG-IP_v11.2.0
remove_metadata Removes the metadata for the specified apps and names. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_description Sets the descriptions for the specified application services. BIG-IP_v11.0.0
set_device_group Set the device group that will be used to sync the application objects to other devices. BIG-IP_v11.0.0
set_metadata_description Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_metadata_persistence Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_metadata_value Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_strict_updates_state Sets the state to enforce strict-updates checking for the object owned by the application service. If set, all modifications made directly to the objects owned by the application will be rejected. All changes must be made by modifying the application variables and executing the appropriate application template action. BIG-IP_v11.0.0
set_traffic_group Set the traffic group that will be used for failover with the application services. BIG-IP_v11.0.0

Structures

Structure

Description

ListVar

An application variable that contains a list of values.

ListVarExtended

An application variable that is a named list of values with extended information indicating whether the variable value is encrypted or not. If this is used as part of a create or set type operation, then the encrypted member indicates that the values should be encrypted by the system if it is not already. On get operations, the encrypted member indicates whether the values are currently encrypted.

ScalarVar

An application variable that is a simple named value.

ScalarVarExtended

An application variable that is a simple named value with extended information indicating whether the variable value is encrypted or not. If this is used as part of a create or set type operation, then the encrypted member indicates that the value should be encrypted by the system if it is not already. On get operations, the encrypted member indicates whether the value is currently encrypted.

TableVar

A complex application variable that contains a 2-dimensional set of values.

TableVarExtended

A complex application variable that contains a 2-dimensional set of values with extended information indicating which columns are encrypted. If this is used as part of a create or set type operation, then the encrypted member indicates that the value should be encrypted by the system if it is not already. On get operations, the encrypted member indicates whether the value is currently encrypted.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ListVarExtendedSequence ListVarExtended [] A sequence of list variables.
ListVarExtendedSequenceSequence ListVarExtended [] [] A sequence of sequence of list variables.
ListVarSequence ListVar [] A sequence of list variables.
ListVarSequenceSequence ListVar [] [] A sequence of sequence list variables.
ScalarVarExtendedSequence ScalarVarExtended [] A sequence of scalar variables.
ScalarVarExtendedSequenceSequence ScalarVarExtended [] [] A sequence of sequence of scalar variables.
ScalarVarSequence ScalarVar [] A sequence of scalar variables.
ScalarVarSequenceSequence ScalarVar [] [] A sequence of sequence of scalar variables.
TableVarExtendedSequence TableVarExtended [] A sequence of table variables.
TableVarExtendedSequenceSequence TableVarExtended [] [] A sequence of sequence table variables.
TableVarSequence TableVar [] A sequence of table variables.
TableVarSequenceSequence TableVar [] [] A sequence of sequence table variables.

See Also

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.