bigiq_regkey_license - Управляет лицензиями в пуле ключей регистрации BIG-IQ
Новая в версии 2.5.
Обзор
- Управляет лицензиями в пуле ключей регистрации BIG-IQ.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- BIG-IQ >= 5.3.0
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| accept_eula | Ключ, указывающий на принятие 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) | По умолчанию: None | Объект dict, содержащий данные подключения. | |
| ssh_keyfile | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER задана. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная среды F5_USER задана. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если переменная среды F5_SERVER_PORT задана. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если переменная среды F5_PASSWORD задана.Псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах под личным контролем с самозаверяющимися сертификатами. Можно опустить этот параметр, если переменная среды F5_VALIDATE_CERTS задана. | |
| 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 (добавлен в 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 строка | changed | Новое описание ключа лицензии. Пример: Моя лицензия для BIG-IP 1 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/bigiq_regkey_license_module.html