openstack.cloud.subnets_info – Получение информации об одной или нескольких подсетях OpenStack.

Примечание

Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Чтобы использовать его в книге задач, укажите: openstack.cloud.subnets_info.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Получение информации об одной или нескольких подсетях из OpenStack.
Этот модуль назывался openstack.cloud.subnets_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль openstack.cloud.subnets_info больше не возвращает ansible_facts!

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должно ждать сокетное подключение, прежде чем истечет время ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина password по умолчанию он должен содержать auth_url, username, password, project_name и любые данные о доменах (например, user_domain_name или 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 строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type
name строка		Имя или идентификатор подсети. Псевдоним 'subnet' добавлен в версии 2.8. Псевдонимы: subnet
region_name строка		Имя региона.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должно ждать запрашиваемого ресурса.
validate_certs логическое значение	Варианты: no ← yes	Нужно ли проверять SSL-API-запросы. До Ansible 2.3 это по умолчанию было `yes`. Псевдонимы: verify
wait логическое значение	Варианты: no yes ←	Должен ли 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
  openstack.cloud.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
  openstack.cloud.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
  openstack.cloud.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 строка	успех	Идентификатор сети, к которой принадлежит эта подсеть.
	tenant_id строка	успех	Идентификатор арендатора, связанный с этой подсетью.

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/subnets_info_module.html