fortinet.fortimanager.fmgr_system_admin_user – Администратор пользователя.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_admin_user.

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка				список кодов rc, при которых условия будут нарушены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия будут выполнены
state строка / обязательно			Варианты: present absent	директива для создания, обновления или удаления объекта
system_admin_user словарь				параметры верхнего уровня
	adom список / элементы=строка			без описания
		adom-name строка		Имена административных доменов.
	adom-exclude список / элементы=строка			без описания
		adom-name строка		Имена административных доменов.
	app-filter список / элементы=строка			без описания
		app-filter-name строка		Имя фильтра приложений.
	avatar строка			Изображение аватара (максимум 4К в кодировке base64).
	ca строка			Сертификат CA пользователя PKI (имя CA в локальной системе).
	change-password строка		Варианты: отключить ← включить	Включить/выключить возможность изменения пароля ограниченным пользователем. отключить - Отключить настройку. включить - Включить настройку.
	dashboard список / элементы=строка			без описания
		column целое число	Значение по умолчанию: 0	ID колонки виджета.
		diskio-content-type строка	Варианты: util ← iops blks	Тип диаграммы виджета монитора ввода-вывода дисков. util - использование пропускной способности. iops - количество запросов ввода-вывода. blks - объем данных запросов ввода-вывода.
		diskio-period строка	Варианты: 1час ← 8час 24час	Период данных виджета монитора ввода-вывода дисков. 1час - 1 час. 8час - 8 часов. 24час - 24 часа.
		log-rate-period строка	Варианты: 2мин 1час 6час	Период данных виджета монитора получения логов. 2мин - 2 минуты. 1час - 1 час. 6час - 6 часов.
		log-rate-topn строка	Варианты: 1 2 3 4 5 ←	Количество отображаемых элементов по убыванию для виджета монитора получения логов. 1 - Топ 1. 2 - Топ 2. 3 - Топ 3. 4 - Топ 4. 5 - Топ 5.
		log-rate-type строка	Варианты: log device ←	Варианты для разбивки статистики в виджете монитора получения логов. log - Отобразить скорости логов для каждого типа лога. device - Отобразить скорости логов для каждого устройства.
		moduleid целое число	Значение по умолчанию: 0	ID виджета.
		name строка		Имя виджета.
		num-entries целое число	Значение по умолчанию: 10	Количество записей.
		refresh-interval целое число	Значение по умолчанию: 300	Интервал обновления виджетов.
		res-cpu-display строка	Варианты: среднее значение ← каждый	Тип отображения CPU виджета. среднее значение - Среднее использование CPU. каждый - Использование CPU каждого ядра.
		res-period строка	Варианты: 10 мин ← час день	Период данных виджета. 10 мин - Последние 10 минут. час - Последний час. день - Последний день.
		res-view-type строка	Варианты: реальное время история ←	Тип отображения данных виджета. реальное время - Режим реального времени. история - История.
		status строка	Варианты: закрыто открыто ←	Состояние открытия/закрытия виджета. закрыто - Виджет закрыт. открыто - Виджет открыт.
		tabid целое число	Значение по умолчанию: 0	ID вкладки, на которой отображается виджет.
		time-period строка	Варианты: 1час ← 8час 24час	Период данных виджета монитора базы данных логов. 1час - 1 час. 8час - 8 часов. 24час - 24 часа.
		widget-type строка	Варианты: top-lograte sysres sysinfo licinfo jsconsole sysop alert statistics rpteng raid logrecv devsummary logdb-perf logdb-lag disk-io log-rcvd-fwd	Тип виджета. 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 список / элементы=строка			без описания
		name строка		Имя вкладки.
		tabid целое число	Значение по умолчанию: 0	ID вкладки.
	description строка			Описание.
	dev-group строка			группа устройств.
	email-address строка			Электронный адрес.
	ext-auth-accprofile-override строка		Варианты: отключить ← включить	Разрешить использование профиля доступа, предоставленного удаленным сервером аутентификации. отключить - Отключить переопределение профиля доступа. включить - Включить переопределение профиля доступа.

END_OF_DOCUMENT_MARKER

