bigip_ucs - Управление загрузкой, установкой и удалением файлов UCS
Новая версия с 2.4.
Обзор
- Управление загрузкой, установкой и удалением файлов UCS.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| force bool |
| Если yes будет загружать файл каждый раз и заменять файл на устройстве. Если no, файл будет загружен только в случае его отсутствия. Обычно следует yes только в тех случаях, когда есть основания полагать, что изображение было повреждено во время загрузки. | |
| include_chassis_level_config bool |
| При восстановлении файла UCS включайте конфигурацию уровня шасси, которая совместно используется наборами томов загрузки. Например, конфигурация кластера по умолчанию. | |
| no_license bool |
| Выполняет полное восстановление файла UCS и всех содержащихся в нём файлов, за исключением файла лицензии. Этот параметр необходимо использовать для восстановления UCS на устройствах RMA (Returned Materials Authorization). | |
| no_platform_check bool |
| Пропускает проверку платформы и позволяет устанавливать UCS, созданный с использованием другой платформы. По умолчанию (без этого параметра) установка UCS, созданного на другой платформе, запрещена. | |
| passphrase bool |
| Указывает пароль, необходимый для загрузки указанного файла UCS. | |
| 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 обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| reset_trust bool |
| При указании этого параметра сертификаты и ключи устройства и домена доверия не загружаются из UCS. Вместо этого генерируется новый набор. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлен в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| state |
| Когда installed, гарантирует, что UCS загружен и установлен на системе. Когда present, гарантирует, что UCS загружен. Когда absent, UCS будет удалён из системы. При installed, загрузка UCS является идемпотентной, однако установка этой конфигурации не является идемпотентной. | |
| ucs | Путь к файлу UCS для установки. Параметр должен быть предоставлен, если state равно либо installed, либо activated. При state равном absent, полный путь для этого параметра будет проигнорирован, и для выбора UCS для удаления будет использовано только имя файла. Таким образом, можно указать /mickey/mouse/test.ucs, и этот модуль будет искать только test.ucs. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Можно опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool (добавлен в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Можно опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Этот модуль выполняет только самые базовые проверки. Необходимо учитывать другие проверки и соображения. См. следующий URL. https://support.f5.com/kb/en-us/solutions/public/11000/300/sol11318.html
- Этот модуль не обрабатывает устройства с HSM FIPS 140.
- Этот модуль не обрабатывает системы BIG-IP на аппаратной платформе 6400, 6800, 8400 или 8800.
- Этот модуль не проверяет, что новые или заменённые ключи SSH из файла UCS синхронизированы между системой BIG-IP и SCCP.
- Этот модуль не поддерживает опцию «rma».
- Этот модуль не поддерживает восстановление архива UCS на BIG-IP 1500, 3400, 4100, 6400, 6800 или 8400 аппаратных платформ, отличных от системы, с которой был создан резервный архив.
- Операция восстановления UCS восстанавливает полную конфигурацию только в том случае, если имя хоста целевой системы совпадает с именем хоста, на котором был создан архив UCS. Если имена хостов не совпадают, восстанавливается только общая конфигурация. Вы можете убедиться, что имена хостов совпадают, используя модуль
bigip_hostnameAnsible в задаче перед использованием этого модуля. - Этот модуль не поддерживает повторную лицензирование BIG-IP, восстановленного из UCS.
- Этот модуль не поддерживает восстановление зашифрованных архивов на заменяющих устройствах RMA.
- Для получения дополнительной информации об использовании Ansible для управления устройствами F5 Networks см. https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Upload UCS
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: present
delegate_to: localhost
- name: Install (upload, install) UCS.
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
delegate_to: localhost
- name: Install (upload, install) UCS without installing the license portion
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
no_license: yes
delegate_to: localhost
- name: Install (upload, install) UCS except the license, and bypassing the platform check
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
no_license: yes
no_platform_check: yes
delegate_to: localhost
- name: Install (upload, install) UCS using a passphrase necessary to load the UCS
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
passphrase: MyPassphrase1234
delegate_to: localhost
- name: Remove uploaded UCS file
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: bigip.localhost.localdomain.ucs
state: absent
delegate_to: localhost
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом 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_module.html