Модуль fortinet.fortios.fortios_system_admin — Настройка администраторов в FortiOS и FortiGate Fortinet.

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в интерфейсе Fortigate.
enable_log логический	Включить/выключить ведение журнала для задачи. Выбор: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов несколько. Параметр, помеченный как member_path, подходит для выполнения операций с членом.
member_state строка	Добавить или удалить члена по указанному пути к атрибуту. При указании member_state опция state игнорируется. Выбор: `"present"` `"absent"`
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Выбор: `"present"` `"absent"`
system_admin словарь	Настройка администраторов.
accprofile строка	Профиль доступа для этого администратора. Профили доступа контролируют доступ администратора к функциям FortiGate. Источник system.accprofile.name.
accprofile_override строка	Включить использование имени профиля доступа, предоставляемого удаленным сервером аутентификации, для управления функциями FortiGate, к которым может получить доступ этот администратор. Выбор: `"enable"` `"disable"`
allow_remove_admin_session строка	Включить/выключить возможность удаления сеанса администратора привилегированными администраторами. Выбор: `"enable"` `"disable"`
comments строка	Комментарий.
email_to строка	Электронный адрес этого администратора.
force_password_change строка	Включить/выключить принудительную смену пароля при следующей авторизации. Выбор: `"enable"` `"disable"`
fortitoken строка	Серийный номер FortiToken этого администратора.
guest_auth строка	Включить/выключить гостевую аутентификацию. Выбор: `"disable"` `"enable"`
guest_lang строка	Язык портала управления гостями. Источник system.custom-language.name.
guest_usergroups список / элементы=словарь	Выберите группы пользователей-гостей.
name строка / обязательно	Выберите группы пользователей-гостей.
gui_dashboard список / элементы=словарь	Панели управления графическим интерфейсом.
columns целое число	Количество столбцов.
id целое число / обязательно	Идентификатор панели управления. См. <a href=’#notes’>Примечания</a>.
layout_type строка	Тип макета. Выбор: `"responsive"` `"fixed"`
name строка	Название панели управления.

permanent string	Постоянная панель мониторинга (не может быть удалена через графический интерфейс). Choices: `"disable"` `"enable"`
scope string	Область действия панели мониторинга. Choices: `"global"` `"vdom"`
vdom string	Виртуальный домен. Источник system.vdom.name.
widget list / elements=dictionary	Виджеты панели мониторинга.
fabric_device string	Устройство Fabric для мониторинга.
fabric_device_widget_name string	Имя виджета устройства Fabric.
fabric_device_widget_visualization_type string	Тип визуализации для виджета устройства Fabric.
fortiview_device string	Устройство FortiView.
fortiview_filters list / elements=dictionary	Фильтры FortiView.
id integer / required	ID фильтра 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 / required	ID виджета. см. <a href=’#notes’>Примечания</a>.
industry string	Отрасль рейтинга аудита безопасности. Choices: `"default"` `"custom"`
interface string	Интерфейс для мониторинга. Источник system.interface.name.
region string	Регион рейтинга аудита безопасности. Choices: `"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 / elements=dictionary	Избранные ID пунктов меню GUI для глобального VDOM.
id string / required	Выберите ID меню.
gui_new_feature_acknowledge list / elements=dictionary	Подтверждение новых функций.
id string / required	Выберите ID меню.
gui_vdom_menu_favorites list / elements=dictionary	Избранные ID пунктов меню GUI для VDOM.
id string / required	Выберите ID меню.
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 / required	Имя пользователя.
name string / required	Имя пользователя.
password string	Пароль администратора.
password_expire string	Время истечения срока действия пароля.
peer_auth string	Установите для включения проверки подлинности с помощью сертификата узла (для доступа администратора HTTPS). Choices: `"enable"` `"disable"`
peer_group string	Имя группы узлов, определённой в группе пользователей конфигурации, которая имеет участников PKI. Используется для проверки подлинности с помощью сертификата узла (для доступа администратора HTTPS).
radius_vdom_override string	Включите, чтобы использовать имена VDOM, предоставленные удалённым сервером аутентификации, для управления VDOM, к которым может получить доступ этот администратор. Choices: `"enable"` `"disable"`
remote_auth string	Включить/отключить аутентификацию с использованием удалённого сервера RADIUS, LDAP или TACACS+. Choices: `"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-сообщений с помощью сервера FortiGuard SMS или пользовательского сервера. Choices: `"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 / required	Имя виртуального домена. Источник system.vdom.name.
vdom_override string	Включить, чтобы использовать имена VDOM, предоставленные удаленным сервером аутентификации, для управления VDOM, к которым может получить доступ этот администратор. Варианты: `"enable"` `"disable"`
wildcard string	Включить/выключить аутентификацию RADIUS с использованием подстановочных знаков. Варианты: `"enable"` `"disable"`
vdom string	Виртуальный домен, среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi был заменен, httpapi — предпочтительный способ запуска playbook'ов
Модуль поддерживает 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 строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_admin_module.html