WebAccelerator::Policies¶
Introduced : BIG-IP_v10.0
Allows manipulation of policies.
Methods¶
| Method | Description | Introduced |
| delete_all_policies | Delete all policies. However, default policies will not be deleted. If any policies deleted are in use by an application, then an error will be thrown. If this function is being used as a cleanup method, it is recommended to run delete_all_applications first. This can be found in the WebAccelerator::Applications module. | BIG-IP_v11.0.0 |
| delete_policy | This method has been deprecated, please use delete_policy_v2 instead. If the policy is in use by an application, then an error will be thrown. Delete a named policy. | BIG-IP_v10.0 |
| delete_policy_v2 | Delete a list of named policies. Attempting to delete policies in use by an application or default policies, will result in an error. | BIG-IP_v11.0.0 |
| export_policy | Export multiple policies from this WebAccelerator. The policy file will be in TMSH format corresponding to the given policy name. If overwrite is false and a policy file to be exported has the same filename as a previously exported policy file, then an error will be thrown. | BIG-IP_v11.0.0 |
| get_list | Get a list of policies present on this WebAccelerator. You will only view the policies of the active folder. You may change the active folder you are working on in the System::Session module using set_active_folder. To view all folders recursively under the active folder you may use the set_recursive_query_state also in that module. | BIG-IP_v10.0 |
| get_publish_comment | Gets the publish comments of the given published policies. | BIG-IP_v11.0.0 |
| get_publish_time | Gets the time of last publishing of the given policies. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v10.0 |
| import_policy | This method is deprecated. Please use import_policy_v2 instead Import a policy onto this WebAccelerator. The policy file must be in an XML format. The policy&aposs name will be extracted from the file. If overwrite is false and the policy to be imported has the same name as a previously defined policy, then an error will be thrown. | BIG-IP_v10.0 |
| import_policy_v2 | Import multiple policies onto this WebAccelerator. The policy file may be in either XML or TMSH format. The policy name will be specified as an argument and may or may not match the name in the file. If overwrite is false and a policy to be imported has the same name as a previously defined policy, then an error will be thrown. | BIG-IP_v11.0.0 |
| is_predefined | Checks if the policies listed are predefined. If they are predefined, then they cannot be deleted in a delete policy call. This setting cannot be changed by the user. | BIG-IP_v11.0.0 |
| publish_policy | Publish a list of policies. This allows a custom policy to be used by an application. | BIG-IP_v11.0.0 |
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.