f5networks.f5_modules.bigip_ucs_fetch – Загрузка файла UCS с удалённых узлов
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: 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не установлено в «да».
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| async_timeout целое число | Значение по умолчанию: 150 | Параметр используется при создании нового файла UCS на устройстве. Количество секунд ожидания завершения асинхронного интерфейса API. Принимаемые значения находятся в диапазоне от 150 до 1800 секунд. | |
| backup логическое значение |
| Создать резервную копию файла, включая отметку времени, чтобы восстановить исходный файл, если он был неправильно перезаписан. | |
| create_on_missing логическое значение |
| Создаёт файл UCS на основе значения src, если файла ещё нет на удалённой системе. | |
| dest путь / обязательно | Директория для сохранения файла UCS. | ||
| encryption_password строка | Пароль для шифрования файла UCS, если необходимо. | ||
| fail_on_missing логическое значение |
| Заставить модуль завершиться ошибкой, если файл UCS отсутствует на удалённой системе. | |
| force логическое значение |
| Если no, файл будет загружен только если файл назначения не существует. | |
| provider словарь добавлено в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщик аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логическое значение |
| Если 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 строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| src строка | Имя файла UCS, который необходимо создать на удалённом сервере для загрузки. Файл будет получен или создан в /var/local/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 |
Авторы
- Тим Рупп (@caphrim007)
- Войцех Выпиор (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_ucs_fetch_module.html
