Значения возврата
Модули Ansible обычно возвращают структуру данных, которую можно зарегистрировать в переменной или увидеть непосредственно при выводе ansible программы. Каждый модуль может по желанию документировать собственные уникальные значения возврата (видимые через ansible-doc и на основном сайте документации).
Этот документ охватывает значения возврата, общие для всех модулей.
Примечание
Некоторые из этих ключей могут быть установлены самим Ansible после обработки информации о возврате модуля.
Общие
backup_file
Для тех модулей, которые реализуют backup=no|yes при манипулировании файлами, путь к резервной копии, созданной, если исходный файл был изменён.
"backup_file": "./foo.txt.32729.2020-07-30@06:24:19~"
изменён
Булево значение, указывающее, должен ли модуль внести изменения в целевой или делегированный хост.
"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": false
вызов
Информация о том, как был вызван модуль.
"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": "line added"
rc
Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (сырой, оболочка, команда и так далее), это поле содержит «код возврата» этих утилит.
"rc": 257
результаты
Если этот ключ существует, это означает, что для задания был цикл, и он содержит список обычных «результатов» модуля на каждый элемент.
"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": true
stderr
Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (сырой, оболочка, команда и так далее), это поле содержит вывод об ошибках этих утилит.
"stderr": "ls: foo: No such file or directory"
stderr_строки
Когда stderr возвращается, мы также всегда предоставляем это поле, которое является списком строк, по одной на строку из исходного.
"stderr_lines": [
"ls: doesntexist: No such file or directory"
]
stdout
Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (сырой, оболочка, команда и так далее). Это поле содержит обычный вывод этих утилит.
"stdout": "foo!"
stdout_строки
Когда stdout возвращается, Ansible всегда предоставляет список строк, каждая из которых содержит один элемент на строку из исходного вывода.
"stdout_lines": [ "foo!" ]
Внутреннее использование
Эти ключи могут быть добавлены модулями, но будут удалены из зарегистрированных переменных; они «потребляются» самим Ansible.
ansible_facts
Этот ключ должен содержать словарь, который будет добавлен к фактам, назначенным хосту. Они будут непосредственно доступны и не требуют использования зарегистрированной переменной.
исключение
Этот ключ может содержать информацию о стеке вызовов, вызванную исключением в модуле. Он будет отображаться только при высоком уровне подробности (-vvv).
предупреждения
Этот ключ содержит список строк, которые будут отображены пользователю.
устаревшие
Этот ключ содержит список словарей, которые будут отображены пользователю. Ключами словарей являются msg и version, значения — строки, значение для ключа version может быть пустой строкой.
См. также
- Индекс коллекций
-
Просмотр существующих коллекций, модулей и плагинов
- Директория модулей GitHub
-
Просмотр исходного кода основных и дополнительных модулей
- Общение
-
Есть вопросы? Нужна помощь? Хотите поделиться своими идеями? Посетите руководство по общению Ansible
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html