1. 程式人生 > >python學習之ansible api

python學習之ansible api

uem 是否 password inventory latest items truct nbsp att

Python API 2.0

在2.0的事情開始更復雜一些,但是你會得到更多離散和可讀的類:

#!/usr/bin/env python

import json
from collections import namedtuple
from ansible.parsing.dataloader import DataLoader
from ansible.vars import VariableManager
from ansible.inventory import Inventory
from ansible.playbook.play import Play
from ansible.executor.task_queue_manager import TaskQueueManager
from ansible.plugins.callback import CallbackBase

class ResultCallback(CallbackBase):
    """用於執行結果的示例回調插件

     如果要將所有結果收集到單個對象進行處理
     執行的結束,看看利用``json``回調插件
     或編寫自己的自定義回調插件
    """
    def v2_runner_on_ok(self, result, **kwargs):
        """打印結果的json表示

         該方法可以將結果存儲在實例屬性中以供以後檢索
        """
        host = result._host
        print json.dumps({host.name: result._result}, indent=4)

Options = namedtuple(‘Options‘, [‘connection‘, ‘module_path‘, ‘forks‘, ‘become‘, ‘become_method‘, ‘become_user‘, ‘check‘])
# initialize needed objects
variable_manager = VariableManager()
loader = DataLoader()
options = Options(connection=‘local‘, module_path=‘/path/to/mymodules‘, forks=100, become=None, become_method=None, become_user=None, check=False)
passwords = dict(vault_pass=‘secret‘)

#實例化我們的ResultCallback來處理結果進來時
results_callback = ResultCallback()

#創建庫存並傳遞給var manager
inventory = Inventory(loader=loader, variable_manager=variable_manager, host_list=‘localhost‘)
variable_manager.set_inventory(inventory)

# create play with tasks
play_source =  dict(
        name = "Ansible Play",
        hosts = ‘localhost‘,
        gather_facts = ‘no‘,
        tasks = [
            dict(action=dict(module=‘shell‘, args=‘ls‘), register=‘shell_out‘),
            dict(action=dict(module=‘debug‘, args=dict(msg=‘{{shell_out.stdout}}‘)))
         ]
    )
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)

# actually run it
tqm = None
try:
    tqm = TaskQueueManager(
              inventory=inventory,
              variable_manager=variable_manager,
              loader=loader,
              options=options,
              passwords=passwords,
              stdout_callback=results_callback,  # Use our custom callback instead of the ``default`` callback plugin
          )
    result = tqm.run(play)
finally:
    if tqm is not None:
        tqm.cleanup()

Python API pre 2.0

這很簡單:

import ansible.runner

runner = ansible.runner.Runner(
   module_name=‘ping‘,
   module_args=‘‘,
   pattern=‘web*‘,
   forks=10
)
datastructure = runner.run()

運行方法返回每個主機的結果,根據是否可以聯系來分組。 返回類型是模塊特定的,如關於模塊文檔中所示:

{
    "dark" : {
       "web1.example.com" : "failure message"
}, "contacted" : { "web2.example.com" : 1 } }

一個模塊可以返回任何類型的JSON數據,所以Ansible可以作為框架來快速構建強大的應用程序和腳本。

詳細API示例

以下腳本打印出所有主機的正常運行時間信息:

#!/usr/bin/python

import ansible.runner
import sys

# construct the ansible runner and execute on all hosts
results = ansible.runner.Runner(
    pattern=‘*‘, forks=10,
    module_name=‘command‘, module_args=‘/usr/bin/uptime‘,
).run()

if results is None:
   print "No hosts found"
   sys.exit(1)

print "UP ***********"
for (hostname, result) in results[‘contacted‘].items():
    if not ‘failed‘ in result:
        print "%s >>> %s" % (hostname, result[‘stdout‘])

print "FAILED *******"
for (hostname, result) in results[‘contacted‘].items():
    if ‘failed‘ in result:
        print "%s >>> %s" % (hostname, result[‘msg‘])

print "DOWN *********"
for (hostname, result) in results[‘dark‘].items():
    print "%s >>> %s" % (hostname, result)

高級程序員也可能希望將源讀取到ansible本身,因為它使用API(具有所有可用選項)來實現可執行的命令行工具(lib / ansible / cli /)。

更多信息請參考官網:http://docs.ansible.com/ansible/latest/dev_guide/developing_api.html  

  

  

python學習之ansible api