Модуль fortinet.fortimanager.fmgr_log_npuserver — настройка всех серверов журналирования и создание групп серверов.

Примечание

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

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

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

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

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

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
log_npuserver dictionary	Набор параметров верхнего уровня.
enforce_seq_order псевдонимы: enforce-seq-order string	Если этот параметр включен, журналы NetFlow сеансов программного коммутатора будут передаваться строго по порядку. Варианты: `"disable"` `"enable"`
fmgr_syslog_facility псевдонимы: syslog-facility integer	Настройка facility Syslog.
log_processing псевдонимы: log-processing string	Настройка обработки журналов узлом: отбрасывать их или не отбрасывать. Варианты: `"may-drop"` `"no-drop"`
log_processor псевдонимы: log-processor string	Настройка модуля журналирования. Варианты: `"hardware"` `"host"`
netflow_ver псевдонимы: netflow-ver string	Настройка версии NetFlow. Варианты: `"v9"` `"v10"`
server_group псевдонимы: server-group list / elements=dictionary	Группа серверов.
group_name псевдонимы: group-name string	Имя группы серверов.
log_format псевдонимы: log-format string	Установка формата журнала Варианты: `"syslog"` `"netflow"`
log_gen_event псевдонимы: log-gen-event string	Включение или отключение создания событий для журнала Per-Mapping Варианты: `"disable"` `"enable"`
log_mode псевдонимы: log-mode string	Установка режима журналирования Варианты: `"per-session"` `"per-nat-mapping"` `"per-session-ending"`
log_tx_mode псевдонимы: log-tx-mode string	Настройка режима передачи журналов. Варианты: `"multicast"` `"roundrobin"`
log_user_info псевдонимы: log-user-info string	Включение или отключение журналирования сведений о пользователях. Варианты: `"disable"` `"enable"`
server_number псевдонимы: server-number integer	Количество серверов в этой группе.
server_start_id псевдонимы: server-start-id integer	Начальный идентификатор последовательности серверов в этой группе [1,16].
sw_log_flags псевдонимы: sw-log-flags any	(int или str) Установка флагов для программного журналирования через драйвер.
server_info псевдонимы: server-info list / elements=dictionary	Сведения о сервере.
dest_port псевдонимы: dest-port integer	Установка порта назначения для пакета журнала
id integer	Идентификатор сервера.
ip_family псевдонимы: ip-family string	Установка версии IP-адреса Варианты: `"v4"` `"v6"`
ipv4_server псевдонимы: ipv4-server string	Установка IPv4-адреса сервера журналирования
ipv6_server псевдонимы: ipv6-server string	Установка IPv6-адреса сервера журналирования
log_transport псевдонимы: log-transport string	Установка транспортного протокола Варианты: `"udp"` `"tcp"`
source_port псевдонимы: source-port integer	Установка исходного порта для пакета журнала
template_tx_timeout псевдонимы: template-tx-timeout integer	Установка тайм-аута передачи шаблона
vdom string	Интерфейс, подключенный к серверу журналирования, находится в этом виртуальном домене
vdom_ string	Виртуальный домен.
syslog_severity псевдонимы: syslog-severity integer	Настройка уровня серьезности Syslog.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия завершения с ошибкой.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного завершения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. В качестве значения можно указать global и другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем. По умолчанию: `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
  gather_facts: false
  tasks:
    - name: Configure all the log servers and create the server groups.
      fortinet.fortimanager.fmgr_log_npuserver:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        log_npuserver:
          # log_processing: <value in [may-drop, no-drop]>
          # log_processor: <value in [hardware, host]>
          # netflow_ver: <value in [v9, v10]>
          # server_group:
          #   - group_name: <string>
          #     log_format: <value in [syslog, netflow]>
          #     log_mode: <value in [per-session, per-nat-mapping, per-session-ending]>
          #     log_tx_mode: <value in [multicast, roundrobin]>
          #     server_number: <integer>
          #     server_start_id: <integer>
          #     sw_log_flags: <value in [tcp-udp-only, enable-all-log, disable-all-log]>
          #     log_gen_event: <value in [disable, enable]>
          #     log_user_info: <value in [disable, enable]>
          # server_info:
          #   - dest_port: <integer>
          #     id: <integer>
          #     ip_family: <value in [v4, v6]>
          #     ipv4_server: <string>
          #     ipv6_server: <string>
          #     source_port: <integer>
          #     template_tx_timeout: <integer>
          #     vdom: <string>
          #     log_transport: <value in [udp, tcp]>
          #     vdom_: <string>
          # fmgr_syslog_facility: <integer>
          # syslog_severity: <integer>
          # enforce_seq_order: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_log_npuserver_module.html