diff options
Diffstat (limited to 'lib/ansible/modules/network/f5/bigip_cli_alias.py')
| -rw-r--r-- | lib/ansible/modules/network/f5/bigip_cli_alias.py | 418 |
1 files changed, 0 insertions, 418 deletions
diff --git a/lib/ansible/modules/network/f5/bigip_cli_alias.py b/lib/ansible/modules/network/f5/bigip_cli_alias.py deleted file mode 100644 index 656f85d0da..0000000000 --- a/lib/ansible/modules/network/f5/bigip_cli_alias.py +++ /dev/null @@ -1,418 +0,0 @@ -#!/usr/bin/python -# -*- coding: utf-8 -*- -# -# Copyright: (c) 2018, F5 Networks Inc. -# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - -from __future__ import absolute_import, division, print_function -__metaclass__ = type - - -ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], - 'supported_by': 'certified'} - -DOCUMENTATION = r''' ---- -module: bigip_cli_alias -short_description: Manage CLI aliases on a BIG-IP -description: - - Allows for managing both private and shared aliases on a BIG-IP. -version_added: 2.7 -options: - name: - description: - - Specifies the name of the alias. - type: str - required: True - scope: - description: - - The scope of the alias; whether it is shared on the system, or usable only - for the user who created it. - type: str - default: shared - choices: - - private - - shared - command: - description: - - The command to alias. - type: str - description: - description: - - Description of the alias. - type: str - partition: - description: - - Device partition to manage resources on. - - This parameter is disregarded when the C(scope) is C(private). - type: str - default: Common - state: - description: - - When C(present), ensures that the resource exists. - - When C(absent), ensures the resource is removed. - type: str - default: present - choices: - - present - - absent -extends_documentation_fragment: f5 -author: - - Tim Rupp (@caphrim007) - - Wojciech Wypior (@wojtek0806) -''' - -EXAMPLES = r''' -- name: Create a new alias - bigip_cli_alias: - name: sync_device_to_bside - scope: shared - command: save /sys config partitions all; run /cm config-sync to-group device-group-1 - provider: - password: secret - server: lb.mydomain.com - user: admin - delegate_to: localhost -''' - -RETURN = r''' -command: - description: The new command that is aliased. - returned: changed - type: str - sample: run /util bash -description: - description: The new description of the alias. - returned: changed - type: str - sample: Run the bash shell -''' - -from ansible.module_utils.basic import AnsibleModule -from ansible.module_utils.basic import env_fallback - -try: - from library.module_utils.network.f5.bigip import F5RestClient - 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 f5_argument_spec - from library.module_utils.network.f5.common import transform_name -except ImportError: - from ansible.module_utils.network.f5.bigip import F5RestClient - 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 f5_argument_spec - from ansible.module_utils.network.f5.common import transform_name - - -class Parameters(AnsibleF5Parameters): - api_map = { - 'tmCommand': 'command' - } - - api_attributes = [ - 'tmCommand', - 'description', - ] - - returnables = [ - 'command', - 'description', - ] - - updatables = [ - 'command', - 'description', - ] - - @property - def full_name(self): - if self.scope == 'shared': - return transform_name(self.partition, self.name) - else: - return self.name - - -class ApiParameters(Parameters): - pass - - -class ModuleParameters(Parameters): - pass - - -class Changes(Parameters): - def to_return(self): - result = {} - try: - for returnable in self.returnables: - result[returnable] = getattr(self, returnable) - result = self._filter_params(result) - except Exception: - pass - return result - - -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 - - -class ModuleManager(object): - def __init__(self, *args, **kwargs): - self.module = kwargs.get('module', None) - self.client = F5RestClient(**self.module.params) - self.want = ModuleParameters(params=self.module.params) - self.have = ApiParameters() - self.changes = UsableChanges() - - 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 = UsableChanges(params=changed) - - 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: - if isinstance(change, dict): - changed.update(change) - else: - changed[k] = change - if changed: - self.changes = UsableChanges(params=changed) - return True - return False - - def should_update(self): - result = self._update_changed_options() - if result: - return True - return False - - def exec_module(self): - changed = False - result = dict() - state = self.want.state - - if state == "present": - changed = self.present() - elif state == "absent": - changed = self.absent() - - 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.client.module.deprecate( - msg=warning['msg'], - version=warning['version'] - ) - - def present(self): - if self.exists(): - return self.update() - else: - return self.create() - - def exists(self): - uri = "https://{0}:{1}/mgmt/tm/cli/alias/{2}/{3}".format( - self.client.provider['server'], - self.client.provider['server_port'], - self.want.scope, - self.want.full_name - ) - 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 update(self): - self.have = self.read_current_from_device() - if not self.should_update(): - return False - if self.module.check_mode: - return True - self.update_on_device() - return True - - def remove(self): - if self.module.check_mode: - return True - self.remove_from_device() - if self.exists(): - raise F5ModuleError("Failed to delete the resource.") - return True - - def create(self): - self._set_changed_options() - if self.module.check_mode: - return True - self.create_on_device() - return True - - def create_on_device(self): - params = self.changes.api_params() - params['name'] = self.want.name - params['partition'] = self.want.partition - uri = "https://{0}:{1}/mgmt/tm/cli/alias/{2}/".format( - self.client.provider['server'], - self.client.provider['server_port'], - self.want.scope - ) - 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): - params = self.changes.api_params() - uri = "https://{0}:{1}/mgmt/tm/cli/alias/{2}/{3}".format( - self.client.provider['server'], - self.client.provider['server_port'], - self.want.scope, - self.want.full_name - ) - 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 absent(self): - if self.exists(): - return self.remove() - return False - - def remove_from_device(self): - uri = "https://{0}:{1}/mgmt/tm/cli/alias/{2}/{3}".format( - self.client.provider['server'], - self.client.provider['server_port'], - self.want.scope, - self.want.full_name - ) - resp = self.client.api.delete(uri) - if resp.status == 200: - return True - - def read_current_from_device(self): - uri = "https://{0}:{1}/mgmt/tm/cli/alias/{2}/{3}".format( - self.client.provider['server'], - self.client.provider['server_port'], - self.want.scope, - self.want.full_name - ) - resp = self.client.api.get(uri) - 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): - def __init__(self): - self.supports_check_mode = True - argument_spec = dict( - name=dict(required=True), - scope=dict( - choices=['private', 'shared'], - default='shared' - ), - description=dict(), - command=dict(), - state=dict( - default='present', - choices=['present', 'absent'] - ), - partition=dict( - default='Common', - fallback=(env_fallback, ['F5_PARTITION']) - ) - ) - self.argument_spec = {} - self.argument_spec.update(f5_argument_spec) - self.argument_spec.update(argument_spec) - - -def main(): - spec = ArgumentSpec() - - module = AnsibleModule( - argument_spec=spec.argument_spec, - supports_check_mode=spec.supports_check_mode, - ) - - try: - mm = ModuleManager(module=module) - results = mm.exec_module() - module.exit_json(**results) - except F5ModuleError as ex: - module.fail_json(msg=str(ex)) - - -if __name__ == '__main__': - main() |