cs_router — Управляет маршрутизаторами в облаках на основе Apache CloudStack.

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

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

Обзор

Запуск, перезапуск, остановка и удаление маршрутизаторов.
state=present не может создавать маршрутизаторы, используйте cs_network вместо этого.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account	По умолчанию: None	Аккаунт, к которому относится маршрутизатор.
api_http_method	Варианты: get post	HTTP-метод, используемый для запроса к API-точке входа. Если не указано, используется значение переменной среды `CLOUDSTACK_METHOD`. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — `get` если не указано.
api_key		API-ключ API CloudStack. Если не указано, используется значение переменной среды `CLOUDSTACK_KEY`. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
api_region	По умолчанию: cloudstack	Имя раздела в файле конфигурации `cloustack.ini`. Если не указано, используется значение переменной среды `CLOUDSTACK_REGION`.
api_secret		Секретный ключ API CloudStack. Если не задано, используется значение переменной среды `CLOUDSTACK_SECRET`. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
api_timeout		Таймаут HTTP-запроса в секундах. Если не указано, используется значение переменной среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — 10 секунд, если не указано.
api_url		URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
domain	По умолчанию: None	Домен, к которому относится маршрутизатор.
name обязательно		Имя маршрутизатора.
poll_async	Варианты: no да ←	Ожидать завершения асинхронных задач.
project	По умолчанию: None	Имя проекта, к которому относится маршрутизатор.
service_offering	По умолчанию: None	Имя или идентификатор предложения услуг маршрутизатора.
state	Варианты: present ← absent started stopped restarted	Состояние маршрутизатора.
zone (добавлен в 2.4)	По умолчанию: None	Имя зоны, в которой развернут маршрутизатор. Если не задано, используются все зоны.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в следующем порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменные окружения CLOUDSTACK_TIMEOUT. Переменная окружения CLOUDSTACK_CONFIG, указывающая на файл конфигурации .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Также можно указать несколько учетных данных и конечных точек с помощью разделов ini в файле cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Подробную информацию см. на https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

# Ensure the router has the desired service offering, no matter if
# the router is running or not.
- local_action:
    module: cs_router
    name: r-40-VM
    service_offering: System Offering for Software Router

# Ensure started
- local_action:
    module: cs_router
    name: r-40-VM
    state: started

# Ensure started with desired service offering.
# If the service offerings changes, router will be rebooted.
- local_action:
    module: cs_router
    name: r-40-VM
    service_offering: System Offering for Software Router
    state: started

# Ensure stopped
- local_action:
    module: cs_router
    name: r-40-VM
    state: stopped

# Remove a router
- local_action:
    module: cs_router
    name: r-40-VM
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится маршрутизатор. Пример: admin
created строка	успех	Дата создания маршрутизатора. Пример: 2014-12-01T14:57:57+0100
domain строка	успех	Домен, к которому относится маршрутизатор. Пример: ROOT
id строка	успех	UUID маршрутизатора. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name строка	успех	Имя маршрутизатора. Пример: r-40-VM
redundant_state строка	успех	Резервное состояние маршрутизатора. Пример: UNKNOWN
requires_upgrade булево	успех	Требуется ли обновление маршрутизатора до новой версии шаблона.
role строка	успех	Роль маршрутизатора. Пример: VIRTUAL_ROUTER
service_offering строка	успех	Название предложения услуг, которым обладает маршрутизатор. Пример: Предложение услуг для программного маршрутизатора
state строка	успех	Состояние маршрутизатора. Пример: Активный
template_version строка	успех	Версия шаблона виртуальной машины. Пример: 4.5.1
zone строка	успех	Имя зоны, в которой находится маршрутизатор. Пример: ch-gva-2

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют отсутствие изменений интерфейса, не совместимых со старыми версиями.

Автор

René Moser (@resmo)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/cs_router_module.html