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

Примечание

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

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

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

Новый в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

Управляет лицензиями в пуле ключей регистрации 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 добавлен в 1.0.0 версии f5networks.f5_modules			Объект типа dict, содержащий данные подключения.
	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`.
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, сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль 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: 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

Авторы

Tim Rupp (@caphrim007)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigiq_regkey_license_module.html