python调用ansible模块
# python调用ansible模块
代码如下:
import json
import shutil
from ansible.module_utils.common.collections import ImmutableDict
from ansible.parsing.dataloader import DataLoader
from ansible.vars.manager import VariableManager
from ansible.inventory.manager import InventoryManager
from ansible.playbook.play import Play
from ansible.executor.task_queue_manager import TaskQueueManager
from ansible.plugins.callback import CallbackBase
from ansible import context
import ansible.constants as C
class ResultCallback(CallbackBase):
"""
重写callbackBase类的部分方法
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.host_ok = {}
self.host_unreachable = {}
self.host_failed = {}
self.task_ok = {}
def v2_runner_on_unreachable(self, result):
self.host_unreachable[result._host.get_name()] = result
def v2_runner_on_ok(self, result, **kwargs):
self.host_ok[result._host.get_name()] = result
def v2_runner_on_failed(self, result, **kwargs):
self.host_failed[result._host.get_name()] = result
class MyAnsiable2():
def __init__(
self,
connection='local', #连接方式local 本地方式,smart ssh方式
remote_user=None, # ssh
remote_password=None, # ssh用户的密码,应该是一个字典,key 必须是conn_pass
private_key_file=None, #指定自定义的私钥地址
sudo=None,
sudo_user=None,
ask_sudo_pass=None,
module_path=None, #模块路径,可以指定一个自定义模块的路径
become=None, #是否提权
become_method=None, #提权方式默认sudo可以是su
become_user=None, #提权后,要成为的用户,并非登录用户
check=False,
diff=False,
listhosts=None,
listtasks=None,
listtags=None,
verbosity=3,
syntax=None,
start_at_task=None,
inventory=None):
#函数文档往释
"""
初始化函数,定义的默认的选项值,
在初始化的时候可以传参,以便覆盖默认选项的值
"""
context.CLIARGS = ImmutableDict(
connection=connection,
remote_user=remote_user,
private_key_file=private_key_file,
sudo=sudo,
sudo_user=sudo_user,
ask_sudo_pass=ask_sudo_pass,
module_path=module_path,
become=become,
become_method=become_method,
become_user=become_user,
verbosity=verbosity,
listhosts=listhosts,
listtasks=listtasks,
listtags=listtags,
syntax=syntax,
start_at_task=start_at_task,
)
#三元表达式,假如没有传递inventory, 就使用" localhost,"
#指定inventory文件
# inventory 的值可以是一个资产清单文件
#也可以是一个包含主机的元组,这个仅仅适用于测试
#比如: 1.1.1.1, #如果只有一个IP最后必须有英文的逗号
#或者: 1.1.1.1, 2.2.2.2
self.inventory = inventory if inventory else "localhost,"
#实例化数据解析器
self.loader = DataLoader()
#实例化资产配置对象
self.inv_obj = InventoryManager(loader=self.loader,
sources=self.inventory)
#设置密码
self.passwords = remote_password
#实例化回调插件对象
self.results_callback = ResultCallback()
#变量管理器
self.variable_manager = VariableManager(self.loader, self.inv_obj)
def run(self,
hosts='localhost',
gether_facts="no",
module="ping",
args='',
task_time=0):
"""
参数说明:
task_time --执行异步任务时等待的秒数,这个需要大于0,等于0的时候不支持异步(默认值)。这个值应该等于执行任务实际耗时时间为好
"""
play_source = dict(
name="Ad-hoc",
hosts=hosts,
gather_facts=gether_facts,
tasks=[
#这里每个task就是这个列表中的一个元素,格式是嵌套的字典
#也可以作为参数传递过来,这里就简单化了。
{
"action": {
"module": module,
"args": args
},
"async": task_time,
"poll": 0
}
])
play = Play().load(play_source,
variable_manager=self.variable_manager,
loader=self.loader)
tqm = None
try:
tqm = TaskQueueManager(inventory=self.inv_obj,
variable_manager=self.variable_manager,
loader=self.loader,
passwords=self.passwords,
stdout_callback=self.results_callback)
result = tqm.run(play)
finally:
if tqm is not None:
tqm.cleanup()
shutil.rmtree(C.DEFAULT_LOCAL_TMP, True)
def playbook(self, playbooks):
"""
Keyword arguments:
playbooks -- 需要是一个列表类型
"""
from ansible.executor.playbook_executor import PlaybookExecutor
playbook = PlaybookExecutor(playbooks=playbooks,
inventory=self.inv_obj,
variable_manager=self.variable_manager,
loader=self.loader,
passwords=self.passwords)
#使用回调函数
playbook._tqm._stdout_callback = self.results_callback
result = playbook.run()
def get_result(self):
result_raw = {'success': {}, 'failed': {}, 'unreachable': {}}
# print(self.results_callback.host ok)
for host, result in self.results_callback.host_ok.items():
result_raw['success'][host] = result._result
for host, result in self.results_callback.host_failed.items():
result_raw['failed'][host] = result._result
for host, result in self.results_callback.host_unreachable.items():
result_raw['unreachable'][host] = result._result
#最终打印结果,并且使用JSON继续格式化
print(json.dumps(result_raw, indent=4))
# # 使用范例一:
# if __name__== '__main__':
# # 记得要先建立免密登录
# # 执行默认的Ad-hoc
# # 实例化
# ansible2 = MyAnsiable2()
# # 执行ad-hoc
# ansible2.run( )
# # 打印结果
# ansible2.get_result()
# 使用范例二:
if __name__ == '__main__':
# 执行自定义的ad-hoc
# 资产配置文件/etc/ansible/hosts
# 内容
# [ nginx]
# 172.19.0.2
# 172.19.0.3
# 使用自己的资产配置文件,并使用ssh 的远程连接方式
ansible2 = MyAnsiable2(inventory='/etc/ansible/hosts', connection='smart')
# 执行自定义任务,执行对象是nginx组
ansible2.run(hosts="nginx", module="shell", args='ip a | grep "inet"')
# 打印结果
ansible2.get_result()
# # 使用范例三执行playbook:
# if __name__== '__main__':
# # 沿用上例继续执行一个playbook
# # playbook
# # /root/test.yml内容
# # ---
# # - name: a test playbook
# # hosts: [nginx]
# # gather_facts: no
# # tasks:
# # - shell: ip a |grep inet
# #...
# ansible2 = MyAnsiable2(inventory= '/etc/ansible/hosts', connection= 'smart' )
# # 传入playbooks的参数,需要是一个列表的数据类型 ,这里是使用的相对路径
# # 相对路径是相对于执行脚本的当前用户的家目录
# ansible2.playbook(playbooks=[ 'test.yml'])
# ansible2.get_result()
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
Last Updated: 2022/03/30, 20:04:37