os_subnets_info – Получение информации о подсетях OpenStack
Обзор
- Получение информации о одной или нескольких подсетях OpenStack.
- Этот модуль назывался
os_subnets_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль os_subnets_info больше не возвращаетansible_facts!
Псевдонимы: os_subnets_facts
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- 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, который может использоваться для проверки запросов API SSL. Псевдонимы: 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 строка |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| name - | Имя или ID подсети. Псевдоним 'subnet' добавлен в версии 2.8. Псевдонимы: subnet | |
| region_name строка | Имя региона. | |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| validate_certs булево |
| Следует ли проверять запросы API SSL. До 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 information about previously created subnets
os_subnets_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
register: result
- name: Show openstack subnets
debug:
msg: "{{ result.openstack_subnets }}"
- name: Gather information about a previously created subnet by name
os_subnets_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
name: subnet1
register: result
- name: Show openstack subnets
debug:
msg: "{{ result.openstack_subnets }}"
- name: Gather information about a previously created subnet with filter
# Note: name and filters parameters are not mutually exclusive
os_subnets_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
filters:
tenant_id: 55e2ce24b2a245b09f181bf025724cbe
register: result
- name: Show openstack subnets
debug:
msg: "{{ result.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 арендатора, связанный с этой подсетью. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/os_subnets_info_module.html