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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

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

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_ucs_fetch.

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup boolean		Варианты: нет ← да	Создать резервную копию файла, включая информацию о времени, чтобы вернуть исходный файл в случае его неправильного перезаписи.
create_on_missing boolean		Варианты: нет да ←	Создаёт файл UCS на основе значения `src`, если файл ещё не существует на удалённой системе.
dest путь / обязательный			Директория для сохранения файла UCS.
encryption_password строка			Пароль для шифрования файла UCS, если необходимо.
fail_on_missing boolean		Варианты: нет ← да	Вызвать ошибку модуля, если файл UCS на удалённой системе отсутствует.
force boolean		Варианты: нет да ←	Если `no`, файл будет перенесён только если файл назначения не существует.
provider словарь добавлен в 1.0.0 модуля f5networks.f5_modules			Объект словаря, содержащий данные соединения.
	auth_provider строка		Настройка поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете пропустить этот параметр, установив переменную окружения `F5_TEEM`.
	password строка / обязательный		Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете пропустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательный		Хост BIG-IP. Вы можете пропустить этот параметр, установив переменную окружения `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете пропустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удалённому устройству.
	user строка / обязательный		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Вы можете пропустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяемыми сертификатами. Вы можете пропустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
src строка			Имя файла UCS для создания на удалённом сервере для загрузки.

Примечания

Примечание

BIG-IP не предоставляет способ получения контрольной суммы файлов UCS на системе через любой интерфейс, за исключением прямого входа на устройство (что не поддерживается в режиме виртуального приложения). Поэтому модуль может только проверить существование файла на диске; контроль контрольной суммы не производится.
Если вы используете этот модуль с Ansible Tower или Ansible AWX, вы должны знать, как эти продукты Ansible выполняют задачи в ограниченных средах. Дополнительную информацию можно найти здесь https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html
Дополнительную информацию об использовании 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

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

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

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

Авторы

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

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