Spec-Zone.ru › Ansible 2.9

avi_serverautoscalepolicy – Модуль для настройки объекта ServerAutoScalePolicy Avi RESTful

Новое в версии 2.4.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Этот модуль используется для настройки объекта ServerAutoScalePolicy
  • больше примеров на https://github.com/avinetworks/devops

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • avisdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_context
словарь
добавлен в 2.5
Контекст API Avi, включающий текущий идентификатор сессии и CSRF-токен.
Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version
строка
По умолчанию:
"16.4.4"
Версия API Avi для использования с API Avi и объектами.
avi_api_patch_op
-
добавлен в 2.5
    Варианты:
  • add
  • replace
  • delete
Операция патчинга для использования при использовании avi_api_update_method как patch.
avi_api_update_method
-
добавлен в 2.5
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Установление значения в patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials
словарь
добавлен в 2.5
Словарь Avi Credentials, который может быть использован вместо перечисления данных входа в Avi Controller.
api_version
-
По умолчанию:
"16.4.4"
Версия контроллера Avi
controller
-
IP-адрес или SQDN контроллера Avi
csrftoken
-
CSRF-токен 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
логическое
добавлен в 2.6
    Варианты:
  • no
  • yes
Отключает кэширование информации о сессии Avi в качестве факта.
controller
строка
По умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
description
-
Определяемая пользователем информация о назначении объекта.
intelligent_autoscale
логическое
    Варианты:
  • no
  • yes
Использовать алгоритм интеллектуального автомасштабирования Avi, где автомасштабирование выполняется путем сравнения нагрузки на пул с оцененной емкостью всех серверов.
По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует это значение как False.
intelligent_scalein_margin
-
Максимальная дополнительная емкость в процентах от нагрузки, используемой интеллектуальной схемой.
Масштабирование влево (scale in) запускается, когда доступная емкость превышает этот предел.
Допустимые значения: 1-99.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 40.
intelligent_scaleout_margin
-
Минимальная дополнительная емкость в процентах от нагрузки, используемой интеллектуальной схемой.
Масштабирование вправо (scale out) запускается, когда доступная емкость меньше этого предела.
Допустимые значения: 1-99.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20.
max_scalein_adjustment_step
-
Максимальное количество серверов, которые могут быть масштабированы влево (scale in) одновременно.
Фактическое количество серверов, которое будет масштабировано влево, выбирается таким образом, чтобы целевое количество серверов всегда было больше или равно min_size.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.
max_scaleout_adjustment_step
-
Максимальное количество серверов, которые могут быть масштабированы вправо (scale out) одновременно.
Фактическое количество серверов, которые будут масштабированы вправо, выбирается таким образом, чтобы целевое количество серверов всегда было меньше или равно max_size.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.
max_size
-
Максимальное количество серверов после масштабирования вправо (scale out).
Допустимые значения: 0-400.
min_size
-
Масштабирование влево (scale in) не происходит, когда количество оперативно работающих серверов достигает min_servers.
Допустимые значения: 0-400.
name
- / обязательно
Имя объекта.
password
строка
По умолчанию:
""
Пароль пользователя Avi в контроллере Avi. По умолчанию используется переменная среды AVI_PASSWORD.
scalein_alertconfig_refs
-
Запуск масштабирования влево (scale in), когда поднимаются тревоги из-за любого из этих конфигураций тревоги.
Это ссылка на объект типа alertconfig.
scalein_cooldown
-
Период охлаждения, в течение которого не запускается новое масштабирование влево (scale in), чтобы позволить предыдущему масштабированию влево успешно завершиться.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300.
scaleout_alertconfig_refs
-
Запуск масштабирования вправо (scale out), когда поднимаются тревоги из-за любого из этих конфигураций тревоги.
Это ссылка на объект типа alertconfig.
scaleout_cooldown
-
Период охлаждения, в течение которого не запускается новое масштабирование вправо (scale out), чтобы позволить предыдущему масштабированию вправо успешно завершиться.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 300.
state
-
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к сущности.
tenant
строка
По умолчанию:
"admin"
Имя тенента, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
-
Это ссылка на объект типа tenant.
tenant_uuid
строка
По умолчанию:
""
UUID тенента, используемого для всех вызовов API Avi и контекста объекта.
url
-
URL контроллера Avi для объекта.
END_OF_DOCUMENT_MARKER
use_predicted_load
boolean
    Выбори:
  • нет
  • да
Использовать прогнозируемую нагрузку вместо текущей.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
username
string
По умолчанию:
""
Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.
uuid
-
Уникальный идентификатор объекта.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create ServerAutoScalePolicy object
  avi_serverautoscalepolicy:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_serverautoscalepolicy

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

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

Ключ Возвращаемое значение Описание
obj
словарь
success, changed
Объект ServerAutoScalePolicy (api/serverautoscalepolicy)



Статус

  • Этот модуль не гарантирует обратную совместимость. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/modules/avi_serverautoscalepolicy_module.html

Spec-Zone.ru

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