bigip_ucs - Управление загрузкой, установкой и удалением файлов UCS
Новое в версии 2.4.
Описание
- Управление загрузкой, установкой и удалением файлов UCS.
Требования
Ниже приведены требования к хосту, на котором выполняется данный модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| force |
| Если yes, файл будет загружаться каждый раз и заменять файл на устройстве. Если no, файл будет загружен только в случае, если он еще не существует. В целом, следует использовать yes только в тех случаях, когда есть основания полагать, что изображение было повреждено во время загрузки. | |
| include_chassis_level_config |
| При восстановлении файла UCS включать конфигурацию уровня шасси, которая совместно используется наборами томов загрузки. Например, конфигурацию по умолчанию кластера. | |
| no_license |
| Выполняет полное восстановление файла UCS и всех содержащихся в нём файлов, за исключением файла лицензии. Данный параметр необходимо использовать для восстановления UCS на устройствах RMA (Авторизация возврата материалов). | |
| no_platform_check |
| Пропускает проверку платформы и позволяет установить UCS, созданный с использованием другой платформы. По умолчанию (без этого параметра) установка UCS, созданного на другой платформе, запрещена. | |
| passphrase |
| Указывает пароль, необходимый для загрузки указанного файла UCS. | |
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| provider (добавлено в 2.5) | По умолчанию: Нет | Объект словаря, содержащий сведения о подключении. | |
| 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 обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. | |
| reset_trust |
| При указании этого параметра сертификаты и ключи устройства и домена доверия не загружаются из 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 (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверяемыми сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Данный модуль выполняет только самые базовые проверки. Необходимо учитывать и другие проверки и соображения. См. следующую ссылку. 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
Статус
Данный модуль помечен как предварительный, что означает, что гарантия обратной совместимости интерфейса не предоставляется.
Автор
- 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_module.html
