Возвращаемые значения
Модули Ansible обычно возвращают структуру данных, которую можно зарегистрировать в переменной или увидеть непосредственно в выводе программы ansible. Каждый модуль может при необходимости документировать собственные уникальные возвращаемые значения (доступные через ansible-doc и на главном сайте документации).
В этом документе описаны возвращаемые значения, общие для всех модулей.
Примечание
Некоторые из этих ключей могут быть установлены самим Ansible после обработки возвращаемой модулем информации.
Общие
backup_file
Для модулей, реализующих backup=no|yes при работе с файлами, — путь к резервной копии, созданной в случае изменения исходного файла.
"backup_file": "./foo.txt.32729.2020-07-30@06:24:19~"
changed
Логическое значение, указывающее, потребовалось ли задаче внести изменения на целевом или делегированном узле.
"changed": true
diff
Информация о различиях между предыдущим и текущим состоянием. Часто представляет собой словарь с записями before и after, которые затем форматируются плагином обратного вызова для отображения различий.
"diff": [
{
"after": "",
"after_header": "foo.txt (content)",
"before": "",
"before_header": "foo.txt (content)"
},
{
"after_header": "foo.txt (file attributes)",
"before_header": "foo.txt (file attributes)"
}
failed
Логическое значение, указывающее, завершилась ли задача с ошибкой.
"failed": false
invocation
Информация о том, как был вызван модуль.
"invocation": {
"module_args": {
"_original_basename": "foo.txt",
"attributes": null,
"backup": true,
"checksum": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
"content": null,
"delimiter": null,
"dest": "./foo.txt",
"directory_mode": null,
"follow": false,
"force": true,
"group": null,
"local_follow": null,
"mode": "666",
"owner": null,
"regexp": null,
"remote_src": null,
"selevel": null,
"serole": null,
"setype": null,
"seuser": null,
"src": "/Users/foo/.ansible/tmp/ansible-tmp-1596115458.110205-105717464505158/source",
"unsafe_writes": null,
"validate": null
}
msg
Строка с общим сообщением для пользователя.
"msg": "line added"
rc
Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (raw, shell, command и т. д.). Это поле содержит «код возврата» этих утилит.
"rc": 257
results
Наличие этого ключа указывает на то, что для задачи использовался цикл и что он содержит список обычных результатов модуля для каждого элемента.
"results": [
{
"ansible_loop_var": "item",
"backup": "foo.txt.83170.2020-07-30@07:03:05~",
"changed": true,
"diff": [
{
"after": "",
"after_header": "foo.txt (content)",
"before": "",
"before_header": "foo.txt (content)"
},
{
"after_header": "foo.txt (file attributes)",
"before_header": "foo.txt (file attributes)"
}
],
"failed": false,
"invocation": {
"module_args": {
"attributes": null,
"backrefs": false,
"backup": true
}
},
"item": "foo",
"msg": "line added"
},
{
"ansible_loop_var": "item",
"backup": "foo.txt.83187.2020-07-30@07:03:05~",
"changed": true,
"diff": [
{
"after": "",
"after_header": "foo.txt (content)",
"before": "",
"before_header": "foo.txt (content)"
},
{
"after_header": "foo.txt (file attributes)",
"before_header": "foo.txt (file attributes)"
}
],
"failed": false,
"invocation": {
"module_args": {
"attributes": null,
"backrefs": false,
"backup": true
}
},
"item": "bar",
"msg": "line added"
}
]
skipped
Логическое значение, указывающее, была ли пропущена задача.
"skipped": true
stderr
Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (raw, shell, command и т. д.). Это поле содержит сообщения об ошибках, выводимые этими утилитами.
"stderr": "ls: foo: No such file or directory"
stderr_lines
Когда возвращается stderr, мы также всегда предоставляем это поле — список строк, по одному элементу на каждую строку исходного вывода.
"stderr_lines": [
"ls: doesntexist: No such file or directory"
]
stdout
Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (raw, shell, command и т. д.). Это поле содержит обычный вывод этих утилит.
"stdout": "foo!"
stdout_lines
Когда возвращается stdout, Ansible всегда предоставляет список строк, каждая из которых содержит одну строку исходного вывода.
"stdout_lines": [ "foo!" ]
Внутреннее использование
Эти ключи могут добавляться модулями, но удаляются из зарегистрированных переменных; Ansible «обрабатывает» их самостоятельно.
ansible_facts
Этот ключ должен содержать словарь, который будет добавлен к фактам, назначенным узлу. Они будут доступны напрямую, и для этого не требуется использовать зарегистрированную переменную.
exception
Этот ключ может содержать информацию трассировки стека, вызванной исключением в модуле. Она отображается только при высоком уровне подробности вывода (-vvv).
warnings
Этот ключ содержит список строк, которые будут показаны пользователю.
deprecations
Этот ключ содержит список словарей, которые будут показаны пользователю. Ключи словарей — msg и version, значения — строки; значение для ключа version может быть пустой строкой.
См. также
- Указатель коллекций
-
Просмотр существующих коллекций, модулей и плагинов
- Каталог модулей на GitHub
-
Просмотр исходного кода основных и дополнительных модулей
- Общение
-
Есть вопросы? Нужна помощь? Хотите поделиться идеями? Ознакомьтесь с руководством по общению Ansible
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html