ansible 和playbook api

ansible给咱们提供2个python api，一个简单的版本低的api，只能执行单个命令操作的，对于复杂的逻辑的操作需要借助playbook来实现，但是playbook的api目前没有研究出命令返回结果的，再研究下callback插件。

ansible api

import ansible.runner
import  json
runner = ansible.runner.Runner(
   module_name='shell',#调用shell模块
   module_args='uptime',#模块参数。
   pattern='test',#匹配的执行的host
   forks=10,#并发数。
   remote_user='root',#远程ssh登录用户。。
   remote_pass='123',#远程登录密码。
)
datastructure = runner.run()#接受run函数返回的执行结果。
data = json.dumps(datastructure,indent=4)
for i,j in datastructure['contacted'].items():#处理执行结果。
    print i,j['stdout']

 输出结果：

127.0.0.1  01:12:15 up 6 days, 12:58, 42 users,  load average: 0.03, 0.04, 0.03

 

原始输出结果：其中记录了命令执行结果，以及调用模块的名字和模块参数。返回值。成功返回值为0、标准输出、标准错误输出等信息！

{
    "dark": {}, 
    "contacted": {
        "127.0.0.1": {
            "cmd": "uptime", 
            "end": "2016-11-10 01:32:59.781879", 
            "stdout": " 01:32:59 up 6 days, 13:19, 34 users,  load average: 0.00, 0.01, 0.00", 
            "changed": true, 
            "start": "2016-11-10 01:32:59.771125", 
            "delta": "0:00:00.010754", 
            "stderr": "", 
            "rc": 0, 
            "invocation": {
                "module_name": "shell", 
                "module_args": "uptime"
            }, 
            "warnings": []
        }
    }
}

 

其中在Runner函数可以使用的字段为：

　　　　 host_list=C.DEFAULT_HOST_LIST,      # ex: /etc/ansible/hosts, legacy usage #执行host清单，如果不指定文件，会读取ansible.cfg文件的inventory = xx字段。
        module_path=None,                   # ex: /usr/share/ansible#模块路径，比如：/usr/share/ansible ex==example。
        module_name=C.DEFAULT_MODULE_NAME,  # ex: copy#模块的名字。
        module_args=C.DEFAULT_MODULE_ARGS,  # ex: "src=/tmp/a dest=/tmp/b"#模块的参数。
        forks=C.DEFAULT_FORKS,              # parallelism level并发进程数。
        timeout=C.DEFAULT_TIMEOUT,          # SSH timeout#ssh 连接超时。
        pattern=C.DEFAULT_PATTERN,          # which hosts?  ex: 'all', 'acme.example.org'#host清单里，匹配的组 host清单。
        remote_user=C.DEFAULT_REMOTE_USER,  # ex: 'username'#远程登录用户和执行用户。
        remote_pass=C.DEFAULT_REMOTE_PASS,  # ex: 'password123' or None if using key#远程登录用户密码。
        remote_port=None,                   # if SSH on different ports#ssh连接端口。
        private_key_file=C.DEFAULT_PRIVATE_KEY_FILE, # if not using keys/passwords#私钥位置，如果不是ssh 连接话。
        background=0,                       # async poll every X seconds, else 0 for non-async#异步参数。
        basedir=None,                       # directory of playbook, if applicable#playbook 路径。
        setup_cache=None,                   # used to share fact data w/ other tasks#搜集远程节点的信息。
        vars_cache=None,                    # used to store variables about hosts#host清单变量。
        transport=C.DEFAULT_TRANSPORT,      # 'ssh', 'paramiko', 'local'#连接远程主机的方式，是ssh还是paramiko....
        conditional='True',                 # run only if this fact expression evals to true  #未知
        callbacks=None,                     # used for output#用于结果输出。
        module_vars=None,                   # a playbooks internals thing##模块变量。
        play_vars=None,                     #
        play_file_vars=None,                #
        role_vars=None,                     #
        role_params=None,                   #
        default_vars=None,                  #
        extra_vars=None,                    # extra vars specified with he playbook(s)#其他额外一些参数。
        is_playbook=False,                  # running from playbook or not?
        inventory=None,                     # reference to Inventory object
        subset=None,                        # subset pattern
        check=False,                        # don't make any changes, just try to probe for potential changes#测试play，看看对hostlist产生哪些变化。
        diff=False,                         # whether to show diffs for template files that change
        environment=None,                   # environment variables (as dict) to use inside the command
        complex_args=None,                  # structured data in addition to module_args, must be a dict
        error_on_undefined_vars=C.DEFAULT_UNDEFINED_VAR_BEHAVIOR, # ex. False
        accelerate=False,                   # use accelerated connection
        accelerate_ipv6=False,              # accelerated connection w/ IPv6
        accelerate_port=None,               # port to use with accelerated connection
        vault_pass=None,
        run_hosts=None,                     # an optional list of pre-calculated hosts to run on
        no_log=False,                       # option to enable/disable logging for a given task
        run_once=False,                     # option to enable/disable host bypass loop for a given task
        become=False,                         # whether to run privelege escalation or not
        become_method=C.DEFAULT_BECOME_METHOD,
        become_user=C.DEFAULT_BECOME_USER,      # ex: 'root'
        become_pass=C.DEFAULT_BECOME_PASS,      # ex: 'password123' or None
        become_exe=C.DEFAULT_BECOME_EXE,        # ex: /usr/local/bin/sudo
        ):

        # used to lock multiprocess inputs and outputs at various levels
        self.output_lockfile  = OUTPUT_LOCKFILE
        self.process_lockfile = PROCESS_LOCKFILE

 

