Introduced : BIG-IP_v13.0.0
The CipherRule interface enables you to manipulate the cipher rule parameters. Cipher Rules are bundled together in Cipher Groups which ultimately determines the ciphers (and their order) available to client-ssl and server-ssl profiles.


Method Description Introduced
create Creates a cipher rule. BIG-IP_v13.0.0
delete_all_cipher_rules Deletes all non-system cipher rules. BIG-IP_v13.0.0
delete_cipher_rule Deletes the specified cipher rules. BIG-IP_v13.0.0
get_cipher Gets the cipher strings for a set of cipher rules. BIG-IP_v13.0.0
get_description Gets the descriptions for a set of cipher rules. BIG-IP_v13.0.0
get_list Gets a list of all cipher rules. BIG-IP_v13.0.0
get_result_list Gets the fully expanded list of ciphers from the cipher string expression above. BIG-IP_v13.0.0
get_version Gets the version information for this interface. BIG-IP_v13.0.0
set_cipher Sets the cipher string expression for a set of cipher rules. Specifies the cipher expression the rule supports. Please see SOL17370 for cipher string examples. BIG-IP_v13.0.0
set_description Sets the description for a set of cipher rules. This is an arbitrary field which can be used for any purpose. BIG-IP_v13.0.0


Structure Description


Enumeration Description


Exception Description


Constant Type Value Description


Alias Type Description

See Also


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.