os_subnets_facts – Получение фактов о подсетях OpenStack.
Новое в версии 2.0.
Обзор
- Получение фактов о одной или нескольких подсетях из 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, который может использоваться для проверки запросов API SSL. | |
| 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. | |
| region_name - | Имя региона. | |
| subnet - | Имя или ID подсети | |
| timeout - | По умолчанию: 180 | Сколько времени ansible должно ждать запрошенного ресурса. |
| verify boolean |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли ansible ждать, пока запрошенный ресурс не будет завершён. |
Примечания
Примечание
- Могут использоваться стандартные переменные среды 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
Примеры
- name: Gather facts about previously created subnets
os_subnets_facts:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
- name: Show openstack subnets
debug:
var: openstack_subnets
- name: Gather facts about a previously created subnet by name
os_subnets_facts:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
name: subnet1
- name: Show openstack subnets
debug:
var: openstack_subnets
- name: Gather facts about a previously created subnet with filter
# Note: name and filters parameters are not mutually exclusive
os_subnets_facts:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
filters:
tenant_id: 55e2ce24b2a245b09f181bf025724cbe
- name: Show openstack subnets
debug:
var: openstack_subnets
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание | |
|---|---|---|---|
| openstack_subnets сложное | всегда, но может быть null | содержит все факты OpenStack о подсетях | |
| allocation_pools список словарей | успех | Наборы выделения, связанные с этой подсетью. | |
| cidr строка | успех | CIDR подсети. | |
| dns_nameservers список строк | успех | DNS-серверы для этой подсети. | |
| enable_dhcp булево | успех | Флаг включения DHCP для этой подсети. | |
| gateway_ip строка | успех | IP шлюза подсети. | |
| id строка | успех | Уникальный UUID. | |
| ip_version целое число | успех | Версия IP для этой подсети. | |
| name строка | успех | Имя, заданное подсети. | |
| network_id строка | успех | ID сети, в которой находится эта подсеть. | |
| tenant_id строка | успех | ID арендатора, связанный с этой подсетью. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Davide Agnello (@dagnello)
Подсказка
Если вы обнаружили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_subnets_facts_module.html
