Модуль fortinet.fortimanager.fmgr_system_admin_user — пользователь-администратор.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_system_admin_user.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах указаны все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, для которых будут переопределены условия успеха. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
system_admin_user dictionary | Параметры верхнего уровня. |
|
adom list / elements=dictionary |
ADOM. |
|
adom_name aliases: adom-name string |
Имена административных доменов. |
|
adom_access aliases: adom-access string |
Установить режим доступа к ADOM: все, указанные или исключенные. all — доступ ко всем ADOM. specify — доступ к указанным ADOM. exclude — исключить доступ к ADOM. Варианты:
|
|
adom_exclude aliases: adom-exclude list / elements=dictionary |
Исключение ADOM. |
|
adom_name aliases: adom-name string |
Имена административных доменов. |
|
app_filter aliases: app-filter list / elements=dictionary |
Фильтр приложений. |
|
app_filter_name aliases: app-filter-name string |
Имя фильтра приложений. |
|
autoreg_user aliases: autoreg-user string |
Пользователь автоматической регистрации. Варианты:
|
|
avatar string |
Файл изображения для аватара |
|
ca string |
Центр сертификации (CA) сертификата пользователя PKI |
|
change_password aliases: change-password string |
Разрешить или запретить пользователю с ограниченными правами менять собственный пароль. disable — отключить настройку. enable — включить настройку. Варианты:
|
|
cors_allow_origin aliases: cors-allow-origin string |
Access-Control-Allow-Origin. |
|
dashboard list / elements=dictionary |
Панель мониторинга. |
|
column integer |
Идентификатор столбца виджетов. |
|
diskio_content_type aliases: diskio-content-type string |
Тип диаграммы виджетов мониторинга дискового ввода-вывода. util — использование пропускной способности. iops — количество запросов ввода-вывода. blks — объем данных запросов ввода-вывода. Варианты:
|
|
diskio_period aliases: diskio-period string |
Период данных виджетов мониторинга дискового ввода-вывода. 1hour — 1 час. 8hour — 8 часов. 24hour — 24 часа. Варианты:
|
|
log_rate_period aliases: log-rate-period string |
Период данных виджетов мониторинга приема журналов. 2min — 2 минуты. 1hour — 1 час. 6hours — 6 часов. Варианты:
|
|
log_rate_topn aliases: log-rate-topn string |
Количество верхних элементов, отображаемых в виджетах мониторинга приема журналов. 1 — первый элемент. 2 — первые 2 элемента. 3 — первые 3 элемента. 4 — первые 4 элемента. 5 — первые 5 элементов. Варианты:
|
|
log_rate_type aliases: log-rate-type string |
Параметры детализации статистики в виджетах мониторинга приема журналов. log — показывать скорость приема журналов для каждого типа журнала. device — показывать скорость приема журналов для каждого устройства. Варианты:
|
|
moduleid integer |
Идентификатор виджета. |
|
name string |
Имя виджета. |
|
num_entries aliases: num-entries integer |
Количество записей. |
|
refresh_interval aliases: refresh-interval integer |
Интервал обновления виджетов. |
|
res_cpu_display aliases: res-cpu-display string |
Тип отображения загрузки ЦП в виджетах. average — средняя загрузка ЦП. each — загрузка каждого ядра ЦП. Варианты:
|
|
res_period aliases: res-period string |
Период данных виджетов. 10min — последние 10 минут. hour — последний час. day — последний день. Варианты:
|
|
res_view_type aliases: res-view-type string |
Тип представления данных виджетов. real-time — представление в реальном времени. history — представление истории. Варианты:
|
|
status string |
Состояние виджета: открыт или закрыт. close — виджет закрыт. open — виджет открыт. Варианты:
|
|
tabid integer |
Идентификатор вкладки, на которой отображается виджет. |
|
time_period aliases: time-period string |
Период данных виджетов мониторинга базы данных журналов. 1hour — 1 час. 8hour — 8 часов. 24hour — 24 часа. Варианты:
|
|
widget_type aliases: widget-type string |
Тип виджета. top-lograte — мониторинг приема журналов. sysres — системные ресурсы. sysinfo — информация о системе. licinfo — информация о лицензии. jsconsole — консоль CLI. sysop — работа устройства. alert — консоль оповещений. statistics — статистика. rpteng — механизм отчетов. raid — мониторинг дисков. logrecv — полученные журналы и данные. devsummary — сводка по устройствам. logdb-perf — мониторинг производительности базы данных журналов. logdb-lag — задержка базы данных журналов. disk-io — дисковый ввод-вывод. log-rcvd-fwd — мониторинг приема и пересылки журналов. Варианты:
|
|
dashboard_tabs aliases: dashboard-tabs list / elements=dictionary |
Вкладки панели мониторинга. |
|
name string |
Имя вкладки. |
|
tabid integer |
Идентификатор вкладки. |
|
description string |
Описание. |
|
dev_group aliases: dev-group string |
Группа устройств. |
|
email_address aliases: email-address string |
|
|
ext_auth_accprofile_override aliases: ext-auth-accprofile-override string |
Разрешить использование профиля доступа, предоставленного сервером удаленной аутентификации. disable — отключить переопределение профиля доступа. enable — включить переопределение профиля доступа. Варианты:
|
|
ext_auth_adom_override aliases: ext-auth-adom-override string |
Разрешить использование ADOM, предоставленного сервером удаленной аутентификации. disable — отключить переопределение ADOM. enable — включить переопределение ADOM. Варианты:
|
|
ext_auth_group_match aliases: ext-auth-group-match string |
Войти могут только администраторы, принадлежащие к этой группе. |
|
fingerprint string |
Отпечаток сертификата пользователя PKI |
|
first_name aliases: first-name string |
Имя. |
|
force_password_change aliases: force-password-change string |
Включить или отключить принудительную смену пароля при следующем входе в систему. disable — отключить параметр. enable — включить параметр. Возможные значения:
|
|
fortiai string |
Включить или отключить FortiAI. disable — отключить параметр. enable — включить параметр. Возможные значения:
|
|
group string |
Имя группы. |
|
integer |
Скрытый администратор. |
|
ips_filter aliases: ips-filter list / elements=dictionary |
Фильтр IPS. |
|
ips_filter_name aliases: ips-filter-name string |
Имя фильтра IPS. |
|
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 |
|
last_name aliases: last-name string |
Фамилия. |
|
ldap_server aliases: ldap-server string |
Имя сервера LDAP. |
|
login_max aliases: login-max integer |
Максимальное количество сеансов входа для этого пользователя. |
|
meta_data aliases: meta-data list / elements=dictionary |
Метаданные. |
|
fieldlength integer |
Длина поля. |
|
fieldname string |
Имя поля. |
|
fieldvalue string |
Значение поля. |
|
importance string |
Обязательность. optional — это поле необязательное. required — это поле обязательное. Возможные значения:
|
|
status string |
Состояние. disabled — это поле отключено. enabled — это поле включено. Возможные значения:
|
|
mobile_number aliases: mobile-number string |
Номер мобильного телефона. |
|
old_password aliases: old-password string |
Старый пароль. |
|
pager_number aliases: pager-number string |
Номер пейджера. |
|
password any |
(список) Пароль. |
|
password_expire aliases: password-expire any |
(список или строка) Время истечения срока действия пароля по Гринвичу. |
|
phone_number aliases: phone-number string |
Номер телефона. |
|
policy_block aliases: policy-block list / elements=dictionary |
Блок политик. |
|
policy_block_name aliases: policy-block-name string |
Имена блоков политик. |
|
policy_package aliases: policy-package list / elements=dictionary |
Пакет политик. |
|
policy_package_name aliases: policy-package-name string |
Имена пакетов политик. |
|
profileid string |
Идентификатор профиля. |
|
radius_server string |
Имя сервера RADIUS. |
|
restrict_access aliases: restrict-access string |
Включить или отключить ограниченный доступ к VDOM разработки. disable — отключить параметр. enable — включить параметр. Возможные значения:
|
|
restrict_dev_vdom aliases: restrict-dev-vdom list / elements=dictionary |
Ограничение VDOM разработки. |
|
dev_vdom aliases: dev-vdom string |
Устройство или VDOM устройства. |
|
rpc_permit aliases: rpc-permit string |
Задать разрешение RPC: none/read/read-write. read-write — разрешение на чтение и запись. none — нет разрешений. read — разрешение только на чтение. Возможные значения:
|
|
ssh_public_key1 aliases: ssh-public-key1 any |
(список) Открытый ключ SSH 1. |
|
ssh_public_key2 aliases: ssh-public-key2 any |
(список) Открытый ключ SSH 2. |
|
ssh_public_key3 aliases: ssh-public-key3 any |
(список) Открытый ключ SSH 3. |
|
subject string |
Ограничения имени субъекта сертификата пользователя PKI. |
|
tacacs_plus_server aliases: tacacs-plus-server string |
Имя сервера TACACS+. |
|
th6_from_profile aliases: th6-from-profile integer |
Только для внутреннего использования |
|
th_from_profile aliases: th-from-profile integer |
Только для внутреннего использования |
|
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. |
|
two_factor_auth aliases: two-factor-auth string |
Включить двухфакторную аутентификацию disable — отключить двухфакторную аутентификацию. enable — включить двухфакторную аутентификацию. Возможные значения:
|
|
use_global_theme aliases: use-global-theme string |
Включение/отключение глобальной темы графического интерфейса администрирования. disable — отключить настройку. enable — включить настройку. Варианты:
|
|
user_theme aliases: user-theme string |
Цветовая схема графического интерфейса пользователя-администратора. blue — Черника green — Киви red — Вишня melongene — Слива spring — Весна summer — Лето autumn — Осень winter — Зима circuit-board — Печатная плата calla-lily — Калла binary-tunnel — Двоичный туннель mars — Марс blue-sea — Синее море technology — Технологии landscape — Пейзаж twilight — Сумерки canyon — Каньон northern-light — Северное сияние astronomy — Астрономия fish — Рыба penguin — Пингвин mountain — Гора panda — Панда parrot — Попугай cave — Пещера zebra — Зебра contrast-dark — Высококонтрастная тёмная Варианты:
|
|
user_type string |
Тип пользователя. local — локальный пользователь. radius — пользователь RADIUS. ldap — пользователь LDAP. tacacs-plus — пользователь TACACS+. pki-auth — пользователь PKI. group — пользователь группы. Варианты:
|
|
userid string / обязательный |
Имя пользователя. |
|
web_filter aliases: web-filter list / elements=dictionary |
Веб-фильтр. |
|
web_filter_name aliases: web-filter-name string |
Имя веб-фильтра. |
|
wildcard string |
Включение/отключение удалённой аутентификации с подстановочными знаками. disable — отключить подстановочные знаки в имени пользователя. enable — включить подстановочные знаки в имени пользователя. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие значения, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 User
fortinet.fortimanager.fmgr_system_admin_user:
state: present
system_admin_user:
adom:
- adom_name: ansible
userid: "ansible-test"
- name: Admin domain.
fortinet.fortimanager.fmgr_system_admin_user_adom:
bypass_validation: false
user: ansible-test # userid
state: present
system_admin_user_adom:
adom_name: "ALL ADOMS"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение появляется, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_user_module.html