fortinet.fortimanager.fmgr_system_admin_profile – Профиль администратора.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_admin_profile.
В версии 2.10: плагина fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| bypass_validation boolean |
| устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия для завершения с ошибкой будут переопределены | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия для успешного завершения будут переопределены | |||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | ||
| system_admin_profile словарь | установленные параметры верхнего уровня | |||
| adom-lock строка |
| Блокировка ADOM none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| adom-policy-packages строка |
| Пакеты политик ADOM. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| adom-switch строка |
| Домен администратора. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| app-filter строка |
| Фильтр приложений. выключить - Отключить настройку. включить - Включить настройку. | ||
| assignment строка |
| Разрешение на назначение. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| change-password строка |
| Включить/выключить ограничение на изменение пароля пользователем. выключить - Отключить настройку. включить - Включить настройку. | ||
| config-retrieve строка |
| Восстановление конфигурации. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| config-revert строка |
| Восстановление конфигурации из истории версий none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| consistency-check строка |
| Проверка согласованности. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| datamask строка |
| Включить/выключить маску данных. выключить - Выключить маску данных. включить - Включить маску данных. | ||
| datamask-custom-fields список / элементы=строка | нет описания | |||
| field-category список / элементы=строка |
| нет описания | ||
| field-name строка | Имя поля. | |||
| field-status строка |
| Статус поля. выключить - Выключить поле. включить - Включить поле. | ||
| field-type строка |
| Тип поля. строка - Строка. ip - IP. mac - MAC-адрес. email - Электронный адрес. неизвестно - Неизвестный. | ||
| datamask-custom-priority строка |
| Установить приоритет для пользовательских полей. выключить - Выключить приоритет поиска по пользовательским полям. включить - Включить приоритет поиска по пользовательским полям. | ||
| datamask-fields список / элементы=строка |
| нет описания | ||
| datamask-key строка | нет описания | |||
| deploy-management строка |
| Установка на устройства. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| description строка | Описание. | |||
| device-ap строка |
| Управление точкой доступа. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-config строка |
| Управление конфигурациями устройств. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-forticlient строка |
| Управление FortiClient. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-fortiswitch строка |
| Управление FortiSwitch. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-manager строка |
| Диспетчер устройств. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-op строка |
| Добавление/удаление/редактирование устройства. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-policy-package-lock строка |
| Блокировка устройства/пакетов политики none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-profile строка |
| Разрешение на профиль устройства. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-revision-deletion строка |
| Удаление версии устройства. none - Нет разрешений. чтение - Разрешение на чтение. чтение-запись - Разрешение на чтение и запись. | ||
| device-wan-link-load-balance string |
| Управление балансировкой нагрузки WAN-соединения. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| event-management string |
| Управление событиями. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| fgd-center-advanced string |
| FortiGuard Center Advanced. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| fgd-center-fmw-mgmt string |
| Управление прошивкой FortiGuard Center. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| fgd-center-licensing string |
| Лицензирование FortiGuard Center. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| fgd_center string |
| FortiGuard Center. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| global-policy-packages string |
| Глобальные пакеты политик. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| import-policy-packages string |
| Импорт пакета политик. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| intf-mapping string |
| Сопоставление интерфейсов none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| ips-filter string |
| Фильтр IPS. disable - Отключить настройку. enable - Включить настройку. | ||
| log-viewer string |
| Просмотр журналов. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| policy-objects string |
| Разрешения на объекты политик. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| profileid string | Идентификатор профиля. | |||
| read-passwd string |
| Просмотр пароля в открытом виде. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| realtime-monitor string |
| Мониторинг в реальном времени. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| report-viewer string |
| Просмотр отчетов. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| scope string |
| Область действия. global - Глобальная область. adom - Область ADOM. | ||
| set-install-targets string |
| Редактирование целевых установок. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| system-setting string |
| Настройки системы. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| term-access string |
| Доступ к терминалу. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| type string |
| Тип профиля. system - Системный администратор. restricted - Ограниченный администратор. | ||
| vpn-manager string |
| Менеджер VPN. none - Отсутствует разрешение. read - Разрешение на чтение. read-write - Разрешение на чтение и запись. | ||
| web-filter string |
| Фильтр веб-сайтов. disable - Отключить настройку. enable - Включить настройку. | ||
| workspace_locking_adom string | ADOM, который следует заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным или другим, включая корневой. | |||
| workspace_locking_timeout integer | По умолчанию: 300 | Максимальное время ожидания в секундах, пока другой пользователь не разблокирует блокировку рабочего пространства. | ||
Примечания
Примечание
- Режим блокировки рабочего пространства поддерживается в этом модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться неудачей, если возвращён код ошибки, отличный от нуля. Также можно переопределить условия завершения с ошибкой или успехом с помощью параметров 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: Admin profile.
fmgr_system_admin_profile:
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, ...]
state: <value in [present, absent]>
system_admin_profile:
adom-lock: <value in [none, read, read-write]>
adom-policy-packages: <value in [none, read, read-write]>
adom-switch: <value in [none, read, read-write]>
app-filter: <value in [disable, enable]>
assignment: <value in [none, read, read-write]>
change-password: <value in [disable, enable]>
config-retrieve: <value in [none, read, read-write]>
config-revert: <value in [none, read, read-write]>
consistency-check: <value in [none, read, read-write]>
datamask: <value in [disable, enable]>
datamask-custom-fields:
-
field-category:
- log
- fortiview
- alert
- ueba
- all
field-name: <value of string>
field-status: <value in [disable, enable]>
field-type: <value in [string, ip, mac, ...]>
datamask-custom-priority: <value in [disable, enable]>
datamask-fields:
- user
- srcip
- srcname
- srcmac
- dstip
- dstname
- email
- message
- domain
datamask-key: <value of string>
deploy-management: <value in [none, read, read-write]>
description: <value of string>
device-ap: <value in [none, read, read-write]>
device-config: <value in [none, read, read-write]>
device-forticlient: <value in [none, read, read-write]>
device-fortiswitch: <value in [none, read, read-write]>
device-manager: <value in [none, read, read-write]>
device-op: <value in [none, read, read-write]>
device-policy-package-lock: <value in [none, read, read-write]>
device-profile: <value in [none, read, read-write]>
device-revision-deletion: <value in [none, read, read-write]>
device-wan-link-load-balance: <value in [none, read, read-write]>
event-management: <value in [none, read, read-write]>
fgd-center-advanced: <value in [none, read, read-write]>
fgd-center-fmw-mgmt: <value in [none, read, read-write]>
fgd-center-licensing: <value in [none, read, read-write]>
fgd_center: <value in [none, read, read-write]>
global-policy-packages: <value in [none, read, read-write]>
import-policy-packages: <value in [none, read, read-write]>
intf-mapping: <value in [none, read, read-write]>
ips-filter: <value in [disable, enable]>
log-viewer: <value in [none, read, read-write]>
policy-objects: <value in [none, read, read-write]>
profileid: <value of string>
read-passwd: <value in [none, read, read-write]>
realtime-monitor: <value in [none, read, read-write]>
report-viewer: <value in [none, read, read-write]>
scope: <value in [global, adom]>
set-install-targets: <value in [none, read, read-write]>
system-setting: <value in [none, read, read-write]>
term-access: <value in [none, read, read-write]>
type: <value in [system, restricted]>
vpn-manager: <value in [none, read, read-write]>
web-filter: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный запрос URL. Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API. |
| response_message string | всегда | Дескриптивное сообщение ответа 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_system_admin_profile_module.html