mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Adds the bigip_snmp module (#25668)
This patch adds a module for managing several snmp related settings on a BIG-IP that are required when configuring the range of SNMP settings on a device. Unit tests are provided. Integration tests can be found here https://github.com/F5Networks/f5-ansible/blob/devel/test/integration/bigip_snmp.yaml#L23 https://github.com/F5Networks/f5-ansible/tree/devel/test/integration/targets/bigip_snmp/tasks
This commit is contained in:
Tim Rupp
John R Barker
parent
478d364f4d
commit
ba12ce64b0
2 changed files with 455 additions and 0 deletions
284
lib/ansible/modules/network/f5/bigip_snmp.py
Normal file
284
lib/ansible/modules/network/f5/bigip_snmp.py
Normal file
|
|
@ -0,0 +1,284 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# Copyright 2017 F5 Networks Inc.
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
ANSIBLE_METADATA = {
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community',
|
||||
'metadata_version': '1.0'
|
||||
}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: bigip_snmp
|
||||
short_description: Manipulate general SNMP settings on a BIG-IP.
|
||||
description:
|
||||
- Manipulate general SNMP settings on a BIG-IP.
|
||||
version_added: 2.4
|
||||
options:
|
||||
contact:
|
||||
description:
|
||||
- Specifies the name of the person who administers the SNMP
|
||||
service for this system.
|
||||
agent_status_traps:
|
||||
description:
|
||||
- When C(enabled), ensures that the system sends a trap whenever the
|
||||
SNMP agent starts running or stops running. This is usually enabled
|
||||
by default on a BIG-IP.
|
||||
choices:
|
||||
- enabled
|
||||
- disabled
|
||||
agent_authentication_traps:
|
||||
description:
|
||||
- When C(enabled), ensures that the system sends authentication warning
|
||||
traps to the trap destinations. This is usually disabled by default on
|
||||
a BIG-IP.
|
||||
choices:
|
||||
- enabled
|
||||
- disabled
|
||||
device_warning_traps:
|
||||
description:
|
||||
- When C(enabled), ensures that the system sends device warning traps
|
||||
to the trap destinations. This is usually enabled by default on a
|
||||
BIG-IP.
|
||||
choices:
|
||||
- enabled
|
||||
- disabled
|
||||
location:
|
||||
description:
|
||||
- Specifies the description of this system's physical location.
|
||||
notes:
|
||||
- Requires the f5-sdk Python package on the host. This is as easy as pip
|
||||
install f5-sdk.
|
||||
extends_documentation_fragment: f5
|
||||
requirements:
|
||||
- f5-sdk >= 2.2.0
|
||||
author:
|
||||
- Tim Rupp (@caphrim007)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Set snmp contact
|
||||
bigip_snmp:
|
||||
contact: "Joe User"
|
||||
password: "secret"
|
||||
server: "lb.mydomain.com"
|
||||
user: "admin"
|
||||
validate_certs: "false"
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Set snmp location
|
||||
bigip_snmp:
|
||||
location: "US West 1"
|
||||
password: "secret"
|
||||
server: "lb.mydomain.com"
|
||||
user: "admin"
|
||||
validate_certs: "false"
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
agent_status_traps:
|
||||
description: Value that the agent status traps was set to.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: "enabled"
|
||||
agent_authentication_traps:
|
||||
description: Value that the authentication status traps was set to.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: "enabled"
|
||||
device_warning_traps:
|
||||
description: Value that the warning status traps was set to.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: "enabled"
|
||||
contact:
|
||||
description: The new value for the person who administers SNMP on the device.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: Joe User
|
||||
location:
|
||||
description: The new value for the system's physical location.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: "US West 1a"
|
||||
'''
|
||||
|
||||
from ansible.module_utils.f5_utils import (
|
||||
AnsibleF5Client,
|
||||
AnsibleF5Parameters,
|
||||
HAS_F5SDK,
|
||||
F5ModuleError,
|
||||
iControlUnexpectedHTTPError
|
||||
)
|
||||
|
||||
|
||||
class Parameters(AnsibleF5Parameters):
|
||||
api_map = {
|
||||
'agentTrap': 'agent_status_traps',
|
||||
'authTrap': 'agent_authentication_traps',
|
||||
'bigipTraps': 'device_warning_traps',
|
||||
'sysLocation': 'location',
|
||||
'sysContact': 'contact'
|
||||
}
|
||||
|
||||
updatables = [
|
||||
'agent_status_traps', 'agent_authentication_traps',
|
||||
'device_warning_traps', 'location', 'contact'
|
||||
]
|
||||
|
||||
returnables = [
|
||||
'agent_status_traps', 'agent_authentication_traps',
|
||||
'device_warning_traps', 'location', 'contact'
|
||||
]
|
||||
|
||||
api_attributes = [
|
||||
'agentTrap', 'authTrap', 'bigipTraps', 'sysLocation', 'sysContact'
|
||||
]
|
||||
|
||||
def to_return(self):
|
||||
result = {}
|
||||
for returnable in self.returnables:
|
||||
result[returnable] = getattr(self, returnable)
|
||||
result = self._filter_params(result)
|
||||
return result
|
||||
|
||||
def api_params(self):
|
||||
result = {}
|
||||
for api_attribute in self.api_attributes:
|
||||
if self.api_map is not None and api_attribute in self.api_map:
|
||||
result[api_attribute] = getattr(self, self.api_map[api_attribute])
|
||||
else:
|
||||
result[api_attribute] = getattr(self, api_attribute)
|
||||
result = self._filter_params(result)
|
||||
return result
|
||||
|
||||
|
||||
class ModuleManager(object):
|
||||
def __init__(self, client):
|
||||
self.client = client
|
||||
self.have = None
|
||||
self.want = Parameters(self.client.module.params)
|
||||
self.changes = Parameters()
|
||||
|
||||
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
|
||||
if changed:
|
||||
self.changes = Parameters(changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
def exec_module(self):
|
||||
result = dict()
|
||||
|
||||
try:
|
||||
changed = self.update()
|
||||
except iControlUnexpectedHTTPError as e:
|
||||
raise F5ModuleError(str(e))
|
||||
|
||||
changes = self.changes.to_return()
|
||||
result.update(**changes)
|
||||
result.update(dict(changed=changed))
|
||||
return result
|
||||
|
||||
def should_update(self):
|
||||
result = self._update_changed_options()
|
||||
if result:
|
||||
return True
|
||||
return False
|
||||
|
||||
def update(self):
|
||||
self.have = self.read_current_from_device()
|
||||
if not self.should_update():
|
||||
return False
|
||||
if self.client.check_mode:
|
||||
return True
|
||||
self.update_on_device()
|
||||
return True
|
||||
|
||||
def update_on_device(self):
|
||||
params = self.want.api_params()
|
||||
result = self.client.api.tm.sys.snmp.load()
|
||||
result.modify(**params)
|
||||
|
||||
def read_current_from_device(self):
|
||||
resource = self.client.api.tm.sys.snmp.load()
|
||||
result = resource.attrs
|
||||
return Parameters(result)
|
||||
|
||||
|
||||
class ArgumentSpec(object):
|
||||
def __init__(self):
|
||||
self.supports_check_mode = True
|
||||
self.choices = ['enabled', 'disabled']
|
||||
self.argument_spec = dict(
|
||||
contact=dict(
|
||||
required=False,
|
||||
default=None
|
||||
),
|
||||
agent_status_traps=dict(
|
||||
required=False,
|
||||
default=None,
|
||||
choices=self.choices
|
||||
),
|
||||
agent_authentication_traps=dict(
|
||||
required=False,
|
||||
default=None,
|
||||
choices=self.choices
|
||||
),
|
||||
device_warning_traps=dict(
|
||||
required=False,
|
||||
default=None,
|
||||
choices=self.choices
|
||||
),
|
||||
location=dict(
|
||||
required=False,
|
||||
default=None
|
||||
)
|
||||
)
|
||||
self.f5_product_name = 'bigip'
|
||||
|
||||
|
||||
def main():
|
||||
if not HAS_F5SDK:
|
||||
raise F5ModuleError("The python f5-sdk module is required")
|
||||
|
||||
spec = ArgumentSpec()
|
||||
|
||||
client = AnsibleF5Client(
|
||||
argument_spec=spec.argument_spec,
|
||||
supports_check_mode=spec.supports_check_mode,
|
||||
f5_product_name=spec.f5_product_name
|
||||
)
|
||||
|
||||
try:
|
||||
mm = ModuleManager(client)
|
||||
results = mm.exec_module()
|
||||
client.module.exit_json(**results)
|
||||
except F5ModuleError as e:
|
||||
client.module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue