Spec-Zone.ru › Ansible 2.8

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

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

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

Обзор

  • Этот модуль используется для настройки объекта Scheduler
  • Дополнительные примеры на 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, который можно использовать вместо перечисления данных входа в контроллер Avi.
backup_config_ref
-
Конфигурация резервного копирования, которая должна быть выполнена этим планировщиком.
Это ссылка на объект типа backupconfiguration.
controller
строка
По умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
enabled
boolean
    Варианты:
  • no
  • yes
Флаг булевого типа для установки включения.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True.
end_date_time
-
Дата и время окончания планировщика.
frequency
-
Частота выполнения пользовательского планировщика.
Допустимые значения от 0 до 60.
frequency_unit
-
Единица измерения частоты выполнения пользовательского планировщика.
Варианты перечисления — SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK,
SCHEDULER_FREQUENCY_UNIT_MONTH.
name
- / обязательно
Имя планировщика.
password
строка
По умолчанию:
""
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD.
run_mode
-
Режим работы планировщика.
Варианты перечисления — RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW.
run_script_ref
-
Скрипт управления, который должен быть выполнен этим планировщиком.
Это ссылка на объект типа alertscriptconfig.
scheduler_action
-
Определите действие планировщика.
Варианты перечисления — SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP.
Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как SCHEDULER_ACTION_BACKUP.
start_date_time
-
Дата и время начала планировщика.
state
-
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к сущности.
tenant
строка
По умолчанию:
"admin"
Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
-
Это ссылка на объект типа tenant.
tenant_uuid
строка
По умолчанию:
""
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
url
-
URL контроллера Avi объекта.
username
строка
По умолчанию:
""
Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME.
uuid
-
Уникальный идентификатор объекта.

Примечания

Примечание

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

Примеры

- name: Example to create Scheduler object
  avi_scheduler:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_scheduler

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

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

Ключ Возвращаемое значение Описание
obj
словарь
успех, изменения
Объект Scheduler (api/scheduler)



Статус

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

Авторы

  • Гaurav 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.8/modules/avi_scheduler_module.html

Spec-Zone.ru

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