原创

Python调用Ansible接口

python需要安装Ansible模块

pip install ansible

引入需要使用的模块

import ansible.constants as C
from ansible.executor.task_queue_manager import TaskQueueManager
from ansible.module_utils.common.collections import ImmutableDict
from ansible.inventory.manager import InventoryManager
from ansible.parsing.dataloader import DataLoader
from ansible.playbook.play import Play
from ansible.plugins.callback import CallbackBase
from ansible.vars.manager import VariableManager
from ansible import context

官方示例，回调对象

# Create a callback plugin so we can capture the output
class ResultsCollectorJSONCallback(CallbackBase):
    """A sample callback plugin used for performing an action as results come in.

    If you want to collect all results into a single object for processing at
    the end of the execution, look into utilizing the ``json`` callback plugin
    or writing your own custom callback plugin.
    """

    def __init__(self, *args, **kwargs):
        super(ResultsCollectorJSONCallback, self).__init__(*args, **kwargs)
        self.host_ok = {}
        self.host_unreachable = {}
        self.host_failed = {}

    def v2_runner_on_unreachable(self, result):
        host = result._host
        self.host_unreachable[host.get_name()] = result

    def v2_runner_on_ok(self, result, *args, **kwargs):
        """Print a json representation of the result.

        Also, store the result in an instance attribute for retrieval later
        """
        host = result._host
        self.host_ok[host.get_name()] = result
        #print(json.dumps({host.name: result._result}, indent=4))

    def v2_runner_on_failed(self, result, *args, **kwargs):
        host = result._host
        self.host_failed[host.get_name()] = result

执行命令函数，需要传两个参数，主机、执行命令

def main(hosts,shell):
    # 判断主机是否为列表，可以多台机器执行命令
    if isinstance(hosts,list):
        host_list = hosts
    else:
        host_list = [hosts]
    # since the API is constructed for CLI it expects certain options to always be set in the context object
    context.CLIARGS = ImmutableDict(connection='smart', module_path=['/to/mymodules', '/usr/share/ansible'], forks=10, become=None,
                                    become_method=None, become_user="www", check=False, diff=False, verbosity=0)
    # required for
    # https://github.com/ansible/ansible/blob/devel/lib/ansible/inventory/manager.py#L204
    sources = ','.join(host_list)
    if len(host_list) == 1:
        sources += ','

    # initialize needed objects
    loader = DataLoader()  # Takes care of finding and reading yaml, json and ini files
    passwords = dict(vault_pass='secret')

    # Instantiate our ResultsCollectorJSONCallback for handling results as they come in. Ansible expects this to be one of its main display outlets
    results_callback = ResultsCollectorJSONCallback()

    # create inventory, use path to host config file as source or hosts in a comma separated string
    inventory = InventoryManager(loader=loader, sources=sources)

    # variable manager takes care of merging all the different sources to give you a unified view of variables available in each context
    variable_manager = VariableManager(loader=loader, inventory=inventory)

    # instantiate task queue manager, which takes care of forking and setting up all objects to iterate over host list and tasks
    # IMPORTANT: This also adds library dirs paths to the module loader
    # IMPORTANT: and so it must be initialized before calling `Play.load()`.
    tqm = TaskQueueManager(
        inventory=inventory,
        variable_manager=variable_manager,
        loader=loader,
        passwords=passwords,
        stdout_callback=results_callback,  # Use our custom callback instead of the ``default`` callback plugin, which prints to stdout
    )

    # create data structure that represents our play, including tasks, this is basically what our YAML loader does internally.
    play_source = dict(
        name="Ansible Play",
        hosts=host_list,
        gather_facts='no',
        tasks=[
            dict(action=dict(module='shell', args=shell), register='shell_out'),
        ]
    )

    # Create play object, playbook objects use .load instead of init or new methods,
    # this will also automatically create the task objects from the info provided in play_source
    play = Play().load(play_source, variable_manager=variable_manager, loader=loader)

    # Actually run it
    try:
        result = tqm.run(play)  # most interesting data for a play is actually sent to the callback's methods
    finally:
        # we always need to cleanup child procs and the structures we use to communicate with them
        tqm.cleanup()
        if loader:
            loader.cleanup_all_tmp_files()

    # Remove ansible tmpdir
    shutil.rmtree(C.DEFAULT_LOCAL_TMP, True)
    data = {"up":None,"failed":None,"down":None}
    #print("UP ***********")
    for host, result in results_callback.host_ok.items():
        data["up"]= '{0} >>> {1}'.format(host, result._result['stdout'])
        #print('{0} >>> {1}'.format(host, result._result['stdout']))

    #print("FAILED *******")
    for host, result in results_callback.host_failed.items():
        data["up"]= '{0} >>> {1}'.format(host, result._result['msg'])
        #print('{0} >>> {1}'.format(host, result._result['msg']))

    #print("DOWN *********")
    for host, result in results_callback.host_unreachable.items():
        data["down"] = '{0} >>> {1}'.format(host, result._result['msg'])
        #print('{0} >>> {1}'.format(host, result._result['msg']))
    return data

直接调用函数就可以批量执行命令了

if __name__ == "__main__":
    run_shell = main("192.168.1.1","ifconfig")
    print(run_shell)

使用ansible自带hosts组操作机器

hosts文件例如：

[www]
192.168.1.1
192.168.1.2

调用函数执行

if __name__ == "__main__":
    run_shell = main("www","ifconfig")
    print(run_shell)


完整代码

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

import json
import shutil

