bigip_ucs_fetch - Загрузка файла UCS с удалённых узлов
Новая версия 2.5.
Краткое описание
- Этот модуль используется для загрузки файлов UCS с удалённых машин и сохранения их локально в файловой системе, структурированной по имени хоста. Обратите внимание, что этот модуль предназначен для передачи файлов UCS, которые могут отсутствовать, поэтому отсутствие удалённого файла UCS не является ошибкой, если fail_on_missing установлен в «да».
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| backup bool |
| Создать резервную копию файла, включая информацию о времени создания, чтобы вы могли восстановить исходный файл, если вы неправильно его перезаписали. | |
| create_on_missing bool |
| Создаёт файл UCS на основе значения src, если файла ещё нет на удалённой системе. | |
| dest обязательно | Директория для сохранения файла UCS. | ||
| encryption_password | Пароль для шифрования файла UCS, если это необходимо | ||
| fail_on_missing bool |
| Вызвать ошибку модуля, если файла UCS на удалённой системе нет. | |
| force bool |
| Если 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 установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверяться. Используйте только на сайтах, контролируемых вами лично, с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| timeout | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| 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 bool (добавлено в 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.
Примеры
- 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. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом 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.6/modules/bigip_ucs_fetch_module.html
