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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
log_npuserver словарь	Настройка параметров верхнего уровня.
enforce_seq_order строка	Устарело, используйте enforce_seq_order. Журналы сессий SW с протоколом netflow будут передаваться в строгом порядке, если установлен… Варианты: `"disable"` `"enable"`
log_processing строка	Устарело, используйте log_processing. Настройка обработки журналов хостом: отбрасывать или нет. Варианты: `"may-drop"` `"no-drop"`
log_processor строка	Устарело, используйте log_processor. Настройка модуля ведения журнала. Варианты: `"hardware"` `"host"`
netflow_ver строка	Устарело, используйте netflow_ver. Настройка версии netflow. Варианты: `"v9"` `"v10"`
server_group список / элементы=словарь	Устарело, используйте server_group. Группа серверов.
group_name строка	Устарело, используйте group_name. Имя группы серверов.
log_format строка	Устарело, используйте log_format. Установка формата журнала Варианты: `"syslog"` `"netflow"`
log_gen_event строка	Устарело, используйте log_gen_event. Включение/выключение генерации событий для журнала Per-Mapping Варианты: `"disable"` `"enable"`
log_mode строка	Устарело, используйте log_mode. Установка режима журнала Варианты: `"per-session"` `"per-nat-mapping"` `"per-session-ending"`
log_tx_mode строка	Устарело, используйте log_tx_mode. Настройка режима передачи журнала. Варианты: `"multicast"` `"roundrobin"`
log_user_info строка	Устарело, используйте log_user_info. Включение/выключение ведения информации о пользователе. Варианты: `"disable"` `"enable"`
server_number целое число	Устарело, используйте server_number. Номер сервера в этой группе.
server_start_id целое число	Устарело, используйте server_start_id. Начальный идентификатор непрерывного ряда серверов в этой группе [1, 16].

sw-log-flags any	(int or str) Устаревшее, пожалуйста, переименуйте его на sw_log_flags. Устанавливает флаги для ведения журнала программного обеспечения через драйвер.
server-info list / elements=dictionary	Устаревшее, пожалуйста, переименуйте его на server_info. Информация о сервере.
dest-port integer	Устаревшее, пожалуйста, переименуйте его на dest_port. Устанавливает порт назначения для пакета журнала
id integer	Идентификатор сервера.
ip-family string	Устаревшее, пожалуйста, переименуйте его на ip_family. Устанавливает версию IP-адреса Варианты: `"v4"` `"v6"`
ipv4-server string	Устаревшее, пожалуйста, переименуйте его на ipv4_server. Устанавливает IPv4-адрес сервера журнала
ipv6-server string	Устаревшее, пожалуйста, переименуйте его на ipv6_server. Устанавливает IPv6-адрес сервера журнала
log-transport string	Устаревшее, пожалуйста, переименуйте его на log_transport. Устанавливает протокол транспорта Варианты: `"udp"` `"tcp"`
source-port integer	Устаревшее, пожалуйста, переименуйте его на source_port. Устанавливает исходный порт для пакета журнала
template-tx-timeout integer	Устаревшее, пожалуйста, переименуйте его на template_tx_timeout. Устанавливает таймаут шаблона tx
vdom string	Интерфейс, подключенный к серверу журнала, находится в этой виртуальной домене
syslog-facility integer	Устаревшее, пожалуйста, переименуйте его на fmgr_syslog_facility. Настройка объекта syslog facility.
syslog-severity integer	Устаревшее, пожалуйста, переименуйте его на syslog_severity. Настройка уровня серьезности syslog.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми будут переопределены условия для сбоя.
rc_succeeded list / elements=integer	Список кодов rc, с которыми будут переопределены условия для успешного завершения.
workspace_locking_adom string	ADOM для блокировки в режиме работы в рабочем пространстве FortiManager, значение может быть глобальным и другими, включая 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure all the log servers and create the server groups.
      fortinet.fortimanager.fmgr_log_npuserver:
        # 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>
        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: <integer or string> <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]>
          fmgr_syslog_facility: <integer>
          syslog_severity: <integer>
          enforce_seq_order: <value in [disable, enable]>

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

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

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