os_subnets_facts - Получение фактов о подсетях OpenStack.
Новая версия с 2.0.
Обзор
- Получение фактов о одной или нескольких подсетях OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должна ждать сокетная прослойка перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку requests ничего не будет передано. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля для аутентификации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о домене, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые параметры, необходимые для работы данного подключаемого модуля для аутентификации. Этот параметр не нужен, если предоставлен параметр cloud или присутствуют переменные среды 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 bool |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли Ansible ждать, пока запрошенный ресурс будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и наконец, из явных параметров в play. Более подробную информацию можно найти на странице 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 о подсетях | |
| id строка | успех | Уникальный UUID. | |
| name строка | успех | Имя, заданное подсети. | |
| network_id строка | успех | ID сети, к которой принадлежит эта подсеть. | |
| cidr строка | успех | CIDR подсети. | |
| gateway_ip строка | успех | IP-адрес шлюза подсети. | |
| enable_dhcp bool | успех | Флаг включения DHCP для этой подсети. | |
| ip_version int | успех | Версия IP для этой подсети. | |
| tenant_id строка | успех | Идентификатор клиента, связанный с этой подсетью. | |
| dns_nameservers список строк | успех | DNS-серверы для этой подсети. | |
| allocation_pools список словарей | успех | Наборы выделения, связанные с этой подсетью. | |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется, что будет обратно совместимым.
Техническое обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/os_subnets_facts_module.html
