Модуль fortinet.fortios.fortios_system_admin — настройка учетных записей администраторов в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_admin.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системных функций и категории администрирования. Перед использованием необходимо скорректировать все параметры и значения в примерах с учетом источников данных. Проверено на FOS v6.0.0

Требования

На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, для которого выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path можно использовать для выполнения операции с элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_admin dictionary	Настройка учетных записей администраторов.
accprofile string	Профиль доступа для этого администратора. Профили доступа управляют доступом администратора к функциям FortiGate. Источник: system.accprofile.name.
accprofile_override string	Включите этот параметр, чтобы использовать имя профиля доступа, предоставленное сервером удаленной аутентификации, для управления функциями FortiGate, к которым может получить доступ этот администратор. Варианты: `"enable"` `"disable"`
allow_remove_admin_session string	Включить/отключить возможность удаления сеансов администратора пользователями с привилегиями администратора. Варианты: `"enable"` `"disable"`
comments string	Комментарий.
email_to string	Адрес электронной почты этого администратора.
force_password_change string	Включить/отключить требование сменить пароль при следующем входе в систему. Варианты: `"enable"` `"disable"`
fortitoken string	Серийный номер FortiToken этого администратора.
guest_auth string	Включить/отключить аутентификацию гостей. Варианты: `"disable"` `"enable"`
guest_lang string	Язык портала управления гостями. Источник: system.custom-language.name.
guest_usergroups list / элементы=dictionary	Выберите группы пользователей-гостей.
name string / обязательный	Выберите группы пользователей-гостей.
gui_dashboard list / элементы=dictionary	Панели мониторинга графического интерфейса.
columns integer	Количество столбцов.
id integer / обязательный	Идентификатор панели мониторинга. См. <a href=’#notes’>примечания</a>.
layout_type string	Тип макета. Варианты: `"responsive"` `"fixed"`
name string	Название панели мониторинга.
permanent string	Постоянная панель мониторинга (ее нельзя удалить через графический интерфейс). Варианты: `"disable"` `"enable"`
scope string	Область действия панели мониторинга. Варианты: `"global"` `"vdom"`
vdom string	Виртуальный домен. Источник: system.vdom.name.
widget list / элементы=dictionary	Виджеты панели мониторинга.
fabric_device string	Устройство Security Fabric для мониторинга.
fabric_device_widget_name string	Название виджета устройства Security Fabric.
fabric_device_widget_visualization_type string	Тип визуализации виджета устройства Security Fabric.
fortiview_device string	Устройство FortiView.
fortiview_filters list / элементы=dictionary	Фильтры FortiView.
id integer / обязательный	Идентификатор фильтра FortiView. См. <a href=’#notes’>примечания</a>.
key string	Ключ фильтра.
value string	Значение фильтра.
fortiview_sort_by string	Поле сортировки FortiView.
fortiview_timeframe string	Временной интервал FortiView.
fortiview_type string	Тип FortiView.
fortiview_visualization string	Визуализация FortiView.
height integer	Высота.
id integer / обязательный	Идентификатор виджета. См. <a href=’#notes’>примечания</a>.
industry string	Отрасль для оценки аудита безопасности. Варианты: `"default"` `"custom"`
interface string	Интерфейс для мониторинга. Источник: system.interface.name.
region string	Регион для оценки аудита безопасности. Варианты: `"default"` `"custom"`
title string	Заголовок виджета.
type string	Тип виджета. Варианты: `"sysinfo"` `"licinfo"` `"forticloud"` `"cpu-usage"` `"memory-usage"` `"disk-usage"` `"log-rate"` `"sessions"` `"session-rate"` `"tr-history"` `"analytics"` `"usb-modem"` `"admins"` `"security-fabric"` `"security-fabric-ranking"` `"sensor-info"` `"ha-status"` `"vulnerability-summary"` `"host-scan-summary"` `"fortiview"` `"botnet-activity"` `"fabric-device"` `"fortimail"`
width integer	Ширина.
x_pos integer	Позиция по оси X.
y_pos integer	Позиция по оси Y.
gui_global_menu_favorites list / элементы=dictionary	Идентификаторы избранных пунктов меню графического интерфейса для глобального VDOM.
id string / обязательный	Выберите идентификатор пункта меню.
gui_new_feature_acknowledge list / элементы=dictionary	Подтверждение ознакомления с новыми функциями.
id string / обязательный	Выберите идентификатор пункта меню.
gui_vdom_menu_favorites list / элементы=dictionary	Идентификаторы избранных пунктов меню графического интерфейса для VDOM.
id string / обязательный	Выберите идентификатор пункта меню.
hidden integer	Атрибут скрытия учетной записи администратора.
history0 string	history0
history1 string	history1
ip6_trusthost1 string	Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost10 string	Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost2 string	Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost3 string	Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost4 string	Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.

