ngine_io.cloudstack.cs_vpc – Управляет VPC на облаках, основанных на Apache CloudStack.

Примечание

Этот плагин является частью коллекции ngine_io.cloudstack (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.

Для использования в книге задач укажите: ngine_io.cloudstack.cs_vpc.

Новое в версии 0.1.0: модуля ngine_io.cloudstack

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Создание, обновление и удаление VPC.

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится VPC.
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, см. также примечания.
api_verify_ssl_cert строка		Файл сертификата CA. Если не задан, рассматривается переменная окружения `CLOUDSTACK_VERIFY`. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию `null`, если не указано.
cidr строка		CIDR VPC, например, 10.1.0.0/16. Все CIDR сетей гостевых VPC должны находиться в пределах этого CIDR. Необходим при state=present.
clean_up булево	Варианты: no yes	Переустанавливать маршрутизатор VPC или нет при state=restarted
display_text строка		Текст для отображения VPC. Если не задан, для создания используется name.
domain строка		Домен, к которому относится VPC.
name строка / обязательно		Имя VPC.
network_domain строка		Домен сети для VPC. Все сети внутри VPC будут принадлежать этому домену. Рассматривается только при создании VPC, изменить нельзя.
poll_async булево	Варианты: no yes ←	Опрашивать асинхронные задачи до завершения.
project строка		Имя проекта, к которому относится VPC.
state строка	Варианты: present ← absent stopped restarted	Состояние VPC. Состояние `present` создает запущенный VPC. Состояние `stopped` рассматривается только при создании VPC, добавлено в версии 2.6.
tags список / элементы=словарь		Список тегов. Теги — это список словарей с ключами key и value. Для удаления всех тегов установите пустой список, например, tags: []. псевдонимы: тег
vpc_offering строка		Имя предложения VPC. Если не задано, используется предложение VPC по умолчанию.
zone строка		Имя зоны. Если не задано, используется зона по умолчанию.

Примечания

Примечание

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

Примеры

- name: Ensure a VPC is present but not started after creating
  ngine_io.cloudstack.cs_vpc:
    name: my_vpc
    display_text: My example VPC
    cidr: 10.10.0.0/16
    state: stopped

- name: Ensure a VPC is present and started after creating
  ngine_io.cloudstack.cs_vpc:
    name: my_vpc
    display_text: My example VPC
    cidr: 10.10.0.0/16

- name: Ensure a VPC is absent
  ngine_io.cloudstack.cs_vpc:
    name: my_vpc
    state: absent

- name: Ensure a VPC is restarted with clean up
  ngine_io.cloudstack.cs_vpc:
    name: my_vpc
    clean_up: yes
    state: restarted

Значения возврата

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

Ключ	Результат	Описание
account строка	успех	Аккаунт, к которому относится VPC. Пример: example account
cidr строка	успех	CIDR VPC. Пример: 10.10.0.0/16
display_text строка	успех	Текст для отображения VPC. Пример: Мой пример VPC
distributed_vpc_router булево	успех	Используется ли для VPC распределённый маршрутизатор? Пример: True
domain строка	успех	Домен, к которому относится VPC. Пример: example domain
id строка	успех	UUID VPC. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name строка	успех	Имя VPC. Пример: my_vpc
network_domain строка	успех	Сетевой домен VPC. Пример: example.com
project строка	успех	Имя проекта, к которому относится VPC. Пример: Производство
redundant_vpc_router булево	успех	Имеет ли VPC резервные маршрутизаторы? Пример: True
region_level_vpc булево	успех	Является ли VPC региональным? Пример: True
restart_required булево	успех	Требуется ли перезапуск маршрутизатора VPC? Пример: True
state строка	успех	Состояние VPC. Пример: Включён
tags список / элементы=строка	успех	Список тегов ресурса, связанных с VPC. Пример: [ { "ключ": "foo", "значение": "bar" } ]
zone строка	успех	Имя зоны, в которой находится VPC. Пример: ch-gva-2

Авторы

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.10/collections/ngine_io/cloudstack/cs_vpc_module.html