AnsibleCallbackBase()插件的使用方法及示例详解

AnsibleCallbackBase是Ansible提供的一个插件类，用于创建Ansible回调插件。回调插件可以用于在执行Ansible任务期间获取任务的状态和结果，并执行一些自定义的操作。

要使用AnsibleCallbackBase插件，需要创建一个自定义的回调插件类，并继承AnsibleCallbackBase类。在这个自定义类中，可以重写一些方法来实现自定义的操作。

以下是一个使用AnsibleCallbackBase插件的示例：

from ansible.plugins.callback import CallbackBase

class MyCallbackPlugin(CallbackBase):

    def v2_playbook_on_play_start(self, play):
        # 在playbook中的每个play开始时执行的方法
        # 可以在这里打印play的一些信息
        print("Playbook starting for play: {}".format(play.name))

    def v2_playbook_on_stats(self, stats):
        # 在playbook中的所有任务执行完毕后执行的方法
        # 可以在这里打印任务的执行结果
        ok_hosts = sorted(stats.ok_hosts)
        failed_hosts = sorted(stats.failed_hosts)
        unreachable_hosts = sorted(stats.dark_hosts)

        print("Hosts that succeeded:")
        for host in ok_hosts:
            print("  - {}".format(host))

        print("Hosts that failed:")
        for host in failed_hosts:
            print("  - {}".format(host))

        print("Hosts that were unreachable:")
        for host in unreachable_hosts:
            print("  - {}".format(host))

    def v2_runner_on_ok(self, result, **kwargs):
        # 在每个任务成功执行之后执行的方法
        # 可以在这里打印任务的执行结果
        print("Task succeeded: {}".format(result._host.get_name()))

    def v2_runner_on_failed(self, result, **kwargs):
        # 在每个任务执行失败时执行的方法
        # 可以在这里打印任务的执行结果
        print("Task failed: {}".format(result._host.get_name()))

    def v2_runner_on_unreachable(self, result, **kwargs):
        # 在任务无法连接到目标主机时执行的方法
        # 可以在这里打印任务的执行结果
        print("Task unreachable: {}".format(result._host.get_name()))

在上面的示例中，我们创建了一个自定义的回调插件类MyCallbackPlugin，继承自AnsibleCallbackBase类。然后重写了几个方法来执行一些特定的操作。在这个示例中，我们重写了v2_playbook_on_play_start方法，在playbook中的每个play开始时打印play的名字；重写了v2_playbook_on_stats方法，在playbook中的所有任务执行完毕后打印任务的执行结果；重写了v2_runner_on_ok、v2_runner_on_failed和v2_runner_on_unreachable方法，在每个任务成功执行、任务执行失败和任务无法连接到目标主机时打印任务的执行结果。

要使用这个自定义的回调插件类，需要将其配置到Ansible的配置文件ansible.cfg中。找到[defaults]部分，添加以下配置：

# callback插件配置
callback_plugins = /path/to/my/plugin/directory

将/path/to/my/plugin/directory替换为你实际存放plugin的目录。

然后，在执行Ansible任务时，就会自动调用这个回调插件，并执行我们定义的操作。

以上就是使用AnsibleCallbackBase插件的方法及示例的详解。通过自定义回调插件，可以获得更多的灵活性和自定义功能来处理Ansible任务的执行结果。