Модуль f5networks.f5_modules.bigip_ucs_fetch – Загрузка файла UCS с удаленных узлов

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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 не является ошибкой, если 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` перед запуском этого модуля с `only_create_file` установленным в `true`. Варианты: `false` ← (по умолчанию) `true`
owner строка	Имя пользователя, который должен владеть объектом файловой системы (как в команде chown). Если не указано, используется текущий пользователь, если вы не являетесь root-пользователем, в этом случае сохраняется предыдущее владение. Указание числового имени пользователя будет интерпретироваться как идентификатор пользователя, а не имя пользователя. Избегайте числовых имен пользователей, чтобы избежать этой путаницы.
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem boolean	Если `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 boolean	Если `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 boolean	Влияет на использование атомарных операций для предотвращения повреждения данных или несогласованных чтений из целевого объекта файловой системы. По умолчанию этот модуль использует атомарные операции для предотвращения повреждения данных или несогласованных чтений из целевых объектов файловой системы, но иногда системы настроены или просто сломаны так, что это невозможно. Одним из примеров являются смонтированные файловые системы Docker, которые не могут обновляться атомарно изнутри контейнера и могут записываться только ненадёжным способом. Этот параметр позволяет Ansible перейти к небезопасным методам обновления объектов файловой системы, когда атомарные операции терпят неудачу (хотя он не принуждает Ansible выполнять небезопасные записи). ВАЖНО! Небезопасные записи подвержены гонкам и могут привести к повреждению данных. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

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

Авторы

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

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_ucs_fetch_module.html