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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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 в случае сбоя или замены по RMA.

Параметры

Параметр	Комментарии
force boolean	Если `true`, файл загружается при каждом запуске и заменяет файл на устройстве. Если `false`, файл загружается, только если он ещё не существует. Как правило, значение `true` следует указывать только в случаях, когда вы считаете, что файл образа был повреждён при загрузке. Варианты: `false` ← (по умолчанию) `true`
include_chassis_level_config boolean	При восстановлении файла UCS включает конфигурацию уровня шасси, общую для наборов загрузочных томов. Например, конфигурацию кластера по умолчанию. Варианты: `false` `true`
no_license boolean	Выполняет полное восстановление файла UCS и всех содержащихся в нём файлов, за исключением файла лицензии. Этот параметр необходимо использовать для восстановления UCS на устройствах, заменённых по RMA (Returned Materials Authorization). Варианты: `false` `true`
no_platform_check boolean	Отключает проверку платформы и разрешает установку UCS, созданного на другой платформе. По умолчанию (без этого параметра) установка UCS, созданного на другой платформе, запрещена. Варианты: `false` `true`
passphrase string	Указывает парольную фразу, необходимую для загрузки указанного файла UCS.
provider dictionary добавлено в 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 псевдонимы: 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/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. Если имена узлов не совпадают, восстанавливается только общая конфигурация. Совпадение имён узлов можно обеспечить, выполнив в задаче модуль 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_ucs_module.html