Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_system_admin_profile — Профиль администратора.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_admin_profile.

Добавлено в fortinet.fortimanager 2.0.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет настраивать устройство FortiManager.
  • В примерах указаны все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределяемый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, используемый для переопределения условий сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, используемый для переопределения условий успешного выполнения.

state

string / обязательный

Указание создать, обновить или удалить объект.

Варианты:

  • "present"
  • "absent"

system_admin_profile

dictionary

Набор параметров верхнего уровня.

adom_admin

aliases: adom-admin

string

Включить права администратора ADOM.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

adom_lock

aliases: adom-lock

string

Блокировка ADOM

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

adom_policy_packages

aliases: adom-policy-packages

string

Пакеты политик ADOM.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

adom_switch

aliases: adom-switch

string

Домен администратора.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

allow_to_install

aliases: allow-to-install

string

Разрешить или запретить пользователю с ограниченными правами устанавливать объекты на устройства.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

app_filter

aliases: app-filter

string

Фильтр приложений.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

assignment

string

Разрешение на назначение.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

change_password

aliases: change-password

string

Разрешить или запретить пользователю с ограниченными правами изменять собственный пароль.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

config_retrieve

aliases: config-retrieve

string

Получение конфигурации.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

config_revert

aliases: config-revert

string

Восстановление конфигурации из истории версий

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

consistency_check

aliases: consistency-check

string

Проверка согласованности.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

datamask

string

Включить или отключить маскирование данных.

disable — отключить маскирование данных.

enable — включить маскирование данных.

Варианты:

  • "disable"
  • "enable"

datamask_custom_fields

aliases: datamask-custom-fields

list / elements=dictionary

Пользовательские поля маскирования данных.

field_category

aliases: field-category

list / elements=string

Категории полей.

log — журнал.

fortiview — FortiView.

alert — управление событиями.

ueba — UEBA.

all — все.

Варианты:

  • "log"
  • "fortiview"
  • "alert"
  • "ueba"
  • "all"

field_name

aliases: field-name

string

Имя поля.

field_status

aliases: field-status

string

Состояние поля.

disable — отключить поле.

enable — включить поле.

Варианты:

  • "disable"
  • "enable"

field_type

aliases: field-type

string

Тип поля.

string — строка.

ip — IP-адрес.

mac — MAC-адрес.

email — адрес электронной почты.

unknown — неизвестный.

Варианты:

  • "string"
  • "ip"
  • "mac"
  • "email"
  • "unknown"

datamask_custom_priority

aliases: datamask-custom-priority

string

Приоритет пользовательских полей.

disable — отключить приоритет поиска пользовательских полей.

enable — включить приоритет поиска пользовательских полей.

Варианты:

  • "disable"
  • "enable"

datamask_fields

aliases: datamask-fields

list / elements=string

Поля маскирования данных.

user — имя пользователя.

srcip — IP-адрес источника.

srcname — имя источника.

srcmac — MAC-адрес источника.

dstip — IP-адрес назначения.

dstname — имя назначения.

email — адрес электронной почты.

message — сообщение.

domain — домен.

Варианты:

  • "user"
  • "srcip"
  • "srcname"
  • "srcmac"
  • "dstip"
  • "dstname"
  • "email"
  • "message"
  • "domain"

datamask_key

aliases: datamask-key

any

(список) Ключ шифрования для маскирования данных.

datamask_unmasked_time

aliases: datamask-unmasked-time

integer

Количество дней без маскирования данных.

deploy_management

aliases: deploy-management

string

Установка на устройства.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

description

string

Описание.

device_ap

aliases: device-ap

string

Управление точками доступа (AP).

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_assignment

aliases: device-assignment

string

Назначение устройства.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_config

aliases: device-config

string

Управление конфигурациями устройств.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_forticlient

aliases: device-forticlient

string

Управление FortiClient.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_fortiextender

aliases: device-fortiextender

string

Управление FortiExtender.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_fortiswitch

aliases: device-fortiswitch

string

Управление FortiSwitch.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_fwm_profile

aliases: device-fwm-profile

string

Разрешение на управление профилем прошивки устройства.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_manager

aliases: device-manager

string

Диспетчер устройств.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_op

aliases: device-op

string

Добавление, удаление и редактирование устройств.

none — нет разрешений.

read — разрешение на чтение.

read-write — разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_policy_package_lock

aliases: device-policy-package-lock

string

Блокировка устройства/пакета политик

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_profile

aliases: device-profile

string

Разрешение для профиля устройства.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_revision_deletion

aliases: device-revision-deletion

string

Удаление версии устройства.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

device_wan_link_load_balance

aliases: device-wan-link-load-balance

string

Управление балансировкой нагрузки каналов WAN.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

event_management

aliases: event-management

string

Управление событиями.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

extension_access

aliases: extension-access

string

Управление доступом к расширениям.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

fabric_viewer

aliases: fabric-viewer

string

Просмотр Fabric.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

fgd_center

string

Центр FortiGuard.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

fgd_center_advanced

aliases: fgd-center-advanced

string

Расширенные функции центра FortiGuard.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

fgd_center_fmw_mgmt

aliases: fgd-center-fmw-mgmt

string

Управление прошивкой в центре FortiGuard.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

fgd_center_licensing

aliases: fgd-center-licensing

string

Лицензирование в центре FortiGuard.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

fgt_gui_proxy

aliases: fgt-gui-proxy

string

Прокси GUI FortiGate.

disable — Нет разрешения.

