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

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

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

Описание

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

Требования

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

openstacksdk
python >= 2.7

Параметры

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

Состояние

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/os_port_facts_module.html