Модуль fortinet.fortimanager.fmgr_devprof_log_syslogd_setting — Глобальные настройки удаленного сервера syslog.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 1.0.0

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

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_log_syslogd_setting словарь	Установленные параметры верхнего уровня.
certificate строка	Сертификат, используемый для связи с сервером Syslog.
csv строка	Включить/отключить форматирование логов в формате CSV. Варианты: `"disable"` `"enable"`
custom_field_name список / элементы=словарь	Устарело, пожалуйста, переименуйте на custom_field_name. Название пользовательского поля.
custom строка	Пользовательское название поля.
id целое число	Идентификатор записи.
name строка	Имя поля.
enc_algorithm строка	Включить/отключить надежную регистрацию syslog с шифрованием TLS. Варианты: `"high"` `"low"` `"disable"` `"high-medium"`
facility строка	Удобство удаленного syslog. Варианты: `"kernel"` `"user"` `"mail"` `"daemon"` `"auth"` `"syslog"` `"lpr"` `"news"` `"uucp"` `"cron"` `"authpriv"` `"ftp"` `"ntp"` `"audit"` `"alert"` `"clock"` `"local0"` `"local1"` `"local2"` `"local3"` `"local4"` `"local5"` `"local6"` `"local7"`
format строка	Формат лога. Варианты: `"default"` `"csv"` `"cef"` `"rfc5424"` `"json"`
interface строка	Укажите исходящий интерфейс для связи с сервером.
interface_select_method строка	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
max_log_rate целое число	Максимальная скорость логов syslog в Мбит/с
mode строка	Удаленная регистрация syslog по протоколам UDP/Reliable TCP. Варианты: `"udp"` `"legacy-reliable"` `"reliable"`
port целое число	Порт прослушивания сервера.

priority строка	Установите приоритет передачи журналов. Варианты: `"low"` `"default"`
reliable строка	Включить/выключить надежное протоколирование Варианты: `"disable"` `"enable"`
server строка	Адрес удаленного сервера syslog.
source-ip строка	Устаревшее, пожалуйста, переименуйте на source_ip. Исходный IP-адрес syslog.
source-ip-interface любой	(список) Устаревшее, пожалуйста, переименуйте на source_ip_interface. Исходный интерфейс syslog.
ssl-min-proto-version строка	Устаревшее, пожалуйста, переименуйте на ssl_min_proto_version. Минимальная поддерживаемая версия протокола для подключений SSL/TLS Варианты: `"default"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1"` `"TLSv1-3"`
status строка	Включить/выключить удаленное протоколирование syslog. Варианты: `"disable"` `"enable"`
syslog-type целое число	Устаревшее, пожалуйста, переименуйте на syslog_type. Тип syslog.
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 строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
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: Global settings for remote syslog server.
      fortinet.fortimanager.fmgr_devprof_log_syslogd_setting:
        # 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_log_syslogd_setting:
          certificate: <string>
          enc_algorithm: <value in [high, low, disable, ...]>
          facility: <value in [kernel, user, mail, ...]>
          mode: <value in [udp, legacy-reliable, reliable]>
          port: <integer>
          server: <string>
          ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          status: <value in [disable, enable]>
          reliable: <value in [disable, enable]>
          csv: <value in [disable, enable]>
          max_log_rate: <integer>
          priority: <value in [low, default]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          format: <value in [default, csv, cef, ...]>
          syslog_type: <integer>
          custom_field_name:
            -
              custom: <string>
              id: <integer>
              name: <string>
          source_ip: <string>
          source_ip_interface: <list or 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 список / элементы=строка	Предупреждение, если параметры, используемые в 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_devprof_log_syslogd_setting_module.html