Spec-Zone.ru › Ansible

Модуль openstack.cloud.network — Создает/удаляет сети в OpenStack

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

admin_state_up

boolean

Указывает, должен ли статус быть отмечен как активный или неактивный.

Варианты:

  • false
  • true

api_timeout

integer

Сколько времени должен ждать уровень сокета, прежде чем истечёт время ожидания для вызовов API. Если это опущено, в библиотеку запросов ничего не будет передано.

auth

dictionary

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

auth_type

string

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

ca_cert

aliases: cacert

string

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

client_cert

aliases: cert

string

Путь к клиенту сертификату для использования в рамках транзакции SSL.

client_key

aliases: key

string

Путь к клиенту ключу для использования в рамках транзакции SSL.

cloud

any

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

dns_domain

string

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

external

boolean

Указывает, доступна ли эта сеть извне.

Варианты:

  • false
  • true

interface

aliases: endpoint_type

string

Тип URL конечной точки для извлечения из каталога сервисов.

Варианты:

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

mtu

aliases: mtu_size

integer

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

name

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

Имя, которое будет назначено сети.

port_security_enabled

boolean

Указывает, включена ли защита портов в сети. Сеть будет использовать значения OpenStack по умолчанию, если этот параметр не используется.

Варианты:

  • false
  • true

project

string

Имя или идентификатор проекта, содержащий сеть (имя доступно только администраторам).

provider_network_type

string

Тип физической сети, которая отображается на этот ресурс сети.

provider_physical_network

string

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

provider_segmentation_id

integer

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

region_name

string

Имя региона.
END_OF_DOCUMENT_MARKER

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

aliases: 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

Возвращается: успех

номер_ревизии

строка

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

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

сегменты

строка

Сегменты

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

состояние

строка

Состояние

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

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

строка

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

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

метки

строка

Метки

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

обновлено_в

строка

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

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

Авторы

  • OpenStack Ansible SIG

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

  • Система отслеживания задач
  • Репозиторий (исходные коды)

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

Spec-Zone.ru

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