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

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

Описание

Создание, обновление и удаление 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"	Имя раздела в файле конфигурации `cloustack.ini`. Если не задано, рассматривается переменная окружения `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ API 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	Варианты: 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_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.9/modules/cs_vpc_module.html