cs_network — Управляет сетями в облаках на основе Apache CloudStack.
Новая версия с 2.0.
- Описание
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Создание, обновление, перезапуск и удаление сетей.
Требования (для хоста, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится сеть. | ||
| acl_type | нет | account |
| Тип контроля доступа. Учитывается только при создании. |
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | Ключ API CloudStack API. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ CloudStack API. | ||
| api_timeout | нет | 10 | Таймаут HTTP. | |
| api_url | нет | URL CloudStack API, например, https://cloud.example.com/client/api. | ||
| cidr_ipv6 | нет | CIDR IPv6 сети, должен быть не менее /64. Учитывается только при создании. | ||
| clean_up | нет | Очистка старых элементов сети. Учитывается только при 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 | нет | True | Ожидать завершения асинхронных задач. | |
| project | нет | Имя проекта, в котором должна быть развернута сеть. | ||
| start_ip | нет | Начальный IPv4 адрес сети. Учитывается только при создании. | ||
| start_ipv6 | нет | Начальный IPv6 адрес сети. Учитывается только при создании. | ||
| state | нет | present |
| Состояние сети. |
| vlan | нет | ID или VID сети. | ||
| vpc | нет | Имя VPC сети. | ||
| zone | нет | Имя зоны, в которой должна быть развернута сеть. Если не задано, используется зона по умолчанию. |
Примеры
# create a network
- local_action:
module: cs_network
name: my network
zone: gva-01
network_offering: DefaultIsolatedNetworkOfferingWithSourceNatService
network_domain: example.com
# update a network
- local_action:
module: cs_network
name: my network
display_text: network of domain example.local
network_domain: example.local
# restart a network with clean up
- local_action:
module: cs_network
name: my network
clean_up: yes
state: restared
# remove a network
- local_action:
module: cs_network
name: my network
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| account | Аккаунт, к которому относится сеть. | успех | строка | example account |
| acl_type | Тип доступа к сети (Домен, Аккаунт). | успех | строка | Аккаунт |
| 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 | Является ли сеть постоянной. | успех | логическое | False |
| name | Имя сети. | успех | строка | web project |
| netmask | IPv4 маска сети. | успех | строка | 255.255.255.0 |
| network_domain | Домен сети | успех | строка | example.local |
| network_offering | Название предложения сети. | успех | строка | DefaultIsolatedNetworkOfferingWithSourceNatService |
| project | Название проекта. | успех | строка | Production |
| state | Состояние сети (Выделено, Реализовано, Настроено). | успех | строка | Выделено |
| tags | Список тегов ресурсов, связанных с сетью. | успех | словарь | [ { "key": "foo", "value": "bar" } ] |
| traffic_type | Тип трафика сети. | успех | строка | Гость |
| type | Тип сети. | успех | строка | Изолированная |
| zone | Имя зоны. | успех | строка | ch-gva-2 |
Примечания
Примечание
- 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 можно найти по адресу http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Состояние
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют, что не будет внесено несовместимых изменений в интерфейс.
Для помощи в разработке модулей, если у вас есть желание, пожалуйста, ознакомьтесь с Информацией о сообществе и участии, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_network_module.html
