Management::CLIScript

Introduced : BIG-IP_v9.0
CLI scripts are written using Tool Command Language (Tcl). It is used to automate management of the BIG-IP system. CLI scripts can be included in other CLI scripts. Procedures defined in a CLI script can be run by other CLI scripts. It makes common code reuse possible for application template implementations and CLI scripts.

Methods

Method Description Introduced
add_checksum Computes and adds a checksum to each specified CLI script. To each CLI script, either checksum or signature can be added but not both. The system will throw an error if both algorithms are attempted on one CLI script. Adding the checksum prevents any unauthorized/ accidental modification to the CLI script content. BIG-IP_v11.4.0
add_signature Computes and adds a signature to each specified CLI script. The signature is used during CLI script validation to assure that the CLI script&aposs content has not been modified. To each CLI script, either checksum or signature can be added but not both. The system will throw an error if both algorithms are attempted on one CLI script. Adding the signature prevents any unauthorized/accidental modification to the CLI script content. BIG-IP_v11.4.0
clear_verification Clear both signature and checksum fields for the specified CLI scripts. 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 CLI scripts had never been signed. BIG-IP_v11.4.0
create Creates the specified CLI scripts. BIG-IP_v11.4.0
delete_all_cli_scripts Deletes all user-defined CLI scripts. BIG-IP_v11.4.0
delete_cli_script Deletes the specified CLI scripts. An exception will be raised when attempting to delete built-in CLI scripts. BIG-IP_v11.4.0
get_description Gets the descriptions for the specified CLI scripts. BIG-IP_v11.4.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 CLI scripts. BIG-IP_v11.4.0
get_script Gets the script definition/content for the specified CLI scripts. BIG-IP_v11.4.0
get_verification_status Gets the verification status for the specified CLI scripts. BIG-IP_v11.4.0
get_version Gets the version information for this interface. BIG-IP_v11.4.0
set_description Sets the description for the specified CLI scripts. Description is an arbitrary field which can be used for any purpose. BIG-IP_v11.4.0
set_ignore_verification_state Sets the ignore verification state for the specified CLI scripts. If enabled, the system will ignore the signature or checksum. Otherwise the signature or checksum is used during CLI script validation to assure that the CLI script&aposs content has not been modified. BIG-IP_v11.4.0
set_script Sets the script definition/content for the specified CLI scripts. BIG-IP_v11.4.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.

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.