LocalLB::CipherGroup¶
Introduced : BIG-IP_v13.0.0
The CipherGroup interface enables you to manipulate the cipher group
parameters. Cipher groups are collections of cipher rules that are
combined and ultimately result in a list of ciphers used by the
client-ssl and server-ssl profiles.
Methods¶
Method | Description | Introduced |
add_allow | Add some allowed cipher rules for the set of cipher groups. | BIG-IP_v13.0.0 |
add_exclude | Adds cipher rules to the exclude list for the set of cipher groups. | BIG-IP_v13.0.0 |
add_require | Adds the required cipher rules for the set of cipher groups. | BIG-IP_v13.0.0 |
create | Creates a cipher group. | BIG-IP_v13.0.0 |
delete_all_cipher_groups | Deletes all non-system cipher groups. | BIG-IP_v13.0.0 |
delete_cipher_group | Deletes the specified cipher groups. | BIG-IP_v13.0.0 |
get_allow | Gets the set of all cipher rules allowed by this group. This is the additive set. See get_exclude and get_require below. | BIG-IP_v13.0.0 |
get_description | Gets the descriptions for a set of cipher groups. | BIG-IP_v13.0.0 |
get_exclude | Return the excluded ciphers from the set of cipher groups. Ciphers defined by this rule will not be in the resulting cipher string. | BIG-IP_v13.0.0 |
get_list | Gets a list of all cipher groups. | BIG-IP_v13.0.0 |
get_order | Gets the ordering functions for a set of cipher groups. | BIG-IP_v13.0.0 |
get_require | Gets the set of required cipher rules for a set of cipher groups. Any cipher not in this set will be exluded from the resulting cipher string. | BIG-IP_v13.0.0 |
get_result_list | Gets the fully expanded list of ciphers after applying the allowed, excluded, and required cipher rules. To arrive at this list, first anything in excluded is removed from allowed, then anything in allowed that is not in required is removed. | BIG-IP_v13.0.0 |
get_version | Gets the version information for this interface. | BIG-IP_v13.0.0 |
remove_all_excludes | Removes all cipher rules from the exclude list for the set of cipher groups. | BIG-IP_v13.0.0 |
remove_all_requires | Removes all required cipher rules for the set of cipher groups. | BIG-IP_v13.0.0 |
remove_allow | Remove some allowed cipher rules for the set of cipher groups. | BIG-IP_v13.0.0 |
remove_exclude | Removes cipher rules from the exclude list for the set of cipher groups. | BIG-IP_v13.0.0 |
remove_require | Removes the required cipher rules for the set of cipher groups. | BIG-IP_v13.0.0 |
set_description | Sets the description for a set of cipher groups. This is an arbitrary field which can be used for any purpose. | BIG-IP_v13.0.0 |
set_order | Sets the ordering of the cipher rules within the cipher group. | BIG-IP_v13.0.0 |
Enumerations¶
Enumeration | Description |
CipherGroupOrder | Cipher group ordering hint. These are applied after the resulting cipher string has been generated. |
Aliases¶
Alias | Type | Description |
CipherGroupOrderSequence | CipherGroupOrder [] | Sequence of cipher group order. |
See Also¶
iControl ::
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.