sys application apl-script
sys application apl-script(1) BIG-IP TMSH Manual sys application apl-script(1)
NAME
apl-script - Provides scripts that can be included by an application template.
MODULE
sys application
SYNTAX
Configure the apl-script component within the sys application module using the syntax in the following sections.
EDIT
create apl-script [name]
modify apl-script [name]
options:
apl-checksum [[string] | none]
apl-signature [[string] | none]
description [[string] | none]
ignore-verification [true | false]
edit apl-script [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
DISPLAY
list apl-script
list apl-script [ [ [name] | [glob] | [regex] ] ... ]
DELETE
delete apl-script [name]
GENERATE
Note: generate cryptographic signature or checksum based on apl script text.
generate sys application apl-script [name]
options:
checksum
signature
DESCRIPTION
An APL script contains APL that can be directly included into application templates. APL scripts provide a convenient way
to build libraries of common presentation elements. For detailed description of application presentation language elements,
See help page of sys application template
EXAMPLES
The following is a fairly simple example of an APL script and a template that makes use of the APL script. The APL script
defines a user type that can then be used multiple times in different templates.
sys application apl-script com.f5.apl.example {
define string port validator "PortNumber"
}
sys application template example_template {
actions {
definition {
presentation {
include "com.f5.apl.example"
section my_section {
string address1
port portnum1
string address2
port portnum2
}
}
}
}
}
generate my_script checksum
Generate a checksum for the script text and add the checksum as a property.
generate my_script signature signing-key my_key
Generate a signature for the script text using the specified private key and add the signature as a property.
Note: For a script which includes a checksum or signature to successfully load, the script text contents must match the
stored checksum or signature.
To temporarily stop the verification of signature or checksum and still retain the checksum or signature, the ignore-
verification attribute must be set to true. This is done by editing the script and adding the ignore-verification
attribute.
To completely clear the signature or checksum, simply set the attribute script-signature or script-checksum to empty string
"". By doing so, the script will be processed as if it was never signed or checksumed.
modify apl-script my_script {
description none
script {
}
ignore-verification true
script-checksum 74778e7b13016e0b9329a17f8d2da601
total-signing-status checksum
verification-status checksum-verified }
OPTIONS
You can use these options with the apl-script command:
checksum
Generate a checksum for the script text and add the checksum to the script as a property. Only for use with the
generate command.
description
User defined description.
glob Displays the items that match the glob expression. See help glob for a description of glob expression syntax.
name Specifies a unique name for the component. This option is required for the commands create and modify.
regex
Displays the items that match the regular expression. The regular expression must be preceded by an at sign (@[regular
expression]) to indicate that the identifier is a regular expression. See help regex for a description of regular
expression syntax.
script
Contains the APL text that can be imported into application templates.
signature
Generate a signature for the script text using the specified private key and add the signature to the script as a
property. Only for use with the generate command.
signing-key
The private key to use for signing the script. Only for use with the signature option.
SEE ALSO
create, delete, edit, glob, list, modify, regex, sys application template and generate.
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2010, 2013, 2015-2016. All rights reserved.
BIG-IP 2016-03-14 sys application apl-script(1)