os_zone – Управление зонами DNS OpenStack

Новое в версии 2.2.

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

Описание

Управление зонами DNS OpenStack. Зоны могут быть созданы, удалены или обновлены. Изменить можно только значения email, description, ttl и masters.

Требования

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

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, который можно использовать при проверке запросов 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.
description -		Описание зоны
email -		Электронная почта владельца зоны (применяется только если zone_type является primary)
interface строка добавлен в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
masters -		Серверы имен masters (применяется только если zone_type является secondary)
name - / обязательно		Имя зоны
region_name строка		Имя региона.
state -	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
timeout целое число	Значение по умолчанию: 180	Сколько времени Ansible должно ждать запрашиваемого ресурса.
ttl -		Значение TTL (Time To Live) в секундах
validate_certs логическое значение	Варианты: no ← yes	Должны ли запросы API SSL проверяться. До Ansible 2.3 это имело значение по умолчанию `yes`. псевдонимы: verify
wait логическое значение	Варианты: no yes ←	Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершен.
zone_type -	Варианты: primary secondary	Тип зоны

Примечания

Примечание

Можно использовать стандартные переменные среды OpenStack, такие как OS_USERNAME, вместо явного указания значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и наконец, из явных параметров в playbooks. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/

Примеры

# Create a zone named "example.net"
- os_zone:
    cloud: mycloud
    state: present
    name: example.net.
    zone_type: primary
    email: test@example.net
    description: Test zone
    ttl: 3600

# Update the TTL on existing "example.net." zone
- os_zone:
    cloud: mycloud
    state: present
    name: example.net.
    ttl: 7200

# Delete zone named "example.net."
- os_zone:
    cloud: mycloud
    state: absent
    name: example.net.

Возвращаемые значения

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

Ключ		Возвращаемое значение	Описание
zone сложный тип		При успехе, когда state равен 'present'.	Словарь, описывающий зону.
	description строка		Описание зоны Пример: Описание теста
	email строка		Электронная почта владельца зоны Пример: test@example.net
	id строка		Уникальный идентификатор зоны Пример: c1c530a3-3619-46f3-b0f6-236927b2618c
	masters список		Серверы имен masters зоны
	name строка		Имя зоны Пример: example.net.
	ttl целое число		Значение TTL зоны Пример: 3600
	type строка		Тип зоны Пример: PRIMARY

Статус

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

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

Подсказка

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

© 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_zone_module.html