Spec-Zone.ru › Ansible

Модуль ngine_io.cloudstack.cs_router – Управление маршрутизаторами в облаках на основе Apache CloudStack.

Примечание

Этот модуль является частью коллекции ngine_io.cloudstack (версия 2.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: ngine_io.cloudstack.cs_router.

Новое в ngine_io.cloudstack 0.1.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

string

Учетная запись, с которой связан маршрутизатор.

api_http_method

string

HTTP-метод, используемый для запроса к конечной точке API.

Если не указано, используется переменная окружения CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (по умолчанию)
  • "post"

api_key

string / обязательно

API-ключ CloudStack API.

Если не указано, используется переменная окружения CLOUDSTACK_KEY.

api_secret

string / обязательно

Секретный ключ CloudStack API.

Если не указано, используется переменная окружения CLOUDSTACK_SECRET.

api_timeout

integer

Таймаут HTTP в секундах.

Если не указано, используется переменная окружения CLOUDSTACK_TIMEOUT.

По умолчанию: 10

api_url

string / обязательно

URL CloudStack API, например, https://cloud.example.com/client/api.

Если не указано, используется переменная окружения CLOUDSTACK_ENDPOINT.

api_verify_ssl_cert

string

Проверить файл сертификата центра сертификации.

Если не указано, используется переменная окружения CLOUDSTACK_VERIFY.

domain

string

Домен, с которым связан маршрутизатор.

name

string / обязательно

Имя маршрутизатора.

poll_async

boolean

Опрашивать асинхронные задания до завершения.

Варианты:

  • false
  • true ← (по умолчанию)

project

string

Имя проекта, с которым связан маршрутизатор.

service_offering

string

Имя или ID предложения сервиса маршрутизатора.

state

string

Состояние маршрутизатора.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "started"
  • "stopped"
  • "restarted"

validate_certs

boolean

добавлено в ngine_io.cloudstack 2.4.0

Если false, SSL-сертификаты проверяться не будут.

Если не указано, используется переменная окружения CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY.

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

Варианты:

  • false
  • true ← (по умолчанию)

zone

string

Имя зоны, в которой развернут маршрутизатор.

Если не указано, используются все зоны.

Примечания

Примечание

  • Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

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

- name: Ensure started
  ngine_io.cloudstack.cs_router:
    name: r-40-VM
    state: started

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

- name: Ensure stopped
  ngine_io.cloudstack.cs_router:
    name: r-40-VM
    state: stopped

- name: Remove a router
  ngine_io.cloudstack.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

строка

Имя предложения сервиса, имеющегося у маршрутизатора.

Возвращается: успех

Пример: "System Offering For Software Router"

state

строка

Состояние маршрутизатора.

Возвращается: успех

Пример: "Active"

template_version

строка

Версия системной VМ-шаблона.

Возвращается: успех

Пример: "4.5.1"

zone

строка

Имя зоны, в которой находится маршрутизатор.

Возвращается: успех

Пример: "ch-gva-2"

Авторы

  • René Moser (@resmo)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_router_module.html

Spec-Zone.ru

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