mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-22 00:00:22 -07:00
Fixes coding conventions, adds a small feature (#39211)
Fixes some coding conventions and adds allowed_addresses to bigip_snmp_trap.
This commit is contained in:
Tim Rupp
GitHub
parent
39e4754fc9
commit
3227143dc8
8 changed files with 430 additions and 132 deletions
|
|
@ -19,6 +19,16 @@ description:
|
|||
- Manipulate general SNMP settings on a BIG-IP.
|
||||
version_added: 2.4
|
||||
options:
|
||||
allowed_addresses:
|
||||
description:
|
||||
- Configures the IP addresses of the SNMP clients from which the snmpd
|
||||
daemon accepts requests.
|
||||
- This value can be hostnames, IP addresses, or IP networks.
|
||||
- You may specify a single list item of C(default) to set the value back
|
||||
to the system's default of C(127.0.0.0/8).
|
||||
- You can remove all allowed addresses by either providing the word C(none), or
|
||||
by providing the empty string C("").
|
||||
version_added: 2.6
|
||||
contact:
|
||||
description:
|
||||
- Specifies the name of the person who administers the SNMP
|
||||
|
|
@ -51,6 +61,11 @@ options:
|
|||
description:
|
||||
- Specifies the description of this system's physical location.
|
||||
extends_documentation_fragment: f5
|
||||
notes:
|
||||
- Requires the netaddr Python package on the host. This is as easy as
|
||||
C(pip install netaddr).
|
||||
requirements:
|
||||
- netaddr
|
||||
author:
|
||||
- Tim Rupp (@caphrim007)
|
||||
'''
|
||||
|
|
@ -101,40 +116,49 @@ location:
|
|||
returned: changed
|
||||
type: string
|
||||
sample: US West 1a
|
||||
allowed_addresses:
|
||||
description: The new allowed addresses for SNMP client connections.
|
||||
returned: changed
|
||||
type: list
|
||||
sample: ['127.0.0.0/8', 'foo.bar.com', '10.10.10.10']
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
HAS_DEVEL_IMPORTS = False
|
||||
from ansible.module_utils.six import string_types
|
||||
|
||||
try:
|
||||
# Sideband repository used for dev
|
||||
from library.module_utils.network.f5.bigip import HAS_F5SDK
|
||||
from library.module_utils.network.f5.bigip import F5Client
|
||||
from library.module_utils.network.f5.common import F5ModuleError
|
||||
from library.module_utils.network.f5.common import AnsibleF5Parameters
|
||||
from library.module_utils.network.f5.common import cleanup_tokens
|
||||
from library.module_utils.network.f5.common import fqdn_name
|
||||
from library.module_utils.network.f5.common import is_valid_hostname
|
||||
from library.module_utils.network.f5.common import f5_argument_spec
|
||||
|
||||
try:
|
||||
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
|
||||
except ImportError:
|
||||
HAS_F5SDK = False
|
||||
HAS_DEVEL_IMPORTS = True
|
||||
except ImportError:
|
||||
# Upstream Ansible
|
||||
from ansible.module_utils.network.f5.bigip import HAS_F5SDK
|
||||
from ansible.module_utils.network.f5.bigip import F5Client
|
||||
from ansible.module_utils.network.f5.common import F5ModuleError
|
||||
from ansible.module_utils.network.f5.common import AnsibleF5Parameters
|
||||
from ansible.module_utils.network.f5.common import cleanup_tokens
|
||||
from ansible.module_utils.network.f5.common import fqdn_name
|
||||
from ansible.module_utils.network.f5.common import is_valid_hostname
|
||||
from ansible.module_utils.network.f5.common import f5_argument_spec
|
||||
|
||||
try:
|
||||
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
|
||||
except ImportError:
|
||||
HAS_F5SDK = False
|
||||
|
||||
try:
|
||||
import netaddr
|
||||
HAS_NETADDR = True
|
||||
except ImportError:
|
||||
HAS_NETADDR = False
|
||||
|
||||
|
||||
class Parameters(AnsibleF5Parameters):
|
||||
api_map = {
|
||||
|
|
@ -142,21 +166,23 @@ class Parameters(AnsibleF5Parameters):
|
|||
'authTrap': 'agent_authentication_traps',
|
||||
'bigipTraps': 'device_warning_traps',
|
||||
'sysLocation': 'location',
|
||||
'sysContact': 'contact'
|
||||
'sysContact': 'contact',
|
||||
'allowedAddresses': 'allowed_addresses'
|
||||
}
|
||||
|
||||
updatables = [
|
||||
'agent_status_traps', 'agent_authentication_traps',
|
||||
'device_warning_traps', 'location', 'contact'
|
||||
'device_warning_traps', 'location', 'contact', 'allowed_addresses'
|
||||
]
|
||||
|
||||
returnables = [
|
||||
'agent_status_traps', 'agent_authentication_traps',
|
||||
'device_warning_traps', 'location', 'contact'
|
||||
'device_warning_traps', 'location', 'contact', 'allowed_addresses'
|
||||
]
|
||||
|
||||
api_attributes = [
|
||||
'agentTrap', 'authTrap', 'bigipTraps', 'sysLocation', 'sysContact'
|
||||
'agentTrap', 'authTrap', 'bigipTraps', 'sysLocation', 'sysContact',
|
||||
'allowedAddresses'
|
||||
]
|
||||
|
||||
def to_return(self):
|
||||
|
|
@ -167,28 +193,121 @@ class Parameters(AnsibleF5Parameters):
|
|||
return result
|
||||
|
||||
|
||||
class ApiParameters(Parameters):
|
||||
@property
|
||||
def allowed_addresses(self):
|
||||
if self._values['allowed_addresses'] is None:
|
||||
return None
|
||||
result = list(set(self._values['allowed_addresses']))
|
||||
result.sort()
|
||||
return result
|
||||
|
||||
|
||||
class ModuleParameters(Parameters):
|
||||
@property
|
||||
def allowed_addresses(self):
|
||||
if self._values['allowed_addresses'] is None:
|
||||
return None
|
||||
result = []
|
||||
addresses = self._values['allowed_addresses']
|
||||
if isinstance(addresses, string_types):
|
||||
if addresses in ['', 'none']:
|
||||
return []
|
||||
else:
|
||||
addresses = [addresses]
|
||||
if len(addresses) == 1 and addresses[0] in ['default', '']:
|
||||
result = ['127.0.0.0/8']
|
||||
return result
|
||||
for address in addresses:
|
||||
try:
|
||||
# Check for valid IPv4 or IPv6 entries
|
||||
netaddr.IPNetwork(address)
|
||||
result.append(address)
|
||||
except netaddr.core.AddrFormatError:
|
||||
# else fallback to checking reasonably well formatted hostnames
|
||||
if is_valid_hostname(address):
|
||||
result.append(str(address))
|
||||
continue
|
||||
raise F5ModuleError(
|
||||
"The provided 'allowed_address' value {0} is not a valid IP or hostname".format(address)
|
||||
)
|
||||
result = list(set(result))
|
||||
result.sort()
|
||||
return result
|
||||
|
||||
|
||||
class Changes(Parameters):
|
||||
pass
|
||||
|
||||
|
||||
class UsableChanges(Changes):
|
||||
pass
|
||||
|
||||
|
||||
class ReportableChanges(Changes):
|
||||
pass
|
||||
|
||||
|
||||
class Difference(object):
|
||||
def __init__(self, want, have=None):
|
||||
self.want = want
|
||||
self.have = have
|
||||
|
||||
def compare(self, param):
|
||||
try:
|
||||
result = getattr(self, param)
|
||||
return result
|
||||
except AttributeError:
|
||||
return self.__default(param)
|
||||
|
||||
def __default(self, param):
|
||||
attr1 = getattr(self.want, param)
|
||||
try:
|
||||
attr2 = getattr(self.have, param)
|
||||
if attr1 != attr2:
|
||||
return attr1
|
||||
except AttributeError:
|
||||
return attr1
|
||||
|
||||
@property
|
||||
def allowed_addresses(self):
|
||||
if self.want.allowed_addresses is None:
|
||||
return None
|
||||
if self.have.allowed_addresses is None:
|
||||
if self.want.allowed_addresses:
|
||||
return self.want.allowed_addresses
|
||||
return None
|
||||
want = set(self.want.allowed_addresses)
|
||||
have = set(self.have.allowed_addresses)
|
||||
if want != have:
|
||||
result = list(want)
|
||||
result.sort()
|
||||
return result
|
||||
|
||||
|
||||
class ModuleManager(object):
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.module = kwargs.get('module', None)
|
||||
self.client = kwargs.get('client', None)
|
||||
self.have = None
|
||||
self.want = Parameters(params=self.module.params)
|
||||
self.changes = Changes()
|
||||
self.have = ApiParameters()
|
||||
self.want = ModuleParameters(params=self.module.params)
|
||||
self.changes = UsableChanges()
|
||||
|
||||
def _update_changed_options(self):
|
||||
changed = {}
|
||||
for key in Parameters.updatables:
|
||||
if getattr(self.want, key) is not None:
|
||||
attr1 = getattr(self.want, key)
|
||||
attr2 = getattr(self.have, key)
|
||||
if attr1 != attr2:
|
||||
changed[key] = attr1
|
||||
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:
|
||||
if isinstance(change, dict):
|
||||
changed.update(change)
|
||||
else:
|
||||
changed[k] = change
|
||||
if changed:
|
||||
self.changes = Changes(params=changed)
|
||||
self.changes = UsableChanges(params=changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
|
|
@ -200,11 +319,21 @@ class ModuleManager(object):
|
|||
except iControlUnexpectedHTTPError as e:
|
||||
raise F5ModuleError(str(e))
|
||||
|
||||
changes = self.changes.to_return()
|
||||
reportable = ReportableChanges(params=self.changes.to_return())
|
||||
changes = reportable.to_return()
|
||||
result.update(**changes)
|
||||
result.update(dict(changed=changed))
|
||||
self._announce_deprecations(result)
|
||||
return result
|
||||
|
||||
def _announce_deprecations(self, result):
|
||||
warnings = result.pop('__warnings', [])
|
||||
for warning in warnings:
|
||||
self.module.deprecate(
|
||||
msg=warning['msg'],
|
||||
version=warning['version']
|
||||
)
|
||||
|
||||
def should_update(self):
|
||||
result = self._update_changed_options()
|
||||
if result:
|
||||
|
|
@ -228,7 +357,7 @@ class ModuleManager(object):
|
|||
def read_current_from_device(self):
|
||||
resource = self.client.api.tm.sys.snmp.load()
|
||||
result = resource.attrs
|
||||
return Parameters(params=result)
|
||||
return ApiParameters(params=result)
|
||||
|
||||
|
||||
class ArgumentSpec(object):
|
||||
|
|
@ -246,7 +375,8 @@ class ArgumentSpec(object):
|
|||
device_warning_traps=dict(
|
||||
choices=self.choices
|
||||
),
|
||||
location=dict()
|
||||
location=dict(),
|
||||
allowed_addresses=dict(type='raw')
|
||||
)
|
||||
self.argument_spec = {}
|
||||
self.argument_spec.update(f5_argument_spec)
|
||||
|
|
@ -262,6 +392,8 @@ def main():
|
|||
)
|
||||
if not HAS_F5SDK:
|
||||
module.fail_json(msg="The python f5-sdk module is required")
|
||||
if not HAS_NETADDR:
|
||||
module.fail_json(msg="The python netaddr module is required")
|
||||
|
||||
try:
|
||||
client = F5Client(**module.params)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue