Spec-Zone.ru › Ansible 2.6

gcdns_record - Создание или удаление записей ресурсов в Google Cloud DNS

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

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

  • Создаёт или удаляет записи ресурсов в Google Cloud DNS.

Требования

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

  • python >= 2.6
  • apache-libcloud >= 0.19.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
credentials_file
Путь к JSON-файлу, связанному с электронным адресом учетной записи службы.
overwrite
bool
    Варианты:
  • no ←
  • yes
Указывает, должно ли успешное или неудачное попытка перезаписи существующей записи. Поведение этого параметра зависит от параметра state.
Если state равен present и overwrite равен True, этот модуль заменит существующую запись ресурса с тем же именем предоставленными данными record_data. Если state равен present и overwrite равен False, этот модуль завершится ошибкой, если существует существующая запись ресурса с тем же именем и типом, но различными данными ресурса.
Если state равен absent и overwrite равен True, этот модуль удалит заданную запись ресурса безусловно. Если state равен absent и overwrite равен False, этот модуль завершится ошибкой, если предоставленные данные record_data не точно соответствуют данным существующей записи ресурса.
pem_file
Путь к PEM-файлу, связанному с электронным адресом учетной записи службы.
Этот параметр устарел и может быть удален в будущих выпусках. Используйте credentials_file вместо него.
project_id
Идентификатор проекта Google Cloud Platform, который необходимо использовать.
record
обязательно
Полное доменное имя записи ресурса.

Псевдонимы: name
record_data
Данные record_data, которые необходимо использовать для записи ресурса.
record_data должен быть указан, если state равен present или overwrite равен True, в противном случае модуль завершится ошибкой.
Допустимые record_data зависят от типа записи. Кроме того, записи ресурсов, содержащие доменное имя DNS в поле значения (например, CNAME, PTR, SRV и т. д.), ДОЛЖНЫ содержать конечную точку в значении.
Отдельные строковые record_data для записей TXT должны быть заключены в двойные кавычки.
Для записей ресурсов, имеющих одинаковое имя, но разные record_data (например, несколько записей A), они должны быть определены как несколько элементов списка в одной записи.

Псевдонимы: value
service_account_email
Электронный адрес учетной записи службы с доступом к Google Cloud DNS.
state
    Варианты:
  • present ←
  • absent
Указывает, должна или не должна быть заданная запись ресурса.
ttl По умолчанию:
300
Время в секундах, в течение которого запись ресурса будет сохраняться в кэше решающего кэша.
type
обязательно
    Варианты:
  • A
  • AAAA
  • CNAME
  • SRV
  • TXT
  • SOA
  • NS
  • MX
  • SPF
  • PTR
Тип записи ресурса, который нужно добавить.
zone
Доменное имя DNS зоны (например, example.com).
Один из параметров zone или zone_id должен быть указан, иначе модуль завершится ошибкой.
Если оба параметра zone и zone_id указаны, будет использоваться zone_id.
zone_id
Идентификатор зоны Google Cloud (например, example-com).
Один из параметров zone или zone_id должен быть указан, иначе модуль завершится ошибкой.
Они обычно имеют вид доменных имён с точками, заменёнными дефисами. Идентификатор зоны никогда не будет содержать точек.
zone_id может быть быстрее, чем zone в проектах с большим количеством зон.
Если оба параметра zone и zone_id указаны, будет использоваться zone_id.

Примечания

Примечание

  • См. также gcdns_zone.
  • Внутренняя библиотека этого модуля не поддерживает обновления записей ресурсов DNS на месте. Вместо этого записи ресурсов быстро удаляются и создаются заново.
  • Записи SOA технически поддерживаются, но их функциональность ограничена проверкой того, что существующая запись SOA зоны соответствует предопределённому значению. Запись SOA не может быть обновлена.
  • Корневые записи NS не могут быть обновлены.
  • Записи NAPTR не поддерживаются.

Примеры

# Create an A record.
- gcdns_record:
    record: 'www1.example.com'
    zone: 'example.com'
    type: A
    value: '1.2.3.4'

# Update an existing record.
- gcdns_record:
    record: 'www1.example.com'
    zone: 'example.com'
    type: A
    overwrite: true
    value: '5.6.7.8'

# Remove an A record.
- gcdns_record:
    record: 'www1.example.com'
    zone_id: 'example-com'
    state: absent
    type: A
    value: '5.6.7.8'

# Create a CNAME record.
- gcdns_record:
    record: 'www.example.com'
    zone_id: 'example-com'
    type: CNAME
    value: 'www.example.com.'    # Note the trailing dot

# Create an MX record with a custom TTL.
- gcdns_record:
    record: 'example.com'
    zone: 'example.com'
    type: MX
    ttl: 3600
    value: '10 mail.example.com.'    # Note the trailing dot

# Create multiple A records with the same name.
- gcdns_record:
    record: 'api.example.com'
    zone_id: 'example-com'
    type: A
    record_data:
      - '192.0.2.23'
      - '10.4.5.6'
      - '198.51.100.5'
      - '203.0.113.10'

# Change the value of an existing record with multiple record_data.
- gcdns_record:
    record: 'api.example.com'
    zone: 'example.com'
    type: A
    overwrite: true
    record_data:           # WARNING: All values in a record will be replaced
      - '192.0.2.23'
      - '192.0.2.42'    # The changed record
      - '198.51.100.5'
      - '203.0.113.10'

# Safely remove a multi-line record.
- gcdns_record:
    record: 'api.example.com'
    zone_id: 'example-com'
    state: absent
    type: A
    record_data:           # NOTE: All of the values must match exactly
      - '192.0.2.23'
      - '192.0.2.42'
      - '198.51.100.5'
      - '203.0.113.10'

# Unconditionally remove a record.
- gcdns_record:
    record: 'api.example.com'
    zone_id: 'example-com'
    state: absent
    overwrite: true   # overwrite is true, so no values are needed
    type: A

# Create an AAAA record
- gcdns_record:
    record: 'www1.example.com'
    zone: 'example.com'
    type: AAAA
    value: 'fd00:db8::1'

# Create a PTR record
- gcdns_record:
    record: '10.5.168.192.in-addr.arpa'
    zone: '5.168.192.in-addr.arpa'
    type: PTR
    value: 'api.example.com.'    # Note the trailing dot.

# Create an NS record
- gcdns_record:
    record: 'subdomain.example.com'
    zone: 'example.com'
    type: NS
    ttl: 21600
    record_data:
      - 'ns-cloud-d1.googledomains.com.'    # Note the trailing dots on values
      - 'ns-cloud-d2.googledomains.com.'
      - 'ns-cloud-d3.googledomains.com.'
      - 'ns-cloud-d4.googledomains.com.'

# Create a TXT record
- gcdns_record:
    record: 'example.com'
    zone_id: 'example-com'
    type: TXT
    record_data:
      - '"v=spf1 include:_spf.google.com -all"'   # A single-string TXT value
      - '"hello " "world"'    # A multi-string TXT value

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

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

Ключ Возвращённое значение Описание
overwrite
boolean
успех
Указывает, позволил ли модуль перезаписать запись.

Пример:
True
record
строка
успех
Полное доменное имя записи ресурса.

Пример:
mail.example.com.
record_data
список
успех
Значения записи ресурса.

Пример:
['5.6.7.8', '9.10.11.12']
state
строка
успех
Указывает, присутствует или отсутствует запись.

Пример:
present
ttl
целое число
успех
Время жизни записи ресурса.

Пример:
300
type
строка
успех
Тип записи ресурса.

Пример:
A
zone
строка
успех
Имя домена зоны.

Пример:
example.com.
zone_id
строка
успех
Идентификатор зоны Google Cloud DNS.

Пример:
example-com


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как общественный, что означает, что его поддерживает сообщество Ansible. Подробнее о техническом обслуживании модулей см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

  • William Albert (@walbert947)

Подсказка

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

© 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/gcdns_record_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API