модуль fortinet.fortimanager.fmgr_system_hascheduledcheck — Запланированная проверка целостности HA.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Допустимые значения: `false` ← (по умолчанию) `true`
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, с помощью которого переопределяются условия успешного выполнения.
system_hascheduledcheck dictionary	Параметры верхнего уровня.
status string	Включить/отключить запланированную проверку целостности. disable — отключить параметр. enable — включить параметр. Допустимые значения: `"disable"` `"enable"`
time string	Время проверки целостности данных.
week_days list / elements=string	Дни недели, в которые следует проверять целостность данных. monday — понедельник. tuesday — вторник. wednesday — среда. thursday — четверг. friday — пятница. saturday — суббота. sunday — воскресенье. Допустимые значения: `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"` `"sunday"`
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие области, включая 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
  gather_facts: false
  tasks:
    - name: Scheduled HA integrity check.
      fortinet.fortimanager.fmgr_system_hascheduledcheck:
        # workspace_locking_adom: <global or your adom name>
        system_hascheduledcheck:
          # status: <value in [disable, enable]>
          # time: <string>
          # week_days: ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday",
          #             "sunday"]

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_hascheduledcheck_module.html