Spec-Zone.ru › Ansible

Модуль openstack.cloud.subnet — добавление/удаление подсети в сети OpenStack

Примечание

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

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

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

Чтобы использовать этот модуль в сценарии, укажите: openstack.cloud.subnet.

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

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

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

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Описание

allocation_pool_end

string

Последний IP-адрес из пула подсети, который должен назначаться виртуальным машинам.

allocation_pool_start

string

Начальный адрес из пула подсети, начиная с которого должны выделяться IP-адреса.

allocation_pools

list / elements=dictionary

Список пулов адресов, назначаемых подсети. Каждый элемент содержит значения «start» и «end».

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

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

cidr

string

Представление CIDR подсети, назначаемой подсети. Обязательный параметр, если значение state — «present» и пул подсетей не указан.

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.

description

string

Описание подсети

disable_gateway_ip

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

boolean

Не назначать шлюзу IP-адрес для этой подсети

Варианты:

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

dns_nameservers

list / elements=string

Список DNS-серверов имён для этой подсети.

extra_attrs

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

dictionary

Словарь с дополнительными парами «ключ/значение», передаваемыми API

По умолчанию: {}

gateway_ip

string

IP-адрес, назначаемый шлюзу этой подсети

host_routes

list / elements=dictionary

Список словарей маршрутов узла для подсети.

destination

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

Сеть назначения (CIDR).

nexthop

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

Следующий переход (то есть шлюз) для destination.

interface

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

string

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

Варианты:

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

ip_version

integer

Версия IP подсети: 4 или 6

Варианты:

  • 4 ← (по умолчанию)
  • 6

ipv6_address_mode

string

Режим адресации IPv6

Варианты:

  • "dhcpv6-stateful"
  • "dhcpv6-stateless"
  • "slaac"

ipv6_ra_mode

string

Режим объявления маршрутизатора IPv6

Варианты:

  • "dhcpv6-stateful"
  • "dhcpv6-stateless"
  • "slaac"

is_dhcp_enabled

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

boolean

Следует ли включить DHCP для этой подсети.

Варианты:

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

name

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

Имя создаваемой подсети. Хотя Neutron допускает неуникальные имена подсетей, этот модуль обеспечивает уникальность имён подсетей.

network

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

string

Имя или идентификатор сети, к которой следует подключить подсеть

Обязательный параметр, если значение state — «present»

prefix_length

string

Длина префикса для выделения подсети из пула подсетей

project

string

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

region_name

string

Имя региона.

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

state

string

Желаемое состояние ресурса

Варианты:

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

subnet_pool

string

Имя или идентификатор пула подсетей, из которого нужно получить CIDR

timeout

integer

Время ожидания ansible запрошенного ресурса.

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

use_default_subnet_pool

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

boolean

Использовать пул подсетей по умолчанию для ip_version, чтобы получить CIDR.

Варианты:

  • false
  • true

validate_certs

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

boolean

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

До 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 a new (or update an existing) subnet on the specified network
- openstack.cloud.subnet:
    state: present
    network_name: network1
    name: net1subnet
    cidr: 192.168.0.0/24
    dns_nameservers:
       - 8.8.8.7
       - 8.8.8.8
    host_routes:
       - destination: 0.0.0.0/0
         nexthop: 12.34.56.78
       - destination: 192.168.0.0/24
         nexthop: 192.168.0.1

# Delete a subnet
- openstack.cloud.subnet:
    state: absent
    name: net1subnet

# Create an ipv6 stateless subnet
- openstack.cloud.subnet:
    state: present
    name: intv6
    network_name: internal
    ip_version: 6
    cidr: 2db8:1::/64
    dns_nameservers:
        - 2001:4860:4860::8888
        - 2001:4860:4860::8844
    ipv6_ra_mode: dhcpv6-stateless
    ipv6_address_mode: dhcpv6-stateless

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

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

Ключ

Описание

id

string

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

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

subnet

dictionary

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

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

allocation_pools

list / elements=dictionary

Пулы адресов, связанные с этой подсетью.

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

cidr

string

Блок CIDR подсети.

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

created_at

string

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

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

description

string

Описание

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

dns_nameservers

list / elements=string

DNS-серверы имён для этой подсети.

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

dns_publish_fixed_ip

boolean

Определяет, публиковать ли записи DNS для фиксированных IP-адресов.

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

gateway_ip

string

IP-адрес шлюза подсети.

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

host_routes

string

Список маршрутов узлов.

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

id

string

Уникальный UUID.

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

ip_version

integer

Версия IP для этой подсети.

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

ipv6_address_mode

string

Режимы адресации IPv6: ‘dhcpv6-stateful’, ‘dhcpv6-stateless’ или ‘slaac’.

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

ipv6_ra_mode

string

Режимы объявлений маршрутизатора IPv6: ‘slaac’, ‘dhcpv6-stateful’, ‘dhcpv6-stateless’.

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

is_dhcp_enabled

boolean

Флаг включения DHCP для этой подсети.

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

name

string

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

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

network_id

string

Идентификатор сети, к которой относится эта подсеть.

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

prefix_length

string

Длина префикса для выделения подсети из пула подсетей.

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

project_id

string

Идентификатор проекта, связанного с этой подсетью.

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

revision_number

integer

Номер редакции ресурса

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

segment_id

string

Идентификатор сегмента, с которым связана эта подсеть.

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

service_types

list / elements=string

Типы служб для этой подсети

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

subnet_pool_id

string

Идентификатор пула подсетей, из которого следует получить CIDR.

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

tags

string

Теги

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

updated_at

string

Время последнего обновления подсети.

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

use_default_subnet_pool

boolean

Определяет, использовать ли пул подсетей по умолчанию для получения CIDR.

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

Авторы

  • 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/subnet_module.html

Spec-Zone.ru

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