Модуль openstack.cloud.trunk — добавление или удаление транков в облаке OpenStack.

Примечание

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

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

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

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

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

Описание

Добавление или удаление транка в облаке OpenStack.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Время ожидания сокетного уровня перед истечением срока ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся.
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.
client_cert псевдонимы: cert строка	Путь к сертификату клиента, используемому при обмене данными по SSL.
client_key псевдонимы: key строка	Путь к ключу клиента, используемому при обмене данными по SSL.
cloud любой тип	Именованное облако или конфигурация облака, с которыми нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки, который нужно получить из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка / обязательный	Имя, которое необходимо присвоить транку. Этот атрибут порта нельзя изменить.
port строка	Имя или идентификатор порта транка.
region_name строка	Имя региона.
sdk_log_level строка	Уровень журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается.
state строка	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
sub_ports список / элементы=словарь	Подчинённые порты транка.
port строка	Идентификатор или имя порта.
segmentation_id целое число	Используемый идентификатор сегментации.
segmentation_type строка	Используемый тип сегментации.
timeout целое число	Время ожидания запрошенного ресурса со стороны Ansible. По умолчанию: `180`
validate_certs псевдонимы: verify логическое значение	Нужно ли проверять запросы SSL API. До Ansible 2.3 значение по умолчанию было `true`. Варианты: `false` `true`
wait логическое значение	Должен ли 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 trunk
- openstack.cloud.trunk:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: trunk1
    port: port1

# Create a trunk with a subport
- openstack.cloud.trunk:
    state: present
    cloud: my-cloud
    name: trunk1
    port: port1
    sub_ports:
      - name: subport1
        segmentation_type: vlan
        segmentation_id: 123

# Remove a trunk
- openstack.cloud.trunk:
    state: absent
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: trunk1

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

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

Ключ	Описание
trunk словарь	Словарь с описанием транка. Возвращается: при успешном выполнении, если state имеет значение `present`.
created_at строка	Время создания транка. Возвращается: при успешном выполнении Пример: `"2022-02-03T13:28:25Z"`
description строка	Описание транка. Возвращается: при успешном выполнении
id строка	Идентификатор транка. Возвращается: при успешном выполнении Пример: `"3ec25c97-7052-4ab8-a8ba-92faf84148de"`
is_admin_state_up логическое значение	Административное состояние транка: активен `True` или неактивен `False`. Возвращается: при успешном выполнении Пример: `true`
name строка	Имя транка. Возвращается: при успешном выполнении Пример: `"trunk_name"`
port_id строка	Идентификатор порта транка Возвращается: при успешном выполнении Пример: `"5ec25c97-7052-4ab8-a8ba-92faf84148df"`
project_id строка	Идентификатор проекта, которому принадлежит транк. Возвращается: при успешном выполнении Пример: `"aa1ede4f-3952-4131-aab6-3b8902268c7d"`
revision_number целое число	Номер редакции ресурса. Возвращается: при успешном выполнении Пример: `0`
status строка	Состояние транка. Значение — `ACTIVE` или `DOWN`. Возвращается: при успешном выполнении Пример: `"ACTIVE"`
sub_ports список / элементы=строка	Список подчинённых портов транка. Возвращается: при успешном выполнении Пример: `[]`
tags список / элементы=строка	Список тегов ресурса. Возвращается: при успешном выполнении Пример: `[]`
tenant_id строка	То же, что и project_id. Устаревший параметр. Возвращается: при успешном выполнении Пример: `"51fce036d7984ba6af4f6c849f65ef00"`
updated_at строка	Время последнего обновления транка. Возвращается: при успешном выполнении Пример: `"2022-02-03T13:28:25Z"`

Авторы

Специальная группа 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/trunk_module.html