ansible.builtin.validate_argument_spec – Проверка спецификации аргументов роли.
Примечание
Этот модуль является частью ansible-base и включен во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля validate_argument_spec даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать FQCN для удобной ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.
Новое в версии 2.11: от ansible.builtin
Описание
- Этот модуль проверяет аргументы роли с помощью определенной спецификации аргументов.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| argument_spec строка / обязательно | Словарь, подобный argument_spec AnsibleModule | |
| provided_arguments строка | Словарь аргументов, которые будут проверены в соответствии с argument_spec |
Примеры
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| argument_errors список / элементы=строка | ошибка | Список ошибок валидации аргументов. Пример: ['ошибка сообщение 1', 'ошибка сообщение 2'] |
| argument_spec_data словарь | ошибка | Словарь данных из аргумента 'argument_spec'. Пример: {'some_arg': {'type': 'str'}, 'some_other_arg': {'required': True, 'type': 'int'}} |
| validate_args_context словарь | всегда | Словарь информации о том, где использовался validate_args_spec Пример: {'argument_spec_name': 'main', 'name': 'my_role', 'path': '/home/user/roles/my_role/', 'type': 'role'} |
Авторы
- Команда разработчиков Ansible
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/validate_argument_spec_module.html
