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

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

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup boolean		Варианты: нет ← да	Создать резервную копию файла, включая отметку времени, чтобы вы могли восстановить исходный файл, если его неправильно перезаписали.
create_on_missing boolean		Варианты: нет да ←	Создаёт UCS на основе значения `src`, если файл ещё не существует на удалённой системе.
dest - / обязательно			Директория для сохранения файла UCS.
encryption_password -			Пароль для шифрования файла UCS, если требуется.
fail_on_missing boolean		Варианты: нет ← да	Вызвать ошибку модуля, если файл UCS на удалённой системе отсутствует.
force boolean		Варианты: нет да ←	Если `no`, файл будет передан только в том случае, если целевой файл не существует.
password - / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды `F5_PASSWORD`. Псевдонимы: pass, pwd
provider - добавлен в 2.5		Значение по умолчанию: null	Объект словаря, содержащий данные подключения.
	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 -	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку.
	transport - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Можно опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
server - / обязательно			Хост BIG-IP. Можно опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port - добавлен в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
src -			Имя файла UCS, который нужно создать на удалённом сервере для загрузки.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean добавлен в 2.0		Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Можно опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

BIG-IP не предоставляет способ получения контрольной суммы файлов UCS на системе через какой-либо интерфейс, кроме, возможно, прямого входа на устройство (что не поддерживает режим прибора). Поэтому модуль может только проверить существование файла на диске; контрольная сумма не проверяется.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия программного обеспечения BIG-IP ≥ 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диск, убедитесь, что есть хотя бы одна задача, использующая модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Download a new UCS
  bigip_ucs_fetch:
    server: lb.mydomain.com
    user: admin
    password: secret
    src: cs_backup.ucs
    dest: /tmp/cs_backup.ucs
  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)

Подсказка

Если вы обнаружите проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

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