cs_vpc – Управляет VPC на облаках Apache CloudStack

Новое в версии 2.3.

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, см. также примечания.
cidr строка		CIDR VPC, например, 10.1.0.0/16 Все CIDR сетей VPC должны находиться в этом CIDR. Требуется при state=present.
clean_up логическое значение добавлено в 2.5	Варианты: нет да	Переразвернуть маршрутизатор VPC при state=restarted или нет.
display_text строка		Текст отображения VPC. Если не указано, используется name при создании.
domain строка		Домен, к которому относится VPC.
name строка / обязательно		Имя VPC.
network_domain строка		Домен сети для VPC. Все сети внутри VPC будут принадлежать этому домену. Рассматривается только при создании VPC, изменить нельзя.
poll_async логическое значение	Варианты: нет да ←	Опрашивать асинхронные задачи до завершения.
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_TIMEOUT. Переменная среды 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
  cs_vpc:
    name: my_vpc
    display_text: My example VPC
    cidr: 10.10.0.0/16
    state: stopped
  delegate_to: localhost

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

- name: Ensure a VPC is absent
  cs_vpc:
    name: my_vpc
    state: absent
  delegate_to: localhost

- name: Ensure a VPC is restarted with clean up
  cs_vpc:
    name: my_vpc
    clean_up: yes
    state: restarted
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
account строка	успешно	Аккаунт, к которому относится VPC. Пример: example account
cidr строка	успешно	CIDR VPC. Пример: 10.10.0.0/16
display_text строка	успешно	Отображаемый текст VPC. Пример: My example 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. Пример: Production
redundant_vpc_router булево	успешно	Имеет ли VPC резервные маршрутизаторы или нет. Пример: True
region_level_vpc булево	успешно	Является ли VPC региональным или нет. Пример: True
restart_required булево	успешно	Требуется ли перезапуск маршрутизатора VPC или нет. Пример: True
state строка	успешно	Состояние VPC. Пример: Enabled
tags список	успешно	Список тегов ресурсов, связанных с VPC. Пример: [ { "key": "foo", "value": "bar" } ]
zone строка	успешно	Название зоны, в которой находится VPC. Пример: 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.8/modules/cs_vpc_module.html