# coding=utf-8
#
"""Classes and functions for configuring BIG-IP"""
# Copyright 2014 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.
#
from icontrol.session import iControlRESTSession
try:
import urlparse
except ImportError:
import urllib.parse as urlparse
try:
import signal
from signal import SIGALRM
HAS_SIGNAL = True
except ImportError:
HAS_SIGNAL = False
from f5.bigip.cm import Cm
from f5.bigip.resource import PathElement
from f5.bigip.shared import Shared
from f5.bigip.tm.auth import Auth as TmAuth
from f5.bigip.tm.cm import Cm as TmCm
from f5.bigip.tm.gtm import Gtm
from f5.bigip.tm.ltm import Ltm
from f5.bigip.tm.net import Net
from f5.bigip.tm.shared import Shared as TmShared
from f5.bigip.tm.sys import Sys
from f5.bigip.tm import Tm
from f5.bigip.tm.transaction import Transactions
from f5.sdk_exception import TimeoutError
def timeout_handler(signum, frame):
raise TimeoutError("Timed out waiting for response")
[docs]class BaseManagement(PathElement):
def __init__(self, hostname, username, password, **kwargs):
self.args = self.parse_arguments(
hostname, username, password, **kwargs
)
self.icrs = self._get_icr_session(**self.args)
self.configure_meta_data(**self.args)
self.set_icr_metadata(self.icrs)
def parse_arguments(self, *args, **kwargs):
result = dict(
timeout=kwargs.pop('timeout', 30),
port=kwargs.pop('port', 443),
icontrol_version=kwargs.pop('icontrol_version', ''),
token=kwargs.pop('token', False),
token_to_use=kwargs.pop('token_to_use', None),
verify=kwargs.pop('verify', False),
auth_provider=kwargs.pop('auth_provider', None),
debug=kwargs.pop('debug', False)
)
if kwargs:
raise TypeError('Unexpected **kwargs: %r' % kwargs)
result.update(dict(
hostname=args[0],
username=args[1],
password=args[2]
))
return result
def _get_icr_session(self, *args, **kwargs):
params = dict(
username=kwargs['username'],
password=kwargs['password'],
timeout=kwargs['timeout'],
verify=kwargs['verify'],
token_to_use=kwargs['token_to_use']
)
if kwargs['auth_provider']:
params['auth_provider'] = kwargs['auth_provider']
else:
params['token'] = kwargs['token']
result = iControlRESTSession(**params)
result.debug = kwargs['debug']
return result
def configure_meta_data(self, *args, **kwargs):
self._meta_data = {
'allowed_lazy_attributes': [Tm, Cm, Shared],
'hostname': kwargs['hostname'],
'port': kwargs['port'],
'device_name': None,
'local_ip': None,
'bigip': self,
'icontrol_version': kwargs['icontrol_version'],
'username': kwargs['username'],
'password': kwargs['password'],
'tmos_version': None,
}
def set_icr_metadata(self, icrs):
self._meta_data['icr_session'] = icrs
def post_configuration_setup(self):
self._get_tmos_version()
def _get_tmos_version(self):
connect = self._meta_data['bigip']._meta_data['icr_session']
base_uri = self._meta_data['uri'] + 'tm/sys/'
try:
if HAS_SIGNAL:
signal.signal(SIGALRM, timeout_handler)
signal.alarm(int(self.args['timeout']))
response = connect.get(base_uri)
signal.alarm(0)
else:
response = connect.get(base_uri)
except ValueError:
# Flask raises this when running F5-SDK in an instance
response = connect.get(base_uri)
ver = response.json()
version = urlparse.parse_qs(
urlparse.urlparse(ver['selfLink']).query)['ver'][0]
self._meta_data['tmos_version'] = version
@property
def hostname(self):
return self._meta_data['hostname']
@property
def icontrol_version(self):
return self._meta_data['icontrol_version']
@property
def tmos_version(self):
if self._meta_data['tmos_version'] is None:
self._meta_data['tmos_version'] = self._get_tmos_version()
return self._meta_data['tmos_version']
@property
def debug(self):
return self.icrs.debug
@debug.setter
def debug(self, value):
self.icrs.debug = value
@property
def debug_output(self):
result = []
if self.icrs.debug_output:
result += self.icrs.debug_output
return result
[docs]class ManagementRoot(BaseManagement):
"""An interface to a single BIG-IP"""
def __init__(self, hostname, username, password, **kwargs):
super(ManagementRoot, self).__init__(
hostname, username, password, **kwargs
)
self.set_metadata_uri(**self.args)
self.post_configuration_setup()
def set_metadata_uri(self, *args, **kwargs):
self._meta_data['uri'] = 'https://{0}:{1}/mgmt/'.format(
kwargs['hostname'], kwargs['port']
)
[docs]class BigIP(ManagementRoot):
"""A shim class used to access the default config resources in 'mgmt/tm.'
PLEASE DO NOT ADD ATTRIBUTES TO THIS CLASS.
This class is depcrated in favor of MangementRoot above. Do not add any
more objects to the allowed_lazy_attributes list here!
This class is solely implemented for backwards compatibility.
"""
def __init__(self, hostname, username, password, **kwargs):
super(BigIP, self).__init__(hostname, username, password, **kwargs)
self._meta_data['uri'] = self._meta_data['uri'] + 'tm/'
self._meta_data['allowed_lazy_attributes'] =\
[TmAuth, TmCm, Ltm, Gtm, Net, TmShared, Sys, Transactions]