Значения возврата

• Общие

  • backup_file
  • изменено
  • diff
  • не удалось
  • вызов
  • сообщение
  • код возврата
  • результаты
  • пропущено
  • stderr
  • строки stderr
  • stdout
  • строки stdout

• Внутреннее использование

  • ansible_facts
  • исключение
  • предупреждения
  • устаревшие

Модули Ansible обычно возвращают структуру данных, которую можно зарегистрировать в переменной или увидеть непосредственно при выводе ansible программы. Каждый модуль может дополнительно документировать свои уникальные значения возврата (доступные через ansible-doc и на основном сайте документации).

В данном документе рассматриваются значения возврата, общие для всех модулей.

Общие

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"

код возврата

Некоторые модули выполняют утилиты командной строки или предназначены для прямого выполнения команд (raw, shell, command и так далее). Это поле содержит код возврата этих утилит.

"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

Некоторые модули выполняют утилиты командной строки или предназначены для прямого выполнения команд (raw, shell, command и так далее). Это поле содержит вывод об ошибках этих утилит.

"stderr": "ls: foo: No such file or directory"

строки stderr

Когда stderr возвращается, мы всегда предоставляем это поле, которое является списком строк, по одной строке из исходного.

"stderr_lines": [
        "ls: doesntexist: No such file or directory"
        ]

stdout

Некоторые модули выполняют утилиты командной строки или предназначены для прямого выполнения команд (raw, shell, command и так далее). Это поле содержит обычный вывод этих утилит.

"stdout": "foo!"

строки stdout

Когда stdout возвращается, Ansible всегда предоставляет список строк, каждая из которых содержит одну строку из исходного вывода.

"stdout_lines": [
"foo!"
]

Внутреннее использование

Эти ключи могут быть добавлены модулями, но будут удалены из зарегистрированных переменных; они «потребляются» самим Ansible.

ansible_facts

Этот ключ должен содержать словарь, который будет добавлен к фактам, назначенным хосту. Они будут непосредственно доступны и не требуют использования зарегистрированной переменной.

исключение

Этот ключ может содержать информацию об отслеживании, вызванную исключением в модуле. Она будет отображаться только при высокой детализации (-vvv).

предупреждения

Этот ключ содержит список строк, которые будут представлены пользователю.

устаревшие

Этот ключ содержит список словарей, которые будут представлены пользователю. Ключи словарей — msg и version, значения — строки, значение для ключа version может быть пустой строкой.