bigip_ucs_fetch - Загрузка файла UCS с удаленных узлов
Новая версия с 2.5.
Обзор
- Этот модуль используется для загрузки файлов UCS с удаленных машин и сохранения их локально в древовидной структуре файлов, организованной по имени хоста. Обратите внимание, что этот модуль написан для передачи файлов UCS, которые могут отсутствовать, поэтому отсутствие удалённого файла UCS не является ошибкой, если fail_on_missing не установлен в «да».
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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) | По умолчанию: Нет | Объект типа dict, содержащий данные подключения. | |
| ssh_keyfile | Указывает файл ключа SSH для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER задана. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, если переменная среды F5_USER задана. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER_PORT задана. | |
| password обязательно | Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная среды F5_PASSWORD задана.Псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющими сертификатами. Этот параметр можно опустить, если переменная среды F5_VALIDATE_CERTS задана. | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| 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 для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет Python f5-sdk на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- 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 |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость.
Автор
- 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.5/modules/bigip_ucs_fetch_module.html
