fortinet.fortimanager.fmgr_system_backup_allsettings модуль — Настройки запланированных резервных копий.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое значение | Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Выбори:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Выбори:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к forticloud API. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Выбори:
|
rc_failed список / элементы=целое число | Список кодов rc, по которым будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое число | Список кодов rc, по которым будут переопределены условия для успеха. |
system_backup_allsettings словарь | Настройка параметров верхнего уровня. |
|
cert строка |
Сертификат SSH для аутентификации. |
|
crptpasswd любой |
(список) Необязательный пароль для защиты содержимого резервной копии. |
|
directory строка |
Директория, в которой будет храниться файл на сервере резервного копирования. |
|
passwd любой |
(список) Пароль пользователя для входа на сервер резервного копирования. |
|
protocol строка |
Протокол, используемый для резервного копирования. sftp - SFTP. ftp - FTP. scp - SCP. Выбори:
|
|
server строка |
Имя/IP-адрес сервера резервного копирования. |
|
status строка |
Включить/выключить запланированное резервное копирование. disable - Выключить настройку. enable - Включить настройку. Выбори:
|
|
time строка |
Время резервного копирования. |
|
user строка |
Пользователь для входа на сервер резервного копирования. |
|
week_days список / элементы=строка |
Дни недели для резервного копирования. понедельник - Понедельник. вторник - Вторник. среда - Среда. четверг - Четверг. пятница - Пятница. суббота - Суббота. воскресенье - Воскресенье. Выбори:
|
workspace_locking_adom строка | ADOM для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Scheduled backup settings.
fortinet.fortimanager.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: <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 словарь | Результат запроса. Возвращаемое значение: всегда |
|
request_url строка |
Полный URL запроса. Возвращаемое значение: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращаемое значение: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращаемое значение: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращаемое значение: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращаемое значение: всегда |
rc целое число | Статус запроса. Возвращаемое значение: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращаемое значение: сложное |
Ссылки на сборку
© 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_system_backup_allsettings_module.html
