ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Remove the f5-sdk from snmp community module (#48028)

Browse source
This commit is contained in:
Tim Rupp 2018-11-02 22:28:18 -07:00 committed by GitHub
parent 6b14bab750
commit 45e990c5f8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 257 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

337
lib/ansible/modules/network/f5/bigip_snmp_community.py
View file

@ -147,6 +147,7 @@ options:
extends_documentation_fragment: f5 extends_documentation_fragment: f5
author: author:
- Tim Rupp (@caphrim007) - Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
''' '''
EXAMPLES = r''' EXAMPLES = r'''
@ -157,10 +158,10 @@ EXAMPLES = r'''
source: all source: all
oid: .1 oid: .1
access: ro access: ro
password: secret provider:
server: lb.mydomain.com password: secret
state: present server: lb.mydomain.com
user: admin user: admin
delegate_to: localhost delegate_to: localhost
- name: Create an SMNP v3 read-write community - name: Create an SMNP v3 read-write community
@ -174,61 +175,98 @@ EXAMPLES = r'''
snmp_privacy_password: secret snmp_privacy_password: secret
oid: .1 oid: .1
access: rw access: rw
password: secret provider:
server: lb.mydomain.com password: secret
state: present server: lb.mydomain.com
user: admin user: admin
delegate_to: localhost delegate_to: localhost
- name: Remove the default 'public' SNMP community - name: Remove the default 'public' SNMP community
bigip_snmp_community: bigip_snmp_community:
name: public name: public
source: default source: default
password: secret
server: lb.mydomain.com
state: absent state: absent
user: admin provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost delegate_to: localhost
''' '''
RETURN = r''' RETURN = r'''
param1: community:
description: The new param1 value of the resource. description: The new community value.
returned: changed
type: bool
sample: true
param2:
description: The new param2 value of the resource.
returned: changed returned: changed
type: string type: string
sample: Foo is bar sample: community1
oid:
description: The new OID value.
returned: changed
type: string
sample: .1
ip_version:
description: The new IP version value.
returned: changed
type: string
sample: .1
snmp_auth_protocol:
description: The new SNMP auth protocol.
returned: changed
type: string
sample: sha
snmp_privacy_protocol:
description: The new SNMP privacy protocol.
returned: changed
type: string
sample: aes
access:
description: The new access level for the MIB.
returned: changed
type: string
sample: ro
source:
description: The new source address to access the MIB.
returned: changed
type: string
sample: 1.1.1.1
snmp_username:
description: The new SNMP username.
returned: changed
type: string
sample: user1
snmp_auth_password:
description: The new password of the given snmp_username.
returned: changed
type: string
sample: secret1
snmp_privacy_password:
description: The new password of the given snmp_username.
returned: changed
type: string
sample: secret2
''' '''
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.basic import env_fallback from ansible.module_utils.basic import env_fallback
try: try:
from library.module_utils.network.f5.bigip import HAS_F5SDK from library.module_utils.network.f5.bigip import F5RestClient
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 F5ModuleError
from library.module_utils.network.f5.common import AnsibleF5Parameters 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 cleanup_tokens
from library.module_utils.network.f5.common import f5_argument_spec from library.module_utils.network.f5.common import f5_argument_spec
try: from library.module_utils.network.f5.common import transform_name
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError from library.module_utils.network.f5.common import exit_json
except ImportError: from library.module_utils.network.f5.common import fail_json
HAS_F5SDK = False
except ImportError: except ImportError:
from ansible.module_utils.network.f5.bigip import HAS_F5SDK from ansible.module_utils.network.f5.bigip import F5RestClient
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 F5ModuleError
from ansible.module_utils.network.f5.common import AnsibleF5Parameters 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 cleanup_tokens
from ansible.module_utils.network.f5.common import f5_argument_spec from ansible.module_utils.network.f5.common import f5_argument_spec
try: from ansible.module_utils.network.f5.common import transform_name
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError from ansible.module_utils.network.f5.common import exit_json
except ImportError: from ansible.module_utils.network.f5.common import fail_json
HAS_F5SDK = False
class Parameters(AnsibleF5Parameters): class Parameters(AnsibleF5Parameters):
@ -241,23 +279,48 @@ class Parameters(AnsibleF5Parameters):
'username': 'snmp_username', 'username': 'snmp_username',
'securityLevel': 'security_level', 'securityLevel': 'security_level',
'authPassword': 'snmp_auth_password', 'authPassword': 'snmp_auth_password',
'privacyPassword': 'snmp_privacy_password' 'privacyPassword': 'snmp_privacy_password',
} }
api_attributes = [ api_attributes = [
'source', 'oidSubset', 'ipv6', 'communityName', 'access', 'authPassword', 'source',
'authProtocol', 'username', 'securityLevel', 'privacyProtocol', 'privacyPassword' 'oidSubset',
'ipv6',
'communityName',
'access',
'authPassword',
'authProtocol',
'username',
'securityLevel',
'privacyProtocol',
'privacyPassword',
] ]
returnables = [ returnables = [
'community', 'oid', 'ip_version', 'snmp_auth_protocol', 'snmp_privacy_protocol', 'community',
'access', 'source', 'snmp_username', 'snmp_auth_password', 'snmp_privacy_password' 'oid',
'ip_version',
'snmp_auth_protocol',
'snmp_privacy_protocol',
'access',
'source',
'snmp_username',
'snmp_auth_password',
'snmp_privacy_password',
] ]
updatables = [ updatables = [
'community', 'oid', 'ip_version', 'snmp_auth_protocol', 'snmp_privacy_protocol', 'community',
'access', 'source', 'snmp_auth_password', 'snmp_privacy_password', 'security_level', 'oid',
'snmp_username' 'ip_version',
'snmp_auth_protocol',
'snmp_privacy_protocol',
'access',
'source',
'snmp_auth_password',
'snmp_privacy_password',
'security_level',
'snmp_username',
] ]
@property @property
@ -499,13 +562,10 @@ class BaseManager(object):
result = dict() result = dict()
state = self.want.state state = self.want.state
try: if state == "present":
if state == "present": changed = self.present()
changed = self.present() elif state == "absent":
elif state == "absent": changed = self.absent()
changed = self.absent()
except iControlUnexpectedHTTPError as e:
raise F5ModuleError(str(e))
reportable = ReportableChanges(params=self.changes.to_return()) reportable = ReportableChanges(params=self.changes.to_return())
changes = reportable.to_return() changes = reportable.to_return()
@ -571,43 +631,87 @@ class V1Manager(BaseManager):
return True return True
def exists(self): def exists(self):
result = self.client.api.tm.sys.snmp.communities_s.community.exists( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/communities/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
return result resp = self.client.api.get(uri)
try:
response = resp.json()
except ValueError:
return False
if resp.status == 404 or 'code' in response and response['code'] == 404:
return False
return True
def create_on_device(self): def create_on_device(self):
params = self.changes.api_params() params = self.changes.api_params()
self.client.api.tm.sys.snmp.communities_s.community.create( params['name'] = self.want.name
name=self.want.name, params['partition'] = self.want.partition
partition=self.want.partition, uri = "https://{0}:{1}/mgmt/tm/sys/snmp/communities/".format(
**params self.client.provider['server'],
self.client.provider['server_port'],
) )
resp = self.client.api.post(uri, json=params)
try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))
if 'code' in response and response['code'] in [400, 403]:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
def update_on_device(self): def update_on_device(self):
params = self.changes.api_params() params = self.changes.api_params()
resource = self.client.api.tm.sys.snmp.communities_s.community.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/communities/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
resource.modify(**params) resp = self.client.api.patch(uri, json=params)
try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))
if 'code' in response and response['code'] == 400:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
def remove_from_device(self): def remove_from_device(self):
resource = self.client.api.tm.sys.snmp.communities_s.community.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/communities/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
if resource: resp = self.client.api.delete(uri)
resource.delete() if resp.status == 200:
return True
def read_current_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.sys.snmp.communities_s.community.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/communities/{2}".format(
name=self.want.name, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.name)
) )
result = resource.attrs resp = self.client.api.get(uri)
return ApiParameters(params=result) try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))
if 'code' in response and response['code'] == 400:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
return ApiParameters(params=response)
class V2Manager(BaseManager): class V2Manager(BaseManager):
@ -648,43 +752,87 @@ class V2Manager(BaseManager):
return True return True
def exists(self): def exists(self):
result = self.client.api.tm.sys.snmp.users_s.user.exists( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/users/{2}".format(
name=self.want.snmp_username, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.snmp_username)
) )
return result resp = self.client.api.get(uri)
try:
response = resp.json()
except ValueError:
return False
if resp.status == 404 or 'code' in response and response['code'] == 404:
return False
return True
def create_on_device(self): def create_on_device(self):
params = self.changes.api_params() params = self.changes.api_params()
self.client.api.tm.sys.snmp.users_s.user.create( params['name'] = self.want.snmp_username
name=self.want.snmp_username, params['partition'] = self.want.partition
partition=self.want.partition, uri = "https://{0}:{1}/mgmt/tm/sys/snmp/users/".format(
**params self.client.provider['server'],
self.client.provider['server_port'],
) )
resp = self.client.api.post(uri, json=params)
try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))
if 'code' in response and response['code'] in [400, 403]:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
def update_on_device(self): def update_on_device(self):
params = self.changes.api_params() params = self.changes.api_params()
resource = self.client.api.tm.sys.snmp.users_s.user.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/users/{2}".format(
name=self.want.snmp_username, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.snmp_username)
) )
resource.modify(**params) resp = self.client.api.patch(uri, json=params)
try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))
if 'code' in response and response['code'] == 400:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
def remove_from_device(self): def remove_from_device(self):
resource = self.client.api.tm.sys.snmp.users_s.user.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/users/{2}".format(
name=self.want.snmp_username, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.snmp_username)
) )
if resource: resp = self.client.api.delete(uri)
resource.delete() if resp.status == 200:
return True
def read_current_from_device(self): def read_current_from_device(self):
resource = self.client.api.tm.sys.snmp.users_s.user.load( uri = "https://{0}:{1}/mgmt/tm/sys/snmp/users/{2}".format(
name=self.want.snmp_username, self.client.provider['server'],
partition=self.want.partition self.client.provider['server_port'],
transform_name(self.want.partition, self.want.snmp_username)
) )
result = resource.attrs resp = self.client.api.get(uri)
return ApiParameters(params=result) try:
response = resp.json()
except ValueError as ex:
raise F5ModuleError(str(ex))
if 'code' in response and response['code'] == 400:
if 'message' in response:
raise F5ModuleError(response['message'])
else:
raise F5ModuleError(resp.content)
return ApiParameters(params=response)
class ArgumentSpec(object): class ArgumentSpec(object):
@ -743,18 +891,17 @@ def main():
supports_check_mode=spec.supports_check_mode, supports_check_mode=spec.supports_check_mode,
required_if=spec.required_if required_if=spec.required_if
) )
if not HAS_F5SDK:
module.fail_json(msg="The python f5-sdk module is required") client = F5RestClient(**module.params)
try: try:
client = F5Client(**module.params)
mm = ModuleManager(module=module, client=client) mm = ModuleManager(module=module, client=client)
results = mm.exec_module() results = mm.exec_module()
cleanup_tokens(client) cleanup_tokens(client)
module.exit_json(**results) exit_json(module, results, client)
except F5ModuleError as ex: except F5ModuleError as ex:
cleanup_tokens(client) cleanup_tokens(client)
module.fail_json(msg=str(ex)) fail_json(module, ex, client)
if __name__ == '__main__': if __name__ == '__main__':