ext-auth-adom-override string		Варианты: disable ← enable	Разрешить использование ADOM, предоставляемого удалённым сервером аутентификации. disable - Отключить переопределение ADOM. enable - Включить переопределение ADOM.
ext-auth-group-match string			Вход могут осуществлять только администраторы, принадлежащие к этой группе.
first-name string			Имя.
force-password-change string		Варианты: disable ← enable	Включить/отключить принудительную смену пароля при следующем входе. disable - Отключить настройку. enable - Включить настройку.
group string			Название группы.
hidden integer		По умолчанию: 0	Скрытый администратор.
ips-filter list / elements=string			нет описания
	ips-filter-name string		Имя фильтра IPS.
ipv6_trusthost1 string		По умолчанию: "::/0"	Доверенный IPv6-адрес хоста администратора, по умолчанию ::/0 для всех.
ipv6_trusthost10 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost2 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost3 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost4 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost5 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost6 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost7 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost8 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
ipv6_trusthost9 string		По умолчанию: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"	Доверенный IPv6-адрес хоста администратора, по умолчанию ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 для отсутствия.
last-name string			Фамилия.
ldap-server string			Название сервера LDAP.
meta-data list / elements=string			нет описания
	fieldlength integer	По умолчанию: 0	Длина поля.
	fieldname string		Имя поля.
	fieldvalue string		Значение поля.
	importance string	Варианты: optional ← required	Важность. optional - Это поле необязательное. required - Это поле обязательное.
	status string	Варианты: disabled enabled ←	Статус. disabled - Это поле отключено. enabled - Это поле включено.
mobile-number string			Мобильный номер.
pager-number string			Номер пейджера.
password string			нет описания
password-expire string			нет описания
phone-number string			Номер телефона.
policy-package list / elements=string			нет описания
	policy-package-name string		Имена пакетов политик.
profileid string		По умолчанию: "Restricted_User"	Идентификатор профиля.
radius_server string			Имя сервера RADIUS.
restrict-access string		Варианты: disable ← enable	Включить/отключить ограниченный доступ к VDOM разработки. disable - Отключить настройку. enable - Включить настройку.
restrict-dev-vdom list / elements=string			нет описания
	dev-vdom string		Устройство или VDOM устройства.
