Модуль f5networks.f5_modules.bigip_ucs_fetch – получение файла UCS с удалённых узлов

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_ucs_fetch.

Добавлено в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль используется для получения файлов UCS с удалённых компьютеров и их локального сохранения в файловой структуре, организованной по именам узлов. Модуль предназначен для создания и передачи файлов UCS, которые могут отсутствовать; предварительно создавать файл UCS не требуется. Поэтому отсутствие удалённого файла UCS не считается ошибкой, если только не задано значение «yes» для fail_on_missing.

Параметры

Параметр	Комментарии
async_timeout целое число	Параметр, используемый при создании нового файла UCS на устройстве. Количество секунд ожидания завершения задачи асинхронным интерфейсом API. Допустимый диапазон значений — от `150` до `1800` секунд. По умолчанию: `150`
attributes псевдонимы: attr строка	Атрибуты, которые должен иметь итоговый объект файловой системы. Сведения о поддерживаемых флагах см. на странице руководства для `chattr` целевой системы. Эта строка должна содержать атрибуты в том же порядке, в котором они отображаются командой `lsattr`. По умолчанию предполагается оператор `=`; в противном случае строка должна содержать операторы `+` или `-`.
backup логическое значение	Создаёт резервную копию с информацией о временной метке, чтобы можно было восстановить исходный файл, если он был перезаписан неверно. Варианты: `false` ← (по умолчанию) `true`
create_on_missing логическое значение	Создаёт файл UCS на основе значения `src`, если файл ещё не существует в удалённой системе. Если задано значение `false`, а для `fail_on_missing` установлено значение `false`, модуль не будет сообщать об изменениях, если файл UCS отсутствует на устройстве. Варианты: `false` `true` ← (по умолчанию)
dest путь	Каталог для сохранения файла UCS. Этот параметр обязателен, если для `only_create_file` задано значение `false`.
encryption_password строка	Пароль для шифрования файла UCS, если оно требуется.
fail_on_missing логическое значение	Завершает работу модуля с ошибкой, если файл UCS отсутствует в удалённой системе. Этот параметр всегда имеет приоритет над `create_on_missing`, поэтому при значении `true` модуль всегда завершится с ошибкой, если файл UCS отсутствует, даже если для параметра `create_on_missing` задано значение `true`. Если задано значение `false`, а для `create_on_missing` установлено значение `false`, модуль не будет сообщать об изменениях, если файл UCS отсутствует на устройстве. Варианты: `false` ← (по умолчанию) `true`
force логическое значение	Если задано значение `false`, файл передаётся только в том случае, если целевой файл не существует. Варианты: `false` `true` ← (по умолчанию)
group строка	Имя группы, которой должен принадлежать объект файловой системы; это значение передаётся команде `chown`. Если значение не указано, используется текущая группа текущего пользователя. Если текущий пользователь — root, может сохраняться прежний владелец.
mode любой тип	Права доступа, которые должен иметь итоговый объект файловой системы. Если вы привыкли к `/usr/bin/chmod`, помните, что режимы на самом деле являются восьмеричными числами. Ansible необходимо предоставить достаточно информации для их правильного разбора. Для получения предсказуемых результатов заключайте восьмеричные числа в кавычки (например, `'644'` или `'1777'`), чтобы Ansible получил строку и преобразовал её в число самостоятельно. Иногда работает добавление ведущего нуля (например, `0755`), но в циклах и некоторых других случаях это может привести к ошибке. Если передать Ansible число, не соблюдая ни одно из этих правил, оно будет интерпретировано как десятичное, что приведёт к неожиданным результатам. Начиная с Ansible 1.8 режим можно указывать в символьном формате (например, `u+rwx` или `u=rw,g=r,o=r`). Если `mode` не указан и целевой объект файловой системы не существует, при задании режима для нового объекта будет использоваться значение по умолчанию `umask` в системе. Если `mode` не указан и целевой объект файловой системы существует, будет использоваться режим существующего объекта файловой системы. Указание `mode` — лучший способ обеспечить создание объектов файловой системы с правильными правами доступа. Дополнительные сведения см. в CVE-2020-1736.
only_create_file логическое значение добавлено в f5networks.f5_modules 1.12.0	Если задано значение `true`, файл создаётся на устройстве, но не скачивается. Если архив UCS существует на устройстве, изменения не вносятся и файл не скачивается. Чтобы пересоздать файлы UCS, оставшиеся на устройстве, удалите их с помощью модуля `bigip_ucs`, прежде чем запускать этот модуль со значением `true` для параметра `only_create_file`. Варианты: `false` ← (по умолчанию) `true`
owner строка	Имя пользователя, которому должен принадлежать объект файловой системы; это значение передаётся команде `chown`. Если значение не указано, используется текущий пользователь. Если текущий пользователь — root, может сохраняться прежний владелец. Числовое имя пользователя будет считаться идентификатором пользователя, а не именем. Во избежание неоднозначности не используйте числовые имена пользователей.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения для подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если задано значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` считается устаревшей, поскольку её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server строка / обязательный	Имя узла BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.
transport строка	Настраивает транспортное соединение, используемое для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs логическое значение	Если задано значение `no`, сертификаты SSL не проверяются. Используйте этот параметр только на подконтрольных вам сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
selevel строка	Уровень в контексте объекта файловой системы SELinux. Это атрибут MLS/MCS, иногда называемый `range`. Если задано значение `_default`, будет использоваться часть политики `level`, если она доступна.
serole строка	Роль в контексте объекта файловой системы SELinux. Если задано значение `_default`, будет использоваться часть политики `role`, если она доступна.
setype строка	Тип в контексте объекта файловой системы SELinux. Если задано значение `_default`, будет использоваться часть политики `type`, если она доступна.
seuser строка	Пользователь в контексте объекта файловой системы SELinux. По умолчанию, если применимо, используется политика `system`. Если задано значение `_default`, будет использоваться часть политики `user`, если она доступна.
src строка	Имя файла UCS, который будет создан на удалённом сервере для скачивания. Файл извлекается или создаётся в каталоге /var/local/ucs/. Этот параметр обязателен, если для `only_create_file` задано значение `true`.
unsafe_writes логическое значение	Определяет, когда использовать атомарные операции для предотвращения повреждения данных или несогласованного чтения целевого объекта файловой системы. По умолчанию этот модуль использует атомарные операции, чтобы предотвратить повреждение данных или несогласованное чтение целевых объектов файловой системы, однако некоторые системы настроены особым образом или работают некорректно, что делает это невозможным. Например, объекты файловой системы, подключённые Docker, нельзя атомарно обновить изнутри контейнера — их можно записывать только небезопасным способом. Этот параметр позволяет Ansible перейти к небезопасным методам обновления объектов файловой системы, если атомарные операции завершатся ошибкой (однако он не заставляет Ansible выполнять небезопасную запись). ВАЖНО! Небезопасная запись подвержена состояниям гонки и может привести к повреждению данных. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

BIG-IP не предоставляет интерфейса для получения контрольной суммы файлов UCS в системе. Возможно, исключением является непосредственный вход на устройство, но этот способ не поддерживает режим устройства. Поэтому модуль может лишь проверить наличие файла на диске; проверка контрольной суммы не выполняется.
Если вы используете этот модуль с Ansible Tower или Ansible AWX, учитывайте, что эти продукты Ansible выполняют задания в ограниченных средах. Дополнительные сведения см. здесь: https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html
Некоторые длительные задачи могут привести к тайм-ауту интерфейса REST на BIG-IP. Чтобы избежать этого, настройте таймеры в соответствии с этой статьёй базы знаний: https://support.f5.com/csp/article/K94602685
Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диске, обязательно включите хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в документации к нему.

Примеры

- name: Download a new UCS
  bigip_ucs_fetch:
    src: cs_backup.ucs
    dest: /tmp/cs_backup.ucs
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Only create new UCS, no download
  bigip_ucs_fetch:
    src: cs_backup.ucs
    only_create_file: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Recreate UCS file left on device - remove file first
  bigip_ucs:
    ucs: cs_backup.ucs
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Recreate UCS file left on device - create new file
  bigip_ucs_fetch:
    src: cs_backup.ucs
    only_create_file: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
backup_file string	Имя файла резервной копии. Возвращается: при изменении и если backup=yes Пример: `"/path/to/file.txt.2015-02-12@22:09~"`
checksum string	Контрольная сумма SHA1 загруженного файла. Возвращается: при успешном выполнении или изменении Пример: `"7b46bbe4f8ebfee64761b5313855618f64c64109"`
dest string	Путь на хосте Ansible, куда был сохранен UCS. Возвращается: при успешном выполнении Пример: `"/path/to/file.txt"`
gid integer	Идентификатор группы файла UCS после выполнения. Возвращается: при успешном выполнении Пример: `100`
group string	Группа файла UCS после выполнения. Возвращается: при успешном выполнении Пример: `"httpd"`
md5sum string	Контрольная сумма MD5 загруженного файла. Возвращается: при изменении или успешном выполнении Пример: `"96cacab4c259c4598727d7cf2ceb3b45"`
mode string	Разрешения целевого файла UCS после выполнения. Возвращается: при успешном выполнении Пример: `"420"`
owner string	Владелец файла UCS после выполнения. Возвращается: при успешном выполнении Пример: `"httpd"`
size integer	Размер целевого файла UCS после выполнения. Возвращается: при успешном выполнении Пример: `1220`
src string	Имя файла UCS на удаленном BIG-IP для загрузки. Если не указано, используется случайно сгенерированное имя файла. Возвращается: при изменении Пример: `"cs_backup.ucs"`
uid integer	Идентификатор владельца файла UCS после выполнения. Возвращается: при успешном выполнении Пример: `100`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 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/collections/f5networks/f5_modules/bigip_ucs_fetch_module.html