fortinet.fortimanager.fmgr_devprof_system_ntp модуль — Настройка системной информации 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.

Новый в fortinet.fortimanager 1.0.0

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

Обзор

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

Параметры

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

END_OF_DOCUMENT_MARKER

ntpsync строка	Включить/отключить установку времени системы FortiGate путем синхронизации с сервером NTP. Варианты: `"disable"` `"enable"`
server-mode строка	Устаревшее, пожалуйста, переименуйте его в server_mode. Включить/отключить режим сервера NTP FortiGate. Варианты: `"disable"` `"enable"`
source-ip строка	Устаревшее, пожалуйста, переименуйте его в source_ip. Поддержка метапеременной IP-адрес источника для связи с сервером NTP.
source-ip6 строка	Устаревшее, пожалуйста, переименуйте его в source_ip6. IPv6-адрес источника для связи с сервером NTP.
syncinterval целое число	Интервал синхронизации NTP
type строка	Использовать сервер NTP FortiGuard или любой другой доступный сервер NTP. Варианты: `"fortiguard"` `"custom"`
enable_log логический	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия завершения задачи с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия успешного завершения задачи.
workspace_locking_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 system NTP information.
      fortinet.fortimanager.fmgr_devprof_system_ntp:
        # 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_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]>
          ntpsync: <value in [disable, enable]>
          source_ip6: <string>
          syncinterval: <integer>
          type: <value in [fortiguard, custom]>
          authentication: <value in [disable, enable]>
          key: <list or string>
          key_id: <integer>
          key_type: <value in [MD5, SHA1, SHA256]>
          interface: <list or string>
          server_mode: <value in [disable, enable]>
          source_ip: <string>

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

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

Ключ	Описание
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_module.html