Spec-Zone.ru › Ansible

community.digitalocean.digital_ocean_domain_record модуль – Управление записями домена DigitalOcean

Примечание

Этот модуль является частью коллекции community.digitalocean (версия 1.27.0).

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

Для установки используйте: ansible-galaxy collection install community.digitalocean.

Для использования в playbook, укажите: community.digitalocean.digital_ocean_domain_record.

Новое в community.digitalocean 1.1.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Создание/удаление записи домена в DigitalOcean.

Параметры

Параметр

Комментарии

data

string

Это значение записи, в зависимости от типа записи.

domain

string / required

Имя домена.

flags

integer

Целое без знака число от 0 до 255, используемое для записей CAA.

force_update

boolean

Если уже существует запись с тем же name и type, принудительно обновить её.

Варианты:

  • false ← (по умолчанию)
  • true

name

string

Требуется для записей A, AAAA, CNAME, TXT, SRV. Имя хоста, псевдоним или служба, определяемые записью.

По умолчанию: "@"

oauth_token

aliases: API_TOKEN

string

Токен OAuth DigitalOcean. Может быть указан в переменных окружения DO_API_KEY, DO_API_TOKEN или DO_OAUTH_TOKEN

port

integer

Порт, на котором доступна служба, только для записей SRV.

priority

integer

Приоритет хоста для записей SRV, MX).

record_id

integer

Используется с force_update=yes и state='absent' для обновления или удаления конкретной записи.

state

string

Указывает желаемое состояние цели.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tag

string

Параметр tag для записей CAA.

Варианты:

  • "issue"
  • "wildissue"
  • "iodef"

ttl

integer

Время жизни записи в секундах.

По умолчанию: 1800

type

string

Тип записи, которую вы хотите создать.

Варианты:

  • "A"
  • "AAAA"
  • "CNAME"
  • "MX"
  • "TXT"
  • "SRV"
  • "NS"
  • "CAA"

weight

integer

Вес записей с одинаковым приоритетом, только для записей SRV.

Примечания

Примечание

  • Используется версия 2 API DigitalOcean.
  • Количество запросов, которые можно сделать через API, в настоящее время ограничено 5000 в час на один токен OAuth.

Примеры

- name: Create default A record for example.com
  community.digitalocean.digital_ocean_domain_record:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    type: A
    name: "@"
    data: 127.0.0.1

- name: Create A record for www
  community.digitalocean.digital_ocean_domain_record:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    type: A
    name: www
    data: 127.0.0.1

- name: Update A record for www based on name/type/data
  community.digitalocean.digital_ocean_domain_record:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    type: A
    name: www
    data: 127.0.0.2
    force_update: true

- name: Update A record for www based on record_id
  community.digitalocean.digital_ocean_domain_record:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    record_id: 123456
    type: A
    name: www
    data: 127.0.0.2
    force_update: true

- name: Remove www record based on name/type/data
  community.digitalocean.digital_ocean_domain_record:
    state: absent
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    type: A
    name: www
    data: 127.0.0.1

- name: Remove www record based on record_id
  community.digitalocean.digital_ocean_domain_record:
    state: absent
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    record_id: 1234567

- name: Create CNAME records for www, git and status subdomains
  community.digitalocean.digital_ocean_domain_record:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    type: CNAME
    name: "{{ item }}"
    data: example.com
  with_items:
    - www
    - git
    - status

- name: Create MX record with priority 10 for example.com
  community.digitalocean.digital_ocean_domain_record:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    domain: example.com
    type: MX
    data: mail1.example.com
    priority: 10

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

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

Ключ

Описание

data

dictionary

Запись домена DigitalOcean

Возвращается: успех

Пример: {"data": "192.168.0.1", "flags": 16, "id": 3352896, "name": "www", "port": 5556, "priority": 10, "tag": "issue", "ttl": 3600, "type": "CNAME", "weight": 10}

Авторы

  • Adam Papai (@woohgit)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (исходный код)

© 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/community/digitalocean/digital_ocean_domain_record_module.html

Spec-Zone.ru

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