一.简述：
熟练使用ansible的api功能，会给我们的工作带来很大便利。 不过不得不说，ansible的api 这种通过继承原生类的方式，是一件比较复杂的事情。需要对配合ansible的源码做些分析了解，才能正确的使用api。
二. options功能详解：
还是通过官方提供的案例说起：
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
.........
Options = namedtuple('Options', ['connection', 'module_path', 'forks', 'become', 'become_method', 'become_user', 'remote_user', 'check'])
variable_manager = VariableManager()
loader = DataLoader()
options = Options(connection='smart', module_path=None, forks=10, become=None, become_method=None, become_user=None, remote_user=None check=False)
.........
tqm = TaskQueueManager(
inventory=inventory,
variable_manager=variable_manager,
loader=loader,
options=options,
passwords=None,
stdout_callback=results_callback,
)
..........我们可以看到， 上文中采用了collections模块(一个python内建的集合模块 )
关于Options的定义：
options -->主要用来替换命令行方式通过args传递进去的参数变量，上文中，首先我们初始化一个集合：
Options = namedtuple('Options', ['connection', 'module_path', 'forks', 'become', 'become_method', 'become_user', 'remote_user', 'check']) #集合元素上文中会通过TaskQueueManager调用options,然后然后交给/PlayContext函数（site-packages/ansible/playbook/play_context.py）:
PlayContext用于合并连接/认证主机的信息,有些是继承与基础配置(connection，port，remote_user，environment,no_log 等)。
class PlayContext(Base):
'''
This class is used to consolidate the connection information for
hosts in a play and child tasks, where the task may override some
connection/authentication information.
'''
# connection fields, some are inherited from Base:
# (connection, port, remote_user, environment, no_log)
_docker_extra_args = FieldAttribute(isa='string')
_remote_addr = FieldAttribute(isa='string')
...................
def __init__(self, play=None, options=None, passwords=None, connection_lockfd=None)
............
if options:
self.set_options(options)通过set_options处理options:
可以看出， 整个options必须包含三个变量值(become,become_method,become_user)
如， 本文中的环境(sudo需求)为： ansible在中心机上以root身份运行playbook，走被操作机的ansible用户然后通过sudo方式执行命令(如 ls /root/)
.....................
Options = namedtuple('Options', ['connection', 'module_path', 'forks', 'become', 'become_method', 'become_user','remote_user', 'check', 'sudo_user', 'sudo'])
options = Options(connection='smart', module_path=None, forks=10, become=True, become_method='sudo', become_user='root',remote_user='ansible', check=False,sudo_user=None,sudo='yes')
.....................
(sudo功能，需提供: become_method='sudo' , become=True,sudo_user=None,sudo='yes' ) ,
site-packages/ansible/playbook/play_context.py会根据不同的变量，生成不同的指令,如，sudo：
if self.become_method == 'sudo':
# If we have a password, we run sudo with a randomly-generated
# prompt set using -p. Otherwise we run it with default -n, which makes
# it fail if it would have prompted for a password.
# Cannot rely on -n as it can be removed from defaults, which should be
# done for older versions of sudo that do not support the option.
#
# Passing a quoted compound command to sudo (or sudo -s)
# directly doesn't work, so we shellquote it with shlex_quote()
# and pass the quoted string to the user's shell.
# force quick error if password is required but not supplied, should prevent sudo hangs.
if self.become_pass:
prompt = '[sudo via ansible, key=%s] password: ' % randbits
becomecmd = '%s %s -p "%s" -u %s %s' % (exe, flags.replace('-n',''), prompt, self.become_user, command)
else:
becomecmd = '%s %s -u %s %s' % (exe, flags, self.become_user, command)回到主题： options -->主要用来替换命令行方式通过args传递进去的参数变量， 可支持的参数：
class Options(object):
'''
用于替换ansible的命令行参数
'''
def __init__(self, verbosity=None, inventory=None, listhosts=None, subset=None, module_paths=None, extra_vars=None,
forks=None, ask_vault_pass=None, vault_password_files=None, new_vault_password_file=None,
output_file=None, tags=None, skip_tags=None, one_line=None, tree=None, ask_sudo_pass=None, ask_su_pass=None,
sudo=None, sudo_user=None, become=False, become_method='sudo', become_user='root', become_ask_pass=None,
ask_pass=None, private_key_file=None, remote_user=None, connection=None, timeout=None, ssh_common_args=None,
sftp_extra_args=None, scp_extra_args=None, ssh_extra_args=None, poll_interval=None, seconds=None, check=None,
syntax=None, diff=None, force_handlers=None, flush_cache=None, listtasks=None, listtags=None, module_path=None):
self.verbosity = verbosity
self.inventory = inventory
self.listhosts = listhosts
self.subset = subset
self.module_paths = module_paths
self.extra_vars = extra_vars
self.forks = forks
self.ask_vault_pass = ask_vault_pass
self.vault_password_files = vault_password_files
self.new_vault_password_file = new_vault_password_file
self.output_file = output_file
self.tags = tags
self.skip_tags = skip_tags
self.one_line = one_line
self.tree = tree
self.ask_sudo_pass = ask_sudo_pass
self.ask_su_pass = ask_su_pass
self.sudo = sudo
self.sudo_user = sudo_user
self.become = become
self.become_method = become_method
self.become_user = become_user
self.become_ask_pass = become_ask_pass
self.ask_pass = ask_pass
self.private_key_file = private_key_file
self.remote_user = remote_user
self.connection = connection
self.timeout = timeout
self.ssh_common_args = ssh_common_args
self.sftp_extra_args = sftp_extra_args
self.scp_extra_args = scp_extra_args
self.ssh_extra_args = ssh_extra_args
self.poll_interval = poll_interval
self.seconds = seconds
self.check = check
self.syntax = syntax
self.diff = diff
self.force_handlers = force_handlers
self.flush_cache = flush_cache
self.listtasks = listtasks
self.listtags = listtags
self.module_path = module_path有相关需求的同学，可以作为参考。。。
----------------------------------------------------------------------------------------------
深耕运维行业多年，擅长linux、容器云原生、运维自动化等方面。
承接各类运维环境部署、方案设计/实施、服务代运维工作，欢迎沟通交流 ！
