cs_network_offering – Управляет предложениями сетей в облаках на основе Apache CloudStack
Новая в версии 2.5.
Краткое описание
- Создание, обновление, включение, отключение и удаление предложений сетей.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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, также см. примечания. | |
| availability строка | Доступность сетевого предложения. Значение по умолчанию — Optional | |
| conserve_mode булево |
| Включен ли режим сохранения IP для сетевого предложения. |
| details список | Детали сетевого предложения в формате ключ/значение. с поставщиком услуг в качестве значения | |
| display_text строка | Текст для отображения сетевых предложений. | |
| egress_default_policy строка |
| Политика по умолчанию для исходящего трафика: разрешить или запретить. |
| for_vpc булево добавлено в 2.8 |
| Предназначено ли предложение для использования в VPC. |
| guest_ip_type строка |
| Тип гостевого сетевого предложения. |
| keepalive_enabled булево |
| Если true, keepalive будет включен в балансировщике нагрузки. На момент написания это имеет эффект только на haproxy. Режим http и опции httpclose сброшены в файле конфигурации haproxy. |
| max_connections целое число | Максимальное количество одновременных подключений, поддерживаемых сетевым предложением. | |
| name строка / обязательно | Название сетевого предложения. | |
| network_rate целое число | Скорость передачи данных в мегабитах в секунду, разрешенная. | |
| persistent булево |
| True, если сетевое предложение поддерживает постоянные сети. По умолчанию false, если не указано. |
| service_capabilities список | Желаемые возможности обслуживания в качестве части сетевого предложения. псевдонимы: service_capability | |
| service_offering строка | Имя или идентификатор предложения службы, используемого поставщиком виртуального маршрутизатора. | |
| service_providers список | Сопоставление поставщика с услугой. Если не указано, поставщик услуги будет сопоставлен с поставщиком по умолчанию в физической сети. псевдонимы: service_provider | |
| specify_ip_ranges булево |
| Поддерживает ли сетевое предложение указание диапазонов IP-адресов. По умолчанию no API, если не указано. |
| specify_vlan булево |
| Поддерживает ли сетевое предложение VLAN или нет. |
| state строка |
| Состояние сетевого предложения. |
| supported_services список |
| Поддерживаемые службы сетевого предложения. Список из одного или нескольких элементов из списка вариантов. псевдонимы: supported_service |
| traffic_type строка | Значение по умолчанию: "Guest" | Тип трафика для сетевого предложения. |
Примечания
Примечание
- 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 Cloud Guide.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Create a network offering and enable it
cs_network_offering:
name: my_network_offering
display_text: network offering description
state: enabled
guest_ip_type: Isolated
supported_services: [ Dns, PortForwarding, Dhcp, SourceNat, UserData, Firewall, StaticNat, Vpn, Lb ]
service_providers:
- { service: 'dns', provider: 'virtualrouter' }
- { service: 'dhcp', provider: 'virtualrouter' }
delegate_to: localhost
- name: Remove a network offering
cs_network_offering:
name: my_network_offering
state: absent
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| availability строка | успех | Доступность сетевого предложения. Пример: Необязательно |
| display_text строка | успех | Текст для отображения сетевого предложения. Пример: Моё сетевое предложение |
| egress_default_policy строка | успех | Политика выходящего трафика по умолчанию. Пример: allow |
| for_vpc булево добавлено в 2.8 | успех | Предназначено ли это предложение для использования в VPC? |
| guest_ip_type строка | успех | Тип гостевого трафика сетевого предложения. Пример: Isolated |
| id строка | успех | UUID сетевого предложения. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| is_default булево | успех | Является ли сетевое предложение предложением по умолчанию? |
| is_persistent булево | успех | Поддерживаются ли персистентные сети? |
| max_connections целое число | успех | Максимальное количество одновременных подключений, обрабатываемых LB. Пример: 300 |
| name строка | успех | Имя сетевого предложения. Пример: MyCustomNetworkOffering |
| network_rate целое число | успех | Скорость передачи сетевого трафика в Мбит/с. Пример: 200 |
| service_offering_id строка | успех | ID предложения сервиса. Пример: c5f7a5fc-43f8-11e5-a151-feff819cdc9f |
| state строка | успех | Состояние сетевого предложения. Пример: Включено |
| traffic_type строка | успех | Тип трафика. Пример: Гостевой |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- David Passante (@dpassante)
Подсказка
Если вы обнаружили какие-либо проблемы в данной документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/cs_network_offering_module.html