Модуль fortinet.fortimanager.fmgr_devprof_system_ntp_ntpserver – Настройка FortiGate для подключения к любому доступному стороннему NTP-серверу.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_devprof_system_ntp_ntpserver.

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_system_ntp_ntpserver словарь	Установленные параметры верхнего уровня.
authentication строка	Включение/выключение аутентификации MD5. Варианты: `"disable"` `"enable"`
id целое число / обязательно	Идентификатор NTP-сервера.
interface строка	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method строка	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите, как выбрать исходящий интерфейс для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ip_type строка	Устарело, пожалуйста, переименуйте на ip_type. Выберите подключение к IPv4 или/и IPv6 NTP-серверу. Варианты: `"IPv6"` `"IPv4"` `"Both"`
key любой	(список) Ключ для аутентификации MD5.
key_id целое число	Устарело, пожалуйста, переименуйте на key_id. Идентификатор ключа для аутентификации.
key_type строка	Устарело, пожалуйста, переименуйте на key_type. Выберите тип аутентификации NTP. Варианты: `"SHA1"` `"SHA256"` `"MD5"`
ntpv3 строка	Включить использование NTPv3 вместо NTPv4. Варианты: `"disable"` `"enable"`
server строка	IP-адрес или имя хоста NTP-сервера.
enable_log булево	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация Ansible-клиента с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, при которых условия будут игнорироваться.
rc_succeeded список / элементы=целое число	Список rc-кодов, при которых условия будут выполняться.

END_OF_DOCUMENT_MARKER

state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки FortiManager в режиме рабочего пространства. Значение может быть глобальным и другими, включая root.
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, запуск одного модуля может завершиться ошибкой, если возвращен ненулевой 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 the FortiGate to connect to any available third-party NTP server.
      fortinet.fortimanager.fmgr_devprof_system_ntp_ntpserver:
        # 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>
        state: present # <value in [present, absent]>
        devprof_system_ntp_ntpserver:
          authentication: <value in [disable, enable]>
          id: <integer>
          key: <list or string>
          key_id: <integer>
          ntpv3: <value in [disable, enable]>
          server: <string>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          ip_type: <value in [IPv6, IPv4, Both]>
          key_type: <value in [SHA1, SHA256, MD5]>

Значения возврата

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_ntp_ntpserver_module.html