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

Новое в версии 2.5.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Этот модуль используется для загрузки файлов 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 словарь добавлено в 2.5			Объект словаря с параметрами соединения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	password строка / обязательно		Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает файл ключа SSH для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli 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 сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль 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=yes	Имя созданного файла резервной копии Пример: /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

Статус

Данному модулю не гарантируется обратная совместимость. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

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.9/modules/bigip_ucs_fetch_module.html