fortinet.fortimanager.fmgr_system_backup_allsettings – Расписание резервного копирования настроек.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач, укажите: fortinet.fortimanager.fmgr_system_backup_allsettings

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливать в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed list / elements=string			список кодов rc, при которых выполнение будет прекращено
rc_succeeded list / elements=string			список кодов rc, при которых выполнение будет успешно завершено
state string / required		Варианты: present absent	направление создания, обновления или удаления объекта
system_backup_allsettings dictionary			параметры верхнего уровня
	cert string		Сертификат SSH для аутентификации.
	crptpasswd string		нет описания
	directory string		Директория, в которой файл будет сохранён на сервере резервного копирования.
	passwd string		нет описания
	protocol string	Варианты: sftp ← ftp scp	Протокол, используемый для резервного копирования. sftp - SFTP. ftp - FTP. scp - SCP.
	server string		Имя/IP-адрес сервера резервного копирования.
	status string	Варианты: отключить ← включить	Включить/выключить расписание резервного копирования. отключить - Отключить настройку. включить - Включить настройку.
	time string		Время резервного копирования.
	user string		Пользователь для входа на сервере резервного копирования.
	week_days list / elements=string	Варианты: понедельник вторник среда четверг пятница суббота воскресенье	нет описания
workspace_locking_adom string			домен для блокировки FortiManager, работающего в режиме рабочей зоны, значение может быть глобальным и другими, включая root
workspace_locking_timeout integer		Значение по умолчанию: 300	максимальное время в секундах ожидания для освобождения блокировки рабочей зоны другим пользователем

Примечания

Примечание

Поддержка режима блокировки рабочей зоны в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогут в этом.
Для создания или обновления объекта используйте директиву present.
Для удаления объекта используйте директиву absent.
Обычно, выполнение одного модуля может завершиться неудачей, если возвращается ненулевой код rc. Вы также можете переопределить условия успеха или неудачи с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Scheduled backup settings.
     fmgr_system_backup_allsettings:
        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, ...]
        system_backup_allsettings:
           cert: <value of string>
           crptpasswd: <value of string>
           directory: <value of string>
           passwd: <value of string>
           protocol: <value in [sftp, ftp, scp]>
           server: <value of string>
           status: <value in [disable, enable]>
           time: <value of string>
           user: <value of string>
           week_days:
             - monday
             - tuesday
             - wednesday
             - thursday
             - friday
             - saturday
             - sunday

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Детальное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_backup_allsettings_module.html