cs_zone_info – Сбор информации о зонах из облаков на основе Apache CloudStack

Новая версия 2.9.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

Сбор информации из API зоны.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_http_method строка	Варианты: get post	Метод HTTP, используемый для запроса к точке входа API. Если не задано, используется значение переменной среды `CLOUDSTACK_METHOD`. В качестве последнего варианта значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию `get` если не указано.
api_key строка		Ключ API CloudStack API. Если не задано, используется значение переменной среды `CLOUDSTACK_KEY`. В качестве последнего варианта значение берётся из файла конфигурации ini, см. также примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не задано, используется значение переменной среды `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ API CloudStack API. Если не задано, используется значение переменной среды `CLOUDSTACK_SECRET`. В качестве последнего варианта значение берётся из файла конфигурации ini, см. также примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не задано, используется значение переменной среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано.
api_url строка		URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется значение переменной среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта значение берётся из файла конфигурации ini, см. также примечания.
zone строка		Имя зоны. Если не указано, возвращаются все зоны. псевдонимы: name

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs если учетные данные не заданы аргументами api_url, api_key, api_secret. Конфигурация читается из нескольких мест в следующем порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT переменные окружения. CLOUDSTACK_CONFIG переменная окружения, указывающая на файл .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких учетных данных и точек входа с использованием разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Для получения дополнительной информации см. https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти в Руководстве по облакам CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: Gather information from a zone
  cs_zone_info:
    zone: ch-gva-1
  register: zone
  delegate_to: localhost

- name: Show the returned results of the registered variable
  debug:
    msg: "{{ zone }}"

- name: Gather information from all zones
  cs_zone_info:
  register: zones
  delegate_to: localhost

- name: Show information on all zones
  debug:
    msg: "{{ zones }}"

Значения возврата

Общие значения возврата описаны здесь, ниже приведены поля, уникальные для данного модуля:

Ключ		Возвращаемое значение	Описание
zones список		success	Список совпадающих зон.
	allocation_state строка	success	Состояние зоны. Пример: Включено
	dhcp_provider строка	success	DHCP-провайдер для зоны Пример: VirtualRouter
	dns1 строка	success	Первый DNS для зоны. Пример: 8.8.8.8
	dns1_ipv6 строка	success	Первый IPv6 DNS для зоны. Пример: 2001:4860:4860::8888
	dns2 строка	success	Второй DNS для зоны. Пример: 8.8.4.4
	dns2_ipv6 строка	success	Второй IPv6 DNS для зоны. Пример: 2001:4860:4860::8844
	domain строка	success	Домен, к которому относится зона. Пример: ROOT
	guest_cidr_address строка	success	Адрес guest CIDR для зоны Пример: 10.1.1.0/24
	id строка	success	UUID зоны. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
	internal_dns1 строка	success	Первый внутренний DNS для зоны. Пример: 8.8.8.8
	internal_dns2 строка	success	Второй внутренний DNS для зоны. Пример: 8.8.4.4
	local_storage_enabled логическое	success	Включено локальное хранилище.
	name строка	success	Название зоны. Пример: zone01
	network_domain строка	success	Сеть домен для зоны. Пример: example.com
	network_type строка	success	Тип сети для зоны. Пример: basic
	securitygroups_enabled логическое	success	Поддержка групп безопасности включена.
	tags словарь	success	Список тегов ресурсов, связанных с зоной. Пример: [{'key': 'foo', 'value': 'bar'}]
	zone_token строка	success	Токен зоны Пример: ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7

Статус

В этом модуле гарантируются изменения интерфейса обратной совместимости в будущем. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

René Moser (@resmo)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/cs_zone_info_module.html