Модуль fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting – Глобальные настройки FortiAnalyzer.

Примечание

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

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

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

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

Новая версия в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_log_fortianalyzer_setting словарь	Параметры верхнего уровня.
__change_ip целое число	Скрытый атрибут.
access-config строка	Устарело, пожалуйста, переименуйте на access_config. Включить/выключить доступ FortiAnalyzer к конфигурации и данным. Варианты: `"disable"` `"enable"`
alt-server строка	Устарело, пожалуйста, переименуйте на alt_server. Альтернативный сервер.
certificate строка	Сертификат, используемый для связи с FortiAnalyzer.
certificate-verification строка	Устарело, пожалуйста, переименуйте на certificate_verification. Включить/выключить проверку подлинности FortiAnalyzer с помощью … Варианты: `"disable"` `"enable"`
conn-timeout целое число	Устарело, пожалуйста, переименуйте на conn_timeout. Время ожидания подключения к FortiAnalyzer в секундах
enc-algorithm строка	Устарело, пожалуйста, переименуйте на enc_algorithm. Включить/выключить отправку данных логов FortiAnalyzer с SSL-шифрованием. Варианты: `"default"` `"high"` `"low"` `"disable"` `"high-medium"` `"low-medium"`
fallback-to-primary строка	Устарело, пожалуйста, переименуйте на fallback_to_primary. Включить/выключить этот блок FortiGate для переключения на первичный FortiAn… Варианты: `"disable"` `"enable"`
hmac-algorithm строка	Устарело, пожалуйста, переименуйте на hmac_algorithm. Алгоритм HMAC туннеля FortiAnalyzer IPsec. Варианты: `"sha256"` `"sha1"`
interface строка	Укажите исходящий интерфейс для подключения к серверу.
interface-select-method строка	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
ips-archive строка	Устарело, пожалуйста, переименуйте на ips_archive. Включить/выключить протоколирование архива пакетов IPS. Варианты: `"disable"` `"enable"`
max-log-rate целое число	Устарело, пожалуйста, переименуйте на max_log_rate. Максимальная скорость логов FortiAnalyzer в Мбит/с
monitor-failure-retry-period целое число	Устарело, пожалуйста, переименуйте на monitor_failure_retry_period. Время между повторными попытками подключения FortiAnalyzer в секундах

monitor-keepalive-period integer	Устаревшее, пожалуйста, переименуйте на monitor_keepalive_period. Время между OFTP keepalives в секундах
preshared-key string	Устаревшее, пожалуйста, переименуйте на preshared_key. Используемый для авторизации ключ, используемый для авторизации на FortiAnalyzer.
priority string	Установите приоритет передачи логов. Варианты: `"low"` `"default"`
reliable string	Включить/выключить надежное ведение журнала в FortiAnalyzer. Варианты: `"disable"` `"enable"`
serial any	(список) Серийные номера FortiAnalyzer.
server string	Удаленный FortiAnalyzer.
server-cert-ca string	Устаревшее, пожалуйста, переименуйте на server_cert_ca. Обязательный CA на FortiGate в цепочке сертификатов сервера.
source-ip string	Устаревшее, пожалуйста, переименуйте на source_ip. Использованный IPv4 или IPv6 адрес источника для связи с FortiAnalyzer.
ssl-min-proto-version string	Устаревшее, пожалуйста, переименуйте на ssl_min_proto_version. Минимальная поддерживаемая версия протокола для SSL/TLS соединений Варианты: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status string	Включить/выключить ведение журнала в FortiAnalyzer. Варианты: `"disable"` `"enable"`
upload-day string	Устаревшее, пожалуйста, переименуйте на upload_day. День недели
upload-interval string	Устаревшее, пожалуйста, переименуйте на upload_interval. Частота загрузки файлов журналов в FortiAnalyzer. Варианты: `"daily"` `"weekly"` `"monthly"`
upload-option string	Устаревшее, пожалуйста, переименуйте на upload_option. Включить/выключить ведение журнала на жесткий диск, а затем загрузку в FortiAnalyzer. Варианты: `"store-and-upload"` `"realtime"` `"1-minute"` `"5-minute"`
upload-time string	Устаревшее, пожалуйста, переименуйте на upload_time. Время загрузки логов
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Авторизовать Ansible-клиент с помощью маркера доступа к API forticloud.
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 в режиме рабочей области; значение может быть глобальным и другими, включая корневой.
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: Global FortiAnalyzer settings.
      fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_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_fortianalyzer_setting:
          certificate: <string>
          conn_timeout: <integer>
          enc_algorithm: <value in [default, high, low, ...]>
          hmac_algorithm: <value in [sha256, sha1]>
          ips_archive: <value in [disable, enable]>
          monitor_failure_retry_period: <integer>
          monitor_keepalive_period: <integer>
          reliable: <value in [disable, enable]>
          ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]>
          upload_day: <string>
          upload_interval: <value in [daily, weekly, monthly]>
          upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
          upload_time: <string>
          access_config: <value in [disable, enable]>
          certificate_verification: <value in [disable, enable]>
          max_log_rate: <integer>
          priority: <value in [low, default]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          preshared_key: <string>
          alt_server: <string>
          fallback_to_primary: <value in [disable, enable]>
          server_cert_ca: <string>
          serial: <list or string>
          source_ip: <string>
          status: <value in [disable, enable]>
          __change_ip: <integer>
          server: <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 список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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_fortianalyzer_setting_module.html