ip6_trusthost5 string	Любой адрес IPv6, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv6.
ip6_trusthost6 string	Любой адрес IPv6, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv6.
ip6_trusthost7 string	Любой адрес IPv6, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv6.
ip6_trusthost8 string	Любой адрес IPv6, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv6.
ip6_trusthost9 string	Любой адрес IPv6, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv6.
login_time list / elements=dictionary	Запись времени входа пользователя.
last_failed_login string	Время последнего неудачного входа.
last_login string	Время последнего успешного входа.
usr_name string / обязательный	Имя пользователя.
name string / обязательный	Имя пользователя.
password string	Пароль пользователя-администратора.
password_expire string	Время истечения срока действия пароля.
peer_auth string	Включить аутентификацию по сертификату узла (для доступа администратора по HTTPS). Варианты: `"enable"` `"disable"`
peer_group string	Имя группы узлов, определенной в config user group и содержащей участников PKI. Используется для аутентификации по сертификату узла (для доступа администратора по HTTPS).
radius_vdom_override string	Включить использование имен VDOM, предоставленных сервером удаленной аутентификации, для управления VDOM, к которым может получить доступ этот администратор. Варианты: `"enable"` `"disable"`
remote_auth string	Включить или отключить аутентификацию с помощью удаленного сервера RADIUS, LDAP или TACACS+. Варианты: `"enable"` `"disable"`
remote_group string	Имя группы пользователей для удаленной аутентификации.
schedule string	Расписание брандмауэра, ограничивающее время, когда администратор может входить в систему. Если расписание не задано, ограничения отсутствуют.
sms_custom_server string	Пользовательский SMS-сервер для отправки SMS-сообщений. Источник: system.sms-server.name.
sms_phone string	Номер телефона, на который администратор получает SMS-сообщения.
sms_server string	Отправлять SMS-сообщения через SMS-сервер FortiGuard или пользовательский сервер. Варианты: `"fortiguard"` `"custom"`
ssh_certificate string	Выберите сертификат, который FortiGate будет использовать для аутентификации SSH-клиента. Источник: certificate.remote.name.
ssh_public_key1 string	Открытый ключ SSH-клиента. Аутентификация клиента выполняется без запроса учетных данных. Создайте пару открытого и закрытого ключей в приложении SSH-клиента.
ssh_public_key2 string	Открытый ключ SSH-клиента. Аутентификация клиента выполняется без запроса учетных данных. Создайте пару открытого и закрытого ключей в приложении SSH-клиента.
ssh_public_key3 string	Открытый ключ SSH-клиента. Аутентификация клиента выполняется без запроса учетных данных. Создайте пару открытого и закрытого ключей в приложении SSH-клиента.
trusthost1 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost10 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost2 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost3 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost4 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost5 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost6 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost7 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost8 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
trusthost9 string	Любой адрес IPv4 или адрес подсети с маской подсети, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого адреса IPv4.
two_factor string	Включить или отключить двухфакторную аутентификацию. Варианты: `"disable"` `"fortitoken"` `"fortitoken-cloud"` `"email"` `"sms"`
two_factor_authentication string	Способ аутентификации с помощью FortiToken Cloud. Варианты: `"fortitoken"` `"email"` `"sms"`
two_factor_notification string	Способ уведомления пользователя об активации с помощью FortiToken Cloud. Варианты: `"email"` `"sms"`
vdom list / elements=dictionary	Виртуальный домен или домены, к которым администратор может получить доступ.
name string / обязательный	Имя виртуального домена. Источник: system.vdom.name.
vdom_override string	Включить использование имен VDOM, предоставленных сервером удаленной аутентификации, для управления VDOM, к которым может получить доступ этот администратор. Варианты: `"enable"` `"disable"`
wildcard string	Включить или отключить аутентификацию RADIUS с подстановочными символами. Варианты: `"enable"` `"disable"`
vdom string	Ранее определенный виртуальный домен. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревшая библиотека fortiosapi больше не поддерживается; предпочтительный способ запуска плейбуков — httpapi
Модуль поддерживает check_mode.

