os_zone — Управление зонами DNS OpenStack
Новая версия с 2.2.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Управление зонами DNS OpenStack. Зоны могут быть созданы, удалены или обновлены. Только значения email, описание, ttl и masters могут быть обновлены.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан библиотеке requests. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, имя пользователя, пароль, имя проекта и любую информацию о домене, если облако её поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | ||
| auth_type | нет | password | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь должно быть указано имя плагина, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к пакету сертификата CA, который может использоваться при проверке запросов API SSL. | |
| cert | нет | None | Путь к клиенту сертификат для использования в рамках транзакции SSL. | |
| cloud | нет | Имя облака для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_*. | ||
| description | нет | None | Описание зоны | |
| email | нет | Электронная почта владельца зоны (применимо только если zone_type — primary) | ||
| endpoint_type | нет | public |
| Тип URL-адреса конечной точки для извлечения из каталога служб. |
| key | нет | None | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| masters | нет | None | Имена серверов имен-мастеров (применимо только если zone_type — secondary) | |
| name | да | Имя зоны | ||
| region_name | нет | Имя региона. | ||
| state | нет | present |
| Должна ли ресурс быть присутствующим или отсутствующим. |
| timeout | нет | 180 | Сколько времени Ansible должен ждать запрашиваемый ресурс. | |
| ttl | нет | None | Значение TTL (Time To Live) в секундах | |
| validate_certs | нет | Должны ли запросы API SSL проверяться. До версии 2.3 это значение по умолчанию было True. псевдонимы: verify | ||
| wait | нет | yes |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершён. |
| zone_type | нет | None |
| Тип зоны |
Примеры
# 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 | Словарь, описывающий зону. | При успехе, когда I(state) — 'present'. | сложный | |||||||||||||||||||||||||||||||||||||||||
| содержит: |
| |||||||||||||||||||||||||||||||||||||||||||
Примечания
Примечание
- Могут использоваться стандартные переменные среды 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
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы так решили, пожалуйста, прочтите Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_zone_module.html
