os_zone - Управление зонами DNS OpenStack
Новая версия с 2.2.
Обзор
- Управление зонами DNS OpenStack. Зоны могут быть созданы, удалены или обновлены. Только значения email, description, ttl и masters могут быть обновлены.
Требования
Ниже перечислены требования, которые необходимы на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должно ждать сокетное подключение перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключения облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о домене, если облако её поддерживает. Для других плагинов, этот параметр должен содержать любые параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации, которое следует использовать. Если облако использует что-то помимо парольной авторизации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который может использоваться для проверки запросов SSL API. | |
| cert | Путь к клиенту сертификату для использования в рамках транзакции SSL. | |
| cloud | Имя облака или конфигурация облака, с которым взаимодействовать. Если cloud является строкой, он ссылается на заданную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| description | Описание зоны | |
| Электронная почта владельца зоны (применимо только если zone_type — primary) | ||
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| key | Путь к ключу клиента, который будет использоваться в рамках транзакции SSL. | |
| masters | Серверы имен-мастера (применимо только если zone_type — secondary) | |
| name обязательно | Имя зоны | |
| region_name | Имя региона. | |
| state |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| ttl | Значение TTL (Time To Live) в секундах | |
| verify bool |
| Необходимо ли проверять запросы SSL API. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs |
| wait bool |
| Должен ли Ansible ждать, пока запрошенный ресурс завершит работу. |
| zone_type |
| Тип зоны |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и наконец, из явных параметров в задачах. Более подробная информация доступна по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# 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'. | Словарь, описывающий зону. | |
| id строка | Уникальный идентификатор зоны Пример: c1c530a3-3619-46f3-b0f6-236927b2618c | ||
| name строка | Имя зоны Пример: example.net. | ||
| type строка | Тип зоны Пример: PRIMARY | ||
| email строка | Электронная почта владельца зоны Пример: test@example.net | ||
| description строка | Описание зоны Пример: Тестовое описание | ||
| ttl целое число | Значение TTL зоны Пример: 3600 | ||
| masters список | Серверы имен-мастера зоны | ||
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/os_zone_module.html
