fortinet.fortimanager.fmgr_dvmdb_workspace_unlock_pkg – Разблокировать определенный пакет, где URL включает как папку(и), так и имя пакета политики.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvmdb_workspace_unlock_pkg.
Новое в версии 2.10: от fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | |
| bypass_validation логический тип |
| устанавливается только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров |
| package_path_name строка / обязательный | параметр (package_path_name) в запрошенном URL | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными с ошибкой | |
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными успешно | |
| workspace_locking_adom строка | adom для блокировки в режиме работы FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корень | |
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство |
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state 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: Unlock a specific package, where the url includes both the folder(s) and name of the policy package.
fmgr_dvmdb_workspace_unlock_pkg:
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>
package_path_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_unlock_pkg_module.html