enable — С разрешением.

Варианты:

  • "disable"
  • "enable"

global_policy_packages

aliases: global-policy-packages

string

Глобальные пакеты политик.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

import_policy_packages

aliases: import-policy-packages

string

Импорт пакета политик.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

intf_mapping

aliases: intf-mapping

string

Сопоставление интерфейсов

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

ips_baseline_cfg

aliases: ips-baseline-cfg

string

Конфигурация базового датчика IPS.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

ips_baseline_ovrd

aliases: ips-baseline-ovrd

string

Включить/отключить переопределение базового датчика IPS.

disable — Отключить настройку.

enable — Включить настройку.

Варианты:

  • "disable"
  • "enable"

ips_filter

aliases: ips-filter

string

Фильтр IPS.

disable — Отключить настройку.

enable — Включить настройку.

Варианты:

  • "disable"
  • "enable"

ips_lock

aliases: ips-lock

string

Блокировка IPS

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

ips_objects

aliases: ips-objects

string

Конфигурация объектов IPS.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

ipv6_trusthost1

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию

ipv6_trusthost10

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost2

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost3

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost4

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost5

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost6

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost7

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost8

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

ipv6_trusthost9

string

Доверенный хост IPv6 пользователя-администратора, по умолчанию ffff

log_viewer

aliases: log-viewer

string

Просмотр журналов.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

policy_ips_attrs

aliases: policy-ips-attrs

string

Конфигурация атрибутов IPS политик.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

policy_objects

aliases: policy-objects

string

Разрешение для объектов политик.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

profileid

string / обязательный

Идентификатор профиля.

read_passwd

aliases: read-passwd

string

Просмотр пароля в открытом виде.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

realtime_monitor

aliases: realtime-monitor

string

Мониторинг в реальном времени.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

report_viewer

aliases: report-viewer

string

Просмотр отчетов.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

rpc_permit

aliases: rpc-permit

string

Задать разрешение RPC: none/read/read-write

read-write — Разрешение на чтение и запись.

none — Нет разрешения.

read — Разрешение только на чтение.

Варианты:

  • "read-write"
  • "none"
  • "read"

run_report

aliases: run-report

string

Запуск отчетов.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

scope

string

Область действия.

global — Глобальная область действия.

adom — Область действия ADOM.

Варианты:

  • "global"
  • "adom"

script_access

aliases: script-access

string

Доступ к сценариям.

none — Нет разрешения.

read — Разрешение на чтение.

read-write — Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

script_run

aliases: script-run

string

Запуск сценариев.

Варианты:

  • "none"
  • "read"
  • "read-write"

set_install_targets

aliases: set-install-targets

string

Редактирование целей установки.

none - Нет разрешения.

read - Разрешение на чтение.

read-write - Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

super_user_profile

aliases: super-user-profile

string

Включение/отключение профиля суперпользователя

disable - Отключить профиль суперпользователя

enable - Включить профиль суперпользователя

Варианты:

  • "disable"
  • "enable"

system_setting

aliases: system-setting

string

Системные настройки.

none - Нет разрешения.

read - Разрешение на чтение.

read-write - Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

term_access

aliases: term-access

string

Доступ к терминалу.

none - Нет разрешения.

read - Разрешение на чтение.

read-write - Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

triage_events

aliases: triage-events

string

Первичная обработка событий.

none - Нет разрешения.

read - Разрешение на чтение.

read-write - Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

trusthost1

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 0.

trusthost10

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost2

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost3

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost4

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost5

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost6

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost7

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost8

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

trusthost9

string

IP-адрес доверенного хоста пользователя-администратора, по умолчанию 255.

type

string

Тип профиля.

system - Системный администратор.

restricted - Администратор с ограниченными правами.

Варианты:

  • "system"
  • "restricted"

update_incidents

aliases: update-incidents

string

Создание/обновление инцидентов.

none - Нет разрешения.

read - Разрешение на чтение.

read-write - Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

vpn_manager

aliases: vpn-manager

string

Управление VPN.

none - Нет разрешения.

read - Разрешение на чтение.

read-write - Разрешение на чтение и запись.

Варианты:

  • "none"
  • "read"
  • "read-write"

web_filter

aliases: web-filter

string

Веб-фильтр.

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

write_passwd_access

aliases: write-passwd-access

string

Настройка режима доступа на запись пароля: all/specify-by-user/specify-by-profile.

all - Все, кроме суперпользователей.

specify-by-user - Указать пользователя.

specify-by-profile - Указать профиль.

Варианты:

  • "all"
  • "specify-by-user"
  • "specify-by-profile"

write_passwd_profiles

aliases: write-passwd-profiles

list / elements=dictionary

Профили записи пароля.

profileid

string

Идентификатор профиля.

write_passwd_user_list

aliases: write-passwd-user-list

list / elements=dictionary

Список пользователей с доступом на запись пароля.

userid

string

Идентификатор пользователя.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другие варианты, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчеркиваний (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Обычно выполнение модуля может завершиться ошибкой, если возвращено ненулевое значение rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Admin profile.
      fortinet.fortimanager.fmgr_system_admin_profile:
        bypass_validation: false
        state: present
        system_admin_profile:
          description: ansible-test-description
          profileid: ansible-test-profile
          scope: adom # <value in [global, adom]>
          type: system # <value in [system, restricted]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the admin profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_profile"
          params:
            profile: "your_value"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение появляется, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager.

Возвращается: при сложных условиях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_admin_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API