zahodi.ansible-mikrotik/library/mt_system.py

# -*- coding: utf-8 -*-
DOCUMENTATION = '''
module: mt_system.py
author:
  - "Valentin Gurmeza"
version_added: "2.4"
short_description: Manage mikrotik system endpoints
requirements:
  - mt_api
description:
  - manage mikrotik system parameters
options:
  hostname:
    description:
      - hotstname of mikrotik router
    required: True
  username:
    description:
      - username used to connect to mikrotik router
    required: True
  password:
    description:
      - password used for authentication to mikrotik router
    required: True
  parameter:
    description:
      - sub enpoint for mikrotik system
    required: True
    options:
      - ntp_client
      - clock
      - logging
      - routerboard
      - identity
  settings:
    description:
      - All Mikrotik compatible parameters for this particular endpoint.
        Any yes/no values must be enclosed in double quotes
  state:
    description:
      - absent or present
'''

EXAMPLES = '''
- mt_system:
    hostname:    "{{ inventory_hostname }}"
    username:    "{{ mt_user }}"
    password:    "{{ mt_pass }}"
    parameter:   identity
    settings:
        name:    test_ansible
'''

from mt_common import clean_params, MikrotikIdempotent
from ansible.module_utils.basic import AnsibleModule



def main():
    module = AnsibleModule(
        argument_spec = dict(
            hostname  = dict(required=True),
            username  = dict(required=True),
            password  = dict(required=True),
            settings  = dict(required=False, type='dict'),
            parameter = dict(
                required  = True,
                choices   = ['ntp_client', 'clock', 'identity', 'logging', 'routerboard_settings'],
                type      = 'str'
            ),
            state   = dict(
                required  = False,
                choices   = ['present', 'absent'],
                type      = 'str'
            ),
        )
    )

    params = module.params

    if params['parameter'] == 'routerboard_settings':
      params['parameter'] = 'routerboard/settings'

    if params['parameter'] == 'ntp_client':
      params['parameter'] = 'ntp/client'

    clean_params(params['settings'])
    mt_obj = MikrotikIdempotent(
        hostname        = params['hostname'],
        username        = params['username'],
        password        = params['password'],
        state           = params['state'],
        desired_params  = params['settings'],
        idempotent_param= None,
        api_path        = '/system/' + params['parameter'],
    )

    mt_obj.sync_state()

    if mt_obj.failed:
        module.fail_json(
          msg = mt_obj.failed_msg
        )
    elif mt_obj.changed:
        module.exit_json(
            failed=False,
            changed=True,
            msg=mt_obj.changed_msg,
            diff={ "prepared": {
                "old": mt_obj.old_params,
                "new": mt_obj.new_params,
            }},
        )
    else:
        module.exit_json(
            failed=False,
            changed=False,
            #msg='',
            msg=params['settings'],
        )

if __name__ == '__main__':
  main()