cs_vpc – Управляет VPC на облаках Apache CloudStack.
Новое в версии 2.3.
Обзор
- Создание, обновление и удаление VPC.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account - | Аккаунт, к которому относится VPC. | |
| api_http_method - |
| 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 boolean добавлено в 2.5 |
| Переразвернуть маршрутизатор VPC или нет при state=restarted
|
| display_text - | Текстовое описание VPC. Если не задано, используется name при создании. | |
| domain - | Домен, к которому относится VPC. | |
| name - / обязательно | Имя VPC. | |
| network_domain - | Сеть домен для VPC. Все сети внутри VPC будут принадлежать этому домену. Рассматривается только при создании VPC, изменить нельзя. | |
| poll_async boolean |
| Ожидать завершения асинхронных задач. |
| project - | Имя проекта, к которому относится VPC. | |
| state - |
| Состояние VPC. Состояние present создает запущенную VPC.Состояние stopped используется только при создании VPC, добавлено в версии 2.6. |
| tags - | Список тегов. Теги — список словарей, имеющих ключи key и value. Для удаления всех тегов установите пустой список, например, tags: []. псевдонимы: tag | |
| vpc_offering - | Имя 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 CloudStack Cloud Guide.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Ensure a VPC is present but not started after creating
local_action:
module: 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
local_action:
module: cs_vpc
name: my_vpc
display_text: My example VPC
cidr: 10.10.0.0/16
- name: Ensure a VPC is absent
local_action:
module: cs_vpc
name: my_vpc
state: absent
- name: Ensure a VPC is restarted with clean up
local_action:
module: 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. Пример: 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.7/modules/cs_vpc_module.html