avi_serviceenginegroup — Модуль для настройки ServiceEngineGroup Avi RESTful Объекта
Новая версия 2.4.
Обзор
- Этот модуль используется для конфигурации объекта ServiceEngineGroup
- больше примеров по адресу https://github.com/avinetworks/devops
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| active_standby | no | Сервисные движки в режиме актив/резерв для аварийного переключения при высокой доступности. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| advertise_backend_networks | no | Объявлять доступность сетей бэкенд-серверов через adc с помощью bgp для функции шлюза по умолчанию. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| aggressive_failure_detection | no | Включить агрессивную конфигурацию аварийного переключения для высокой доступности. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| algo | no | При компактном размещении виртуальные службы размещаются на существующих се, пока не будет достигнуто ограничение max_vs_per_se. Варианты перечисления - PLACEMENT_ALGO_PACKED, PLACEMENT_ALGO_DISTRIBUTED. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как PLACEMENT_ALGO_PACKED. | ||
| api_version | no | Версия API Avi для использования в Avi API и объектах. | ||
| archive_shm_limit | no | Объем памяти се в ГБ, до которого собирается общая память в архив ядра. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 8. | ||
| async_ssl (added in 2.4)
| no | SSL-рукопожатия будут обрабатываться выделенными потоками SSL. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| async_ssl_threads (added in 2.4)
| no | Количество потоков асинхронного SSL на се_dp. Допустимые значения - от 1 до 4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| auto_rebalance | no | Если установлено, виртуальные службы будут автоматически мигрированы, когда нагрузка на се меньше минимального или больше максимального порога. Если auto_rebalance не установлен, генерируются только оповещения. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| auto_rebalance_interval | no | Частота перебалансировки, если включен 'автоматический перебаланс'. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. | ||
| auto_redistribute_active_standby_load | no | Перераспределение виртуальных служб с перехватывающего се на заменяющий се может привести к кратковременному потере трафика. Если опция автоматического перераспределения нагрузки оставлена в состоянии выключенного по умолчанию, для перебалансировки необходимо выполнить вызовы API rest. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| buffer_se | no | Дополнительная мощность сервисного движка, выделенная для аварийного переключения высокой доступности. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| cloud_ref | no | Ссылка на объект типа cloud. | ||
| connection_memory_percentage | no | Процент памяти для состояния соединения. Это произойдет за счет памяти, используемой для кэша http в оперативной памяти. Допустимые значения - от 10 до 90. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 50. | ||
| controller | no | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения AVI_CONTROLLER. | ||
| cpu_reserve | no | Флаг булевого типа для установки cpu_reserve. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| cpu_socket_affinity | no | Назначить все ядра процессора виртуальным машинам сервисного движка на одном сокете процессора. Применимо только для облака vcenter. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| custom_securitygroups_data | no | Пользовательские группы безопасности, которые должны быть связаны с виртуальными сетями данных для экземпляров се в облаках OpenStack и AWS. Поле введено в 17.1.3. | ||
| custom_securitygroups_mgmt | no | Пользовательские группы безопасности, которые должны быть связаны с виртуальными сетями управления для экземпляров се в облаках OpenStack и AWS. Поле введено в 17.1.3. | ||
| custom_tag | no | Пользовательский тег будет использован для создания тегов для экземпляра се в AWS. Обратите внимание, что это не то же самое, что префикс имени се. | ||
| dedicated_dispatcher_core | no | Выделить ядро, которое обрабатывает прием/передачу пакетов из сети, только для функции диспетчеризации. Не использовать для функций tcp/ip и ssl. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| description | no | Пользовательское описание объекта. | ||
| disk_per_se | no | Объем дискового пространства для каждой виртуальной машины сервисного движка. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10. | ||
| distribute_load_active_standby | no | Использовать как активный, так и резервный сервисные движки для размещения виртуальных служб в режиме наследуемой высокой доступности актив/резерв. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| enable_routing | no | Включить маршрутизацию для этого сервисного движка. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| enable_vip_on_all_interfaces | no | Включить vip на всех интерфейсах се. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | ||
| enable_vmac | no | Использовать виртуальный MAC-адрес для интерфейсов, на которых размещены плавающие IP-адреса интерфейса. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| extra_config_multiplier | no | Множитель для дополнительной конфигурации для поддержки конфигурации большого количества виртуальных служб/пулов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0,0. | ||
| extra_shared_config_memory | no | Дополнительная конфигурационная память для поддержки конфигурации большой гео-базы данных. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| floating_intf_ip | no | Если для serviceenginegroup настроена модель наследуемой высокой доступности 1+1 актив/резерв, плавающие IP-адреса будут объявляться только активным се в паре. Виртуальные службы в этой группе должны быть отключены/включены для вступления в силу любых изменений в плавающих IP-адресах. Только активный се, размещающий vs, помеченный тегом активного резервного се 1, будет объявлять этот плавающий IP-адрес при включенном ручном распределении нагрузки. | ||
| floating_intf_ip_se_2 | no | Если для serviceenginegroup настроена модель наследуемой высокой доступности 1+1 актив/резерв, плавающие IP-адреса будут объявляться только активным се в паре. Виртуальные службы в этой группе должны быть отключены/включены для вступления в силу любых изменений в плавающих IP-адресах. Только активный се, размещающий vs, помеченный тегом активного резервного се 2, будет объявлять этот плавающий IP-адрес при включенном ручном распределении нагрузки. | ||
| ha_mode | no | Режим высокой доступности для всех виртуальных служб, использующих эту группу сервисных движков. Варианты перечисления - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как HA_MODE_SHARED. | ||
| hardwaresecuritymodulegroup_ref | no | Ссылка на объект типа hardwaresecuritymodulegroup. | ||
| hm_on_standby | no | Включить активный мониторинг работоспособности с резервного се для всех размещенных виртуальных служб. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | ||
| host_attribute_key | no | Ключ пары (ключ, значение), определяющий метку для набора узлов, обычно в облаках контейнеров. Нужно указывать вместе с host_attribute_value. Се могут быть настроены по-разному, включая режимы высокой доступности, в разных группах се. Может использоваться также для изоляции различных классов виртуальных служб. Группа се виртуальных служб может быть указана через аннотации/метки. Пространство имен openshift/kubernetes может быть помечено соответствующей меткой группы се, например, openshift.io/node-selector apptype=prod. Когда в облаке используются несколько групп се с указанными атрибутами хоста, только одна группа се может существовать как группа "соответствие всем", без host_attribute_key. | ||
| host_attribute_value | no | Значение пары (ключ, значение), определяющей метку для набора узлов, обычно в облаках контейнеров. Нужно указывать вместе с host_attribute_key. | ||
| hypervisor | no | Переопределение значения по умолчанию гипервизора. Варианты перечисления - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. | ||
| instance_flavor | no | Тип экземпляра/хранилища для экземпляра се. | ||
| iptables | no | Правила iptables. | ||
| least_load_core_selection | no | Выбор ядра с наименьшей нагрузкой для нового потока. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| log_disksz | нет | Максимальный объем диска (в МБ), который должен быть выделен для se. Используется исключительно для отладки и логов. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 10000. | ||
| max_cpu_usage | нет | Когда использование ЦП на се превышает этот порог, виртуальные сервисы, размещенные на этом се, могут быть перебалансированы на другие се, чтобы снизить нагрузку. В рамках этого процесса может быть создан новый се. Допустимые значения — от 40 до 90. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 80. | ||
| max_scaleout_per_vs | нет | Максимальное количество активных серверных узлов для виртуального сервиса. Допустимые значения — от 1 до 64. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 4. | ||
| max_se | нет | Максимальное количество серверных узлов в этой группе. Допустимые значения — от 0 до 1000. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 10. | ||
| max_vs_per_se | нет | Максимальное количество виртуальных сервисов, которые могут быть размещены на одном серверном узле. Виртуальные сервисы «восток-запад» исключаются из этого ограничения. Допустимые значения — от 1 до 1000. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 10. | ||
| mem_reserve | нет | Логический флаг для установки mem_reserve. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как True. | ||
| memory_per_se | нет | Объем памяти для каждой виртуальной машины серверного узла. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 2048. | ||
| mgmt_network_ref | нет | Сеть управления, используемая для серверных узлов Avi. Это ссылка на объект типа сеть. | ||
| mgmt_subnet | нет | Подсеть управления, используемая для серверных узлов Avi. | ||
| min_cpu_usage | нет | Если использование ЦП на се опускается ниже минимального порога, виртуальные сервисы, размещенные на се, могут быть объединены на другие менее загруженные се. После объединения неиспользуемые серверные узлы могут быть удалены. Допустимые значения — от 20 до 60. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 30. | ||
| min_scaleout_per_vs | нет | Минимальное количество активных серверных узлов для виртуального сервиса. Допустимые значения — от 1 до 64. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1. | ||
| name | да | Имя объекта. | ||
| non_significant_log_throttle | нет | Это значение ограничивает количество незначащих логов, генерируемых в секунду на ядро на этом се. По умолчанию — 100 логов в секунду. Установите значение 0, чтобы отключить ограничение. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 100. | ||
| num_flow_cores_sum_changes_to_ignore | нет | Количество изменений в сумме ядер потоков для игнорирования. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 8. | ||
| openstack_availability_zone | нет | Поле устарело в 17.1.1. | ||
| openstack_availability_zones | нет | Поле добавлено в 17.1.1. | ||
| openstack_mgmt_network_name | нет | Имя сети управления Avi. | ||
| openstack_mgmt_network_uuid | нет | UUID сети управления. | ||
| os_reserved_memory | нет | Количество дополнительной памяти, которое необходимо зарезервировать для использования операционной системой на серверном узле. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 0. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | ||
| per_app | нет | Режим se на приложение предназначен для развертывания специализированных балансировщиков нагрузки на каждое приложение (vs). В этом режиме каждый се ограничен максимум 2 vs. Vcpus в се для приложения учитываются при подсчете лицензий со ставкой 25%. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как False. | ||
| placement_mode | нет | Если режим размещения 'auto', виртуальные сервисы автоматически размещаются на серверных узлах. Варианты перечисления — PLACEMENT_MODE_AUTO. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как PLACEMENT_MODE_AUTO. | ||
| realtime_se_metrics | нет | Включить или отключить метрики се в реальном времени. | ||
| se_deprovision_delay | нет | Продолжительность сохранения неиспользуемых виртуальных машин серверных узлов перед их удалением. Если трафик виртуального сервиса резко увеличится, этот се по-прежнему будет доступен для использования вместо создания нового се. Если это значение установлено в 0, контроллер никогда не будет удалять се, и администратор должен вручную очистить неиспользуемые се. Допустимые значения — от 0 до 525600. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 120. | ||
| se_dos_profile | нет | Настройки профиля Dosthreshold для serviceenginegroup. | ||
| se_ipc_udp_port (добавлено в 2.4) | нет | Порт UDP для se_dp ipc в режиме моста Docker. Поле добавлено в 17.1.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1500. | ||
| se_name_prefix | нет | Префикс для использования в имени виртуальной машины серверных узлов. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как Avi. | ||
| se_remote_punt_udp_port (добавлено в 2.4) | нет | Порт UDP для пакетов, перенаправленных по методу punt, в режиме моста Docker. Поле добавлено в 17.1.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1501. | ||
| se_thread_multiplier | нет | Множитель для потоков се на основе vcpu. Допустимые значения — от 1 до 10. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1. | ||
| se_tunnel_mode | нет | Определяет, активен ли dsr со вторичного се или нет. 0 автоматически определяется на основе типа гипервизора. 1 отключает dsr безусловно. ~[0,1] включает dsr безусловно. Поле добавлено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 0. | ||
| se_tunnel_udp_port | нет | Порт UDP для туннелируемых пакетов со вторичного на первичный се в режиме моста Docker. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1550. | ||
| se_udp_encap_ipc (добавлено в 2.4) | нет | Определяет, инкапсулируются ли сообщения се-се ipc в заголовке UDP. 0 автоматически определяется на основе типа гипервизора. 1 использует инкапсуляцию UDP безусловно. ~[0,1] не использовать инкапсуляцию UDP. Поле добавлено в 17.1.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 0. | ||
| se_vs_hb_max_pkts_in_batch | нет | Максимальное количество агрегированных пакетов проверки работоспособности vs, отправляемых в пакет. Допустимые значения — от 1 до 256. Поле добавлено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 8. | ||
| se_vs_hb_max_vs_in_pkt | нет | Максимальное количество виртуальных сервисов, для которых сообщения проверки работоспособности агрегируются в одном пакете. Допустимые значения — от 1 до 1024. Поле добавлено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 256. | ||
| service_ip_subnets | нет | Подсети, назначенные группе се. Необходимы для размещения группы vs. Поле добавлено в 17.1.1. | ||
| significant_log_throttle | нет | Это значение ограничивает количество значимых логов, генерируемых в секунду на ядро на этом се. По умолчанию — 100 логов в секунду. Установите значение 0, чтобы отключить ограничение. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 100. | ||
| state | нет | есть |
| Состояние, которое должно быть применено к сущности. |
| tenant | нет | админ | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref | нет | Это ссылка на объект типа арендатор. | ||
| tenant_uuid | нет | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. | ||
| udf_log_throttle | нет | Это значение ограничивает количество логов udf, генерируемых в секунду на ядро на этом се. Логи udf генерируются из-за настроенных фильтров логов клиентов или правил с включенным ведением журнала. По умолчанию — 100 логов в секунду. Установите значение 0, чтобы отключить ограничение. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 100. | ||
| url | нет | URL контроллера Avi объекта. |
| имя пользователя | нет | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | ||
| uuid | нет | Уникальный идентификатор объекта. | ||
| vcenter_clusters | нет | Настройки vcenterclusters для serviceenginegroup. | ||
| vcenter_datastore_mode | нет | Варианты перечисления — vcenter_datastore_any, vcenter_datastore_local, vcenter_datastore_shared. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как VCENTER_DATASTORE_ANY. | ||
| vcenter_datastores | нет | Список vcenterdatastore. | ||
| vcenter_datastores_include | нет | Флаг булевого типа для установки vcenter_datastores_include. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| vcenter_folder | нет | Папка для размещения всех виртуальных машин service engine в vcenter. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как AviSeFolder. | ||
| vcenter_hosts | нет | Настройки vcenterhosts для serviceenginegroup. | ||
| vcpus_per_se | нет | Количество vcpus для каждой из виртуальных машин service engine. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| vs_host_redundancy | нет | Обеспечивает, чтобы первичный и вторичный service engine развертывались на разных физических узлах. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | ||
| vs_scalein_timeout | нет | Время ожидания, пока масштабируемая виртуальная машина se не завершит обработку существующих потоков перед пометкой масштабирования как завершённого. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 30. | ||
| vs_scalein_timeout_for_upgrade | нет | Во время обновления se, время ожидания, пока масштабируемая виртуальная машина se не завершит обработку существующих потоков перед пометкой масштабирования как завершённого. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 30. | ||
| vs_scaleout_timeout | нет | Время ожидания, пока масштабируемая виртуальная машина se не станет готова перед пометкой масштабирования как завершённого. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 30. |
Примеры
- name: Example to create ServiceEngineGroup object
avi_serviceenginegroup:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_serviceenginegroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| obj | Объект ServiceEngineGroup (api/serviceenginegroup) | успех, изменено | dict |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_serviceenginegroup_module.html
