# coding=utf-8
#
# Copyright 2014-2016 F5 Networks Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""BIG-IP® Local Traffic Manager (LTM) policy module.
REST URI
``http://localhost/mgmt/tm/ltm/policy``
GUI Path
``Local Traffic --> policy``
REST Kind
``tm:ltm:policy:*``
"""
from f5.bigip.resource import Collection
from f5.bigip.resource import Resource
from f5.sdk_exception import F5SDKError
from distutils.version import LooseVersion
[docs]class DraftPolicyNotSupportedInTMOSVersion(F5SDKError):
'''Raise if legacy mode is set when creating a policy'''
pass
[docs]class OperationNotSupportedOnPublishedPolicy(F5SDKError):
'''Raise if update/modify attempted on published policy'''
pass
[docs]class Policys(Collection):
"""BIG-IP® LTM policy collection."""
def __init__(self, ltm):
super(Policys, self).__init__(ltm)
self._meta_data['allowed_lazy_attributes'] = [Policy]
self._meta_data['attribute_registry'] =\
{'tm:ltm:policy:policystate': Policy}
[docs]class Policy(Resource):
"""BIG-IP® LTM policy resource."""
def __init__(self, policy_s):
super(Policy, self).__init__(policy_s)
self._meta_data['required_json_kind'] = 'tm:ltm:policy:policystate'
self._meta_data['required_creation_parameters'].update(('strategy',))
temp = {'tm:ltm:policy:rules:rulescollectionstate': Rules_s}
self._meta_data['attribute_registry'] = temp
def _create(self, **kwargs):
'''Allow creation of draft policy and ability to publish a draft
Draft policies only exist in 12.1.0 and greater versions of TMOS.
But there must be a method to create a draft, then publish it.
:raises: DraftPolicyNotSupportedInTMOSVersion,
OperationNotSupportedOnPublishedPolicy
'''
tmos_ver = self._meta_data['bigip']._meta_data['tmos_version']
legacy = kwargs.pop('legacy', True)
publish = kwargs.pop('publish', False)
if legacy and publish:
msg = "The keyword arguments 'legacy' and 'publish' were given " \
"to this method and both are set to True. A legacy ltm " \
"policy does not have the 'draft' or 'published' status."
raise DraftPolicyNotSupportedInTMOSVersion(msg)
elif legacy and not publish:
return super(Policy, self)._create(**kwargs)
elif not legacy and LooseVersion(tmos_ver) < LooseVersion('12.1.0'):
msg = "The version of TMOS on the device does not support " \
"draft policies. The keyword argument 'legacy' was " \
"given to this method and it was set to 'False'. This " \
"is not allowed on the current device."
raise DraftPolicyNotSupportedInTMOSVersion(msg)
elif not legacy and LooseVersion(tmos_ver) >= LooseVersion('12.1.0'):
if publish:
self = super(Policy, self)._create(**kwargs)
self.publish()
return self
else:
return super(Policy, self)._create(**kwargs)
def _modify(self, **patch):
'''Modify only draft or legacy policies
Published policies cannot be modified
:raises: OperationNotSupportedOnPublishedPolicy
'''
tmos_ver = self._meta_data['bigip']._meta_data['tmos_version']
if 'Drafts' not in self._meta_data['uri'] and \
LooseVersion(tmos_ver) >= LooseVersion('12.1.0'):
msg = 'Modify operation not allowed on a published policy.'
raise OperationNotSupportedOnPublishedPolicy(msg)
super(Policy, self)._modify(**patch)
def _update(self, **kwargs):
'''Update only draft or legacy policies
Published policies cannot be updated
:raises: OperationNotSupportedOnPublishedPolicy
'''
tmos_ver = self._meta_data['bigip']._meta_data['tmos_version']
if 'Drafts' not in self._meta_data['uri'] and \
LooseVersion(tmos_ver) >= LooseVersion('12.1.0'):
msg = 'Update operation not allowed on a published policy.'
raise OperationNotSupportedOnPublishedPolicy(msg)
super(Policy, self)._update(**kwargs)
[docs] def publish(self, **kwargs):
'''Publishing a draft policy is only applicable in TMOS 12.1 and up.
This operation updates the meta_data['uri'] of the existing object
and effectively moves a draft into a published state on the device.
The self object is also updated with the response from a GET to the
device.
:raises: PolicyNotDraft
'''
assert 'Drafts' in self._meta_data['uri']
assert self.status.lower() == 'draft'
base_uri = self._meta_data['container']._meta_data['uri']
requests_params = self._handle_requests_params(kwargs)
session = self._meta_data['bigip']._meta_data['icr_session']
if 'command' not in kwargs:
kwargs['command'] = 'publish'
if 'Drafts' not in self.name:
kwargs['name'] = self.fullPath
session.post(base_uri, json=kwargs, **requests_params)
get_kwargs = {
'name': self.name, 'partition': self.partition,
'uri_as_parts': True
}
response = session.get(base_uri, **get_kwargs)
json_data = response.json()
self._local_update(json_data)
self._activate_URI(json_data['selfLink'])
[docs]class Rules_s(Collection):
"""BIG-IP® LTM policy rules sub-collection."""
def __init__(self, policy):
super(Rules_s, self).__init__(policy)
self._meta_data['attribute_registry'] =\
{'tm:ltm:policy:rules:rulesstate': Rules}
self._meta_data['required_json_kind'] =\
'tm:ltm:policy:rules:rulescollectionstate'
self._meta_data['allowed_lazy_attributes'] = [Rules]
[docs]class Rules(Resource):
"""BIG-IP® LTM policy rules sub-collection resource."""
def __init__(self, rules_s):
super(Rules, self).__init__(rules_s)
self._meta_data['required_json_kind'] =\
'tm:ltm:policy:rules:rulesstate'
temp = {'tm:ltm:policy:rules:actions:actionscollectionstate':
Actions_s,
'tm:ltm:policy:rules:conditions:conditionscollectionstate':
Conditions_s}
self._meta_data['attribute_registry'] = temp
[docs]class Actions_s(Collection):
"""BIG-IP® LTM policy actions sub-collection."""
def __init__(self, rules):
super(Actions_s, self).__init__(rules)
self._meta_data['required_json_kind'] =\
'tm:ltm:policy:rules:actions:actionscollectionstate'
self._meta_data['allowed_lazy_attributes'] = [Actions]
self._meta_data['attribute_registry'] =\
{'tm:ltm:policy:rules:actions:actionsstate': Actions}
[docs]class Actions(Resource):
"""BIG-IP® LTM policy actions sub-collection resource."""
def __init__(self, actions_s):
super(Actions, self).__init__(actions_s)
self._meta_data['required_json_kind'] =\
'tm:ltm:policy:rules:actions:actionsstate'
[docs]class Conditions_s(Collection):
"""BIG-IP® LTM policy conditions sub-collection."""
def __init__(self, rules):
super(Conditions_s, self).__init__(rules)
self._meta_data['required_json_kind'] =\
'tm:ltm:policy:rules:conditions:conditionscollectionstate'
self._meta_data['allowed_lazy_attributes'] = [Conditions]
self._meta_data['attribute_registry'] =\
{'tm:ltm:policy:rules:conditions:conditionsstate': Conditions}
[docs]class Conditions(Resource):
"""BIG-IP® LTM policy conditions sub-collection resource."""
def __init__(self, conditions_s):
super(Conditions, self).__init__(conditions_s)
self._meta_data['required_json_kind'] =\
'tm:ltm:policy:rules:conditions:conditionsstate'