community.network.avi_serverautoscalepolicy – Модуль для настройки объекта ServerAutoScalePolicy Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.avi_serverautoscalepolicy.
Обзор
- Этот модуль используется для конфигурации объекта ServerAutoScalePolicy.
- Дополнительные примеры можно найти по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий ID сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | |
| avi_api_patch_op строка |
| Операция изменения для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi Controller. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера Avi | ||
| csrftoken строка | Маркер csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password строка | Пароль пользователя Avi в контроллере 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 boolean |
| Отключает кеширование информации о сессии avi в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| description строка | Определяемое пользователем описание объекта. | ||
| intelligent_autoscale boolean |
| Использование алгоритма интеллектуального масштабирования 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 boolean |
| Использовать предсказанную нагрузку вместо текущей. Значение по умолчанию, если не указано в 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/avi_serverautoscalepolicy_module.html
