Spec-Zone.ru › Ansible 2.11

ansible.builtin.first_found – возврат первого найденного файла из списка

Примечание

Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля first_found даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать FQCN для удобной ссылки на документацию по модулю и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

  • Этот поиск проверяет список файлов и путей и возвращает полный путь к первой найденной комбинации.
  • Как и все поиски, при подаче относительных путей он сначала попробует использовать расположение текущей задачи, а затем подниматься по цепочке к расположению содержащего роли/игры/включения и т.д.
  • Список файлов имеет приоритет над проверяемыми путями. Например, если в задаче роли есть ‘file1’ в относительном пути игры, он будет использован; ‘file2’ в относительном пути роли не будет.
  • Для работы этого плагина требуется либо список файлов _terms , либо ключ files со списком файлов.

Параметры

Параметр Варианты/Значения по умолчанию Конфигурация Комментарии
_terms
строка
список имён файлов
files
строка
список имён файлов
paths
строка
список путей, в которых следует искать файлы
skip
логическое
    Варианты:
  • нет ←
  • да
Возвращает пустой список, если файл не найден, вместо ошибки.

Примечания

Примечание

  • Этот поиск может использоваться в «двойном режиме», передавая либо список имён файлов, либо словарь, содержащий files и paths.

Примеры

- name: show first existing file or ignore if none do
  debug: msg={{lookup('first_found', findme, errors='ignore')}}
  vars:
    findme:
      - "/path/to/foo.txt"
      - "bar.txt"  # will be looked in files/ dir relative to role and/or play
      - "/path/to/biz.txt"

- name: |
        include tasks only if files exist.  Note the use of query() to return
        a blank list for the loop if no files are found.
  import_tasks: '{{ item }}'
  vars:
    params:
      files:
        - path/tasks.yaml
        - path/other_tasks.yaml
  loop: "{{ query('first_found', params, errors='ignore') }}"

- name: |
        copy first existing file found to /some/file,
        looking in relative directories from where the task is defined and
        including any play objects that contain it
  copy: src={{lookup('first_found', findme)}} dest=/some/file
  vars:
    findme:
      - foo
      - "{{inventory_hostname}}"
      - bar

- name: same copy but specific paths
  copy: src={{lookup('first_found', params)}} dest=/some/file
  vars:
    params:
      files:
        - foo
        - "{{inventory_hostname}}"
        - bar
      paths:
        - /tmp/production
        - /tmp/staging

- name: INTERFACES | Create Ansible header for /etc/network/interfaces
  template:
    src: "{{ lookup('first_found', findme)}}"
    dest: "/etc/foo.conf"
  vars:
    findme:
      - "{{ ansible_virtualization_type }}_foo.conf"
      - "default_foo.conf"

- name: read vars from first file found, use 'vars/' relative subdir
  include_vars: "{{lookup('first_found', params)}}"
  vars:
    params:
      files:
        - '{{ansible_distribution}}.yml'
        - '{{ansible_os_family}}.yml'
        - default.yml
      paths:
        - 'vars'

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

Общие значения возврата описаны здесь, следующие поля уникальны для этого поиска:

Ключ Возвращённое значение Описание
_raw
список / элементы=путь
успех
путь к найденному файлу



Авторы

  • Seth Vidal (!UNKNOWN) <skvidal@fedoraproject.org>

© 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/first_found_lookup.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API