community.network.avi_serverautoscalepolicy – Модуль для настройки объекта ServerAutoScalePolicy Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_serverautoscalepolicy.
Обзор
- Этот модуль используется для настройки объекта ServerAutoScalePolicy.
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| avi_api_patch_op строка |
| Операция исправления, используемая при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch приведет к изменению этого поведения на использование HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который может быть использован вместо перечисления данных входа в Avi контроллер. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | Маркер csrftoken API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль пользователя контроллера Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken | ||
| tenant строка | По умолчанию: "admin" | Тенент контроллера Avi | |
| tenant_uuid строка | UUID тенента контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact логическое |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| description строка | Пользовательское описание объекта. | ||
| intelligent_autoscale логическое |
| Использовать алгоритм интеллектуального масштабирования Avi, где масштабирование выполняется путем сравнения нагрузки на пул с оцененной емкостью всех серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| intelligent_scalein_margin строка | Максимальная дополнительная емкость в процентах от нагрузки, используемой интеллектуальной схемой. Масштабирование влево происходит, когда доступная емкость превышает этот предел. Допустимые значения — от 1 до 99. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 40. | ||
| intelligent_scaleout_margin строка | Минимальная дополнительная емкость в процентах от нагрузки, используемой интеллектуальной схемой. Масштабирование вправо происходит, когда доступная емкость меньше этого предела. Допустимые значения — от 1 до 99. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20. | ||
| max_scalein_adjustment_step строка | Максимальное количество серверов для одновременного масштабирования влево. Фактическое число серверов, которые нужно масштабировать влево, выбирается так, чтобы целевое число серверов всегда было больше или равно min_size. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| max_scaleout_adjustment_step строка | Максимальное количество серверов для одновременного масштабирования вправо. Фактическое число серверов, которые нужно масштабировать вправо, выбирается так, чтобы целевое число серверов всегда было меньше или равно max_size. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| max_size строка | Максимальное количество серверов после масштабирования вправо. Допустимые значения — от 0 до 400. | ||
| min_size строка | Масштабирование влево не происходит, если число рабочих серверов достигает min_servers. Допустимые значения — от 0 до 400. | ||
| name строка / обязательно | Имя объекта. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| scalein_alertconfig_refs строка | Вызвать масштабирование влево, когда будут подняты тревоги из-за любого из этих конфигураций предупреждений. Это ссылка на объект типа alertconfig. | ||
| scalein_cooldown строка | Период охлаждения, в течение которого не будет инициироваться новое масштабирование влево, чтобы позволить предыдущему масштабированию влево успешно завершиться. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. | ||
| scaleout_alertconfig_refs строка | Вызвать масштабирование вправо, когда будут подняты тревоги из-за любого из этих конфигураций предупреждений. Это ссылка на объект типа alertconfig. | ||
| scaleout_cooldown строка | Период охлаждения, в течение которого не будет инициироваться новое масштабирование вправо, чтобы позволить предыдущему масштабированию вправо успешно завершиться. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Это ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi объекта. | ||
| use_predicted_load логическое |
| Использовать предсказанную нагрузку вместо текущей. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create ServerAutoScalePolicy object
community.network.avi_serverautoscalepolicy:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_serverautoscalepolicy
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменение | Объект ServerAutoScalePolicy (api/serverautoscalepolicy) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_serverautoscalepolicy_module.html