ansible  playbook api：

playbook的优势：可以自定义yml文件，定义play，列出我们想要执行的任务清单。符合更复杂的逻辑处理。

import sys
import ansible.playbook
from ansible import callbacks
from ansible import utils
stats = callbacks.AggregateStats()#holds stats about per-host activity during playbook runs，储存每个host在执行任务的时候状态信息。
playbook_cb = callbacks.PlaybookCallbacks(verbose=utils.VERBOSITY)
runner_cb = callbacks.PlaybookRunnerCallbacks(stats, verbose=utils.VERBOSITY)
def execute(play,params):
  pb = ansible.playbook.PlayBook(
    playbook=play,
    stats=stats,
    forks=20,
    callbacks=playbook_cb,
    remote_pass=123,
    runner_callbacks=runner_cb,
    check=False,
#    timeout=2,
    extra_vars=eval(params)
  )
  return  pb.run()
if __name__=='__main__':
  res=execute(sys.argv[1],sys.argv[2])
  print res

 其中：支持字段如下：

        """
        playbook:         path to a playbook file#yml文件位置。
        host_list:        path to a file like /etc/ansible/hosts#host清单。
        module_path:      path to ansible modules, like /usr/share/ansible/#模路径。
        forks:            desired level of parallelism#并发进程数，parallelism并发的意思。
        timeout:          connection timeout#类似于ssh连接超时
        remote_user:      run as this user if not specified in a particular play#远程执行和登录用户。
        remote_pass:      use this remote password (for all plays) vs using SSH keys#远程登录的ssh密码。
        remote_port:      default remote port to use if not specified with the host or play#ssh端口。
        transport:        how to connect to hosts that don't specify a transport (local, paramiko, etc)#连接类型，
        callbacks         output callbacks for the playbook#执行结果输出。
        runner_callbacks: more callbacks, this time for the runner API#执行回调函数api。
        stats:            holds aggregrate data about events occurring to each host#每个host执行过程中信息。
        inventory:        can be specified instead of host_list to use a pre-existing inventory object#host执行清单。
        check:            don't change anything, just try to detect some potential changes#检测 执行yml文件的对主机产生哪些变化。
        any_errors_fatal: terminate the entire execution immediately when one of the hosts has failed#当主机执行过程中出现错误，终止执行过程。
        force_handlers:   continue to notify and run handlers even if a task fails#强制执行handlers 及时主机执行错误。
        """

 

如果不填写参数，参数默认列表：

        playbook         = None,
        host_list        = C.DEFAULT_HOST_LIST,
        module_path      = None,
        forks            = C.DEFAULT_FORKS,
        timeout          = C.DEFAULT_TIMEOUT,
        remote_user      = C.DEFAULT_REMOTE_USER,
        remote_pass      = C.DEFAULT_REMOTE_PASS,
        remote_port      = None,
        transport        = C.DEFAULT_TRANSPORT,
        private_key_file = C.DEFAULT_PRIVATE_KEY_FILE,
        callbacks        = None,
        runner_callbacks = None,
        stats            = None,
        extra_vars       = None,
        only_tags        = None,
        skip_tags        = None,
        subset           = C.DEFAULT_SUBSET,
        inventory        = None,
        check            = False,
        diff             = False,
        any_errors_fatal = False,
        vault_password   = False,
        force_handlers   = False,
        # privelege escalation
        become           = C.DEFAULT_BECOME,
        become_method    = C.DEFAULT_BECOME_METHOD,
        become_user      = C.DEFAULT_BECOME_USER,
        become_pass      = None,

 

其中必须参数：

        arguments = []
        if playbook is None:
            arguments.append('playbook')
        if callbacks is None:
            arguments.append('callbacks')
        if runner_callbacks is None:
            arguments.append('runner_callbacks')
        if stats is None:
            arguments.append('stats')
        if arguments:
            raise Exception('PlayBook missing required arguments: %s' % ', '.join(arguments))

 

playbook、callbacks、runner_callbacks、stats必须不为空，否则会主动抛错！！