fortinet.fortimanager.fmgr_dvm_cmd_update_device – Обновление подключения FGFM и системной информации устройства.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvm_cmd_update_device.
Новое в версии 2.10: fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливать только в том случае, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров | |
| dvm_cmd_update_device словарь | устанавливаются параметры верхнего уровня | ||
| adom строка | Имя или ID ADOM, на котором нужно выполнить команду. | ||
| device строка | Имя или ID целевого устройства. | ||
| flags список / элементы=строка |
| нет описания | |
| 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: Refresh the FGFM connection and system information of a device.
fmgr_dvm_cmd_update_device:
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, ...]
dvm_cmd_update_device:
adom: <value of string>
device: <value of string>
flags:
- none
- create_task
- nonblocking
- log_dev
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_dvm_cmd_update_device_module.html
