fortinet.fortimanager.fmgr_pm_wanprof_adom – без описания
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_pm_wanprof_adom
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для данных источников перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation логическое значение |
| устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| pm_wanprof_adom словарь | параметры верхнего уровня | |||
| description строка | без описания | |||
| name строка | без описания | |||
| oid целое число | без описания | |||
| scope member список / элементы=строка | без описания | |||
| name строка | без описания | |||
| vdom строка | без описания | |||
| type строка |
| без описания | ||
| rc_failed список / элементы=строка | список кодов rc, при которых выполнение будет завершено ошибкой | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых выполнение будет завершено успешно | |||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | ||
| workspace_locking_adom строка | адрес домена для блокировки FortiManager в режиме рабочего пространства. значение может быть глобальным или другим, включая root | |||
| 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: no description
fmgr_pm_wanprof_adom:
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>
pm_wanprof_adom:
description: <value of string>
name: <value of string>
oid: <value of integer>
scope member:
-
name: <value of string>
vdom: <value of string>
type: <value in [wanprof]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_pm_wanprof_adom_module.html
