Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_provision_async — управление подготовкой модулей BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_provision_async.

Добавлено в f5networks.f5_modules 1.25.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управляет подготовкой модулей BIG-IP. Этот модуль выполняет операции подготовки в асинхронном режиме. Дополнительные сведения см. в разделе «Примечания».

Параметры

Параметр

Комментарии

check_status

логический

Если true, модуль проверит ход подготовки.

Обязательный параметр при использовании параметра module.

Возможные значения:

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

level

строка

Задаёт уровень подготовки для указанных модулей. Изменение уровня одного модуля может потребовать изменения уровня другого. Например, изменение уровня одного модуля на dedicated требует установить для всех остальных уровень none. Если задать для модуля уровень none, это означает, что модуль не активирован.

Используйте state, если отсутствует, чтобы задать для c(level) значение none и отменить подготовку модуля.

Этот параметр не применим к cgnat - pre tmos 15.0 или mgmt и не будет применён к модулю cgnat - pre tmos 15.0 или mgmt.

Возможные значения:

  • "dedicated"
  • "nominal" ← (по умолчанию)
  • "minimum"

memory

строка

Задаёт дополнительный объём памяти для модуля управления. Он добавляется к минимально выделенному объёму ОЗУ — 1264 МБ.

Допустимый диапазон значений: 0 - 8192. Максимальное значение ограничено доступным объёмом ОЗУ в системе.

Указание large резервирует дополнительные 500 МБ для модуля mgmt.

Указание medium резервирует дополнительные 200 МБ для модуля mgmt.

Указание small не резервирует дополнительную ОЗУ для модуля mgmt.

Используйте large для конфигураций, содержащих более 2000 объектов, или, точнее, для конфигураций, в которых на каждые 2 ГБ установленной памяти приходится более 1000 объектов. Изменение размера памяти Management mgmt после первоначальной подготовки приводит к повторной операции подготовки.

module

псевдонимы: name

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

Модуль для подготовки на BIG-IP.

Возможные значения:

  • "am"
  • "afm"
  • "apm"
  • "asm"
  • "avr"
  • "cgnat"
  • "fps"
  • "gtm"
  • "ilx"
  • "lc"
  • "ltm"
  • "mgmt"
  • "pem"
  • "sam"
  • "sslo"
  • "swg"
  • "urldb"
  • "vcmp"

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

строка

Состояние подготовленного модуля в системе. Если present, это гарантирует подготовку указанного модуля на запрошенном уровне при условии, что на устройстве достаточно ресурсов (например, физической ОЗУ) для его работы.

Если absent, подготовка модуля отменяется.

absent не является допустимым значением для модуля mgmt, поскольку отменить его подготовку невозможно.

Возможные значения:

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

status_timeout

целое число

Время ожидания завершения процесса подготовки в секундах.

Допустимый диапазон значений — от 150 до 3600 секунд.

Если устройству требуется перезапустить модуль, оно вернёт результат без изменений и соответствующее сообщение. В таких случаях необходимо приостановить выполнение плейбука до готовности устройства (см. раздел EXAMPLES).

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

Примечания

Примечание

  • Проверка состояния подготовки с помощью параметра check_status не является идемпотентной (см. раздел EXAMPLES).
  • Модуль выполняет те же операции подготовки, что и bigip_provision, но не ожидает перезапуска служб или перезагрузки устройства. Это позволяет обрабатывать особые случаи при использовании модуля в некоторых средах, где операция подготовки может привести к истечению времени ожидания или бесконечному циклу, даже если она завершилась успешно.
  • Для достижения наилучших результатов используйте этот модуль совместно с модулем bigip_wait.
  • Для работы этого модуля требуется TMOS версии 15.x или более поздней.
  • Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия программного обеспечения BIG-IP не ниже 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диск, обязательно добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в его документации.

Примеры

- name: Provision GTM on the device
  bigip_provision_async:
    module: "gtm"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin

- name: Check for provision progress
  bigip_provision_async:
    module: "gtm"
    check_status: true
    status_timeout: 900
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost
  register: status

- name: Wait for 3 minutes if device is restarting services
  bigip_wait:
    timeout: 180
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost
  when:
    - result.message == "Device is restarting services, unable to check provisioning status."

- name: Re-check for provision progress
  bigip_provision_async:
    module: "gtm"
    check_status: true
    status_timeout: 900
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost
  register: status
  when:
    - status.message == "Device is restarting services, unable to check provisioning status."

- name: Provision GTM on the device - Idempotent Check
  bigip_provision_async:
    module: "gtm"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost
  register: result
  when:
    - status.message == "Device has finished provisioning the requested module."

- name: Assert Provision GTM on the device - Idempotent Check
  assert:
    that:
      - result is not changed
  when:
    - status.message == "Device has finished provisioning the requested module."

- name: Provision VCMP on the device
  bigip_provision_async:
    module: "vcmp"
    level: "dedicated"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost

- name: Check for provision progress
  bigip_provision_async:
    module: "vcmp"
    level: "dedicated"
    check_status: true
    status_timeout: 900
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost
  register: status

- name: Wait for 10 minutes if device is restarting services
  bigip_wait:
    timeout: 600
    type: vcmp
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost
  when:
    - result.message == "Device is restarting services, unable to check provisioning status."

- name: Re-check for provision progress
  bigip_provision_async:
    module: "vcmp"
    level: "dedicated"
    check_status: true
    status_timeout: 900
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost
  register: status
  when:
    - status.message == "Device is restarting services, unable to check provisioning status."

- name: Provision VCMP on the device - Idempotent Check
  bigip_provision_async:
    module: "vcmp"
    level: "dedicated"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  register: result
  delegate_to: localhost
  when:
    - status.message == "Device has finished provisioning the requested module."

- name: Assert Provision VCMP on the device - Idempotent Check
  assert:
    that:
      - result is not changed
  when:
    - status.message == "Device has finished provisioning the requested module."

- name: De-provision VCMP on the device
  bigip_provision_async:
    module: "vcmp"
    state: "absent"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin

- name: Check for de-provision progress
  bigip_provision_async:
    module: "vcmp"
    state: "absent"
    check_status: true
    status_timeout: 900
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  register: status

- name: Wait for 10 minutes if device is restarting services
  bigip_wait:
    timeout: 600
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  when:
    - result.message == "Device is restarting services, unable to check provisioning status."

- name: Re-check for de-provision progress
  bigip_provision_async:
    module: "vcmp"
    state: "absent"
    check_status: true
    status_timeout: 900
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  register: status
  when:
    - status.message == "Device is restarting services, unable to check provisioning status."

- name: De-provision VCMP on the device - Idempotent Check
  bigip_provision_async:
    module: "vcmp"
    state: "absent"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  register: result
  when:
    - status.message == "Device has finished de-provisioning the requested module."

- name: Assert Provision VCMP on the device - Idempotent Check
  assert:
    that:
      - result is not changed
  when:
    - status.message == "Device has finished de-provisioning the requested module."

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

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

Ключ

Описание

level

строка

Новый уровень подготовки модуля.

Возвращается: при изменении

Пример: "minimum"

memory

строка

Новый объём памяти, выделенный для модуля mgmt.

Возвращается: при изменении

Пример: "large"

message

словарь

Информационное сообщение о состоянии задачи Ansible.

Возвращается: при изменении

Пример: "hash/dictionary of values"

Авторы

  • Wojciech Wypior (@wojtek0806)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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