fortinet.fortimanager.fmgr_devprof_system_dns модуль — Настройка DNS.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

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

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

Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_system_dns.

Добавлена в fortinet.fortimanager 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполняться без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_system_dns словарь	Настройка параметров верхнего уровня.
cache_notfound_responses строка	Устарело, пожалуйста, переименуйте на cache_notfound_responses. Включить/отключить ответ от сервера DNS, когда запись не… Варианты: `"disable"` `"enable"`
dns_cache_limit целое число	Устарело, пожалуйста, переименуйте на dns_cache_limit. Максимальное количество записей в кэше DNS.
dns_cache_ttl целое число	Устарело, пожалуйста, переименуйте на dns_cache_ttl. Время в секундах, которое кэш DNS сохраняет информацию.
dns_over_tls строка	Устарело, пожалуйста, переименуйте на dns_over_tls. Включить/отключить/принудительно использовать DNS over TLS. Варианты: `"disable"` `"enable"` `"enforce"`
domain любой	(список или строка) Суффикс доменного имени для IP-адресов сервера DNS.
interface строка	Укажите исходящий интерфейс для доступа к серверу.
interface_select_method строка	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите способ выбора исходящего интерфейса для доступа к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ip6_primary строка	Устарело, пожалуйста, переименуйте на ip6_primary. Основной IPv6 адрес сервера DNS.
ip6_secondary строка	Устарело, пожалуйста, переименуйте на ip6_secondary. Вторичный IPv6 адрес сервера DNS.
primary строка	Основной IP-адрес сервера DNS.
retry целое число	Количество попыток повтора.
secondary строка	Вторичный IP-адрес сервера DNS.
server_hostname любой	(список) Устарело, пожалуйста, переименуйте на server_hostname. Список имен хостов сервера DNS.
ssl_certificate строка	Устарело, пожалуйста, переименуйте на ssl_certificate. Имя локального сертификата для SSL-соединений.
timeout целое число	Интервал таймаута запроса DNS в секундах
enable_log булево	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с токеном доступа к forticloud API.

proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для успеха.
workspace_locking_adom строка	ADOM для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным или другим, включая корень.
workspace_locking_timeout целое число	Максимальное время ожидания (в секундах), пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют именование с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов всё ещё доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия отказа или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DNS.
      fortinet.fortimanager.fmgr_devprof_system_dns:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_system_dns:
          cache_notfound_responses: <value in [disable, enable]>
          dns_cache_limit: <integer>
          dns_cache_ttl: <integer>
          domain: <list or string>
          ip6_primary: <string>
          ip6_secondary: <string>
          primary: <string>
          secondary: <string>
          dns_over_tls: <value in [disable, enable, enforce]>
          retry: <integer>
          server_hostname: <list or string>
          ssl_certificate: <string>
          timeout: <integer>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_devprof_system_dns_module.html