os_subnets_facts – Извлечение фактов о одной или нескольких подсетях OpenStack
Новое в версии 2.0.
Описание
- Извлечение фактов о одной или нескольких подсетях из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать транспортная сокетная прослойка, прежде чем отключиться по таймауту для API-вызовов. Если это значение опущено, к библиотеке запросов ничего не будет передано. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если их поддерживает облако. Для других плагинов этот параметр должен содержать любые параметры, необходимые для этого плагина. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации, который следует использовать. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к набору сертификатов CA, который может использоваться при проверке SSL API-запросов. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификат, который следует использовать в рамках SSL-транзакции. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента, который следует использовать в рамках SSL-транзакции. псевдонимы: key | |
| cloud сырой | Наименованное облако или конфигурация облака для работы. Если cloud – строка, она ссылается на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud – словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| filters - | Словарь метаданных, используемых для дополнительной фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| interface строка добавлено в 2.3 |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| name - | Имя или идентификатор подсети. Псевдоним «subnet» добавлен в версии 2.8. псевдонимы: subnet | |
| region_name строка | Имя региона. | |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемого ресурса. |
| validate_certs логическое |
| Необходимо ли проверять SSL API-запросы. До Ansible 2.3 это имело значение по умолчанию yes. псевдонимы: verify |
| wait логическое |
| Должен ли Ansible ждать завершения запрашиваемого ресурса. |
Примечания
Примечание
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAME, могут использоваться вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
- 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 сложный | всегда, но может быть пустое | содержит все факты Openstack о подсетях | |
| allocation_pools список словарей | успех | Наборы выделения, связанные с этой подсетью. | |
| cidr строка | успех | CIDR подсети. | |
| dns_nameservers список строк | успех | DNS-серверы для этой подсети. | |
| enable_dhcp логическое | успех | Флаг включения DHCP для этой подсети. | |
| gateway_ip строка | успех | IP-адрес шлюза подсети. | |
| id строка | успех | Уникальный UUID. | |
| ip_version целое число | успех | Версия IP для этой подсети. | |
| name строка | успех | Присвоенное имя подсети. | |
| network_id строка | успех | Идентификатор сети, к которой принадлежит эта подсеть. | |
| tenant_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.8/modules/os_subnets_facts_module.html
