f5networks.f5_modules.bigiq_regkey_license модуль – Управление лицензиями в пуле ключей регистрации BIG-IQ

Примечание

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

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

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: f5networks.f5_modules.bigiq_regkey_license.

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

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Управляет лицензиями в пуле ключей регистрации BIG-IQ.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

BIG-IQ >= 5.3.0

Параметры

Параметр	Комментарии
accept_eula boolean	Ключ, подтверждающий принятие EULA F5 для данной лицензии. Копию EULA можно найти здесь https://askf5.f5.com/csp/article/K12902 Это необходимо, когда `state` является `present`. Варианты: `false` `true`
addon_keys list / elements=string добавлен в f5networks.f5_modules 1.16.0	Ключи дополнений, которые нужно добавить в пул.
description string	Описание лицензии.
license_key string / обязательно	Ключ лицензии, который нужно добавить в пул.
provider dictionary добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
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` ← (по умолчанию)
regkey_pool string / обязательно	Пул ключей регистрации, в котором вы хотите разместить лицензию. Вы должны присваивать уникальные имена пулам регистрации. Хотя BIG-IQ этого не требует, данный модуль это делает. Если вы этого не сделаете, поведение модуля не определено, и вы можете поместить лицензии в неправильный пул ключей регистрации.
state string	Состояние лицензии regkey в пуле на системе. Когда `present`, гарантирует, что лицензия существует в пуле. Когда `absent`, удаляет лицензию из пула. Варианты: `"absent"` `"present"` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 обрабатывают только рабочую конфигурацию продукта F5. Чтобы гарантировать сохранение конфигурации BIG-IP на диске, убедитесь, что включён хотя бы один таск, использующий модуль f5networks.f5_modules.bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля за правильным использованием модуля для сохранения рабочей конфигурации.

Примеры

- name: Add a registration key license to a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    accept_eula: true
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add a registration key license with addon keys to a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    addon_keys:
      - YYYY-YYY-YYY
      - ZZZZ-ZZZ-ZZZ
    accept_eula: true
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove a registration key license from a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    state: absent
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
описание строка	Новое описание ключа лицензии. Возвращено: изменено Пример: `"My license for BIG-IP 1"`

Авторы

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/bigiq_regkey_license_module.html