fortinet.fortimanager.fmgr_fmupdate_fdssetting_updateschedule модуль – Настройка расписания, когда встроенный FortiGuard получает обновления антивируса и IPS.

Примечание

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

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

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

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_fmupdate_fdssetting_updateschedule.

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполняться без проверки параметров. Выборы: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Выборы: `false` ← (по умолчанию) `true`
fmupdate_fdssetting_updateschedule словарь	Установленные параметры верхнего уровня.
day строка	Указывает день, в который будет выполняться обновление, если частота — еженедельная. Воскресенье - Обновление каждое воскресенье. Понедельник - Обновление каждый понедельник. Вторник - Обновление каждый вторник. Среда - Обновление каждую среду. Четверг - Обновление каждый четверг. Пятница - Обновление каждую пятницу. Суббота - Обновление каждую субботу. Выборы: `"Sunday"` `"Monday"` `"Tuesday"` `"Wednesday"` `"Thursday"` `"Friday"` `"Saturday"`
frequency строка	Указывает частоту обновления. every - Интервал времени. daily - Ежедневно. weekly - Еженедельно. Выборы: `"every"` `"daily"` `"weekly"`
status строка	Включить/выключить запланированные обновления. disable - Выключить настройку. enable - Включить настройку. Выборы: `"disable"` `"enable"`
time любой	(список) Интервал времени между обновлениями или час и минута, когда происходит обновление.
forticloud_access_token строка	Авторизует Ansible-клиент с токеном доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выборы: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условие будет переопределено для неудачи.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условие будет переопределено для успеха.
workspace_locking_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: Configure the schedule when built-in FortiGuard retrieves antivirus and IPS updates.
      fortinet.fortimanager.fmgr_fmupdate_fdssetting_updateschedule:
        # 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, ...]
        fmupdate_fdssetting_updateschedule:
          day: <value in [Sunday, Monday, Tuesday, ...]>
          frequency: <value in [every, daily, weekly]>
          status: <value in [disable, enable]>
          time: <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 список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_fmupdate_fdssetting_updateschedule_module.html