Spec-Zone.ru › Ansible

fortinet.fortios.fortios_system_ddns module — Настройка DDNS в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_ddns.

Добавлено в fortinet.fortios 2.0.0

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

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), устанавливая и изменяя системные функции и категорию ddns. В примерах приведены все параметры; перед использованием необходимо настроить их значения в соответствии с источниками данных. Проверено на FOS v6.0.0.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

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

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с указанием member_path подходит для выполнения операций над элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

system_ddns

dictionary

Настройка DDNS.

addr_type

string

Тип адреса интерфейса в обновлении DDNS.

Варианты:

  • "ipv4"
  • "ipv6"

bound_ip

string

Привязанный IP-адрес.

clear_text

string

Включить или отключить использование незашифрованных соединений.

Варианты:

  • "disable"
  • "enable"

ddns_auth

string

Включить или отключить TSIG-аутентификацию для сервера DDNS.

Варианты:

  • "disable"
  • "tsig"

ddns_domain

string

Полное доменное имя. Например, yourname.ddns.com.

ddns_key

string

Ключ обновления DDNS (кодировка base 64).

ddns_keyname

string

Имя ключа обновления DDNS.

ddns_password

string

Пароль DDNS.

ddns_server

string

Выберите поставщика службы DDNS.

Варианты:

  • "dyndns.org"
  • "dyns.net"
  • "tzo.com"
  • "vavic.com"
  • "dipdns.net"
  • "now.net.cn"
  • "dhs.org"
  • "easydns.com"
  • "genericDDNS"
  • "FortiGuardDDNS"
  • "noip.com"

ddns_server_addr

list / elements=dictionary

Список IP-адресов или полных доменных имен универсальных серверов DDNS.

addr

string / обязательный

IP-адрес или полное доменное имя сервера.

ddns_server_ip

string

IP-адрес универсального сервера DDNS.

ddns_sn

string

Серийный номер DDNS.

ddns_ttl

integer

Время жизни пакетов DDNS.

ddns_username

string

Имя пользователя DDNS.

ddns_zone

string

Зона доменного имени (например, DDNS.com).

ddnsid

integer / обязательный

Идентификатор DDNS. См. <a href=’#notes’>Примечания</a>.

monitor_interface

list / elements=dictionary

Отслеживаемый интерфейс.

interface_name

string / обязательный

Имя интерфейса. Источник: system.interface.name.

server_type

string

Тип адреса сервера DDNS.

Варианты:

  • "ipv4"
  • "ipv6"

ssl_certificate

string

Имя локального сертификата для SSL-соединений. Источник: certificate.local.name.

update_interval

integer

Интервал обновления DDNS (60–2592000 с; 0 означает значение по умолчанию).

use_public_ip

string

Включить или отключить использование общедоступного IP-адреса.

Варианты:

  • "disable"
  • "enable"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

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

Примечания

Примечание

  • Настоятельно рекомендуем использовать собственное значение ddnsid вместо 0. Хотя «0» — специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, у него есть ограничения. Подробнее см. в разделе «Вопросы и ответы».
  • Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков предпочтительно использовать httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure DDNS.
  fortinet.fortios.fortios_system_ddns:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_ddns:
          addr_type: "ipv4"
          bound_ip: "<your_own_value>"
          clear_text: "disable"
          ddns_auth: "disable"
          ddns_domain: "<your_own_value>"
          ddns_key: "<your_own_value>"
          ddns_keyname: "<your_own_value>"
          ddns_password: "<your_own_value>"
          ddns_server: "dyndns.org"
          ddns_server_addr:
              -
                  addr: "<your_own_value>"
          ddns_server_ip: "<your_own_value>"
          ddns_sn: "<your_own_value>"
          ddns_ttl: "300"
          ddns_username: "<your_own_value>"
          ddns_zone: "<your_own_value>"
          ddnsid: "<you_own_value>"
          monitor_interface:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          server_type: "ipv4"
          ssl_certificate: "<your_own_value> (source certificate.local.name)"
          update_interval: "300"
          use_public_ip: "disable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate при последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Основной ключ (идентификатор), использованный при последнем обращении к FortiGate

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

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Использованный виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

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

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_ddns_module.html

Spec-Zone.ru

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