Spec-Zone.ru › Ansible

Модуль openstack.cloud.network — создание и удаление сетей в OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.network.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

Следующие требования должны быть выполнены на хосте, где выполняется этот модуль.

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

admin_state_up

boolean

Следует ли пометить состояние как включённое или выключенное.

Варианты:

  • false
  • true

api_timeout

integer

Как долго сокетный уровень должен ожидать ответа, прежде чем завершить вызов API по тайм-ауту. Если параметр не указан, библиотеке requests ничего не передаётся.

auth

dictionary

Словарь с данными аутентификации, необходимыми выбранной облачной стратегией аутентификации. Для стандартного плагина password здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, укажите здесь имя плагина и соответствующим образом измените содержимое параметра auth.

ca_cert

псевдонимы: cacert

string

Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов к API по SSL.

client_cert

псевдонимы: cert

string

Путь к клиентскому сертификату, используемому при обмене данными по SSL.

client_key

псевдонимы: key

string

Путь к клиентскому ключу, используемому при обмене данными по SSL.

cloud

any

Именованное облако или конфигурация облака, с которыми нужно работать. Если cloud — строка, она указывает на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml.

dns_domain

string

Задаваемое значение домена DNS. Если этот параметр не указан, сеть использует значения по умолчанию OpenStack.

external

boolean

Доступна ли эта сеть извне.

Варианты:

  • false
  • true

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

is_default

boolean

Является ли эта сеть сетью по умолчанию. Действует только для внешних сетей.

Варианты:

  • false
  • true

is_vlan_transparent

boolean

Является ли эта сеть прозрачной для VLAN.

Варианты:

  • false
  • true

mtu

псевдонимы: mtu_size

integer

Значение максимального размера передаваемого блока (MTU), позволяющее учитывать фрагментацию. Если этот параметр не указан, сеть использует значения по умолчанию OpenStack.

name

string / обязательный

Имя, присваиваемое сети.

port_security_enabled

boolean

Включена ли безопасность портов в сети. Если этот параметр не используется, сеть применяет значения по умолчанию OpenStack.

Варианты:

  • false
  • true

project

string

Имя или ID проекта, которому принадлежит сеть (по имени — только для администратора)

provider_network_type

string

Тип физической сети, соответствующей этому сетевому ресурсу.

provider_physical_network

string

Физическая сеть, в которой реализован этот сетевой объект.

provider_segmentation_id

integer

Изолированный сегмент физической сети. Атрибут network_type определяет модель сегментации. Например, если значение network_type равно vlan, этот ID является идентификатором VLAN. Если значение network_type равно gre, этот ID является ключом GRE.

region_name

string

Название региона.

sdk_log_level

string

Уровень журналирования OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если путь не указан, журнал не ведётся.

shared

boolean

Является ли эта сеть общей.

Варианты:

  • false
  • true

state

string

Указывает требуемое состояние ресурса.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

Как долго Ansible должен ожидать запрошенный ресурс.

По умолчанию: 180

validate_certs

псевдонимы: verify

boolean

Следует ли проверять запросы к API по SSL.

До Ansible 2.3 значение по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли Ansible ждать завершения создания запрошенного ресурса.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Вместо явного указания значений можно использовать стандартные переменные среды 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'.
- openstack.cloud.network:
    cloud: mycloud
    state: present
    name: ext_network
    external: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ

Описание

id

string

Идентификатор сети

Возвращается: При успешном выполнении, если сеть существует.

network

dictionary

Словарь с описанием сети.

Возвращается: При успешном выполнении, если сеть существует.

availability_zone_hints

string

Подсказки по зонам доступности

Возвращается: при успешном выполнении

availability_zones

string

Зоны доступности

Возвращается: при успешном выполнении

created_at

string

Временная метка создания

Возвращается: при успешном выполнении

description

string

Описание

Возвращается: при успешном выполнении

dns_domain

string

DNS-домен

Возвращается: при успешном выполнении

id

string

Идентификатор

Возвращается: при успешном выполнении

ipv4_address_scope_id

string

Идентификатор области адресов IPv4

Возвращается: при успешном выполнении

ipv6_address_scope_id

string

Идентификатор области адресов IPv6

Возвращается: при успешном выполнении

is_admin_state_up

string

Включено ли административное состояние

Возвращается: при успешном выполнении

is_default

string

Является ли сеть сетью по умолчанию

Возвращается: при успешном выполнении

is_port_security_enabled

string

Включена ли защита портов

Возвращается: при успешном выполнении

is_router_external

string

Является ли маршрутизатор внешним

Возвращается: при успешном выполнении

is_shared

string

Является ли сеть общей

Возвращается: при успешном выполнении

is_vlan_transparent

string

Включена ли прозрачность VLAN

Возвращается: при успешном выполнении

mtu

string

MTU

Возвращается: при успешном выполнении

name

string

Имя

Возвращается: при успешном выполнении

project_id

string

Идентификатор проекта

Возвращается: при успешном выполнении

provider_network_type

string

Тип сети провайдера

Возвращается: при успешном выполнении

provider_physical_network

string

Физическая сеть провайдера

Возвращается: при успешном выполнении

provider_segmentation_id

string

Идентификатор сегментации провайдера

Возвращается: при успешном выполнении

qos_policy_id

string

Идентификатор политики QoS

Возвращается: при успешном выполнении

revision_number

string

Номер ревизии

Возвращается: при успешном выполнении

segments

string

Сегменты

Возвращается: при успешном выполнении

status

string

Статус

Возвращается: при успешном выполнении

subnet_ids

string

Идентификаторы подсетей

Возвращается: при успешном выполнении

tags

string

Теги

Возвращается: при успешном выполнении

updated_at

string

Временная метка обновления

Возвращается: при успешном выполнении

Авторы

  • OpenStack Ansible SIG

Ссылки на коллекцию

  • Отслеживание ошибок
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/network_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API