bigiq_regkey_license - Управляет лицензиями в пуле ключей регистрации BIG-IQ
Новая версия с 2.5.
Обзор
- Управляет лицензиями в пуле ключей регистрации BIG-IQ.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- BIG-IQ >= 5.3.0
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| accept_eula bool |
| Ключ, обозначающий принятие EULA F5 для данной лицензии. Копию EULA можно найти здесь https://askf5.f5.com/csp/article/K12902 Требуется, когда state равно present. | |
| description | Описание лицензии. | ||
| license_key обязательно | Ключ лицензии для добавления в пул. | ||
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| provider (добавлено в 2.5) | Объект типа dict, содержащий детали подключения. | ||
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Можно опустить, если переменная окружения F5_SERVER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить, если переменная окружения F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Пользователь должен иметь административные привилегии на устройстве. Можно опустить, если переменная окружения F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых сайтах с самозаверенными сертификатами. Можно опустить, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| timeout | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. | |
| regkey_pool обязательно | Пул ключей регистрации, в который вы хотите поместить лицензию. Необходимо использовать уникальные имена пулов регистрации. Хотя BIG-IQ этого не требует, этот модуль требует. Если этого не сделать, поведение модуля не определено, и вы можете поместить лицензии в неправильный пул ключей регистрации. | ||
| server обязательно | Хост BIG-IP. Можно опустить, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить, если переменная окружения F5_SERVER_PORT установлена. | |
| state |
| Состояние лицензии regkey в пуле на системе. Когда present, гарантирует, что лицензия существует в пуле.Когда absent, удаляет лицензию из пула. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Пользователь должен иметь административные привилегии на устройстве. Можно опустить, если переменная окружения F5_USER установлена. | ||
| validate_certs bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых сайтах с самозаверенными сертификатами. Можно опустить, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это легко выполняется как
pip install f5-sdk.
Примеры
- 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
password: secret
server: lb.mydomain.com
state: present
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
password: secret
server: lb.mydomain.com
state: absent
user: admin
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | изменён | Новое описание ключа лицензии. Пример: Моя лицензия для BIG-IP 1 |
Статус
Этот модуль помечен как превью, что означает, что гарантия обратной совместимости интерфейса не предоставляется.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/bigiq_regkey_license_module.html