Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

  • Создание, обновление или удаление пула подсетей в OpenStack.

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

address_scope

string

ID или имя области адресов, связанной с этим пулом подсетей.

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.

default_prefix_length

integer

Длина префикса, выделяемого при создании подсети, если атрибуты cidr или prefixlen не указаны.

default_quota

integer

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

description

string

Описание пула подсетей.

extra_specs

dictionary

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

interface

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

string

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

Варианты:

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

is_default

boolean

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

Варианты:

  • false
  • true

is_shared

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

boolean

Является ли этот пул подсетей общим.

Этот атрибут нельзя обновить.

Варианты:

  • false
  • true

maximum_prefix_length

integer

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

minimum_prefix_length

integer

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

name

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

Имя, присваиваемое пулу подсетей.

Этот атрибут нельзя обновить.

prefixes

list / элементы=string

Префиксы пула подсетей в нотации CIDR.

project

string

Имя или ID проекта.

region_name

string

Имя региона.

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

state

string

Должен ли пул подсетей быть present или absent.

Варианты:

  • "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/

Примеры

- name: Create an subnet pool.
  openstack.cloud.subnet_pool:
    cloud: mycloud
    state: present
    name: my_subnet_pool
    prefixes:
        - 10.10.10.0/24

- name: Create a subnet pool for a given project.
  openstack.cloud.subnet_pool:
    cloud: mycloud
    state: present
    name: my_subnet_pool
    project: myproj
    prefixes:
        - 10.10.10.0/24

- name: Create a shared and default subnet pool in existing address scope
  openstack.cloud.subnet_pool:
    cloud: mycloud
    state: present
    name: my_subnet_pool
    address_scope: my_adress_scope
    is_default: True
    default_quota: 10
    maximum_prefix_length: 32
    minimum_prefix_length: 8
    default_prefix_length: 24
    is_shared: True
    prefixes:
        - 10.10.10.0/8

- name: Delete subnet poool.
  openstack.cloud.subnet_pool:
    cloud: mycloud
    state: absent
    name: my_subnet_pool

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

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

Ключ

Описание

subnet_pool

dictionary

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

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

address_scope_id

string

ID области адресов.

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

Пример: "861174b82b43463c9edc5202aadc60ef"

created_at

string

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

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

Пример: ""

default_prefix_length

integer

Длина префикса, выделяемого при создании подсети, если атрибуты cidr или prefixlen не указаны.

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

Пример: 32

default_quota

integer

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

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

Пример: 22

description

string

Описание пула подсетей.

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

Пример: "My test subnet pool."

id

string

ID пула подсетей.

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

Пример: "474acfe5-be34-494c-b339-50f06aa143e4"

ip_version

integer

Версия IP пула подсетей: 4 или 6.

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

Пример: 4

is_default

boolean

Указывает, является ли этот пул пулом подсетей по умолчанию.

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

Пример: false

is_shared

boolean

Указывает, доступен ли этот пул подсетей для всех проектов.

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

Пример: false

maximum_prefix_length

integer

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

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

Пример: 22

minimum_prefix_length

integer

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

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

Пример: 8

name

string

Имя пула подсетей.

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

Пример: "my_subnet_pool"

prefixes

list / элементы=string

Список префиксов подсетей, назначенных пулу подсетей.

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

Пример: ["10.10.20.0/24", "10.20.10.0/24"]

project_id

string

ID проекта.

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

Пример: "861174b82b43463c9edc5202aadc60ef"

revision_number

integer

Номер ревизии пула подсетей.

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

Пример: 5

tags

list / элементы=string

Список связанных тегов.

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

tenant_id

string

ID проекта. Устарело.

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

Пример: "861174b82b43463c9edc5202aadc60ef"

updated_at

string

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

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

Авторы

  • Специальная группа OpenStack Ansible

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

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

© 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_pool_module.html

Spec-Zone.ru

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