import ansible.constants as C
from ansible.executor.task_queue_manager import TaskQueueManager
from ansible.module_utils.common.collections import ImmutableDict
from ansible.inventory.manager import InventoryManager
from ansible.parsing.dataloader import DataLoader
from ansible.playbook.play import Play
from ansible.plugins.callback import CallbackBase
from ansible.vars.manager import VariableManager
from ansible import context


# Create a callback plugin so we can capture the output
class ResultsCollectorJSONCallback(CallbackBase):
    """A sample callback plugin used for performing an action as results come in.

    If you want to collect all results into a single object for processing at
    the end of the execution, look into utilizing the ``json`` callback plugin
    or writing your own custom callback plugin.
    """

    def __init__(self, *args, **kwargs):
        super(ResultsCollectorJSONCallback, self).__init__(*args, **kwargs)
        self.host_ok = {}
        self.host_unreachable = {}
        self.host_failed = {}

    def v2_runner_on_unreachable(self, result):
        host = result._host
        self.host_unreachable[host.get_name()] = result

    def v2_runner_on_ok(self, result, *args, **kwargs):
        """Print a json representation of the result.

        Also, store the result in an instance attribute for retrieval later
        """
        host = result._host
        self.host_ok[host.get_name()] = result
        #print(json.dumps({host.name: result._result}, indent=4))

    def v2_runner_on_failed(self, result, *args, **kwargs):
        host = result._host
        self.host_failed[host.get_name()] = result


def main(hosts,shell):
    # 判断主机是否为列表，可以多台机器执行命令
    if isinstance(hosts,list):
        host_list = hosts
    else:
        host_list = [hosts]
    # since the API is constructed for CLI it expects certain options to always be set in the context object
    context.CLIARGS = ImmutableDict(connection='smart', module_path=['/to/mymodules', '/usr/share/ansible'], forks=10, become=None,
                                    become_method=None, become_user="www", check=False, diff=False, verbosity=0)
    # required for
    # https://github.com/ansible/ansible/blob/devel/lib/ansible/inventory/manager.py#L204
    sources = ','.join(host_list)
    if len(host_list) == 1:
        sources += ','

    # initialize needed objects
    loader = DataLoader()  # Takes care of finding and reading yaml, json and ini files
    passwords = dict(vault_pass='secret')

    # Instantiate our ResultsCollectorJSONCallback for handling results as they come in. Ansible expects this to be one of its main display outlets
    results_callback = ResultsCollectorJSONCallback()

    # create inventory, use path to host config file as source or hosts in a comma separated string
    inventory = InventoryManager(loader=loader, sources=sources)

    # variable manager takes care of merging all the different sources to give you a unified view of variables available in each context
    variable_manager = VariableManager(loader=loader, inventory=inventory)

    # instantiate task queue manager, which takes care of forking and setting up all objects to iterate over host list and tasks
    # IMPORTANT: This also adds library dirs paths to the module loader
    # IMPORTANT: and so it must be initialized before calling `Play.load()`.
    tqm = TaskQueueManager(
        inventory=inventory,
        variable_manager=variable_manager,
        loader=loader,
        passwords=passwords,
        stdout_callback=results_callback,  # Use our custom callback instead of the ``default`` callback plugin, which prints to stdout
    )

    # create data structure that represents our play, including tasks, this is basically what our YAML loader does internally.
    play_source = dict(
        name="Ansible Play",
        hosts=host_list,
        gather_facts='no',
        tasks=[
            dict(action=dict(module='shell', args=shell), register='shell_out'),
        ]
    )

    # Create play object, playbook objects use .load instead of init or new methods,
    # this will also automatically create the task objects from the info provided in play_source
    play = Play().load(play_source, variable_manager=variable_manager, loader=loader)

    # Actually run it
    try:
        result = tqm.run(play)  # most interesting data for a play is actually sent to the callback's methods
    finally:
        # we always need to cleanup child procs and the structures we use to communicate with them
        tqm.cleanup()
        if loader:
            loader.cleanup_all_tmp_files()

    # Remove ansible tmpdir
    shutil.rmtree(C.DEFAULT_LOCAL_TMP, True)
    data = {"up":None,"failed":None,"down":None}
    #print("UP ***********")
    for host, result in results_callback.host_ok.items():
        data["up"]= '{0} >>> {1}'.format(host, result._result['stdout'])
        #print('{0} >>> {1}'.format(host, result._result['stdout']))

    #print("FAILED *******")
    for host, result in results_callback.host_failed.items():
        data["up"]= '{0} >>> {1}'.format(host, result._result['msg'])
        #print('{0} >>> {1}'.format(host, result._result['msg']))

    #print("DOWN *********")
    for host, result in results_callback.host_unreachable.items():
        data["down"] = '{0} >>> {1}'.format(host, result._result['msg'])
        #print('{0} >>> {1}'.format(host, result._result['msg']))
    return data

if __name__ == '__main__':
    run_shell = main("192.168.30.132","ifconfig")
    print(run_shell)
正文到此结束
所属分类：Python
  • 本文标签： Python Ansible
  • 版权声明： 本站原创文章，于2022年04月19日由 PGaZn发布，转载请注明出处
热门推荐
相关文章
评论

登录后才能发表评论 登录/注册

0评论
  • 还没有评论，快来抢沙发吧！
本文目录
    标签云
    Linux 其他 Python Flask elk elasticsearch windows rsync django Mysql Nginx redis Node pm2 Docker prometheus 监控 grafana open-falcon 运维工具 kibana logstash SRS 流媒体服务 GitLab Jenkins Ansible K8S rabbitmq Rclone 对象存储
    近期评论
    网站信息
    • 文章总数：79 篇
    • 标签总数：31 个
    • 分类总数：27 个
    • 留言数量：0 条
    • 运行天数：1025天