cs_network - Управляет сетями в облаках на основе Apache CloudStack.
Новое в версии 2.0.
Краткое описание
- Создание, обновление, перезапуск и удаление сетей.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account | Аккаунт, к которому относится сеть. | |
| acl (добавлен в 2.5) | Имя списка управления доступом для уровня сети 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 bool |
| Очистка старых элементов сети. Рассматривается только при 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 bool |
| Опрос асинхронных заданий до завершения работы. |
| project | Имя проекта, в котором должна быть развернута сеть. | |
| start_ip | Начальный IPv4-адрес сети. Рассматривается только при создании. | |
| start_ipv6 | Начальный IPv6-адрес сети. Рассматривается только при создании. | |
| state |
| Состояние сети. |
| subdomain_access bool (добавлен в 2.5) |
| Определяет, разрешено ли доменам-поддоменам использовать сети, выделенные их родительскому домену(ам). Должно использоваться с acl_type=domain.Рассматривается только при создании. |
| vlan | Идентификатор или VID сети. | |
| 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: 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 строка | успех | Аккаунт, к которому относится сеть. Пример: example account |
| acl строка (добавлено в 2.5) | успех | Имя списка управления доступом (ACL) для уровня сети VPC. Пример: My ACL |
| acl_id строка (добавлено в 2.5) | успех | Идентификатор списка управления доступом (ACL) для уровня сети VPC. Пример: dfafcd55-0510-4b8c-b6c5-b8cedb4cfd88 |
| acl_type строка | успех | Тип доступа уровня сети VPC (Домен, Аккаунт). Пример: Аккаунт |
| broadcast_domain_type строка | успех | Тип домена широковещательной передачи сети. Пример: Vlan |
| cidr строка | успех | CIDR IPv4 сети. Пример: 10.101.64.0/24 |
| cidr_ipv6 строка | успех | CIDR IPv6 сети. Пример: 2001:db8::/64 |
| display_text строка | успех | Текст для отображения сети. Пример: web project |
| 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 bool (добавлено в 2.5) | успех | Является ли сеть связанной с системой. |
| name строка | успех | Имя сети. Пример: web project |
| netmask строка | успех | IPv4 маска сети. Пример: 255.255.255.0 |
| network_domain строка | успех | Домен сети. Пример: example.local |
| network_offering строка | успех | Имя предложения сети. Пример: DefaultIsolatedNetworkOfferingWithSourceNatService |
| network_offering_availability строка (добавлено в 2.5) | успех | Доступность предложения сети, из которого создана сеть. Пример: Optional |
| network_offering_conserve_mode bool (добавлено в 2.5) | успех | Включен ли режим сохранения IP в предложении сети. |
| network_offering_display_text строка (добавлено в 2.5) | успех | Текст для отображения предложения сети. Пример: Предложение для изолированных сетей VPC с включенной службой Source Nat |
| project строка | успех | Имя проекта. Пример: Production |
| state строка | успех | Состояние сети (Выделено, Реализовано, Настроено). Пример: Выделено |
| tags словарь | успех | Список тегов ресурсов, связанных с сетью. Пример: [ { "key": "foo", "value": "bar" } ] |
| traffic_type строка | успех | Тип трафика сети. Пример: Guest |
| type строка | успех | Тип сети. Пример: Изолированная |
| zone строка | успех | Имя зоны. Пример: ch-gva-2 |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет внесено обратной совместимости интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/cs_network_module.html