os_port_facts - Получение фактов о портах в OpenStack.
Новое в версии 2.1.
Обзор
- Получение фактов о портах из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени (в секундах) должна ждать транспортный уровень перед таймаутом для API-вызовов. Если этот параметр опущен, ничего не будет передано в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любые данные о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды 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) |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| key | Путь к клиентскому ключу для использования в рамках SSL-транзакции. | |
| port | Уникальное имя или ID порта. | |
| region_name | Имя региона. | |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify bool |
| Необходимо ли проверять SSL-API-запросы. До версии 2.3 значение по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли 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. См. Техническое обслуживание модулей и поддержка для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/os_port_facts_module.html
