Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
  • Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_token

строка

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

bypass_validation

булево

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

Варианты:

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

enable_log

булево

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

Варианты:

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

forticloud_access_token

строка

Авторизовать клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

строка

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

Варианты:

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

rc_failed

список / элементы=целое

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

rc_succeeded

список / элементы=целое

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

state

строка / обязательно

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

Варианты:

  • "present"
  • "absent"

system_admin_profile

словарь

Настройка верхнего уровня параметров.

adom-admin

строка

Устарело, пожалуйста, переименуйте на adom_admin.

Включить Adom Admin.

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

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

Варианты:

  • "disable"
  • "enable"

adom-lock

строка

Устарело, пожалуйста, переименуйте на adom_lock.

Блокировка ADOM

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

adom-policy-packages

строка

Устарело, пожалуйста, переименуйте на adom_policy_packages.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

adom-switch

строка

Устарело, пожалуйста, переименуйте на adom_switch.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

allow-to-install

строка

Устарело, пожалуйста, переименуйте на allow_to_install.

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

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

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

Варианты:

  • "disable"
  • "enable"

app-filter

строка

Устарело, пожалуйста, переименуйте на app_filter.

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

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

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

Варианты:

  • "disable"
  • "enable"

assignment

строка

Права доступа на задание.

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

change-password

строка

Устарело, пожалуйста, переименуйте на change_password.

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

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

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

Варианты:

  • "disable"
  • "enable"

config-retrieve

string

Устарело, переименуйте в config_retrieve.

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

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

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

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

Варианты:

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

config-revert

string

Устарело, переименуйте в config_revert.

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

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

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

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

Варианты:

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

consistency-check

string

Устарело, переименуйте в consistency_check.

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

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

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

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

Варианты:

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

datamask

string

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

disable - Отключить маскировку данных.

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

Варианты:

  • "disable"
  • "enable"

datamask-custom-fields

list / elements=dictionary

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

field-category

list / elements=string

Устарело, переименуйте в field_category.

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

log - Журнал.

fortiview - FortiView.

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

ueba - UEBA.

all - Все.

Варианты:

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

field-name

string

Устарело, переименуйте в field_name. Имя поля.

field-status

string

Устарело, переименуйте в field_status.

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

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

enable - Включить поле.

Варианты:

  • "disable"
  • "enable"

field-type

string

Устарело, переименуйте в field_type.

Тип поля.

string - Строка.

ip - IP-адрес.

mac - MAC-адрес.

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

unknown - Неизвестно.

Варианты:

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

datamask-custom-priority

string

Устарело, переименуйте в datamask_custom_priority.

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

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

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

Варианты:

  • "disable"
  • "enable"

datamask-fields

list / elements=string

Устарело, переименуйте в datamask_fields.

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

user - Имя пользователя.

srcip - Исходный IP-адрес.

srcname - Исходное имя.

srcmac - Исходный MAC-адрес.

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

dstname - Имя назначения.

email - Электронная почта.

message - Сообщение.

domain - Домен.

Варианты:

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

datamask-key

any

(list) Устарело, переименуйте в datamask_key. Ключ шифрования маскировки данных.

datamask-unmasked-time

integer

Устарело, переименуйте в datamask_unmasked_time. Время в днях без маскировки данных.

deploy-management

string

Устарело, переименуйте в deploy_management.

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

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

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

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

Варианты:

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

description

string

Описание.

device-ap

string

Устарело, переименуйте в device_ap.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-config

string

Устарело, переименуйте в device_config.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-forticlient

string

Устарело, переименуйте в device_forticlient.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-fortiextender

string

Устарело, переименуйте в device_fortiextender.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-fortiswitch

string

Устарело, переименуйте в device_fortiswitch.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-manager

string

Устарело, переименуйте в device_manager.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-op

string

Устарело, переименуйте в device_op.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-policy-package-lock

string

Устарело, переименуйте в device_policy_package_lock.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-profile

string

Устарело, переименуйте в device_profile.

Права на профиль устройства.

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-revision-deletion

string

Устарело, переименуйте в device_revision_deletion.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

device-wan-link-load-balance

string

Устарело, переименуйте в device_wan_link_load_balance.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

event-management

string

Устарело, переименуйте в event_management.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

extension-access

string

Устарело, переименуйте в extension_access.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

fabric-viewer

string

Устарело, переименуйте в fabric_viewer.