21
test/units/modules/network/f5/test_bigip_snmp_community.py
View file

@ -15,9 +15,6 @@ from nose.plugins.skip import SkipTest
if sys.version_info < (2, 7): if sys.version_info < (2, 7):
raise SkipTest("F5 Ansible modules require Python >= 2.7") raise SkipTest("F5 Ansible modules require Python >= 2.7")
from units.compat import unittest
from units.compat.mock import Mock
from units.compat.mock import patch
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
try: try:
@ -27,9 +24,15 @@ try:
from library.modules.bigip_snmp_community import V1Manager from library.modules.bigip_snmp_community import V1Manager
from library.modules.bigip_snmp_community import V2Manager from library.modules.bigip_snmp_community import V2Manager
from library.modules.bigip_snmp_community import ArgumentSpec from library.modules.bigip_snmp_community import ArgumentSpec
from library.module_utils.network.f5.common import F5ModuleError from library.module_utils.network.f5.common import F5ModuleError
from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
from test.unit.modules.utils import set_module_args # In Ansible 2.8, Ansible changed import paths.
from test.units.compat import unittest
from test.units.compat.mock import Mock
from test.units.compat.mock import patch
from test.units.modules.utils import set_module_args
except ImportError: except ImportError:
try: try:
from ansible.modules.network.f5.bigip_snmp_community import ApiParameters from ansible.modules.network.f5.bigip_snmp_community import ApiParameters
@ -38,8 +41,14 @@ except ImportError:
from ansible.modules.network.f5.bigip_snmp_community import V1Manager from ansible.modules.network.f5.bigip_snmp_community import V1Manager
from ansible.modules.network.f5.bigip_snmp_community import V2Manager from ansible.modules.network.f5.bigip_snmp_community import V2Manager
from ansible.modules.network.f5.bigip_snmp_community import ArgumentSpec from ansible.modules.network.f5.bigip_snmp_community import ArgumentSpec
from ansible.module_utils.network.f5.common import F5ModuleError from ansible.module_utils.network.f5.common import F5ModuleError
from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
# Ansible 2.8 imports
from units.compat import unittest
from units.compat.mock import Mock
from units.compat.mock import patch
from units.modules.utils import set_module_args from units.modules.utils import set_module_args
except ImportError: except ImportError:
raise SkipTest("F5 Ansible modules require the f5-sdk Python library") raise SkipTest("F5 Ansible modules require the f5-sdk Python library")