Spec-Zone.ru › Ansible 2.9

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

Новая в версии 2.5.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

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

Требования

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

  • BIG-IQ >= 5.3.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
accept_eula
boolean
    Варианты:
  • no
  • yes
Ключ, указывающий на принятие EULA F5 для этой лицензии.
Копию EULA можно найти здесь https://askf5.f5.com/csp/article/K12902
Это требуется, когда state является present.
description
string
Описание лицензии.
license_key
string / обязательно
Ключ лицензии для добавления в пул.
provider
dictionary
добавлено в 2.5
Объект словаря, содержащий данные подключения.
auth_provider
string
Настраивает поставщика авторизации для получения маркеров аутентификации с удаленного устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
password
string / обязательно
Пароль учетной записи пользователя для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.

псевдонимы: pass, pwd
server
string / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER.
server_port
integer
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT.
ssh_keyfile
path
Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli.
Вы можете опустить этот параметр, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
integer
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
transport
string
    Варианты:
  • cli
  • rest ←
Настраивает транспортное подключение для подключения к удаленному устройству.
user
string / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.
regkey_pool
string / обязательно
Пул ключей регистрации, в который нужно поместить лицензию.
Необходимо использовать уникальные имена для пулов регистрации. Хотя BIG-IQ этого не требует, этот модуль требует. Если этого не сделать, поведение модуля не определено, и вы можете поместить лицензии в неправильный пул ключей регистрации.
state
string
    Варианты:
  • absent
  • present ←
Состояние лицензии regkey в пуле на системе.
Когда present, гарантирует, что лицензия существует в пуле.
Когда absent, удаляет лицензию из пула.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы гарантировать, что специфичная для BIG-IP конфигурация сохранится на диске, убедитесь, что включен хотя бы один этап, использующий модуль 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: yes
    provider:
      password: secret
      server: lb.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: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

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

Ключ Возвращённое значение Описание
description
string
changed
Новое описание ключа лицензии.

Пример:
Моя лицензия для BIG-IP 1


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
  • Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

  • Tim Rupp (@caphrim007)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigiq_regkey_license_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API