os_subnets_facts - Получение фактов о подсетях OpenStack.
Новая версия с 2.0.
Описание
- Получение фактов о одной или нескольких подсетях из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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-транзакции. | |
| region_name | Имя региона. | |
| subnet | Имя или ID подсети | |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify |
| Необходимо ли проверять SSL-API-запросы. До версии 2.3 по умолчанию было True. алиасы: validate_certs |
| wait |
| Должен ли 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 о подсетях | |
| name строка | успех | Имя, присвоенное подсети. | |
| enable_dhcp логическое значение | успех | Флаг включения DHCP для этой подсети. | |
| network_id строка | успех | ID сети, к которой принадлежит эта подсеть. | |
| tenant_id строка | успех | ID арендатора, связанный с этой подсетью. | |
| dns_nameservers список строк | успех | DNS-серверы для этой подсети. | |
| allocation_pools список словарей | успех | Наборы выделения, связанные с этой подсетью. | |
| gateway_ip строка | успех | IP-адрес шлюза подсети. | |
| ip_version целое число | успех | Версия IP для этой подсети. | |
| cidr строка | успех | CIDR подсети. | |
| id строка | успех | Уникальный UUID. | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/os_subnets_facts_module.html
