os_network – Создаёт/удаляет сети из OpenStack

Новое в версии 2.0.

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

Добавление или удаление сети из OpenStack.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state_up boolean	Варианты: no yes ←	Указывает, должно ли состояние быть отмечено как активное или неактивное.
api_timeout integer		Время ожидания сокетом перед таймаутом вызовов API. Если этот параметр опущен, он не будет передан библиотеке requests.
auth dictionary		Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type string		Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone -		Игнорируется. Наличие для обратной совместимости.
ca_cert string		Путь к набору сертификатов CA, которые могут использоваться при проверке запросов SSL API. Псевдонимы: cacert
client_cert string		Путь к клиенту сертификат для использования в рамках транзакции SSL. Псевдонимы: cert
client_key string		Путь к ключу клиента для использования в рамках транзакции SSL. Псевдонимы: key
cloud raw		Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
external boolean	Варианты: no ← yes	Указывает, доступна ли эта сеть извне.
interface string добавлено в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для получения из каталога сервисов. Псевдонимы: endpoint_type
name - / обязательно		Имя, которое будет назначено сети.
port_security_enabled boolean добавлено в 2.8	Варианты: no yes	Включена ли защита портов в сети. Сеть будет использовать значения OpenStack по умолчанию, если этот параметр не используется. Требуется openstacksdk>=0.18.
project - добавлено в 2.1		Имя или ID проекта, содержащего сеть (только для администраторов)
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 string		Имя региона.
shared boolean	Варианты: no ← yes	Указывает, является ли эта сеть общей.
state -	Варианты: present ← absent	Указывает желаемое состояние ресурса.
timeout integer	По умолчанию: 180	Время ожидания Ansible для запрошенного ресурса.
validate_certs boolean	Варианты: no ← yes	Указывает, необходимо ли проверять запросы SSL API. До Ansible 2.3 по умолчанию было `yes`. Псевдонимы: verify
wait boolean	Варианты: no yes ←	Ansible должен ждать завершения запрошенного ресурса.

Примечания

Примечание

Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явных значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем из явных параметров в сценариях. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

# 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

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.8/modules/os_network_module.html