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

Примечание

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

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

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

Новое в версии 1.0.0: модуля 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 (Возврат материальных ресурсов).
no_platform_check boolean		Варианты: no yes	Пропускает проверку платформы и позволяет установить UCS, созданный на другой платформе. По умолчанию (без этого параметра) установка UCS, созданного на другой платформе, запрещена.
passphrase string			Указывает пароль, необходимый для загрузки указанного файла UCS.
provider dictionary добавлен в 1.0.0 модуля 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/ru-ru/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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_ucs_module.html