os_port_facts - Получение фактов о портах в OpenStack.

Новая версия 2.1.

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

Обзор

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

Требования

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

python >= 2.6
python >= 2.7
shade

Параметры

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

Примечания

Примечание

Факты помещаются в переменную openstack_ports.
Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо указания явных значений.
Информация об авторизации управляется os-client-config, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных окружения, а затем, наконец, из явных параметров в пьесах. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config

Примеры

# Gather facts about all ports
- os_port_facts:
    cloud: mycloud

# Gather facts about a single port
- os_port_facts:
    cloud: mycloud
    port: 6140317d-e676-31e1-8a4a-b1913814a471

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

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

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

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

Статус

Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

David Shrewsbury (@Shrews)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_port_facts_module.html