Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigiq_regkey_pool — Управляет пулами ключей регистрации на 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_pool.

Новое в f5networks.f5_modules 1.0.0

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

Описание

  • Управляет пулами ключей регистрации (regkey) на BIG-IQ. Эти пулы служат контейнером, в который вы добавляете списки ключей регистрации. Для добавления ключей регистрации используйте модуль bigiq_regkey_license.

Требования

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

  • BIG-IQ >= 5.3.0

Параметры

Параметр

Комментарии

description

строка

Описание, которое нужно добавить к пулу.

name

строка / обязательно

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

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

provider

словарь

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

Объект типа dict, содержащий данные подключения.

auth_provider

строка

Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства.

Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem

булево

Если yes, данные телеметрии TEEM не отправляются в F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Ранее используемая переменная F5_TEEM устарела, так как её название вызывало недоразумения.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

строка / обязательно

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

server

строка / обязательно

Хост BIG-IP или хост BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

целое число

Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.

transport

строка

Настраивает транспортное подключение для использования при подключении к удалённому устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

строка / обязательно

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

булево

Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

state

строка

Состояние пула 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: Create a registration key (regkey) pool to hold individual device licenses
  bigiq_regkey_pool:
    name: foo-pool
    state: present
    provider:
      user: admin
      password: secret
      server: cm.mydomain.com
  delegate_to: localhost

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

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

Ключ

Описание

description

строка

Новое описание пула regkey.

Возвращено: изменён

Пример: "My description"

Авторы

  • Tim Rupp (@caphrim007)

Ссылки на коллекцию

  • Отслеживание задач
  • Главная страница
  • Репозиторий (Исходные тексты)

© 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_pool_module.html

Spec-Zone.ru

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