mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
Removes deprecated code from bigip_monitor_tcp (#34520)
* Removes deprecated code from bigip_monitor_tcp The deprecated code was moved into its own modules. We let it lay here for a release, and now I'm removing it. * Fixing upstreaming tests
This commit is contained in:
Tim Rupp
GitHub
parent
f189106ef6
commit
803e4124b6
2 changed files with 108 additions and 1148 deletions
|
|
@ -190,6 +190,26 @@ except ImportError:
|
|||
|
||||
|
||||
class Parameters(AnsibleF5Parameters):
|
||||
api_map = {
|
||||
'timeUntilUp': 'time_until_up',
|
||||
'defaultsFrom': 'parent',
|
||||
'recv': 'receive'
|
||||
}
|
||||
|
||||
api_attributes = [
|
||||
'timeUntilUp', 'defaultsFrom', 'interval', 'timeout', 'recv', 'send',
|
||||
'destination'
|
||||
]
|
||||
|
||||
returnables = [
|
||||
'parent', 'send', 'receive', 'ip', 'port', 'interval', 'timeout',
|
||||
'time_until_up'
|
||||
]
|
||||
|
||||
updatables = [
|
||||
'destination', 'send', 'receive', 'interval', 'timeout', 'time_until_up'
|
||||
]
|
||||
|
||||
def __init__(self, params=None):
|
||||
self._values = defaultdict(lambda: None)
|
||||
self._values['__warnings'] = []
|
||||
|
|
@ -220,6 +240,11 @@ class Parameters(AnsibleF5Parameters):
|
|||
# If the mapped value is not a @property
|
||||
self._values[map_key] = v
|
||||
|
||||
def _fqdn_name(self, value):
|
||||
if value is not None and not value.startswith('/'):
|
||||
return '/{0}/{1}'.format(self.partition, value)
|
||||
return value
|
||||
|
||||
def to_return(self):
|
||||
result = {}
|
||||
try:
|
||||
|
|
@ -278,57 +303,10 @@ class Parameters(AnsibleF5Parameters):
|
|||
|
||||
@property
|
||||
def parent(self):
|
||||
if self._values['parent_partition']:
|
||||
if self._values['parent_partition'] is None:
|
||||
return None
|
||||
if self._values['parent_partition'].startswith('/'):
|
||||
partition = os.path.basename(self._values['parent_partition'])
|
||||
result = '/{0}/{1}'.format(partition, self.type)
|
||||
else:
|
||||
result = '/{0}/{1}'.format(self.parent_partition, self.type)
|
||||
else:
|
||||
if self._values['parent'] is None:
|
||||
return None
|
||||
if self._values['parent'].startswith('/'):
|
||||
parent = os.path.basename(self._values['parent'])
|
||||
result = '/{0}/{1}'.format(self.partition, parent)
|
||||
else:
|
||||
result = '/{0}/{1}'.format(self.partition, self._values['parent'])
|
||||
return result
|
||||
|
||||
@property
|
||||
def parent_partition(self):
|
||||
if self._values['parent_partition'] is None:
|
||||
if self._values['parent'] is None:
|
||||
return None
|
||||
self._values['__warnings'].append(
|
||||
dict(
|
||||
msg="The parent_partition param is deprecated",
|
||||
version='2.4'
|
||||
)
|
||||
)
|
||||
return self._values['parent_partition']
|
||||
|
||||
|
||||
class ParametersTcp(Parameters):
|
||||
api_map = {
|
||||
'timeUntilUp': 'time_until_up',
|
||||
'defaultsFrom': 'parent',
|
||||
'recv': 'receive'
|
||||
}
|
||||
|
||||
api_attributes = [
|
||||
'timeUntilUp', 'defaultsFrom', 'interval', 'timeout', 'recv', 'send',
|
||||
'destination'
|
||||
]
|
||||
|
||||
returnables = [
|
||||
'parent', 'send', 'receive', 'ip', 'port', 'interval', 'timeout',
|
||||
'time_until_up'
|
||||
]
|
||||
|
||||
updatables = [
|
||||
'destination', 'send', 'receive', 'interval', 'timeout', 'time_until_up'
|
||||
]
|
||||
result = self._fqdn_name(self._values['parent'])
|
||||
return result
|
||||
|
||||
@property
|
||||
def port(self):
|
||||
|
|
@ -355,148 +333,6 @@ class ParametersTcp(Parameters):
|
|||
def type(self):
|
||||
return 'tcp'
|
||||
|
||||
@type.setter
|
||||
def type(self, value):
|
||||
if value:
|
||||
self._values['__warnings'].append(
|
||||
dict(
|
||||
msg="The type param is deprecated",
|
||||
version='2.4'
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class ParametersEcho(Parameters):
|
||||
api_map = {
|
||||
'timeUntilUp': 'time_until_up',
|
||||
'defaultsFrom': 'parent',
|
||||
'destination': 'ip'
|
||||
}
|
||||
|
||||
api_attributes = [
|
||||
'timeUntilUp', 'defaultsFrom', 'interval', 'timeout', 'destination'
|
||||
]
|
||||
|
||||
returnables = [
|
||||
'parent', 'ip', 'interval', 'timeout', 'time_until_up'
|
||||
]
|
||||
|
||||
updatables = [
|
||||
'destination', 'interval', 'timeout', 'time_until_up'
|
||||
]
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return 'tcp_echo'
|
||||
|
||||
@type.setter
|
||||
def type(self, value):
|
||||
if value:
|
||||
self._values['__warnings'].append(
|
||||
dict(
|
||||
msg="The type param is deprecated",
|
||||
version='2.4'
|
||||
)
|
||||
)
|
||||
|
||||
@property
|
||||
def destination(self):
|
||||
return self.ip
|
||||
|
||||
@destination.setter
|
||||
def destination(self, value):
|
||||
self._values['ip'] = value
|
||||
|
||||
@property
|
||||
def send(self):
|
||||
if self._values['send'] is None:
|
||||
return None
|
||||
raise F5ModuleError(
|
||||
"The 'send' parameter is not available for TCP echo"
|
||||
)
|
||||
|
||||
@property
|
||||
def receive(self):
|
||||
if self._values['receive'] is None:
|
||||
return None
|
||||
raise F5ModuleError(
|
||||
"The 'receive' parameter is not available for TCP echo"
|
||||
)
|
||||
|
||||
@property
|
||||
def port(self):
|
||||
return None
|
||||
|
||||
|
||||
class ParametersHalfOpen(Parameters):
|
||||
api_map = {
|
||||
'timeUntilUp': 'time_until_up',
|
||||
'defaultsFrom': 'parent'
|
||||
}
|
||||
|
||||
api_attributes = [
|
||||
'timeUntilUp', 'defaultsFrom', 'interval', 'timeout', 'destination'
|
||||
]
|
||||
|
||||
returnables = [
|
||||
'parent', 'ip', 'port', 'interval', 'timeout', 'time_until_up'
|
||||
]
|
||||
|
||||
updatables = [
|
||||
'destination', 'interval', 'timeout', 'time_until_up'
|
||||
]
|
||||
|
||||
@property
|
||||
def destination(self):
|
||||
if self.ip is None and self.port is None:
|
||||
return None
|
||||
result = '{0}:{1}'.format(self.ip, self.port)
|
||||
return result
|
||||
|
||||
@destination.setter
|
||||
def destination(self, value):
|
||||
ip, port = value.split(':')
|
||||
self._values['ip'] = ip
|
||||
self._values['port'] = port
|
||||
|
||||
@property
|
||||
def port(self):
|
||||
if self._values['port'] is None:
|
||||
return None
|
||||
elif self._values['port'] == '*':
|
||||
return '*'
|
||||
return int(self._values['port'])
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return 'tcp_half_open'
|
||||
|
||||
@type.setter
|
||||
def type(self, value):
|
||||
if value:
|
||||
self._values['__warnings'].append(
|
||||
dict(
|
||||
msg="The type param is deprecated",
|
||||
version='2.4'
|
||||
)
|
||||
)
|
||||
|
||||
@property
|
||||
def send(self):
|
||||
if self._values['send'] is None:
|
||||
return None
|
||||
raise F5ModuleError(
|
||||
"The 'send' parameter is not available for TCP half open"
|
||||
)
|
||||
|
||||
@property
|
||||
def receive(self):
|
||||
if self._values['receive'] is None:
|
||||
return None
|
||||
raise F5ModuleError(
|
||||
"The 'receive' parameter is not available for TCP half open"
|
||||
)
|
||||
|
||||
|
||||
class Difference(object):
|
||||
def __init__(self, want, have=None):
|
||||
|
|
@ -513,28 +349,24 @@ class Difference(object):
|
|||
|
||||
@property
|
||||
def parent(self):
|
||||
if self.want.parent != self.want.parent:
|
||||
if self.want.parent != self.have.parent:
|
||||
raise F5ModuleError(
|
||||
"The parent monitor cannot be changed"
|
||||
)
|
||||
|
||||
@property
|
||||
def destination(self):
|
||||
if self.want.type == 'tcp_echo':
|
||||
if self.want.ip is None:
|
||||
return None
|
||||
else:
|
||||
if self.want.ip is None and self.want.port is None:
|
||||
return None
|
||||
if self.want.port is None:
|
||||
self.want.update({'port': self.have.port})
|
||||
if self.want.ip is None:
|
||||
self.want.update({'ip': self.have.ip})
|
||||
if self.want.ip is None and self.want.port is None:
|
||||
return None
|
||||
if self.want.port is None:
|
||||
self.want.update({'port': self.have.port})
|
||||
if self.want.ip is None:
|
||||
self.want.update({'ip': self.have.ip})
|
||||
|
||||
if self.want.port in [None, '*'] and self.want.ip != '*':
|
||||
raise F5ModuleError(
|
||||
"Specifying an IP address requires that a port number be specified"
|
||||
)
|
||||
if self.want.port in [None, '*'] and self.want.ip != '*':
|
||||
raise F5ModuleError(
|
||||
"Specifying an IP address requires that a port number be specified"
|
||||
)
|
||||
|
||||
if self.want.destination != self.have.destination:
|
||||
return self.want.destination
|
||||
|
|
@ -569,26 +401,36 @@ class Difference(object):
|
|||
return attr1
|
||||
|
||||
|
||||
# TODO: Remove all of this in 2.5
|
||||
class ModuleManager(object):
|
||||
def __init__(self, client):
|
||||
self.client = client
|
||||
self.have = None
|
||||
self.want = Parameters(self.client.module.params)
|
||||
self.changes = Parameters()
|
||||
|
||||
def exec_module(self):
|
||||
type = self.client.module.params.get('type', 'tcp')
|
||||
manager = self.get_manager(type)
|
||||
return manager.exec_module()
|
||||
def _set_changed_options(self):
|
||||
changed = {}
|
||||
for key in Parameters.returnables:
|
||||
if getattr(self.want, key) is not None:
|
||||
changed[key] = getattr(self.want, key)
|
||||
if changed:
|
||||
self.changes = Parameters(changed)
|
||||
|
||||
def get_manager(self, type):
|
||||
if type in [None, 'tcp', 'TTYPE_TCP']:
|
||||
return TcpManager(self.client)
|
||||
elif type in ['tcp_echo', 'TTYPE_TCP_ECHO']:
|
||||
return TcpEchoManager(self.client)
|
||||
elif type in ['tcp_half_open', 'TTYPE_TCP_HALF_OPEN']:
|
||||
return TcpHalfOpenManager(self.client)
|
||||
def _update_changed_options(self):
|
||||
diff = Difference(self.want, self.have)
|
||||
updatables = Parameters.updatables
|
||||
changed = dict()
|
||||
for k in updatables:
|
||||
change = diff.compare(k)
|
||||
if change is None:
|
||||
continue
|
||||
else:
|
||||
changed[k] = change
|
||||
if changed:
|
||||
self.changes = Parameters(changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
class BaseManager(object):
|
||||
def _announce_deprecations(self):
|
||||
warnings = []
|
||||
if self.want:
|
||||
|
|
@ -662,37 +504,6 @@ class BaseManager(object):
|
|||
raise F5ModuleError("Failed to delete the monitor.")
|
||||
return True
|
||||
|
||||
|
||||
class TcpManager(BaseManager):
|
||||
def __init__(self, client):
|
||||
self.client = client
|
||||
self.have = None
|
||||
self.want = ParametersTcp(self.client.module.params)
|
||||
self.changes = ParametersTcp()
|
||||
|
||||
def _set_changed_options(self):
|
||||
changed = {}
|
||||
for key in ParametersTcp.returnables:
|
||||
if getattr(self.want, key) is not None:
|
||||
changed[key] = getattr(self.want, key)
|
||||
if changed:
|
||||
self.changes = ParametersTcp(changed)
|
||||
|
||||
def _update_changed_options(self):
|
||||
diff = Difference(self.want, self.have)
|
||||
updatables = ParametersTcp.updatables
|
||||
changed = dict()
|
||||
for k in updatables:
|
||||
change = diff.compare(k)
|
||||
if change is None:
|
||||
continue
|
||||
else:
|
||||
changed[k] = change
|
||||
if changed:
|
||||
self.changes = ParametersTcp(changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
def _set_default_creation_values(self):
|
||||
if self.want.timeout is None:
|
||||
self.want.update({'timeout': 16})
|
||||
|
|
@ -711,7 +522,7 @@ class TcpManager(BaseManager):
|
|||
partition=self.want.partition
|
||||
)
|
||||
result = resource.attrs
|
||||
return ParametersTcp(result)
|
||||
return Parameters(result)
|
||||
|
||||
def exists(self):
|
||||
result = self.client.api.tm.ltm.monitor.tcps.tcp.exists(
|
||||
|
|
@ -745,199 +556,19 @@ class TcpManager(BaseManager):
|
|||
result.delete()
|
||||
|
||||
|
||||
# TODO: Remove this in 2.5 and put it its own module
|
||||
class TcpEchoManager(BaseManager):
|
||||
def __init__(self, client):
|
||||
self.client = client
|
||||
self.have = None
|
||||
self.want = ParametersEcho(self.client.module.params)
|
||||
self.changes = ParametersEcho()
|
||||
|
||||
def _set_default_creation_values(self):
|
||||
if self.want.timeout is None:
|
||||
self.want.update({'timeout': 16})
|
||||
if self.want.interval is None:
|
||||
self.want.update({'interval': 5})
|
||||
if self.want.time_until_up is None:
|
||||
self.want.update({'time_until_up': 0})
|
||||
if self.want.ip is None:
|
||||
self.want.update({'ip': '*'})
|
||||
|
||||
def _set_changed_options(self):
|
||||
changed = {}
|
||||
for key in ParametersEcho.returnables:
|
||||
if getattr(self.want, key) is not None:
|
||||
changed[key] = getattr(self.want, key)
|
||||
if changed:
|
||||
self.changes = ParametersEcho(changed)
|
||||
|
||||
def _update_changed_options(self):
|
||||
diff = Difference(self.want, self.have)
|
||||
updatables = ParametersEcho.updatables
|
||||
changed = dict()
|
||||
for k in updatables:
|
||||
change = diff.compare(k)
|
||||
if change is None:
|
||||
continue
|
||||
else:
|
||||
changed[k] = change
|
||||
if changed:
|
||||
self.changes = ParametersEcho(changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
def read_current_from_device(self):
|
||||
resource = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.load(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
result = resource.attrs
|
||||
return ParametersEcho(result)
|
||||
|
||||
def exists(self):
|
||||
result = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.exists(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
return result
|
||||
|
||||
def update_on_device(self):
|
||||
params = self.want.api_params()
|
||||
result = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.load(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
result.modify(**params)
|
||||
|
||||
def create_on_device(self):
|
||||
params = self.want.api_params()
|
||||
self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.create(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition,
|
||||
**params
|
||||
)
|
||||
|
||||
def remove_from_device(self):
|
||||
result = self.client.api.tm.ltm.monitor.tcp_echos.tcp_echo.load(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
if result:
|
||||
result.delete()
|
||||
|
||||
|
||||
# TODO: Remove this in 2.5 and put it its own module
|
||||
class TcpHalfOpenManager(BaseManager):
|
||||
def __init__(self, client):
|
||||
self.client = client
|
||||
self.have = None
|
||||
self.want = ParametersHalfOpen(self.client.module.params)
|
||||
self.changes = ParametersHalfOpen()
|
||||
|
||||
def _set_changed_options(self):
|
||||
changed = {}
|
||||
for key in ParametersHalfOpen.returnables:
|
||||
if getattr(self.want, key) is not None:
|
||||
changed[key] = getattr(self.want, key)
|
||||
if changed:
|
||||
self.changes = ParametersHalfOpen(changed)
|
||||
|
||||
def _update_changed_options(self):
|
||||
diff = Difference(self.want, self.have)
|
||||
updatables = ParametersHalfOpen.updatables
|
||||
changed = dict()
|
||||
for k in updatables:
|
||||
change = diff.compare(k)
|
||||
if change is None:
|
||||
continue
|
||||
else:
|
||||
changed[k] = change
|
||||
if changed:
|
||||
self.changes = ParametersHalfOpen(changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
def _set_default_creation_values(self):
|
||||
if self.want.timeout is None:
|
||||
self.want.update({'timeout': 16})
|
||||
if self.want.interval is None:
|
||||
self.want.update({'interval': 5})
|
||||
if self.want.time_until_up is None:
|
||||
self.want.update({'time_until_up': 0})
|
||||
if self.want.ip is None:
|
||||
self.want.update({'ip': '*'})
|
||||
if self.want.port is None:
|
||||
self.want.update({'port': '*'})
|
||||
|
||||
def read_current_from_device(self):
|
||||
resource = self.client.api.tm.ltm.monitor.tcp_half_opens.tcp_half_open.load(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
result = resource.attrs
|
||||
return ParametersHalfOpen(result)
|
||||
|
||||
def exists(self):
|
||||
result = self.client.api.tm.ltm.monitor.tcp_half_opens.tcp_half_open.exists(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
return result
|
||||
|
||||
def update_on_device(self):
|
||||
params = self.want.api_params()
|
||||
result = self.client.api.tm.ltm.monitor.tcp_half_opens.tcp_half_open.load(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
result.modify(**params)
|
||||
|
||||
def create_on_device(self):
|
||||
params = self.want.api_params()
|
||||
self.client.api.tm.ltm.monitor.tcp_half_opens.tcp_half_open.create(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition,
|
||||
**params
|
||||
)
|
||||
|
||||
def remove_from_device(self):
|
||||
result = self.client.api.tm.ltm.monitor.tcp_half_opens.tcp_half_open.load(
|
||||
name=self.want.name,
|
||||
partition=self.want.partition
|
||||
)
|
||||
if result:
|
||||
result.delete()
|
||||
|
||||
|
||||
class ArgumentSpec(object):
|
||||
def __init__(self):
|
||||
self.supports_check_mode = True
|
||||
self.argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
|
||||
# Make this assume "tcp" in the partition specified. The user
|
||||
# is required to specify the full path if they want to use a different
|
||||
# partition.
|
||||
parent=dict(default='tcp'),
|
||||
|
||||
parent=dict(default='/Common/tcp'),
|
||||
send=dict(),
|
||||
receive=dict(),
|
||||
ip=dict(),
|
||||
port=dict(type='int'),
|
||||
interval=dict(type='int'),
|
||||
timeout=dict(type='int'),
|
||||
time_until_up=dict(type='int'),
|
||||
|
||||
# Deprecated params
|
||||
type=dict(
|
||||
removed_in_version='2.4',
|
||||
choices=[
|
||||
'tcp', 'TTYPE_TCP', 'TTYPE_TCP_ECHO', 'TTYPE_TCP_HALF_OPEN'
|
||||
]
|
||||
),
|
||||
parent_partition=dict(
|
||||
removed_in_version='2.4'
|
||||
)
|
||||
time_until_up=dict(type='int')
|
||||
)
|
||||
self.f5_product_name = 'bigip'
|
||||
self.mutually_exclusive = [
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue