Модуль fortinet.fortimanager.fmgr_system_backup_allsettings — Настройки резервного копирования по расписанию.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.0.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_backup_allsettings dictionary	Параметры верхнего уровня.
cert string	Сертификат SSH для аутентификации.
crptpasswd any	(список) Необязательный пароль для защиты содержимого резервной копии.
directory string	Каталог на сервере резервного копирования, в котором будет храниться файл.
passwd any	(список) Пароль пользователя для входа на сервер резервного копирования.
protocol string	Протокол, используемый для резервного копирования. sftp — SFTP. ftp — FTP. scp — SCP. Варианты: `"sftp"` `"ftp"` `"scp"`
server string	Имя/IP-адрес сервера резервного копирования.
status string	Включить или отключить резервное копирование по расписанию. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
time string	Время выполнения резервного копирования.
user 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, работающего в режиме workspace. В качестве значения можно указать global или другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки workspace другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Чтобы игнорировать это предупреждение, задайте deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; параметры верхнего уровня 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 backup settings.
      fortinet.fortimanager.fmgr_system_backup_allsettings:
        # workspace_locking_adom: <global or your adom name>
        system_backup_allsettings:
          # cert: <string>
          # crptpasswd: <list or string>
          # directory: <string>
          # passwd: <list or string>
          # protocol: <value in [sftp, ftp, scp]>
          # server: <string>
          # status: <value in [disable, enable]>
          # time: <string>
          # user: <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_backup_allsettings_module.html