os_network – Создаёт/удаляет сети в OpenStack
Новое в версии 2.0.
Описание
- Добавление или удаление сети из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_state_up boolean |
| Указывает, должно ли состояние быть помечено как активное или неактивное. |
| api_timeout - | Сколько времени должна ждать сокетная часть, прежде чем отключиться из-за таймаута для вызовов API. Если это опущено, ничего не будет передано библиотеке requests. | |
| auth - | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password это будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать требуемые параметры плагина авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type - | Имя плагина авторизации, который следует использовать. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| cacert - | Путь к пакету сертификатов CA, который может быть использован для проверки запросов API SSL. | |
| cert - | Путь к клиенту сертификат, используемый в рамках SSL-транзакции. | |
| cloud - | Именованное облако или конфигурация облака для работы. Если cloud является строкой, он ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| external boolean |
| Указывает, доступна ли эта сеть извне. |
| interface - добавлен в 2.3 |
| Тип URL конечной точки для получения из каталога служб. Псевдонимы: endpoint_type |
| key - | Путь к ключу клиента, используемому в рамках SSL-транзакции. | |
| name - / обязательно | Имя, которое будет присвоено сети. | |
| project - добавлен в 2.1 | Имя или идентификатор проекта, содержащего сеть (только для администратора) | |
| provider_network_type - добавлен в 2.1 | Тип физической сети, которая отображается на этот ресурс сети. | |
| provider_physical_network - добавлен в 2.1 | Физическая сеть, в которой реализован этот объект сети. | |
| provider_segmentation_id - добавлен в 2.1 | Изолированный сегмент в физической сети. Атрибут network_type определяет модель сегментации. Например, если значение network_type равно vlan, этот идентификатор — идентификатор vlan. Если значение network_type равно gre, этот идентификатор — ключ gre. | |
| region_name - | Имя региона. | |
| shared boolean |
| Указывает, является ли эта сеть общей. |
| state - |
| Указывает желаемое состояние ресурса. |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемый ресурс. |
| verify boolean |
| Указывает, должны ли быть проверены запросы API SSL. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершён. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об аутентификации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Create an externally accessible network named 'ext_network'.
- os_network:
cloud: mycloud
state: present
name: ext_network
external: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| network сложный | При успехе, когда state равно 'present'. | Словарь, описывающий сеть. | |
| admin_state_up булево | Административное состояние сети. Пример: True | ||
| id строка | Идентификатор сети. Пример: 4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56 | ||
| mtu целое число | MTU ресурса сети. | ||
| name строка | Имя сети. Пример: ext_network | ||
| port_security_enabled булево | Статус защиты портов Пример: True | ||
| provider:network_type строка | Тип физической сети, соответствующей этому ресурсу сети. Пример: vlan | ||
| provider:physical_network строка | Физическая сеть, где реализован этот объект сети. Пример: my_vlan_net | ||
| provider:segmentation_id строка | Изолированный сегмент в физической сети. Пример: 101 | ||
| router:external булево | Указывает, доступна ли эта сеть извне. Пример: True | ||
| shared булево | Указывает, является ли эта сеть общей для всех арендаторов. | ||
| status строка | Статус сети. Пример: ACTIVE | ||
| subnets список | Связанные подсети. | ||
| tenant_id строка | Идентификатор арендатора. Пример: 06820f94b9f54b119636be2728d216fc | ||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Monty Taylor (@emonty)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/os_network_module.html
