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

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

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

Описание

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

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

Примечания

Примечание

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

Статус

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

Обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и обслуживание модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/cs_router_module.html