Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_system_locallog_memory_setting – Настройки буфера памяти.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

логическое значение

Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Допустимые значения:

  • false ← (по умолчанию)
  • true

enable_log

логическое значение

Включить или отключить ведение журнала для задачи.

Допустимые значения:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Допустимые значения:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.

system_locallog_memory_setting

словарь

Набор параметров верхнего уровня.

diskfull

строка

Действие при заполнении диска.

overwrite — перезаписывать самые старые журналы, когда диск заполнен.

nolog — прекращать ведение журнала, когда диск заполнен.

Допустимые значения:

  • "overwrite"
  • "nolog"

severity

строка

Минимальный уровень серьёзности для записи в журнал.

emergency — уровень «чрезвычайная ситуация».

alert — уровень «тревога».

critical — уровень «критический».

error — уровень «ошибка».

warning — уровень «предупреждение».

notification — уровень «уведомление».

information — уровень «информация».

debug — уровень «отладка».

Допустимые значения:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "information"
  • "debug"

status

строка

Включить или отключить запись журналов в буфер памяти.

disable — не записывать журналы в буфер памяти.

enable — записывать журналы в буфер памяти.

Допустимые значения:

  • "disable"
  • "enable"

workspace_locking_adom

строка

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие ADOM, включая 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
  gather_facts: false
  tasks:
    - name: Settings for memory buffer.
      fortinet.fortimanager.fmgr_system_locallog_memory_setting:
        # workspace_locking_adom: <global or your adom name>
        system_locallog_memory_setting:
          # diskfull: <value in [overwrite, nolog]>
          # severity: <value in [emergency, alert, critical, ...]>
          # status: <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

список / элементы=строка

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API