f5networks.f5_modules.bigip_ucs — Управление загрузкой, установкой и удалением файлов UCS

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать его в playbook, укажите: f5networks.f5_modules.bigip_ucs.

Новое в версии 1.0.0: of f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры

Обзор

Управление загрузкой, установкой и удалением файлов UCS на системе BIG-IP. Набор конфигураций пользователя (UCS) — это резервная копия, содержащая данные конфигурации BIG-IP, которые могут быть использованы для полного восстановления системы BIG-IP в случае сбоя или замены в рамках RMA.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
force boolean		Варианты: no ← yes	Если `yes`, система загружает файл каждый раз и заменяет файл на устройстве. Если `no`, файл загружается только в том случае, если он еще не существует. В целом следует использовать только `yes` в тех случаях, когда вы считаете, что изображение было повреждено во время загрузки.
include_chassis_level_config boolean		Варианты: no yes	При восстановлении файла UCS включает конфигурацию уровня шины, которая совместно используется наборами загрузочных томов. Например, кластерная конфигурация по умолчанию.
no_license boolean		Варианты: no yes	Выполняет полное восстановление файла UCS и всех содержащихся в нем файлов, за исключением файла лицензии. Этот параметр необходимо использовать для восстановления UCS на устройствах RMA (Returned Materials Authorization).
no_platform_check boolean		Варианты: no yes	Обойти проверку платформы и разрешить установку UCS, созданного с использованием другой платформы. По умолчанию (без этого параметра) установка UCS, созданного с другой платформы, не разрешена.
passphrase string			Указывает пароль, необходимый для загрузки указанного файла UCS.
provider dictionary добавлен в 1.0.0 of f5networks.f5_modules			Объект словаря, содержащий сведения о подключении.
	auth_provider string		Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password string / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port integer	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout integer		Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	transport string	Варианты: rest ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user string / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
reset_trust boolean		Варианты: no yes	При указании устройство и сертификаты домена доверия и ключи не загружаются из UCS. Вместо этого генерируется новый набор.
state string		Варианты: absent installed present ←	При `installed`, гарантирует загрузку и установку UCS на системе. При `present`, гарантирует загрузку UCS. При `absent`, UCS удаляется с системы. При `installed`, загрузка UCS является идемпотентной, но установка этой конфигурации не является идемпотентной.
ucs string / обязательно			Путь к файлу UCS для установки. Параметр должен быть предоставлен, если `state` равно `installed` или `activated`. Когда `state` равно `absent`, полный путь для этого параметра игнорируется, и используется только имя файла для выбора UCS для удаления. Таким образом, вы можете указать `/foo/bar/test.ucs`, и этот модуль будет искать только `test.ucs`.

Примечания

Примечание

Этот модуль выполняет только самые базовые проверки. Необходимо учитывать и другие проверки и соображения. См. https://support.f5.com/kb/en-us/solutions/public/11000/300/sol11318.html
Этот модуль не обрабатывает устройства с FIPS 140 HSM.
Этот модуль не обрабатывает системы BIG-IP на аппаратных платформах 6400, 6800, 8400 или 8800.
Этот модуль не проверяет, синхронизированы ли новые или замененные ключи SSH из файла UCS между системой BIG-IP и SCCP.
Этот модуль не поддерживает параметр «rma».
Этот модуль не поддерживает восстановление архива UCS на аппаратных платформах BIG-IP 1500, 3400, 4100, 6400, 6800 или 8400, отличных от системы, с которой была создана резервная копия.
Операция восстановления UCS восстанавливает полную конфигурацию только в том случае, если имя хоста целевой системы совпадает с именем хоста, на котором был создан архив UCS. Если имена хостов не совпадают, восстанавливается только общая конфигурация. Вы можете убедиться, что имена хостов совпадают, используя модуль Ansible bigip_hostname в задаче перед использованием этого модуля.
Этот модуль не поддерживает повторную лицензирование BIG-IP, восстановленного из UCS.
Этот модуль не поддерживает восстановление зашифрованных архивов на заменяемых устройствах RMA.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. в https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP ≥ 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config, чтобы сохранить текущую конфигурацию. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Upload UCS
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS.
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS without installing the license portion
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    no_license: yes
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS except the license, and bypassing the platform check
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    no_license: yes
    no_platform_check: yes
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS using a passphrase necessary to load the UCS
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    passphrase: MyPassphrase1234
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove uploaded UCS file
  bigip_ucs:
    ucs: bigip.localhost.localdomain.ucs
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@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_module.html