bigip_ucs_fetch – Загрузка файла UCS с удаленных узлов
Новая версия с 2.5.
Обзор
- Этот модуль используется для загрузки файлов UCS с удаленных машин и сохранения их локально в файловой системе, организованной по имени хоста. Обратите внимание, что этот модуль предназначен для передачи файлов UCS, которые могут отсутствовать, поэтому отсутствие удалённого файла UCS не будет ошибкой, если fail_on_missing установлен в «да».
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| backup логический тип |
| Создаёт резервную копию файла, включая информацию о времени создания, чтобы вы могли восстановить исходный файл, если случайно его повредите. | |
| create_on_missing логический тип |
| Создаёт файл UCS на основе значения src, если он ещё не существует на удалённой системе. | |
| dest путь / обязательно | Директория для сохранения файла UCS. | ||
| encryption_password строка | Пароль для шифрования файла UCS, если это необходимо. | ||
| fail_on_missing логический тип |
| Принудительно завершить выполнение модуля, если файл UCS на удалённой системе отсутствует. | |
| force логический тип |
| Если no, файл будет скопирован только если целевой файл не существует. | |
| password строка / обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий данные подключения. | ||
| 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 строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логический тип |
| Если 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 логический тип добавлен в 2.0 |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах под вашим контролем, использующих самозаверенные сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- 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=да | Имя созданного файла резервной копии Пример: /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.8/modules/bigip_ucs_fetch_module.html
