Spec-Zone.ru › Ansible

Модуль openstack.cloud.port_info — получение информации о портах в OpenStack.

Примечание

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

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

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

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

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

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

  • Получение информации о портах из OpenStack.

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

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.

filters

dictionary

Словарь метаданных для дополнительной фильтрации. Элементы этого словаря будут сопоставлены и переданы в API в качестве фильтров параметров запроса.

interface

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

string

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

Варианты:

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

name

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

string

Уникальное имя или идентификатор порта.

region_name

string

Название региона.

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

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/

Примеры

# Gather information about all ports
- openstack.cloud.port_info:
    cloud: mycloud
  register: result

- debug:
    msg: "{{ result.ports}}"

# Gather information about a single port
- openstack.cloud.port_info:
    cloud: mycloud
    name: 6140317d-e676-31e1-8a4a-b1913814a471

# Gather information about all ports that have device_id set to a specific
# value and with a status of ACTIVE.
- openstack.cloud.port_info:
    cloud: mycloud
    filters:
      device_id: 1038a010-3a37-4a9d-82ea-652f1da36597
      status: ACTIVE

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

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

Ключ

Описание

ports

list / elements=dictionary

Список словарей портов. В зависимости от поставщика облачных услуг может возвращаться подмножество перечисленных ниже ключей словаря.

Возвращается: всегда

allowed_address_pairs

list / elements=string

Разрешённые пары адресов.

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

Пример: []

binding_host_id

string

Идентификатор хоста, на котором размещён порт. В некоторых случаях разные реализации могут выполняться на разных хостах.

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

Пример: "b4bd682d-234a-4091-aa5b-4b025a6a7759"

binding_profile

dictionary

Словарь, позволяющий приложению, выполняющемуся на указанном хосте, передавать подключаемому модулю и получать от него сведения, относящиеся к порту VIF.

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

Пример: {}

binding_vif_details

dictionary

Словарь, позволяющий приложению передавать сведения о функциях, предоставляемых API Networking.

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

binding_vif_type

dictionary

Тип VIF для порта.

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

binding_vnic_type

string

Тип виртуальной сетевой карты (vNIC), привязанной к порту neutron.

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

Пример: "normal"

created_at

string

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

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

Пример: "2022-02-03T13:28:25Z"

data_plane_status

string

Состояние базового уровня передачи данных порта.

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

description

string

Описание порта.

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

device_id

string

Идентификатор устройства этого порта.

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

Пример: "b4bd682d-234a-4091-aa5b-4b025a6a7759"

device_owner

string

Владелец устройства этого порта, например network:dhcp.

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

Пример: "network:router_interface"

device_profile

string

Профиль устройства этого порта; относится к профилям устройств Cyborg: https://docs.openstack.org/api-ref/accelerator/v2/index.html# device-profiles.

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

dns_assignment

list / elements=string

Назначение DNS для порта.

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

dns_domain

string

Домен DNS, назначенный порту.

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

dns_name

string

Имя DNS для порта.

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

extra_dhcp_opts

list / elements=string

Набор из нуля или более дополнительных пар параметров DHCP. Пара параметров состоит из значения и имени параметра.

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

Пример: []

fixed_ips

list / elements=string

IP-адреса порта. Включают IP-адрес и идентификатор подсети.

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

id

string

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

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

Пример: "3ec25c97-7052-4ab8-a8ba-92faf84148de"

ip_allocation

string

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

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

is_admin_state_up

boolean

Административное состояние порта: включён True или выключен False.

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

Пример: true

is_port_security_enabled

boolean

Состояние защиты порта: включена True или отключена False.

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

Пример: false

mac_address

string

MAC-адрес разрешённой пары адресов.

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

Пример: "00:00:5E:00:53:42"

name

string

Имя порта.

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

Пример: "port_name"

network_id

string

Идентификатор подключённой сети.

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

Пример: "dd1ede4f-3952-4131-aab6-3b8902268c7d"

numa_affinity_policy

string

Политика NUMA-affinity, заданная для этого порта.

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

Пример: "required"

project_id

string

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

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

Пример: "aa1ede4f-3952-4131-aab6-3b8902268c7d"

propagate_uplink_status

boolean

Определяет, следует ли распространять состояние восходящего канала порта.

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

Пример: false

qos_network_policy_id

string

Идентификатор политики QoS, назначенной сети, к которой подключён порт.

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

Пример: "1e4f3958-c0c9-4dec-82fa-ed2dc1c5cb34"

qos_policy_id

string

Идентификатор политики QoS, назначенной порту.

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

Пример: "b20bb47f-5d6d-45a6-8fe7-2c1b44f0db73"

resource_request

string

Параметр port-resource-request предоставляет сведения о ресурсах Placement (например, минимальная пропускная способность) и характеристиках (например, тип vNIC, physnet), запрошенных портом у Nova и Placement.

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

revision_number

integer

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

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

Пример: 0

security_group_ids

list / elements=string

Идентификаторы подключённых групп безопасности.

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

status

string

Состояние порта. Значение — ACTIVE или DOWN.

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

Пример: "ACTIVE"

tags

list / elements=string

Список тегов ресурса.

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

Пример: []

tenant_id

string

То же, что и project_id. Устарело.

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

Пример: "51fce036d7984ba6af4f6c849f65ef00"

trunk_details

dictionary

Транк, ссылающийся на этот родительский порт и его подчинённые порты. Присутствует для родительских портов транка, если загружено расширение trunk-details.

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

updated_at

string

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

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

Пример: "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/port_info_module.html

Spec-Zone.ru

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