Модуль fortinet.fortimanager.fmgr_devprof_system_ntp_ntpserver — настройка подключения FortiGate к любому доступному стороннему серверу NTP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
devprof string / обязательный | Параметр (devprof) в запрошенном URL. |
devprof_system_ntp_ntpserver dictionary | Параметры верхнего уровня. |
|
authentication string |
Включение/отключение аутентификации MD5. Варианты:
|
|
id integer / обязательный |
Идентификатор сервера NTP. |
|
interface string |
Укажите исходящий интерфейс для подключения к серверу. |
|
interface_select_method псевдонимы: interface-select-method string |
Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты:
|
|
ip_type псевдонимы: ip-type string |
Выберите подключение к серверу NTP по IPv4 и/или IPv6. Варианты:
|
|
key any |
(список) Ключ для аутентификации MD5. |
|
key_id псевдонимы: key-id integer |
Идентификатор ключа для аутентификации. |
|
key_type псевдонимы: key-type string |
Выберите тип аутентификации NTP. Варианты:
|
|
ntpv3 string |
Включите, чтобы использовать NTPv3 вместо NTPv4. Варианты:
|
|
server string |
IP-адрес или имя хоста сервера NTP. |
|
vrf_select псевдонимы: vrf-select integer |
Идентификатор VRF, используемый для подключения к серверу. |
enable_log boolean | Включение/отключение ведения журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom string | ADOM для блокировки в FortiManager, работающем в режиме workspace. Значением может быть global или другой ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки workspace другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Как правило, выполнение модуля может завершиться с ошибкой при возврате ненулевого значения rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure the FortiGate to connect to any available third-party NTP server.
fortinet.fortimanager.fmgr_devprof_system_ntp_ntpserver:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
devprof: <your own value>
state: present # <value in [present, absent]>
devprof_system_ntp_ntpserver:
id: 0 # Required variable, integer
# authentication: <value in [disable, enable]>
# 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]>
# vrf_select: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Сведения о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии сложных данных |
Ссылки на коллекцию
© 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/fortimanager/fmgr_devprof_system_ntp_ntpserver_module.html