cs_network – Управляет сетями на облачных платформах Apache CloudStack.
Новая версия 2.0.
Описание
- Создание, обновление, перезапуск и удаление сетей.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account - | Аккаунт, к которому относится сеть. | |
| acl - добавлен в 2.5 | Имя списка управления доступом (ACL) для уровня VPC-сети. | |
| acl_type - |
| Тип управления доступом для уровня 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_ipv6 - | CIDR IPv6 сети, должен быть не менее /64. Рассматривается только при создании. | |
| clean_up boolean |
| Очистка старых элементов сети. Рассматривается только при state=restarted. |
| display_text - | Текст отображения сети. Если не указано, используется name, как display_text. | |
| domain - | Домен, к которому относится сеть. | |
| end_ip - | Конечный IPv4 адрес сети. Если не указано, используется значение start_ip.Рассматривается только при создании. | |
| end_ipv6 - | Конечный IPv6 адрес сети. Если не указано, используется значение start_ipv6.Рассматривается только при создании. | |
| gateway - | Шлюз сети. Требуется для общих сетей и изолированных сетей, если они принадлежат VPC. Рассматривается только при создании. | |
| gateway_ipv6 - | Шлюз IPv6 сети. Требуется для общих сетей. Рассматривается только при создании. | |
| isolated_pvlan - | Изолированный частный VLAN для этой сети. | |
| name - / обязательно | Имя сети (регистрозависимое). | |
| netmask - | Маска сети. Требуется для общих сетей и изолированных сетей, если они принадлежат VPC. Рассматривается только при создании. | |
| network_domain - | Домен сети. | |
| network_offering - | Имя предложения для сети. Требуется, если state=present. | |
| poll_async boolean |
| Ожидание завершения асинхронных задач. |
| project - | Имя проекта, в котором должна развертываться сеть. | |
| start_ip - | Начальный IPv4 адрес сети. Рассматривается только при создании. | |
| start_ipv6 - | Начальный IPv6 адрес сети. Рассматривается только при создании. | |
| state - |
| Состояние сети. |
| subdomain_access boolean добавлен в 2.5 |
| Определяет, разрешать ли дочерним доменам использовать сети, предназначенные для их родительских доменов. Должен использоваться с acl_type=domain.Рассматривается только при создании. |
| vlan - | Идентификатор (ID) или VID сети. | |
| 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: Create a network
local_action:
module: cs_network
name: my network
zone: gva-01
network_offering: DefaultIsolatedNetworkOfferingWithSourceNatService
network_domain: example.com
- name: Create a VPC tier
local_action:
module: cs_network
name: my VPC tier 1
zone: gva-01
vpc: my VPC
network_offering: DefaultIsolatedNetworkOfferingForVpcNetworks
gateway: 10.43.0.1
netmask: 255.255.255.0
acl: my web acl
- name: Update a network
local_action:
module: cs_network
name: my network
display_text: network of domain example.local
network_domain: example.local
- name: Restart a network with clean up
local_action:
module: cs_network
name: my network
clean_up: yes
state: restared
- name: Remove a network
local_action:
module: cs_network
name: my network
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успех | Аккаунт, к которому относится сеть. Пример: пример аккаунта |
| acl строка добавлен в 2.5 | успех | Имя списка управления доступом (ACL) для уровня сети VPC. Пример: Мой список ACL |
| acl_id строка добавлен в 2.5 | успех | Идентификатор списка управления доступом (ACL) для уровня сети VPC. Пример: dfafcd55-0510-4b8c-b6c5-b8cedb4cfd88 |
| acl_type строка | успех | Тип доступа для уровня сети VPC (Домен, Аккаунт). Пример: Аккаунт |
| broadcast_domain_type строка | успех | Тип домена широковещательной передачи сети. Пример: Vlan |
| cidr строка | успех | IPv4 CIDR сети. Пример: 10.101.64.0/24 |
| cidr_ipv6 строка | успех | IPv6 CIDR сети. Пример: 2001:db8::/64 |
| display_text строка | успех | Текст для отображения сети. Пример: веб-проект |
| dns1 строка | успех | IP-адрес первого сервера имен. Пример: 1.2.3.4 |
| dns2 строка | успех | IP-адрес второго сервера имен. Пример: 1.2.3.4 |
| domain строка | успех | Домен, к которому относится сеть. Пример: ROOT |
| gateway строка | успех | IPv4 шлюз. Пример: 10.101.64.1 |
| gateway_ipv6 строка | успех | IPv6 шлюз. Пример: 2001:db8::1 |
| id строка | успех | UUID сети. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| is_persistent логическое значение | успех | Является ли сеть постоянной. |
| is_system логическое значение добавлен в 2.5 | успех | Связана ли сеть с системой. |
| name строка | успех | Имя сети. Пример: веб-проект |
| netmask строка | успех | IPv4 маска подсети. Пример: 255.255.255.0 |
| network_domain строка | успех | Домен сети Пример: example.local |
| network_offering строка | успех | Имя предложения сети. Пример: DefaultIsolatedNetworkOfferingWithSourceNatService |
| network_offering_availability строка добавлен в 2.5 | успех | Доступность предложения сети, из которого создана сеть. Пример: Необязательно |
| network_offering_conserve_mode логическое значение добавлен в 2.5 | успех | Включен ли режим сохранения IP в предложении сети. |
| network_offering_display_text строка добавлен в 2.5 | успех | Текст для отображения предложения сети. Пример: Предложение для изолированных сетей VPC с включенной службой Source Nat |
| project строка | успех | Название проекта. Пример: Производство |
| state строка | успех | Состояние сети (Выделено, Реализовано, Настроено). Пример: Выделено |
| tags словарь | успех | Список тегов ресурсов, связанных с сетью. Пример: [ { "ключ": "foo", "значение": "bar" } ] |
| traffic_type строка | успех | Тип трафика сети. Пример: Гость |
| type строка | успех | Тип сети. Пример: Изолированная |
| zone строка | успех | Название зоны. Пример: 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_network_module.html