自定义Ansible回调函数的CallbackBase()插件

Ansible回调函数是一种机制，可以在Ansible的执行过程中根据需要添加自定义的逻辑。Ansible回调函数可以用于记录日志、发送通知、执行额外的操作等。

Ansible提供了一些内置的回调函数，如默认的stdout回调函数，用于将执行结果输出到标准输出。除了内置的回调函数外，用户还可以自定义回调函数，以满足特定的需求。

要自定义Ansible回调函数，需要创建一个继承自ansible.plugins.callback.CallbackBase的类，并重写其中的方法来实现自定义逻辑。

下面是一个简单的自定义回调函数的例子：

# 导入必要的模块
from ansible.plugins.callback import CallbackBase

class MyCallback(CallbackBase):
    
    def __init__(self, *args, **kwargs):
        super(MyCallback, self).__init__(*args, **kwargs)
        # 初始化自定义属性
        self.results = []

    def v2_runner_on_ok(self, result, **kwargs):
        host = result._host
        self.results.append({
            'host': host.name,
            'status': 'SUCCESS',
            'result': result._result
        })

    def v2_runner_on_failed(self, result, **kwargs):
        host = result._host
        self.results.append({
            'host': host.name,
            'status': 'FAILED',
            'result': result._result,
            'stderr': result._result.get('stderr', '')
        })

    def v2_runner_on_unreachable(self, result, **kwargs):
        host = result._host
        self.results.append({
            'host': host.name,
            'status': 'UNREACHABLE',
            'result': result._result,
            'stderr': result._result.get('stderr', '')
        })

    def v2_runner_on_skipped(self, result, **kwargs):
        host = result._host
        self.results.append({
            'host': host.name,
            'status': 'SKIPPED',
            'result': result._result
        })
        
    def v2_playbook_on_stats(self, stats):
        for host in stats.processed.keys():
            self.results.append({
                'host': host,
                'status': 'SUMMARY',
                'result': stats.summarize(host)
            })

# 创建回调对象
callback = MyCallback()

# 创建Ansible对象
ansible = Ansible(
    ...
    callbacks=callback,
    ...
)

# 执行ansible操作
ansible.run()

在上述代码中，我们定义了一个名为MyCallback的自定义回调函数。这个回调函数继承自ansible.plugins.callback.CallbackBase类，并实现了其中的一些方法。

- v2_runner_on_ok: 当执行成功时调用。我们将执行结果保存到self.results中。

- v2_runner_on_failed: 当执行失败时调用。我们将执行结果保存到self.results中。

- v2_runner_on_unreachable: 当无法连接到主机时调用。我们将执行结果保存到self.results中。

- v2_runner_on_skipped: 当任务被跳过时调用。我们将执行结果保存到self.results中。

- v2_playbook_on_stats: 当Playbook执行完毕后调用。我们将执行结果保存到self.results中。

在使用自定义回调函数时，需要先创建回调对象，并在创建Ansible对象时将其传递给callbacks参数。然后，可以通过ansible.run()方法来执行Ansible操作。

通过这种方式，我们可以根据自己的需求来扩展Ansible的功能，实现更多的自定义逻辑。可以将执行结果保存到其他地方，如数据库、文件、消息队列等。也可以发送通知，如邮件、短信等。同时也可以在执行过程中执行额外的操作，如执行脚本、调用API等。

总结来说，自定义Ansible回调函数可以根据具体需求来扩展Ansible的功能，实现更加灵活和定制化的自动化操作。对于一些复杂的场景和需求，自定义回调函数是一个非常有用的扩展点。