Просмотрщик Fabric.

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

fgd-center-advanced

string

Устарело, переименуйте в fgd_center_advanced.

FortiGuard Center Advanced.

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

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

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

Варианты:

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

fgd-center-fmw-mgmt

string

Устарело, переименуйте в fgd_center_fmw_mgmt.

FortiGuard Center Firmware Management.

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

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

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

Варианты:

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

fgd-center-licensing

string

Устарело, переименуйте в fgd_center_licensing.

FortiGuard Center Licensing.

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

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

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

Варианты:

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

fgd_center

string

FortiGuard Center.

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

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

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

Варианты:

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

fgt-gui-proxy

string

Устарело, переименуйте в fgt_gui_proxy.

FortiGate GUI proxy.

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

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

Варианты:

  • "disable"
  • "enable"

global-policy-packages

string

Устарело, переименуйте в global_policy_packages.

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

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

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

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

Варианты:

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

import-policy-packages

string

Устарело, переименуйте в import_policy_packages.

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

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

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

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

Варианты:

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

intf-mapping

string

Устарело, переименуйте в intf_mapping.

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

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

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

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

Варианты:

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

ips-baseline-cfg

string

Устарело, переименуйте в ips_baseline_cfg.

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

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

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

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

Варианты:

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

ips-baseline-ovrd

string

Устарело, переименуйте в ips_baseline_ovrd.

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

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

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

Варианты:

  • "disable"
  • "enable"

ips-filter

string

Устарело, переименуйте в ips_filter.

Фильтр IPS.

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

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

Варианты:

  • "disable"
  • "enable"

ips-lock

string

Устарело, переименуйте в ips_lock.

Блокировка IPS

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

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

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

Варианты:

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

ips-objects

string

Устарело, переименуйте в ips_objects.

Конфигурация объектов 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

string

Устарело, переименуйте в log_viewer.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

policy-ips-attrs

string

Устарело, переименуйте в policy_ips_attrs.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

policy-objects

string

Устарело, переименуйте в policy_objects.

Права на объекты политик.

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

profileid

string / required

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

read-passwd

string

Устарело, переименуйте в read_passwd.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

realtime-monitor

string

Устарело, переименуйте в realtime_monitor.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

report-viewer

string

Устарело, переименуйте в report_viewer.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

rpc-permit

string

Устарело, переименуйте в rpc_permit.

Установить права rpc none/read/read-write

read-write - Права на чтение и запись.

none - Нет прав.

read - Права только на чтение.

Варианты:

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

run-report

string

Устарело, переименуйте в run_report.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

scope

string

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

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

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

Варианты:

  • "global"
  • "adom"

script-access

string

Устарело, переименуйте в script_access.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Варианты:

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

set-install-targets

string

Устарело, переименуйте в set_install_targets.

Изменить целевые объекты установки.

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

super-user-profile

string

Устарело, переименуйте в super_user_profile.

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

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

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

Choices:

  • "disable"
  • "enable"

system-setting

string

Устарело, переименуйте в system_setting.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

term-access

string

Устарело, переименуйте в term_access.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

triage-events

string

Устарело, переименуйте в triage_events.

События триажа.

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

  • "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 - Администратор с ограниченными правами.

Choices:

  • "system"
  • "restricted"

update-incidents

string

Устарело, переименуйте в update_incidents.

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

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

vpn-manager

string

Устарело, переименуйте в vpn_manager.

Менеджер VPN.

none - Нет прав.

read - Права на чтение.

read-write - Права на чтение и запись.

Choices:

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

web-filter

string

Устарело, переименуйте в web_filter.

Веб-фильтр.

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

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

Choices:

  • "disable"
  • "enable"

write-passwd-access

string

Устаревшее, пожалуйста, переименуйте на write_passwd_access.

Установить режим доступа к паролям для всех/указать по пользователю/указать по профилю.

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

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

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

Варианты:

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

write-passwd-profiles

list / elements=dictionary

Устаревшее, пожалуйста, переименуйте на write_passwd_profiles. Профили записи паролей.

profileid

string

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

write-passwd-user-list

list / elements=dictionary

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

userid

string

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

workspace_locking_adom

string

ADOM для блокировки рабочего пространства FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 помогают выполнить эту задачу.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой rc. Также вы можете переопределить условия завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_admin_profile_module.html

Spec-Zone.ru

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