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

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

Обзор

Запуск, перезапуск, остановка и уничтожение маршрутизаторов.
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-ключ API CloudStack. Если не указан, рассматривается переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта, значение берется из файла конфигурации ini, также см. примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела ini в файле `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 строка		Домен, к которому относится маршрутизатор.
name строка / обязательно		Имя маршрутизатора.
poll_async логическое значение	Варианты: 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.
- name: Present router
  cs_router:
    name: r-40-VM
    service_offering: System Offering for Software Router
  delegate_to: localhost

- name: Ensure started
  cs_router:
    name: r-40-VM
    state: started
  delegate_to: localhost

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

- name: Ensure stopped
  cs_router:
    name: r-40-VM
    state: stopped
  delegate_to: localhost

- name: Remove a router
  cs_router:
    name: r-40-VM
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
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 строка	успех	Имя предлагаемого сервиса для маршрутизатора. Пример: System Offering For Software Router
state строка	успех	Состояние маршрутизатора. Пример: Active
template_version строка	успех	Версия шаблона системной виртуальной машины. Пример: 4.5.1
zone строка	успех	Имя зоны, в которой находится маршрутизатор. Пример: ch-gva-2

Статус

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

Авторы

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