Примеры

- name: Configure admin users.
  fortinet.fortios.fortios_system_admin:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          accprofile_override: "enable"
          allow_remove_admin_session: "enable"
          comments: "<your_own_value>"
          email_to: "<your_own_value>"
          force_password_change: "enable"
          fortitoken: "<your_own_value>"
          guest_auth: "disable"
          guest_lang: "<your_own_value> (source system.custom-language.name)"
          guest_usergroups:
              -
                  name: "default_name_13"
          gui_dashboard:
              -
                  columns: "10"
                  id: "16"
                  layout_type: "responsive"
                  name: "default_name_18"
                  permanent: "disable"
                  scope: "global"
                  vdom: "<your_own_value> (source system.vdom.name)"
                  widget:
                      -
                          fabric_device: "<your_own_value>"
                          fabric_device_widget_name: "<your_own_value>"
                          fabric_device_widget_visualization_type: "<your_own_value>"
                          fortiview_device: "<your_own_value>"
                          fortiview_filters:
                              -
                                  id: "28"
                                  key: "<your_own_value>"
                                  value: "<your_own_value>"
                          fortiview_sort_by: "<your_own_value>"
                          fortiview_timeframe: "<your_own_value>"
                          fortiview_type: "<your_own_value>"
                          fortiview_visualization: "<your_own_value>"
                          height: "25"
                          id: "36"
                          industry: "default"
                          interface: "<your_own_value> (source system.interface.name)"
                          region: "default"
                          title: "<your_own_value>"
                          type: "sysinfo"
                          width: "25"
                          x_pos: "500"
                          y_pos: "500"
          gui_global_menu_favorites:
              -
                  id: "46"
          gui_new_feature_acknowledge:
              -
                  id: "48"
          gui_vdom_menu_favorites:
              -
                  id: "50"
          hidden: "127"
          history0: "<your_own_value>"
          history1: "<your_own_value>"
          ip6_trusthost1: "myhostname"
          ip6_trusthost10: "myhostname"
          ip6_trusthost2: "myhostname"
          ip6_trusthost3: "myhostname"
          ip6_trusthost4: "myhostname"
          ip6_trusthost5: "myhostname"
          ip6_trusthost6: "myhostname"
          ip6_trusthost7: "myhostname"
          ip6_trusthost8: "myhostname"
          ip6_trusthost9: "myhostname"
          login_time:
              -
                  last_failed_login: "<your_own_value>"
                  last_login: "<your_own_value>"
                  usr_name: "<your_own_value>"
          name: "default_name_68"
          password: "<your_own_value>"
          password_expire: "<your_own_value>"
          peer_auth: "enable"
          peer_group: "<your_own_value>"
          radius_vdom_override: "enable"
          remote_auth: "enable"
          remote_group: "<your_own_value>"
          schedule: "<your_own_value>"
          sms_custom_server: "<your_own_value> (source system.sms-server.name)"
          sms_phone: "<your_own_value>"
          sms_server: "fortiguard"
          ssh_certificate: "<your_own_value> (source certificate.remote.name)"
          ssh_public_key1: "<your_own_value>"
          ssh_public_key2: "<your_own_value>"
          ssh_public_key3: "<your_own_value>"
          trusthost1: "myhostname"
          trusthost10: "myhostname"
          trusthost2: "myhostname"
          trusthost3: "myhostname"
          trusthost4: "myhostname"
          trusthost5: "myhostname"
          trusthost6: "myhostname"
          trusthost7: "myhostname"
          trusthost8: "myhostname"
          trusthost9: "myhostname"
          two_factor: "disable"
          two_factor_authentication: "fortitoken"
          two_factor_notification: "email"
          vdom:
              -
                  name: "default_name_98 (source system.vdom.name)"
          vdom_override: "enable"
          wildcard: "enable"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат выполнения операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

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

© 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/fortios/fortios_system_admin_module.html