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

Примечание

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

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

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

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

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

Обзор

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
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, который можно использовать для проверки запросов API SSL.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud - строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные окружения OpenStack OS_* . Если cloud - словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml.
filters словарь	Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря будут сопоставлены и переданы в API в качестве фильтров параметров запроса.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name псевдонимы: port строка	Уникальное имя или ID порта.
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается.
timeout целое число	Сколько времени Ansible должно ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify логическое значение	Необходимо ли проверять запросы API SSL. До 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/

Примеры

# 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 список / элементы=словарь	Список словарей портов. Подмножество ключей словаря, перечисленных ниже, может быть возвращено в зависимости от вашего облачного провайдера. Возвращается: всегда
allowed_address_pairs список / элементы=строка	Разрешённые пары адресов. Возвращается: успешно Пример: `[]`
binding_host_id строка	Идентификатор хоста, где выделен порт. В некоторых случаях разные реализации могут выполняться на разных хостах. Возвращается: успешно Пример: `"b4bd682d-234a-4091-aa5b-4b025a6a7759"`
binding_profile словарь	Словарь, который позволяет приложению, выполняемому на указанном хосте, передавать и получать информацию о порте виртуальной машины в плагин. Возвращается: успешно Пример: `{}`
binding_vif_details словарь	Словарь, который позволяет приложению передавать информацию о функциях, предоставляемых API сетевых операций. Возвращается: успешно
binding_vif_type словарь	Тип VIF для порта. Возвращается: успешно
binding_vnic_type строка	Тип виртуального сетевого интерфейса (vNIC), привязанного к порту Neutron. Возвращается: успешно Пример: `"normal"`
created_at строка	Отметка времени создания порта. Возвращается: успешно Пример: `"2022-02-03T13:28:25Z"`
data_plane_status строка	Состояние подлежащего плоскости данных порта. Возвращается: успешно
description строка	Описание порта. Возвращается: успешно
device_id строка	Идентификатор устройства этого порта. Возвращается: успешно Пример: `"b4bd682d-234a-4091-aa5b-4b025a6a7759"`
device_owner строка	Владелец устройства этого порта, например, `network:dhcp`. Возвращается: успешно Пример: `"network:router_interface"`
device_profile строка	Профиль устройства этого порта, относится к профилям устройств Cyborg: https://docs.openstack.org/api-ref/accelerator/v2/index.html# device-profiles. Возвращается: успешно
dns_assignment список / элементы=строка	Назначение DNS для порта. Возвращается: успешно
dns_domain строка	Домен DNS, назначенный порту. Возвращается: успешно
dns_name строка	Имя DNS для порта. Возвращается: успешно
extra_dhcp_opts список / элементы=строка	Набор из нуля или более дополнительных пар опций DHCP. Пара опций состоит из имени и значения опции. Возвращается: успешно Пример: `[]`
fixed_ips список / элементы=строка	IP-адреса для порта. Включает IP-адрес и идентификатор подсети. Возвращается: успешно

END_OF_DOCUMENT_MARKER

id string	Идентификатор порта. Возвращено: success Пример: `"3ec25c97-7052-4ab8-a8ba-92faf84148de"`
ip_allocation string	Параметр ip_allocation указывает, используют ли порты отложенное, немедленное или отсутствие выделения IP-адресов. Возвращено: success
is_admin_state_up boolean	Административное состояние порта: включено `True` или выключено `False`. Возвращено: success Пример: `true`
is_port_security_enabled boolean	Состояние безопасности порта: включено `True` или выключено `False`. Возвращено: success Пример: `false`
mac_address string	MAC-адрес разрешенной пары адресов. Возвращено: success Пример: `"00:00:5E:00:53:42"`
name string	Имя порта. Возвращено: success Пример: `"port_name"`
network_id string	Идентификатор подключенной сети. Возвращено: success Пример: `"dd1ede4f-3952-4131-aab6-3b8902268c7d"`
numa_affinity_policy string	Политика NUMA-сродства, определенная для этого порта. Возвращено: success Пример: `"required"`
project_id string	Идентификатор проекта, которому принадлежит сеть. Возвращено: success Пример: `"aa1ede4f-3952-4131-aab6-3b8902268c7d"`
propagate_uplink_status boolean	Необходимо ли распространять статус восходящей линии порта. Возвращено: success Пример: `false`
qos_network_policy_id string	Идентификатор политики QoS, присоединенной к сети, к которой привязан порт. Возвращено: success Пример: `"1e4f3958-c0c9-4dec-82fa-ed2dc1c5cb34"`
qos_policy_id string	Идентификатор политики QoS, присоединенной к порту. Возвращено: success Пример: `"b20bb47f-5d6d-45a6-8fe7-2c1b44f0db73"`
resource_request string	Параметр port-resource-request предоставляет ресурсы Placement (например: минимальная пропускная способность) и признаки (например: тип vnic, physnet), запрашиваемые портом у Nova и Placement. Возвращено: success
revision_number integer	Номер ревизии ресурса. Возвращено: success Пример: `0`
security_group_ids list / elements=string	Идентификаторы любых присоединенных групп безопасности. Возвращено: success
status string	Состояние порта. Значение: `ACTIVE` или `DOWN`. Возвращено: success Пример: `"ACTIVE"`
tags list / elements=string	Список тегов ресурса. Возвращено: success Пример: `[]`

tenant_id string	То же самое, что и project_id. Устарело. Возвращается: успех Пример: `"51fce036d7984ba6af4f6c849f65ef00"`
trunk_details dictionary	Ветка, относящаяся к этому порту-родителю и его дочерним портам. Присутствует для портов-родителей типа «trunk», если `trunk-details` расширение загружено. Возвращается: успех
updated_at string	Отметка времени последнего обновления порта. Возвращается: успех Пример: `"2022-02-03T13:28:25Z"`

Авторы

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/port_info_module.html