openstack.cloud.os_recordset – Управление записями DNS OpenStack
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook, укажите: openstack.cloud.os_recordset.
Обзор
- Управление записями DNS OpenStack. Записи могут быть созданы, удалены или обновлены. Обновление допускается только для значений records, description и ttl.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, требуемые данным плагином авторизации. Этот параметр не нужен, если указан параметр cloud или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Название плагина авторизации для использования. Если облако использует что-то, кроме аутентификации по паролю, здесь следует указать имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификат для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud raw | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан параметр auth или если присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| description строка | Описание записи | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| name строка / обязательный | Имя записи. Оно должно заканчиваться именем зоны DNS. | |
| records список / элементы=строка | Список определений записей. Требуется, когда state=present. | |
| recordset_type строка |
| Тип записи Требуется, когда state=present. |
| region_name строка | Имя региона. | |
| state строка |
| Должен ли ресурс присутствовать или отсутствовать. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| ttl целое число | Значение TTL (Time To Live) в секундах | |
| validate_certs булево |
| Должны ли запросы API SSL проверяться. До версии Ansible 2.3 это по умолчанию было yes.псевдонимы: verify |
| wait булево |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
| zone строка / обязательный | Зона, управляющая записью |
Примечания
Примечание
- Могут использоваться стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, явными параметрами в playbook. Более подробную информацию можно найти на https://docs.openstack.org/openstacksdk/
Примеры
# Create a recordset named "www.example.net."
- openstack.cloud.recordset:
cloud: mycloud
state: present
zone: example.net.
name: www.example.net.
recordset_type: "a"
records: ['10.1.1.1']
description: test recordset
ttl: 3600
# Update the TTL on existing "www.example.net." recordset
- openstack.cloud.recordset:
cloud: mycloud
state: present
zone: example.net.
name: www.example.net.
ttl: 7200
# Delete recordset named "www.example.net."
- openstack.cloud.recordset:
cloud: mycloud
state: absent
zone: example.net.
name: www.example.net.
Возвращаемые значения
Общие возвращаемые значения описаны в документации, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| recordset сложный | При успехе, когда state равен 'present'. | Словарь, описывающий запись. | |
| description строка | success | Описание записи Пример: Описание для теста | |
| id строка | success | Уникальный идентификатор записи Пример: c1c530a3-3619-46f3-b0f6-236927b2618c | |
| name строка | success | Имя записи Пример: www.example.net. | |
| records список / элементы=строка | success | Записи записи Пример: ['10.0.0.1'] | |
| ttl целое число | success | Значение TTL зоны Пример: 3600 | |
| type строка | success | Тип записи Пример: A | |
| zone_id строка | success | Идентификатор зоны Пример: 9508e177-41d8-434e-962c-6fe6ca880af7 | |
Авторы
- 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_recordset_module.html