fortinet.fortimanager.fmgr_system_ntp модуль — Настройки NTP.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_system_ntp.

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентифицировать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с помощью которых будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список rc-кодов, с помощью которых будут переопределены условия для успеха.
system_ntp словарь	Параметры верхнего уровня.
ntpserver список / элементы=словарь	Ntpserver.
authentication строка	Включить/выключить аутентификацию MD5. disable - Выключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
id целое число	Идентификатор сервера времени.
key любой	(список) Ключ для аутентификации.
key_id целое число	Устарело, пожалуйста, переименуйте на key_id. Идентификатор ключа для аутентификации.
maxpoll целое число	Максимальный интервал опроса в секундах, как степень двойки
minpoll целое число	Минимальный интервал опроса в секундах, как степень двойки
ntpv3 строка	Включить/выключить NTPv3. disable - Выключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
server строка	IP-адрес/имя хоста NTP-сервера.
status строка	Включить/выключить NTP. disable - Выключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
sync_interval целое число	Интервал синхронизации NTP
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: NTP settings.
      fortinet.fortimanager.fmgr_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, ...]
        system_ntp:
          ntpserver:
            -
              authentication: <value in [disable, enable]>
              id: <integer>
              key: <list or string>
              key_id: <integer>
              ntpv3: <value in [disable, enable]>
              server: <string>
              maxpoll: <integer>
              minpoll: <integer>
          status: <value in [disable, enable]>
          sync_interval: <integer>

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

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

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