fortinet.fortimanager.fmgr_dvmdb_workspace_commit_obj – Сохранить изменения(я) определённого объекта, где URL содержит полный путь к объекту (например, <i>firewall/address/obj_name</i>).
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_dvmdb_workspace_commit_obj.
Добавлена в версии 2.10: от fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |
| bypass_validation логическое |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров |
| object_url_name строка / обязательно | параметр (object_url_name) в запрошенном URL | |
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия для сбоя | |
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия для успеха | |
| workspace_locking_adom строка | домен для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root | |
| workspace_locking_timeout целое число | По умолчанию: 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: Commit change(s) of a specific object, where the url contains the full path to the object (eg. <i>firewall/address/obj_name</i>).
fmgr_dvmdb_workspace_commit_obj:
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, ...]
adom: <your own value>
object_url_name: <your own value>
Значения возврата
Общие значения возврата описаны в разделе здесь; следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрошенный URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание ответа 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_dvmdb_workspace_commit_obj_module.html