mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-05 16:04:09 -07:00
Removes the f5-sdk from bigip_provision (#48397)
This commit is contained in:
Tim Rupp
GitHub
parent
38806e8507
commit
7290bc23b8
3 changed files with 547 additions and 331 deletions
|
|
@ -14,12 +14,10 @@ try:
|
|||
except ImportError:
|
||||
from io import StringIO
|
||||
|
||||
from ansible.module_utils.urls import open_url
|
||||
from ansible.module_utils.six import iteritems
|
||||
from ansible.module_utils.urls import urllib_error
|
||||
from ansible.module_utils.urls import urlparse
|
||||
from ansible.module_utils.urls import generic_urlparse
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.six import PY3
|
||||
from ansible.module_utils.urls import Request
|
||||
|
||||
try:
|
||||
import json as _json
|
||||
|
|
@ -87,71 +85,7 @@ print(resp.json())
|
|||
```
|
||||
"""
|
||||
|
||||
|
||||
class Request(object):
|
||||
def __init__(self, method=None, url=None, headers=None, data=None, params=None,
|
||||
auth=None, json=None):
|
||||
self.method = method
|
||||
self.url = url
|
||||
self.headers = headers or {}
|
||||
self.data = data or []
|
||||
self.json = json
|
||||
self.params = params or {}
|
||||
self.auth = auth
|
||||
|
||||
def prepare(self):
|
||||
p = PreparedRequest()
|
||||
p.prepare(
|
||||
method=self.method,
|
||||
url=self.url,
|
||||
headers=self.headers,
|
||||
data=self.data,
|
||||
json=self.json,
|
||||
params=self.params,
|
||||
)
|
||||
return p
|
||||
|
||||
|
||||
class PreparedRequest(object):
|
||||
def __init__(self):
|
||||
self.method = None
|
||||
self.url = None
|
||||
self.headers = None
|
||||
self.body = None
|
||||
|
||||
def prepare(self, method=None, url=None, headers=None, data=None, params=None, json=None):
|
||||
self.prepare_method(method)
|
||||
self.prepare_url(url, params)
|
||||
self.prepare_headers(headers)
|
||||
self.prepare_body(data, json)
|
||||
|
||||
def prepare_url(self, url, params):
|
||||
self.url = url
|
||||
|
||||
def prepare_method(self, method):
|
||||
self.method = method
|
||||
if self.method:
|
||||
self.method = self.method.upper()
|
||||
|
||||
def prepare_headers(self, headers):
|
||||
self.headers = {}
|
||||
if headers:
|
||||
for k, v in iteritems(headers):
|
||||
self.headers[k] = v
|
||||
|
||||
def prepare_body(self, data, json=None):
|
||||
body = None
|
||||
|
||||
if not data and json is not None:
|
||||
self.headers['Content-Type'] = 'application/json'
|
||||
body = _json.dumps(json)
|
||||
if not isinstance(body, bytes):
|
||||
body = body.encode('utf-8')
|
||||
|
||||
if data:
|
||||
body = data
|
||||
|
||||
self.body = body
|
||||
from ansible.module_utils.six.moves.urllib.error import HTTPError
|
||||
|
||||
|
||||
class Response(object):
|
||||
|
|
@ -162,17 +96,18 @@ class Response(object):
|
|||
self.url = None
|
||||
self.reason = None
|
||||
self.request = None
|
||||
self.msg = None
|
||||
|
||||
@property
|
||||
def content(self):
|
||||
return self._content.decode('utf-8')
|
||||
return self._content
|
||||
|
||||
@property
|
||||
def raw_content(self):
|
||||
return self._content
|
||||
|
||||
def json(self):
|
||||
return _json.loads(self._content)
|
||||
return _json.loads(self._content or 'null')
|
||||
|
||||
@property
|
||||
def ok(self):
|
||||
|
|
@ -190,145 +125,171 @@ class Response(object):
|
|||
class iControlRestSession(object):
|
||||
"""Represents a session that communicates with a BigIP.
|
||||
|
||||
Instantiate one of these when you want to communicate with an F5 REST
|
||||
Server, it will handle F5-specific authentication.
|
||||
|
||||
Pass an existing authentication token to the ``token`` argument to re-use
|
||||
that token for authentication. Otherwise, token authentication is handled
|
||||
automatically for you.
|
||||
|
||||
On BIG-IQ, it may be necessary to pass the ``auth_provider`` argument if the
|
||||
user has a different authentication handler configured. Otherwise, the system
|
||||
defaults for the different products will be used.
|
||||
This acts as a loose wrapper around Ansible's ``Request`` class. We're doing
|
||||
this as interim work until we move to the httpapi connector.
|
||||
"""
|
||||
def __init__(self):
|
||||
self.headers = self.default_headers()
|
||||
self.verify = True
|
||||
self.params = {}
|
||||
self.timeout = 30
|
||||
|
||||
self.server = None
|
||||
self.user = None
|
||||
self.password = None
|
||||
self.server_port = None
|
||||
self.auth_provider = None
|
||||
|
||||
def _normalize_headers(self, headers):
|
||||
result = {}
|
||||
result.update(dict((k.lower(), v) for k, v in headers))
|
||||
|
||||
# Don't be lossy, append header values for duplicate headers
|
||||
# In Py2 there is nothing that needs done, py2 does this for us
|
||||
if PY3:
|
||||
temp_headers = {}
|
||||
for name, value in headers:
|
||||
# The same as above, lower case keys to match py2 behavior, and create more consistent results
|
||||
name = name.lower()
|
||||
if name in temp_headers:
|
||||
temp_headers[name] = ', '.join((temp_headers[name], value))
|
||||
else:
|
||||
temp_headers[name] = value
|
||||
result.update(temp_headers)
|
||||
return result
|
||||
|
||||
def default_headers(self):
|
||||
return {
|
||||
'connection': 'keep-alive',
|
||||
'accept': '*/*',
|
||||
}
|
||||
|
||||
def prepare_request(self, request):
|
||||
headers = self.headers.copy()
|
||||
params = self.params.copy()
|
||||
|
||||
if request.headers is not None:
|
||||
headers.update(request.headers)
|
||||
if request.params is not None:
|
||||
params.update(request.params)
|
||||
|
||||
prepared = PreparedRequest()
|
||||
prepared.prepare(
|
||||
method=request.method,
|
||||
url=request.url,
|
||||
data=request.data,
|
||||
json=request.json,
|
||||
def __init__(self, headers=None, use_proxy=True, force=False, timeout=120,
|
||||
validate_certs=True, url_username=None, url_password=None,
|
||||
http_agent=None, force_basic_auth=False, follow_redirects='urllib2',
|
||||
client_cert=None, client_key=None, cookies=None):
|
||||
self.request = Request(
|
||||
headers=headers,
|
||||
params=params,
|
||||
)
|
||||
return prepared
|
||||
|
||||
def request(self, method, url, params=None, data=None, headers=None, auth=None,
|
||||
timeout=None, verify=None, json=None):
|
||||
request = Request(
|
||||
method=method.upper(),
|
||||
url=url,
|
||||
headers=headers,
|
||||
json=json,
|
||||
data=data or {},
|
||||
params=params or {},
|
||||
auth=auth
|
||||
)
|
||||
kwargs = dict(
|
||||
use_proxy=use_proxy,
|
||||
force=force,
|
||||
timeout=timeout,
|
||||
verify=verify
|
||||
validate_certs=validate_certs,
|
||||
url_username=url_username,
|
||||
url_password=url_password,
|
||||
http_agent=http_agent,
|
||||
force_basic_auth=force_basic_auth,
|
||||
follow_redirects=follow_redirects,
|
||||
client_cert=client_cert,
|
||||
client_key=client_key,
|
||||
cookies=cookies
|
||||
)
|
||||
prepared = self.prepare_request(request)
|
||||
return self.send(prepared, **kwargs)
|
||||
self.last_url = None
|
||||
|
||||
def send(self, request, **kwargs):
|
||||
def get_headers(self, result):
|
||||
try:
|
||||
return dict(result.getheaders())
|
||||
except AttributeError:
|
||||
return result.headers
|
||||
|
||||
def update_response(self, response, result):
|
||||
response.headers = self.get_headers(result)
|
||||
response._content = result.read()
|
||||
response.status = result.getcode()
|
||||
response.url = result.geturl()
|
||||
response.msg = "OK (%s bytes)" % response.headers.get('Content-Length', 'unknown')
|
||||
|
||||
def send(self, method, url, **kwargs):
|
||||
response = Response()
|
||||
|
||||
params = dict(
|
||||
method=request.method,
|
||||
data=request.body,
|
||||
timeout=kwargs.get('timeout', None) or self.timeout,
|
||||
validate_certs=kwargs.get('verify', None) or self.verify,
|
||||
headers=request.headers
|
||||
)
|
||||
# Set the last_url called
|
||||
#
|
||||
# This is used by the object destructor to erase the token when the
|
||||
# ModuleManager exits and destroys the iControlRestSession object
|
||||
self.last_url = url
|
||||
|
||||
body = None
|
||||
data = kwargs.pop('data', None)
|
||||
json = kwargs.pop('json', None)
|
||||
|
||||
if not data and json is not None:
|
||||
self.request.headers['Content-Type'] = 'application/json'
|
||||
body = _json.dumps(json)
|
||||
if not isinstance(body, bytes):
|
||||
body = body.encode('utf-8')
|
||||
if data:
|
||||
body = data
|
||||
if body:
|
||||
kwargs['data'] = body
|
||||
|
||||
try:
|
||||
result = open_url(request.url, **params)
|
||||
response._content = result.read()
|
||||
response.status = result.getcode()
|
||||
response.url = result.geturl()
|
||||
response.msg = "OK (%s bytes)" % result.headers.get('Content-Length', 'unknown')
|
||||
response.headers = self._normalize_headers(result.headers.items())
|
||||
response.request = request
|
||||
except urllib_error.HTTPError as e:
|
||||
try:
|
||||
response._content = e.read()
|
||||
except AttributeError:
|
||||
response._content = ''
|
||||
result = self.request.open(method, url, **kwargs)
|
||||
except HTTPError as e:
|
||||
# Catch HTTPError delivered from Ansible
|
||||
#
|
||||
# The structure of this object, in Ansible 2.8 is
|
||||
#
|
||||
# HttpError {
|
||||
# args
|
||||
# characters_written
|
||||
# close
|
||||
# code
|
||||
# delete
|
||||
# errno
|
||||
# file
|
||||
# filename
|
||||
# filename2
|
||||
# fp
|
||||
# getcode
|
||||
# geturl
|
||||
# hdrs
|
||||
# headers
|
||||
# info
|
||||
# msg
|
||||
# name
|
||||
# reason
|
||||
# strerror
|
||||
# url
|
||||
# with_traceback
|
||||
# }
|
||||
self.update_response(response, e)
|
||||
return response
|
||||
|
||||
response.reason = to_native(e)
|
||||
response.status_code = e.code
|
||||
self.update_response(response, result)
|
||||
return response
|
||||
|
||||
def delete(self, url, json=None, **kwargs):
|
||||
return self.request('DELETE', url, json=json, **kwargs)
|
||||
def delete(self, url, **kwargs):
|
||||
return self.send('DELETE', url, **kwargs)
|
||||
|
||||
def get(self, url, **kwargs):
|
||||
return self.request('GET', url, **kwargs)
|
||||
return self.send('GET', url, **kwargs)
|
||||
|
||||
def patch(self, url, data=None, **kwargs):
|
||||
return self.request('PATCH', url, data=data, **kwargs)
|
||||
return self.send('PATCH', url, data=data, **kwargs)
|
||||
|
||||
def post(self, url, data=None, json=None, **kwargs):
|
||||
return self.request('POST', url, data=data, json=json, **kwargs)
|
||||
def post(self, url, data=None, **kwargs):
|
||||
return self.send('POST', url, data=data, **kwargs)
|
||||
|
||||
def put(self, url, data=None, **kwargs):
|
||||
return self.request('PUT', url, data=data, **kwargs)
|
||||
return self.send('PUT', url, data=data, **kwargs)
|
||||
|
||||
def __del__(self):
|
||||
if self.last_url is None:
|
||||
return
|
||||
token = self.request.headers.get('X-F5-Auth-Token', None)
|
||||
if not token:
|
||||
return
|
||||
try:
|
||||
p = generic_urlparse(urlparse(self.last_url))
|
||||
uri = "https://{0}:{1}/mgmt/shared/authz/tokens/{2}".format(
|
||||
p['hostname'], p['port'], token
|
||||
)
|
||||
self.delete(uri)
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
|
||||
def debug_prepared_request(url, method, headers, data=None):
|
||||
result = "curl -k -X {0} {1}".format(method.upper(), url)
|
||||
for k, v in iteritems(headers):
|
||||
result = result + " -H '{0}: {1}'".format(k, v)
|
||||
if any(v == 'application/json' for k, v in iteritems(headers)):
|
||||
if data:
|
||||
kwargs = _json.loads(data.decode('utf-8'))
|
||||
result = result + " -d '" + _json.dumps(kwargs, sort_keys=True) + "'"
|
||||
return result
|
||||
class TransactionContextManager(object):
|
||||
def __init__(self, client, validate_only=False):
|
||||
self.client = client
|
||||
self.validate_only = validate_only
|
||||
self.transid = None
|
||||
|
||||
def __enter__(self):
|
||||
uri = "https://{0}:{1}/mgmt/tm/transaction/".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port']
|
||||
)
|
||||
resp = self.client.api.post(uri, json={})
|
||||
if resp.status not in [200]:
|
||||
raise Exception
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError as ex:
|
||||
raise F5ModuleError(str(ex))
|
||||
|
||||
self.transid = response['transId']
|
||||
self.client.api.request.headers['X-F5-REST-Coordination-Id'] = self.transid
|
||||
return self.client
|
||||
|
||||
def __exit__(self, exc_type, exc_value, exc_tb):
|
||||
self.client.request.headers.pop('X-F5-REST-Coordination-Id')
|
||||
if exc_tb is None:
|
||||
uri = "https://{0}:{1}/mgmt/tm/transaction/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
self.transid
|
||||
)
|
||||
params = dict(
|
||||
state="VALIDATING",
|
||||
validateOnly=self.validate_only
|
||||
)
|
||||
resp = self.client.api.patch(uri, json=params)
|
||||
if resp.status not in [200]:
|
||||
raise Exception
|
||||
|
||||
|
||||
def download_file(client, url, dest):
|
||||
|
|
@ -375,7 +336,7 @@ def download_file(client, url, dest):
|
|||
# the loop
|
||||
if end == size:
|
||||
break
|
||||
crange = response.headers['content-range']
|
||||
crange = response.headers['Content-Range']
|
||||
# Determine the total number of bytes to read.
|
||||
if size == 0:
|
||||
size = int(crange.split('/')[-1]) - 1
|
||||
|
|
@ -542,15 +503,25 @@ def tmos_version(client):
|
|||
|
||||
|
||||
def module_provisioned(client, module_name):
|
||||
modules = dict(
|
||||
afm='provisioned.cpu.afm', avr='provisioned.cpu.avr', asm='provisioned.cpu.asm',
|
||||
apm='provisioned.cpu.apm', gtm='provisioned.cpu.gtm', ilx='provisioned.cpu.ilx',
|
||||
pem='provisioned.cpu.pem', vcmp='provisioned.cpu.vcmp'
|
||||
)
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/db/{2}".format(
|
||||
provisioned = modules_provisioned(client)
|
||||
if module_name in provisioned:
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def modules_provisioned(client):
|
||||
"""Returns a list of all provisioned modules
|
||||
|
||||
Args:
|
||||
client: Client connection to the BIG-IP
|
||||
|
||||
Returns:
|
||||
A list of provisioned modules in their short name for.
|
||||
For example, ['afm', 'asm', 'ltm']
|
||||
"""
|
||||
uri = "https://{0}:{1}/mgmt/tm/sys/provision".format(
|
||||
client.provider['server'],
|
||||
client.provider['server_port'],
|
||||
modules[module_name]
|
||||
client.provider['server_port']
|
||||
)
|
||||
resp = client.api.get(uri)
|
||||
|
||||
|
|
@ -564,6 +535,6 @@ def module_provisioned(client, module_name):
|
|||
raise F5ModuleError(response['message'])
|
||||
else:
|
||||
raise F5ModuleError(resp.content)
|
||||
if int(response['value']) == 0:
|
||||
return False
|
||||
return True
|
||||
if 'items' not in response:
|
||||
return []
|
||||
return [x['name'] for x in response['items'] if x['level'] != 'none']
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue