Spec-Zone.ru › Ansible 2.9

fortios_system_admin – Настройка администраторских пользователей в Fortinet’s FortiOS и FortiGate

Новая версия с 2.8.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

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

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
строка
IP-адрес FortiOS или FortiGate.
https
логическое
    Варианты:
  • no
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
строка
Значение по умолчанию:
""
Пароль FortiOS или FortiGate.
ssl_verify
логическое
добавлен в 2.9
    Варианты:
  • no
  • да ←
Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации.
state
строка
добавлен в 2.9
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перемещён на этот внешний уровень.
system_admin
словарь
Значение по умолчанию:
null
Настройка администраторских пользователей.
accprofile
строка
Профиль доступа для этого администратора. Профили доступа контролируют доступ администратора к функциям FortiGate. Имя профиля доступа из системы источника.
accprofile_override
строка
    Варианты:
  • enable
  • disable
Включить использование имени профиля доступа, предоставленного сервером удаленной аутентификации, для управления функциями FortiGate, к которым может получить доступ этот администратор.
allow_remove_admin_session
строка
    Варианты:
  • enable
  • disable
Включить/выключить возможность удаления сессии администратора привилегированными пользователями.
comments
строка
Комментарий.
email_to
строка
Электронный адрес этого администратора.
force_password_change
строка
    Варианты:
  • enable
  • disable
Включить/выключить принудительную смену пароля при следующем входе.
fortitoken
строка
Серийный номер FortiToken этого администратора.
guest_auth
строка
    Варианты:
  • disable
  • enable
Включить/выключить гостевую аутентификацию.
guest_lang
строка
Язык портала управления гостями. Имя пользовательского языка из системы источника.
guest_usergroups
список
Выбор групп гостевых пользователей.
name
строка / обязательно
Выбор групп гостевых пользователей.
gui_dashboard
список
Панели управления GUI.
columns
целое число
Количество столбцов.
id
целое число / обязательно
ID панели управления.
layout_type
строка
    Варианты:
  • responsive
  • fixed
Тип макета.
name
строка
Название панели управления.
scope
строка
    Варианты:
  • global
  • vdom
Область действия панели управления.
widget
список
Виджеты панели управления.
fabric_device
строка
Устройство Fabric для мониторинга.
fortiview_filters
список
Фильтры FortiView.
id
целое число / обязательно
ID фильтра FortiView.
key
строка
Ключ фильтра.
value
строка
Значение фильтра.
fortiview_sort_by
строка
Сортировка FortiView.
fortiview_timeframe
строка
Временной интервал FortiView.
fortiview_type
строка
Тип FortiView.
fortiview_visualization
строка
Визуализация FortiView.
height
целое число
Высота.
id
целое число / обязательно
ID виджета.
industry
строка
    Варианты:
  • default
  • custom
Отрасль рейтинга аудита безопасности.
interface
строка
Интерфейс для мониторинга. Имя интерфейса из системы источника.
region
строка
    Варианты:
  • default
  • custom
Регион рейтинга аудита безопасности.
Название
строка
Название виджета.
Тип
строка
    Варианты:
  • sysinfo
  • licinfo
  • vminfo
  • forticloud
  • cpu-usage
  • memory-usage
  • disk-usage
  • log-rate
  • sessions
  • session-rate
  • tr-history
  • analytics
  • usb-modem
  • admins
  • security-fabric
  • security-fabric-ranking
  • ha-status
  • vulnerability-summary
  • host-scan-summary
  • fortiview
  • botnet-activity
  • fortimail
Тип виджета.
Ширина
целое число
Ширина.
x_pos
целое число
Положение по оси X.
y_pos
целое число
Положение по оси Y.
gui_global_menu_favorites
список
Избранные идентификаторы меню глобального VDOM для графического интерфейса.
id
строка / обязательно
Выберите идентификатор меню.
gui_vdom_menu_favorites
список
Избранные идентификаторы меню графического интерфейса для VDOM.
id
строка / обязательно
Выберите идентификатор меню.
hidden
целое число
Скрытый атрибут для администратора.
history0
строка
history0
history1
строка
history1
ip6_trusthost1
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost10
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost2
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost3
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost4
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost5
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost6
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost7
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost8
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
ip6_trusthost9
строка
Любой IPv6-адрес, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv6-адреса.
login_time
список
Запись времени входа пользователя.
last_failed_login
строка
Время последней неудачной попытки входа.
last_login
строка
Время последнего успешного входа.
usr_name
строка
Имя пользователя.
name
строка / обязательно
Имя пользователя.
password
строка
Пароль администратора.
password_expire
строка
Время истечения срока действия пароля.
peer_auth
строка
    Варианты:
  • enable
  • disable
Установить для включения проверки подлинности по сертификату участника (для доступа к административной панели по HTTPS).
peer_group
строка
Имя группы участников, определенной в группе пользователей config, имеющей членов PKI. Используется для проверки подлинности по сертификату участника (для доступа к административной панели по HTTPS).
radius_vdom_override
строка
    Варианты:
  • enable
  • disable
