Management::ApplicationTemplate

Introduced : BIG-IP_v11.0.0
An Application Template is used to create and modify Application Services. The template provides a custom UI (presentation) to present questions to the user that are needed to create the application. The implementation script is executed when the application is created or modified to create the necessary configuration objects from the user supplied answers to the presentation questions.

Methods

Method Description Introduced
add_checksum Computes and adds a checksum to each specified template. To each template, either checksum or signature can be added but not both. The system will throw if both algorithms are attempted on one template. BIG-IP_v11.4.0
add_signature Computes and adds a signature to each specified template. The signature is used during template validation to assure that the template&aposs fields - presentation, implementation, help and macro have not been modified. To each template, either checksum or signature can be added but not both. The system will throw if both algorithms are attempted on one template. BIG-IP_v11.4.0
clear_verification Clear both signature and checksum fields for the specified templates. The difference between enabling “ignore_verification” and “clear_verification” is: “ignore” suspends the verification temporarily while leaving the signature and checksum fields intact. Verification can be resumed. “clear” resets for good the signing information as if the templates had never been signed. BIG-IP_v11.4.0
create Creates a set of application templates. Each template automatically is created with a default empty “definition” action. BIG-IP_v11.0.0
delete_all_templates Deletes all application templates. BIG-IP_v11.0.0
delete_application_template Deletes a set of application templates. BIG-IP_v11.0.0
get_action_implementation Gets the implementation script text for the specified application template actions. BIG-IP_v11.0.0
get_action_list Gets the names of the actions in the application templates. BIG-IP_v11.0.0
get_action_presentation Gets the presentation text for the specified application template actions. BIG-IP_v11.0.0
get_action_presentation_help Gets the HTML help text for the specified application template actions. BIG-IP_v11.0.0
get_description Gets the descriptions for the specified application templates. BIG-IP_v11.0.0
get_ignore_verification_state Gets the state of ignoring the signature or checksum. BIG-IP_v11.4.0
get_list Gets the names of all application templates. BIG-IP_v11.0.0
get_prerequisite_bigip_version_maximum Gets the maximum version of BIG-IP for which this template is valid. BIG-IP_v11.2.0
get_prerequisite_bigip_version_minimum Gets the minimum version of BIG-IP for which this template is valid. BIG-IP_v11.2.0
get_prerequisite_errors Gets the error string indicating the prerequisite errors for a template. A blank string indicates no errors. A non-blank error string means that there are prerequisites for the template that are not met on that machine, and creating a system application object from that template on that machine will result in an exception. Note that the contents of the error string are meant to be human readable. While the presence of a non-blank error string can be used programmatically, the contents should only be used for non-programmatic purposes. BIG-IP_v11.2.0
get_prerequisite_modules Gets the list of modules required by the specified templates. BIG-IP_v11.2.0
get_verification_status Gets the verification status for the specified templates. BIG-IP_v11.4.0
get_version Gets the version information for this interface. BIG-IP_v11.0.0
set_action_implementation Sets the implementation script text for a set of actions in an application templates. The implementation is a TMSH script that can use the answers to the questions in the presentation, provided as variables, to create the configuration objects that make up the application service. This script is executed whenever the application is created or modified. BIG-IP_v11.0.0
set_action_presentation Sets the presentation text for a set of actions in application templates. The presentation contains Application Presentation Language (APL) text that describes what input is needed and how it should be displayed in the UI. BIG-IP_v11.0.0
set_action_presentation_help Sets the HTML help text for a set of actions in application templates. BIG-IP_v11.0.0
set_description Sets the descriptions for the specified appliation templates. BIG-IP_v11.0.0
set_ignore_verification_state Sets the ignore verification state for the specified templates. If enabled, the system will ignore the signature or checksum. Otherwise the signature or checksum is used during template validation to assure that the template&aposs field - presentation, implementation, help and macro have not been modified. BIG-IP_v11.4.0
set_prerequisite_bigip_version_maximum Sets the maximum version of BIG-IP for which this template is valid. Attempting to create an application from this template on an incompatible version of BIG-IP will produce an error. The version is of the form #.#.#, #.#, or #. For example, “11”, “11.1”, and “11.1.2” would all be valid version strings. BIG-IP_v11.2.0
set_prerequisite_bigip_version_minimum Sets the minimum version of BIG-IP for which this template is valid. Attempting to create an application from this template on an incompatible version of BIG-IP will produce an error. The version is of the form #.#.#, #.#, or #. For example, “11”, “11.1”, and “11.1.2” would all be valid version strings. BIG-IP_v11.2.0
set_prerequisite_modules Sets the list of modules required by each template. Attempting to create an application from this template when one or more of these modules are not provisioned will produce an error. Note: Beginning with BIG-IP_v11.4.0 if TMOS_MODULE_WAM, TMOS_MODULE_WOM, TMOS_MODULE_WOML, and/or TMOS_MODULE_AM is specified then TMOS_MODULE_AM will be set as the prerequisite module. BIG-IP_v11.2.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

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.