rpc-permit string		Варианты: read-write none ← read	установка none/read/read-write rpc-разрешений. read-write - Разрешение на чтение и запись. none - Отсутствует разрешение. read - Разрешение только на чтение.
ssh-public-key1 string			нет описания
ssh-public-key2 string			нет описания
ssh-public-key3 string			нет описания
subject string			Ограничения имени сертификата пользователя PKI.
tacacs-plus-server string			Имя сервера TACACS+.
trusthost1 string		По умолчанию: "0.0.0.0 0.0.0.0"	Доверенный IP-адрес хоста администратора, по умолчанию 0.0.0.0 0.0.0.0 для всех.
trusthost10 string		По умолчанию: "255.255.255.255 255.255.255.255"	Доверенный IP-адрес хоста администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
trusthost2 string		По умолчанию: "255.255.255.255 255.255.255.255"	Доверенный IP-адрес хоста администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.

	trusthost3 string		Значение по умолчанию: "255.255.255.255 255.255.255.255"	IP-адрес доверенного узла пользователя администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
	trusthost4 string		Значение по умолчанию: "255.255.255.255 255.255.255.255"	IP-адрес доверенного узла пользователя администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
	trusthost5 string		Значение по умолчанию: "255.255.255.255 255.255.255.255"	IP-адрес доверенного узла пользователя администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
	trusthost6 string		Значение по умолчанию: "255.255.255.255 255.255.255.255"	IP-адрес доверенного узла пользователя администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
	trusthost7 string		Значение по умолчанию: "255.255.255.255 255.255.255.255"	IP-адрес доверенного узла пользователя администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
	trusthost8 string		Значение по умолчанию: "255.255.255.255 255.255.255.255"	IP-адрес доверенного узла пользователя администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
	trusthost9 string		Значение по умолчанию: "255.255.255.255 255.255.255.255"	IP-адрес доверенного узла пользователя администратора, по умолчанию 255.255.255.255 255.255.255.255 для отсутствия.
	two-factor-auth string		Варианты: disable ← enable	Включить двухфакторную аутентификацию (сертификат + пароль). disable - Отключить двухфакторную аутентификацию. enable - Включить двухфакторную аутентификацию.
	user_type string		Варианты: local ← radius ldap tacacs-plus pki-auth group	Тип пользователя. local - Локальный пользователь. radius - Пользователь RADIUS. ldap - Пользователь LDAP. tacacs-plus - Пользователь TACACS+. pki-auth - Пользователь PKI. group - Пользователь группы.
	userid string			Имя пользователя.
	web-filter list / elements=string			Описание отсутствует
		web-filter-name string		Имя веб-фильтра.
	wildcard string		Варианты: disable ← enable	Включить/отключить аутентификацию по шаблону для удаленного доступа. 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 user.
     fmgr_system_admin_user:
        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_user:
           adom:
             -
                 adom-name: <value of string>
           adom-exclude:
             -
                 adom-name: <value of string>
           app-filter:
             -
                 app-filter-name: <value of string>
           avatar: <value of string>
           ca: <value of string>
           change-password: <value in [disable, enable]>
           dashboard:
             -
                 column: <value of integer>
                 diskio-content-type: <value in [util, iops, blks]>
                 diskio-period: <value in [1hour, 8hour, 24hour]>
                 log-rate-period: <value in [2min , 1hour, 6hours]>
                 log-rate-topn: <value in [1, 2, 3, ...]>
                 log-rate-type: <value in [log, device]>
                 moduleid: <value of integer>
                 name: <value of string>
                 num-entries: <value of integer>
                 refresh-interval: <value of integer>
                 res-cpu-display: <value in [average , each]>
                 res-period: <value in [10min , hour, day]>
                 res-view-type: <value in [real-time , history]>
                 status: <value in [close, open]>
                 tabid: <value of integer>
                 time-period: <value in [1hour, 8hour, 24hour]>
                 widget-type: <value in [top-lograte, sysres, sysinfo, ...]>
           dashboard-tabs:
             -
                 name: <value of string>
                 tabid: <value of integer>
           description: <value of string>
           dev-group: <value of string>
           email-address: <value of string>
           ext-auth-accprofile-override: <value in [disable, enable]>
           ext-auth-adom-override: <value in [disable, enable]>
           ext-auth-group-match: <value of string>
           first-name: <value of string>
           force-password-change: <value in [disable, enable]>
           group: <value of string>
           hidden: <value of integer>
           ips-filter:
             -
                 ips-filter-name: <value of string>
           ipv6_trusthost1: <value of string>
           ipv6_trusthost10: <value of string>
           ipv6_trusthost2: <value of string>
           ipv6_trusthost3: <value of string>
           ipv6_trusthost4: <value of string>
           ipv6_trusthost5: <value of string>
           ipv6_trusthost6: <value of string>
           ipv6_trusthost7: <value of string>
           ipv6_trusthost8: <value of string>
           ipv6_trusthost9: <value of string>
           last-name: <value of string>
           ldap-server: <value of string>
           meta-data:
             -
                 fieldlength: <value of integer>
                 fieldname: <value of string>
                 fieldvalue: <value of string>
                 importance: <value in [optional, required]>
                 status: <value in [disabled, enabled]>
           mobile-number: <value of string>
           pager-number: <value of string>
           password: <value of string>
           password-expire: <value of string>
           phone-number: <value of string>
           policy-package:
             -
                 policy-package-name: <value of string>
           profileid: <value of string>
           radius_server: <value of string>
           restrict-access: <value in [disable, enable]>
           restrict-dev-vdom:
             -
                 dev-vdom: <value of string>
           rpc-permit: <value in [read-write, none, read]>
           ssh-public-key1: <value of string>
           ssh-public-key2: <value of string>
           ssh-public-key3: <value of string>
           subject: <value of string>
           tacacs-plus-server: <value of string>
           trusthost1: <value of string>
           trusthost10: <value of string>
           trusthost2: <value of string>
           trusthost3: <value of string>
           trusthost4: <value of string>
           trusthost5: <value of string>
           trusthost6: <value of string>
           trusthost7: <value of string>
           trusthost8: <value of string>
           trusthost9: <value of string>
           two-factor-auth: <value in [disable, enable]>
           user_type: <value in [local, radius, ldap, ...]>
           userid: <value of string>
           web-filter:
             -
                 web-filter-name: <value of string>
           wildcard: <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_user_module.html