os_port_facts - Получение фактов о портах в OpenStack.
Новое в версии 2.1.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Описание
- Получение фактов о портах из OpenStack.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| параметр | обязательно | по умолчанию | варианты | примечания |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должна ждать сокетная прослойка перед таймаутом вызовов API. Если этот параметр опущен, в библиотеку requests ничего не будет передано. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он будет содержать auth_url, username, password, project_name и любые данные о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые для данного подключаемого модуля авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | ||
| auth_type | нет | password | Имя подключаемого модуля авторизации для использования. Если облако использует что-то, кроме аутентификации по паролю, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Наличие для обеспечения обратной совместимости | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. | |
| cert | нет | None | Путь к клиенту сертификат для использования в рамках транзакции SSL. | |
| cloud | нет | Именованное облако для работы. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. | ||
| endpoint_type | нет | public |
| Тип URL конечной точки для извлечения из каталога служб. |
| filters | нет | Словарь метаданных для дальнейшей фильтрации. Элементы этого словаря будут сопоставляться с возвращаемыми словарями портов. Сопоставление в настоящее время ограничено строками в словаре порта или строками вложенных словарей. | ||
| key | нет | None | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| port | нет | Уникальное имя или идентификатор порта. | ||
| region_name | нет | Имя региона. | ||
| timeout | нет | 180 | Сколько времени Ansible должно ждать запрошенного ресурса. | |
| validate_certs | нет | Должны ли проверяться запросы API SSL. До версии 2.3 значение по умолчанию было True. псевдонимы: verify | ||
| wait | нет | yes |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примеры
# 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 | сложный | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| содержит: |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Примечания
Примечание
- Факты размещаются в переменной
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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Для получения помощи в разработке модулей, если вы так заинтересованы, пожалуйста, прочитайте Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_port_facts_module.html