Включить, чтобы использовать имена VDOM, предоставленные удаленным сервером проверки подлинности, для управления VDOM, к которым может получить доступ этот администратор.
remote_auth
строка
    Варианты:
  • enable
  • disable
Включить/выключить проверку подлинности с использованием удаленного сервера RADIUS, LDAP или TACACS+.
remote_group
строка
Имя группы пользователей, используемой для удаленной проверки подлинности.
schedule
строка
Расписание брандмауэра, используемое для ограничения времени входа администратора. Отсутствие расписания означает отсутствие ограничений.
sms_custom_server
строка
Пользовательский SMS-сервер для отправки SMS-сообщений. Система sms-server.name.
sms_phone
строка
Номер телефона, на который администратор получает SMS-сообщения.
sms_server
строка
    Варианты:
  • fortiguard
  • custom
Отправка SMS-сообщений с использованием сервера FortiGuard SMS или пользовательского сервера.
ssh_certificate
строка
Выберите сертификат, который будет использоваться FortiGate для проверки подлинности с SSH-клиентом. Источник certificate.local.name.
ssh_public_key1
строка
Открытый ключ SSH-клиента. Клиент аутентифицируется без запроса учетных данных. Создайте пару открытый-закрытый ключ в приложении SSH-клиента.
ssh_public_key2
строка
Открытый ключ SSH-клиента. Клиент аутентифицируется без запроса учетных данных. Создайте пару открытый-закрытый ключ в приложении SSH-клиента.
ssh_public_key3
строка
Открытый ключ SSH-клиента. Клиент аутентифицируется без запроса учетных данных. Создайте пару открытый-закрытый ключ в приложении SSH-клиента.
state
строка
    Варианты:
  • present
  • absent
Устарело
Начиная с Ansible 2.9, рекомендуется использовать параметр "state" на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
trusthost1
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost10
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost2
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost3
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost4
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost5
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost6
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost7
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost8
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
trusthost9
строка
Любой IPv4-адрес или адрес подсети с маской, с которого администратор может подключиться к устройству FortiGate. По умолчанию доступ разрешен с любого IPv4-адреса.
two_factor
строка
    Варианты:
  • disable
  • fortitoken
  • email
  • sms
Включить/выключить двухфакторную аутентификацию.
vdom
список
Виртуальная(ые) домен(ы), к которым может получить доступ администратор.
name
строка / обязательно
Имя виртуального домена. Имя домена vdom системного источника.
wildcard
строка
    Варианты:
  • enable
  • disable
Включить/выключить аутентификацию RADIUS с подстановкой wildcard.
username
строка
Имя пользователя FortiOS или FortiGate.
vdom
строка
По умолчанию:
"root"
Виртуальный домен, среди ранее определённых. Vdom - виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Выполняется как local_action в вашем плейбуке

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure admin users.
    fortios_system_admin:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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: "15"
            id:  "16"
            layout_type: "responsive"
            name: "default_name_18"
            scope: "global"
            widget:
             -
                fabric_device: "<your_own_value>"
                fortiview_filters:
                 -
                    id:  "23"
                    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: "30"
                id:  "31"
                industry: "default"
                interface: "<your_own_value> (source system.interface.name)"
                region: "default"
                title: "<your_own_value>"
                type: "sysinfo"
                width: "37"
                x_pos: "38"
                y_pos: "39"
        gui_global_menu_favorites:
         -
            id:  "41"
        gui_vdom_menu_favorites:
         -
            id:  "43"
        hidden: "44"
        history0: "<your_own_value>"
        history1: "<your_own_value>"
        ip6_trusthost1: "<your_own_value>"
        ip6_trusthost10: "<your_own_value>"
        ip6_trusthost2: "<your_own_value>"
        ip6_trusthost3: "<your_own_value>"
        ip6_trusthost4: "<your_own_value>"
        ip6_trusthost5: "<your_own_value>"
        ip6_trusthost6: "<your_own_value>"
        ip6_trusthost7: "<your_own_value>"
        ip6_trusthost8: "<your_own_value>"
        ip6_trusthost9: "<your_own_value>"
        login_time:
         -
            last_failed_login: "<your_own_value>"
            last_login: "<your_own_value>"
            usr_name: "<your_own_value>"
        name: "default_name_61"
        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.local.name)"
        ssh_public_key1: "<your_own_value>"
        ssh_public_key2: "<your_own_value>"
        ssh_public_key3: "<your_own_value>"
        trusthost1: "<your_own_value>"
        trusthost10: "<your_own_value>"
        trusthost2: "<your_own_value>"
        trusthost3: "<your_own_value>"
        trusthost4: "<your_own_value>"
        trusthost5: "<your_own_value>"
        trusthost6: "<your_own_value>"
        trusthost7: "<your_own_value>"
        trusthost8: "<your_own_value>"
        trusthost9: "<your_own_value>"
        two_factor: "disable"
        vdom:
         -
            name: "default_name_89 (source system.vdom.name)"
        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
строка
всегда
Указание результата операции

Пример:
успех
vdom
строка
всегда
Использованный виртуальный домен

Пример:
root
version
строка
всегда
Версия FortiGate

Пример:
v5.6.3


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_admin_module.html

Spec-Zone.ru

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