os_port_facts – Получение сведений о портах в OpenStack

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

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

Обзор

Получение сведений о портах из OpenStack.

Требования

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

openstacksdk
python >= 2.7

Параметры

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

Примечания

Примечание

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

Примеры

# 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 словарь	успех	Словарь, который позволяет приложению, работающему на хосте, передавать и получать информацию о порте виртуальной машины в плагин.
	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.8/modules/os_port_facts_module.html