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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Добавлен в f5networks.f5_modules 1.0.0

Описание
Параметры
Примечания
Примеры

Описание

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

Параметры

Параметр	Комментарии
force boolean	Если `true`, система загружает файл каждый раз и заменяет файл на устройстве. Если `false`, файл загружается только в том случае, если он ещё не существует. В целом, следует использовать только `true` в тех случаях, когда вы считаете, что изображение было повреждено во время загрузки. Варианты: `false` ← (по умолчанию) `true`
include_chassis_level_config boolean	Во время восстановления файла UCS включает конфигурацию уровня системного блока, которая используется наборами загрузочных томов. Например, кластерная конфигурация по умолчанию. Варианты: `false` `true`
no_license boolean	Выполняет полное восстановление файла UCS и всех содержащихся в нём файлов, за исключением файла лицензии. Параметр необходимо использовать для восстановления UCS на устройствах RMA (Возвращенного Материала Авторизации). Варианты: `false` `true`
no_platform_check boolean	Пропускает проверку платформы и позволяет установить UCS, созданный с использованием другой платформы. По умолчанию (без этого параметра) установка UCS, созданного на другой платформе, запрещена. Варианты: `false` `true`
passphrase string	Указывает пароль, необходимый для загрузки указанного файла UCS.
provider dictionary added in f5networks.f5_modules 1.0.0	Объект типа dict, содержащий данные подключения.
auth_provider string	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как её название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password aliases: pass, pwd string / обязательно	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server string / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное подключение, используемое при подключении к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
reset_trust boolean	При указании, сертификаты устройства и домена доверия, а также ключи не загружаются из UCS. Вместо этого создаётся новый набор. Варианты: `false` `true`

state

string

Когда installed, гарантирует загрузку и установку UCS на системе. Когда present, гарантирует загрузку UCS. Когда absent, UCS удаляется из системы. Когда installed, загрузка UCS является идемпотентной, однако установка этой конфигурации не является идемпотентной.

Варианты:

"absent"
"installed"
"present" ← (по умолчанию)

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: true
    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: true
    no_platform_check: true
    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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_ucs_module.html