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

Примечание

Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в плейбуке укажите: openstack.cloud.port_info.

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

Обзор

Получение информации о портах из OpenStack.
Этот модуль назывался openstack.cloud.port_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль openstack.cloud.port_info больше не возвращает ansible_facts!

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ожидать программа, прежде чем прервать вызов API из-за таймаута сокета. Если этот параметр опущен, он не будет передан в библиотеку запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка		Название подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь следует указать имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Существует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который может использоваться при проверке запросов API SSL. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификату для использования в рамках SSL транзакции. псевдонимы: cert
client_key строка		Путь к клиенту ключу для использования в рамках SSL транзакции. псевдонимы: key
cloud сырой		Назначенное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на конфигурацию облака с именем, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
filters словарь		Словарь метаданных для дальнейшей фильтрации. Элементы этого словаря будут сопоставляться с возвращаемыми словарями портов. Сопоставление в настоящее время ограничено строками в словаре порта или строками в вложенных словарях.
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервиса. псевдонимы: endpoint_type
port строка		Уникальное имя или идентификатор порта.
region_name строка		Имя региона.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должно ждать запрашиваемого ресурса.
validate_certs булево	Варианты: нет ← да	Выполнять ли проверку запросов API SSL. До Ansible 2.3 это по умолчанию было `yes`. псевдонимы: verify
wait булево	Варианты: нет да ←	Должен ли Ansible ждать, пока запрашиваемый ресурс завершит работу.

Примечания

Примечание

Можно использовать стандартные переменные среды 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.openstack_ports }}"

# Gather information about a single port
- openstack.cloud.port_info:
    cloud: mycloud
    port: 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

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

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

Ключ		Возвращаемое значение	Описание
openstack_ports сложный		всегда, но может быть null	Список словарей портов. Подмножество ключей словаря, перечисленных ниже, может быть возвращено в зависимости от вашего облачного провайдера.
	admin_state_up булево	успех	Административное состояние маршрутизатора, которое равно включенному (true) или выключенному (false). Пример: True
	allowed_address_pairs список / элементы=строка	успех	Набор нуля или более разрешенных пар адресов. Пара адресов состоит из IP-адреса и MAC-адреса.
	binding:host_id строка	успех	UUID хоста, на котором выделен порт. Пример: b4bd682d-234a-4091-aa5b-4b025a6a7759
	binding:profile словарь	успех	Словарь, который позволяет приложению, работающему на хосте, передавать и получать информацию о порте VIF, специфичную для плагина.
	binding:vif_details словарь	успех	Словарь, который позволяет приложению передавать информацию о функциях, предоставляемых API сети. Пример: {'port_filter': True}
	binding:vif_type словарь	успех	Тип VIF для порта. Пример: ovs
	binding:vnic_type строка	успех	Тип виртуальной сетевой карты (vNIC), привязанной к порту Neutron. Пример: normal
	device_id строка	успех	UUID устройства, использующего этот порт. Пример: b4bd682d-234a-4091-aa5b-4b025a6a7759
	device_owner строка	успех	UUID сущности, использующей этот порт. Пример: network:router_interface
	dns_assignment список / элементы=строка	успех	Информация о назначении DNS.
	dns_name строка	успех	Имя DNS
	extra_dhcp_opts список / элементы=строка	успех	Набор нуля или более дополнительных пар параметров DHCP. Пара параметров состоит из значения и имени параметра.
	fixed_ips список / элементы=строка	успех	IP-адреса для порта. Включает IP-адрес и UUID подсети.
	id строка	успех	UUID порта. Пример: 3ec25c97-7052-4ab8-a8ba-92faf84148de
	ip_address строка	успех	IP-адрес. Пример: 127.0.0.1
	mac_address строка	успех	MAC-адрес. Пример: 00:00:5E:00:53:42
	name строка	успех	Имя порта. Пример: port_name
	network_id строка	успех	UUID подключенной сети. Пример: dd1ede4f-3952-4131-aab6-3b8902268c7d
	port_security_enabled булево	успех	Статус безопасности порта. Статус включен (true) или выключен (false).
	security_groups список / элементы=строка	успех	UUID присоединенных групп безопасности.
	status строка	успех	Статус порта. Пример: ACTIVE
	tenant_id строка	успех	UUID арендатора, владеющего сетью. Пример: 51fce036d7984ba6af4f6c849f65ef00

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/openstack/cloud/port_info_module.html