Blame roles/ipaclient/library/ipaclient_setup_ntp.py

Packit Service ee01e6
#!/usr/bin/python
Packit Service 0a38ef
# -*- coding: utf-8 -*-
Packit Service 0a38ef
Packit Service 0a38ef
# Authors:
Packit Service 0a38ef
#   Thomas Woerner <twoerner@redhat.com>
Packit Service 0a38ef
#
Packit Service 0a38ef
# Based on ipa-client-install code
Packit Service 0a38ef
#
Packit Service 0a38ef
# Copyright (C) 2017  Red Hat
Packit Service 0a38ef
# see file 'COPYING' for use and warranty information
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is free software; you can redistribute it and/or modify
Packit Service 0a38ef
# it under the terms of the GNU General Public License as published by
Packit Service 0a38ef
# the Free Software Foundation, either version 3 of the License, or
Packit Service 0a38ef
# (at your option) any later version.
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is distributed in the hope that it will be useful,
Packit Service 0a38ef
# but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 0a38ef
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service 0a38ef
# GNU General Public License for more details.
Packit Service 0a38ef
#
Packit Service 0a38ef
# You should have received a copy of the GNU General Public License
Packit Service 0a38ef
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
Packit Service 0a38ef
Packit Service 0a38ef
ANSIBLE_METADATA = {
Packit Service 0a38ef
    'metadata_version': '1.0',
Packit Service 0a38ef
    'supported_by': 'community',
Packit Service 0a38ef
    'status': ['preview'],
Packit Service 0a38ef
}
Packit Service 0a38ef
Packit Service 0a38ef
DOCUMENTATION = '''
Packit Service 0a38ef
---
Packit Service 0a38ef
module: ipaclient_setup_ntp
Packit Service 0a38ef
short description: Setup NTP for IPA client
Packit Service 0a38ef
description:
Packit Service 0a38ef
  Setup NTP for IPA client
Packit Service 0a38ef
options:
Packit Service 0a38ef
  ntp_servers:
Packit Service 0a38ef
    description: ntp servers to use
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  ntp_pool:
Packit Service 0a38ef
    description: ntp server pool to use
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  no_ntp:
Packit Service 0a38ef
    description: Do not configure ntp
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  on_master:
Packit Service 0a38ef
    description: Whether the configuration is done on the master or not
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  servers:
Packit Service 0a38ef
    description: Fully qualified name of IPA servers to enroll to
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  domain:
Packit Service 0a38ef
    description: Primary DNS domain of the IPA deployment
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
author:
Packit Service 0a38ef
    - Thomas Woerner
Packit Service 0a38ef
'''
Packit Service 0a38ef
Packit Service 0a38ef
EXAMPLES = '''
Packit Service 0a38ef
'''
Packit Service 0a38ef
Packit Service 0a38ef
RETURN = '''
Packit Service 0a38ef
'''
Packit Service 0a38ef
Packit Service 0a38ef
import inspect
Packit Service 0a38ef
Packit Service 0a38ef
from ansible.module_utils.basic import AnsibleModule
Packit Service 0a38ef
from ansible.module_utils.ansible_ipa_client import (
Packit Service 0a38ef
    setup_logging,
Packit Service 0a38ef
    options, sysrestore, paths, sync_time, logger, ipadiscovery,
Packit Service 0a38ef
    timeconf
Packit Service 0a38ef
)
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def main():
Packit Service 0a38ef
    module = AnsibleModule(
Packit Service 0a38ef
        argument_spec=dict(
Packit Service 0a38ef
            # basic
Packit Service 0a38ef
            ntp_servers=dict(required=False, type='list', default=None),
Packit Service 0a38ef
            ntp_pool=dict(required=False, default=None),
Packit Service 0a38ef
            no_ntp=dict(required=False, type='bool', default=False),
Packit Service 0a38ef
            # force_ntpd=dict(required=False, type='bool', default=False),
Packit Service 0a38ef
            on_master=dict(required=False, type='bool', default=False),
Packit Service 0a38ef
            # additional
Packit Service 0a38ef
            servers=dict(required=False, type='list', default=None),
Packit Service 0a38ef
            domain=dict(required=False, default=None),
Packit Service 0a38ef
        ),
Packit Service 0a38ef
        supports_check_mode=True,
Packit Service 0a38ef
    )
Packit Service 0a38ef
Packit Service 0a38ef
    # module._ansible_debug = True
Packit Service 0a38ef
    setup_logging()
Packit Service 0a38ef
Packit Service 0a38ef
    options.ntp_servers = module.params.get('ntp_servers')
Packit Service 0a38ef
    options.ntp_pool = module.params.get('ntp_pool')
Packit Service 0a38ef
    options.no_ntp = module.params.get('no_ntp')
