Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_provision_async модуль — Управление развёртыванием модулей BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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. Этот модуль выполняет операции развёртывания в асинхронном режиме. Дополнительная информация в разделе "Примечания".
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

check_status

boolean

Если true, модуль будет запущен для проверки хода выполнения процесса подготовки.

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

Варианты:

  • false ← (default)
  • true

level

string

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

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

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

Варианты:

  • "dedicated"
  • "nominal" ← (default)
  • "minimum"

memory

string

Задает дополнительную память для модуля управления. Это дополнительно к минимально выделенной оперативной памяти в 1264 МБ.

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

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

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

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

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

module

aliases: name

string / required

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

Варианты:

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

provider

dictionary

added in f5networks.f5_modules 1.0.0

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

auth_provider

string

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

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

no_f5_teem

boolean

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

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

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

Варианты:

  • false ← (default)
  • true

password

aliases: pass, pwd

string / required

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

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

server

string / required

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

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

server_port

integer

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

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

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

timeout

integer

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

transport

string

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

Варианты:

  • "rest" ← (default)

user

string / required

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

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

validate_certs

boolean

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

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

Варианты:

  • false
  • true ← (default)

состояние

строка

Состояние провизионированного модуля в системе. Если 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."

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

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

Ключ

Описание

уровень

строка

Новый уровень провизионирования модуля.

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

Пример: "minimum"

память

строка

Новое количество выделенной памяти для модуля mgmt.

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

Пример: "large"

сообщение

словарь

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

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

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

Авторы

  • Wojciech Wypior (@wojtek0806)

Ссылки на сборку

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

© 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/bigip_provision_async_module.html

Spec-Zone.ru

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