cs_router - Управляет маршрутизаторами в облаках на основе Apache CloudStack.
Новое в версии 2.2.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Запуск, перезапуск, остановка и удаление маршрутизаторов.
-
state=presentне может создавать маршрутизаторы, используйте cs_network вместо этого.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательный | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится маршрутизатор. | ||
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | API-ключ CloudStack API. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ CloudStack API. | ||
| api_timeout | нет | 10 | Таймаут HTTP. | |
| api_url | нет | URL CloudStack API, например, https://cloud.example.com/client/api. | ||
| domain | нет | Домен, к которому относится маршрутизатор. | ||
| name | да | Имя маршрутизатора. | ||
| project | нет | Имя проекта, к которому относится маршрутизатор. | ||
| service_offering | нет | Имя или ID предложения услуг маршрутизатора. | ||
| state | нет | present |
| Состояние маршрутизатора. |
| zone (добавлено в 2.4)
| нет | Имя зоны, в которой развернут маршрутизатор. Если не указано, используются все зоны. |
Примеры
# 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 | Требуется ли обновление маршрутизатора до новой шаблона. | успех | булево | False |
| role | Роль маршрутизатора. | успех | строка | VIRTUAL_ROUTER |
| service_offering | Имя предложения услуг, которым обладает маршрутизатор. | успех | строка | Предложение услуг для программного маршрутизатора |
| state | Состояние маршрутизатора. | успех | строка | Активный |
| template_version | Версия шаблона системной виртуальной машины. | успех | строка | 4.5.1 |
| zone | Имя зоны, в которой находится маршрутизатор. | успех | строка | ch-gva-2 |
Примечания
Примечание
- 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 можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет внесено обратной совместимости с интерфейсом изменений.
Для получения помощи в разработке модулей, если вас это заинтересует, пожалуйста, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_router_module.html