Packit Service 0a38ef
    # options.force_ntpd = module.params.get('force_ntpd')
Packit Service 0a38ef
    options.on_master = module.params.get('on_master')
Packit Service 0a38ef
    cli_server = module.params.get('servers')
Packit Service 0a38ef
    cli_domain = module.params.get('domain')
Packit Service 0a38ef
Packit Service 0a38ef
    options.conf_ntp = not options.no_ntp
Packit Service 0a38ef
    options.debug = False
Packit Service 0a38ef
Packit Service 0a38ef
    fstore = sysrestore.FileStore(paths.IPA_CLIENT_SYSRESTORE)
Packit Service 0a38ef
    statestore = sysrestore.StateFile(paths.IPA_CLIENT_SYSRESTORE)
Packit Service 0a38ef
Packit Service 0a38ef
    synced_ntp = False
Packit Service 0a38ef
    if sync_time is not None:
Packit Service 0a38ef
        if options.conf_ntp:
Packit Service 0a38ef
            # Attempt to configure and sync time with NTP server (chrony).
Packit Service 0a38ef
            argspec = inspect.getargspec(sync_time)
Packit Service 0a38ef
            if "options" not in argspec.args:
Packit Service 0a38ef
                synced_ntp = sync_time(options.ntp_servers, options.ntp_pool,
Packit Service 0a38ef
                                       fstore, statestore)
Packit Service 0a38ef
            else:
Packit Service 0a38ef
                synced_ntp = sync_time(options, fstore, statestore)
Packit Service 0a38ef
        elif options.on_master:
Packit Service 0a38ef
            # If we're on master skipping the time sync here because it was
Packit Service 0a38ef
            # done in ipa-server-install
Packit Service 0a38ef
            logger.info(
Packit Service 0a38ef
                "Skipping attempt to configure and synchronize time with"
Packit Service 0a38ef
                " chrony server as it has been already done on master.")
Packit Service 0a38ef
        else:
Packit Service 0a38ef
            logger.info("Skipping chrony configuration")
Packit Service 0a38ef
Packit Service 0a38ef
    else:
Packit Service 0a38ef
        ntp_srv_servers = []
Packit Service 0a38ef
        if not options.on_master and options.conf_ntp:
Packit Service 0a38ef
            # Attempt to sync time with IPA server.
Packit Service 0a38ef
            # If we're skipping NTP configuration, we also skip the time sync
Packit Service 0a38ef
            # here.
Packit Service 0a38ef
            # We assume that NTP servers are discoverable through SRV records
Packit Service 0a38ef
            # in the DNS.
Packit Service 0a38ef
            # If that fails, we try to sync directly with IPA server,
Packit Service 0a38ef
            # assuming it runs NTP
Packit Service 0a38ef
            logger.info('Synchronizing time with KDC...')
Packit Service 0a38ef
            ds = ipadiscovery.IPADiscovery()
Packit Service 0a38ef
            ntp_srv_servers = ds.ipadns_search_srv(cli_domain, '_ntp._udp',
Packit Service 0a38ef
                                                   None, break_on_first=False)
Packit Service 0a38ef
            synced_ntp = False
Packit Service 0a38ef
            ntp_servers = ntp_srv_servers
Packit Service 0a38ef
Packit Service 0a38ef
            # use user specified NTP servers if there are any
Packit Service 0a38ef
            if options.ntp_servers:
Packit Service 0a38ef
                ntp_servers = options.ntp_servers
Packit Service 0a38ef
Packit Service 0a38ef
            for s in ntp_servers:
Packit Service 0a38ef
                synced_ntp = timeconf.synconce_ntp(s, options.debug)
Packit Service 0a38ef
                if synced_ntp:
Packit Service 0a38ef
                    break
Packit Service 0a38ef
Packit Service 0a38ef
            if not synced_ntp and not options.ntp_servers:
Packit Service 0a38ef
                synced_ntp = timeconf.synconce_ntp(cli_server[0],
Packit Service 0a38ef
                                                   options.debug)
Packit Service 0a38ef
            if not synced_ntp:
Packit Service 0a38ef
                module.warn(
Packit Service 0a38ef
                    "Unable to sync time with NTP "
Packit Service 0a38ef
                    "server, assuming the time is in sync. Please check "
Packit Service 0a38ef
                    "that 123 UDP port is opened.")
Packit Service 0a38ef
        else:
Packit Service 0a38ef
            logger.info('Skipping synchronizing time with NTP server.')
Packit Service 0a38ef
Packit Service 0a38ef
    # Done
Packit Service 0a38ef
    module.exit_json(changed=synced_ntp)
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
if __name__ == '__main__':
Packit Service 0a38ef
    main()