openstack.cloud.recordset модуль – Управление наборами записей OpenStack DNS

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в playbook, укажите: openstack.cloud.recordset.

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

Описание

Управление наборами записей OpenStack DNS. Наборы записей могут быть созданы, удалены или обновлены. Могут быть обновлены только значения records, description и ttl.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени (в секундах) должно ожидать сокетное соединение перед завершением запроса к API. Если параметр опущен, библиотека запросов ничего не получит.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password он должен содержать auth_url, username, password, project_name, а также любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Наименованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию облака, определенную в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную секции в clouds.yaml.
description строка	Описание записей.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка / обязательно	Имя записей. Должно заканчиваться именем зоны DNS.
records список / элементы=строка	Список определений записей. Требуется, когда state=present.
recordset_type строка	Тип записей Требуется, когда state=present. Варианты: `"a"` `"aaaa"` `"mx"` `"cname"` `"txt"` `"ns"` `"srv"` `"ptr"` `"caa"`
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается.
state строка	Должен ли ресурс быть присутствующим или отсутствующим. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должно ждать запрошенного ресурса. По умолчанию: `180`
ttl целое число	Значение TTL (Time To Live) в секундах
validate_certs псевдонимы: verify логический тип	Нужно ли проверять запросы API SSL. До Ansible 2.3 по умолчанию было `true`. Варианты: `false` `true`

END_OF_DOCUMENT_MARKER

wait boolean	Должен ли Ansible ждать завершения запрошенного ресурса. Выбои: `false` `true` ← (по умолчанию)
zone string / обязательно	Имя или ID зоны, управляющей набором записей.

Примечания

Примечание

Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явных значений.
Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явных параметров в задачах. Более подробную информацию можно найти на странице 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.
    recordset_type: "a"
    records: ['10.1.1.1']
    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’.
action строка	Текущее действие, выполняемое над ресурсом Возвращается: всегда
created_at строка	Отметка времени создания зоны Возвращается: всегда
description строка	Описание набора записей Возвращается: всегда Пример: `"Test description"`
id строка	Уникальный идентификатор набора записей Возвращается: при успехе Пример: `"c1c530a3-3619-46f3-b0f6-236927b2618c"`
links словарь	Ссылки, связанные с ресурсом Возвращается: всегда
name строка	Имя набора записей Возвращается: всегда Пример: `"www.example.net."`
project_id строка	Идентификатор проекта, к которому относится набор записей Возвращается: всегда
records список / элементы=строка	Записи набора записей Возвращается: всегда Пример: `["10.0.0.1"]`
status строка	Статус набора записей Допустимые значения включают `PENDING_CREATE`, `ACTIVE`,`PENDING_DELETE`, `ERROR` Возвращается: всегда
ttl целое число	Значение TTL зоны Возвращается: всегда Пример: `3600`
type строка	Тип набора записей Допустимые значения включают `A`, `AAAA`, `MX`, `CNAME`, `TXT`, `NS`, `SSHFP`, `SPF`, `SRV`, `PTR` Возвращается: всегда Пример: `"A"`
zone_id строка	Идентификатор зоны, к которой относится этот набор записей Возвращается: всегда Пример: `"9508e177-41d8-434e-962c-6fe6ca880af7"`
zone_name строка	Имя зоны, к которой относится этот набор записей Возвращается: всегда Пример: `"example.com."`

Авторы

OpenStack Ansible SIG

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/recordset_module.html