Spec-Zone.ru › Ansible

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

Примечание

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

строка

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

allocation_pool_start

строка

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

api_timeout

целое число

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

auth

словарь

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

auth_type

строка

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

ca_cert

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

строка

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

cidr

строка

Представление CIDR подсети, которая должна быть назначена подсети. Требуется, когда state равен ‘present’ и не указан subnetpool.

client_cert

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

строка

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

client_key

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

строка

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

cloud

любой

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

description

строка

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

disable_gateway_ip

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

булево

IP шлюза не будет назначен для этой подсети

Варианты:

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

dns_nameservers

список / элементы=строка

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

extra_attrs

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

словарь

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

Значение по умолчанию: {}

gateway_ip

строка

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

host_routes

список / элементы=словарь

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

destination

строка / обязательно

Целевая сеть (CIDR).

nexthop

строка / обязательно

Следующий узел (также шлюз) для destination.

interface

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

строка

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

Варианты:

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

ip_version

целое число

Версия 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

aliases: enable_dhcp

boolean

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

Варианты:

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

name

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

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

network

aliases: network_name

string

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

Требуется, когда state равен ‘present’

prefix_length

string

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

project

string

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

region_name

string

Имя региона.

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

state

string

Укажите желаемое состояние ресурса

Варианты:

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

subnet_pool

string

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

timeout

integer

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

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

use_default_subnet_pool

aliases: use_default_subnetpool

boolean

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

Варианты:

  • false
  • true

validate_certs

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

Шлюз подсети.

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

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.

Возвращается при: success

tags

string

Тэги

Возвращается при: success

updated_at

string

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

Возвращается при: success

use_default_subnet_pool

boolean

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

Возвращается при: success

Авторы

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

Spec-Zone.ru

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