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

Примечание

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

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

Для использования в playbook укажите: openstack.cloud.os_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 логическое значение	Варианты: нет ← да	Нужно ли проверять 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, затем из стандартных переменных среды, и, наконец, явными параметрами в playbooks. Более подробную информацию можно найти по адресу 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/os_subnets_info_module.html