Spec-Zone.ru › Ansible 2.9

fortios_user_group – Настройка групп пользователей в FortiOS и FortiGate Fortinet

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

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

Описание

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

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
строка
IP-адрес FortiOS или FortiGate.
https
логическое
    Варианты:
  • нет
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
строка
Значение по умолчанию:
""
Пароль FortiOS или FortiGate.
ssl_verify
логическое
    Варианты:
  • нет
  • да ←
Обеспечивает, что сертификат FortiGate должен быть проверен надлежащим центром сертификации.
state
строка / обязательно
    Варианты:
  • присутствует
  • отсутствует
Указывает, нужно ли создать или удалить объект.
user_group
словарь
Значение по умолчанию:
null
Настройка пользовательских групп.
auth_concurrent_override
строка
    Варианты:
  • включить
  • выключить
Включить/выключить переопределение общего числа одновременных сессий аутентификации для этой пользовательской группы.
auth_concurrent_value
целое число
Максимальное количество одновременных аутентифицированных подключений на пользователя (0 - 100).
authtimeout
целое число
Таймаут аутентификации в минутах для этой пользовательской группы. 0 для использования глобального пользовательского параметра auth-timeout.
company
строка
    Варианты:
  • необязательно
  • обязательно
  • выключено
Установите действие для поля гостевого пользователя компании.
email
строка
    Варианты:
  • выключить
  • включить
Включить/выключить поле адреса электронной почты гостевого пользователя.
expire
целое число
Время в секундах, прежде чем учетные записи гостевых пользователей истекают. (1 - 31536000 сек)
expire_type
строка
    Варианты:
  • немедленно
  • первый-успешный-вход
Определите, когда начинается обратный отсчет истечения срока действия.
group_type
строка
    Варианты:
  • брандмауэр
  • fsso-сервис
  • rsso
  • гость
Установите группу для аутентификации брандмауэра, FSSO, RSSO или гостевых пользователей.
guest
список
Гостевой пользователь.
comment
строка
Комментарий.
company
строка
Установите действие для поля гостевого пользователя компании.
email
строка
Электронная почта.
expiration
строка
Время истечения срока действия.
mobile_phone
строка
Мобильный телефон.
name
строка
Имя гостевого пользователя.
password
строка
Пароль гостевого пользователя.
sponsor
строка
Установите действие для поля спонсора гостевого пользователя.
user_id
строка
Идентификатор гостевого пользователя.
http_digest_realm
строка
Атрибут домена для аутентификации MD5-digest.
id
целое число
Идентификатор группы.
match
список
Совпадения групп.
group_name
строка
Имя совпадающей группы на удаленном сервере аутентификации.
id
целое число / обязательно
Идентификатор.
server_name
строка
Имя удаленного сервера аутентификации. Источник пользователя.radius.name user.ldap.name user.tacacs+.name.
max_accounts
целое число
Максимальное количество учетных записей гостевых пользователей, которые могут быть созданы для этой группы (0 означает неограниченное).
member
список
Имена пользователей, коллег, серверов LDAP или серверов RADIUS для добавления в пользовательскую группу.
name
строка / обязательно
Имя участника группы. Источник user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.adgrp.name user .pop3.name.
mobile_phone
строка
    Варианты:
  • выключить
  • включить
Включить/выключить поле номера мобильного телефона гостевого пользователя.
multiple_guest_add
строка
    Варианты:
  • выключить
  • включить
Включить/выключить добавление нескольких гостей.
name
строка / обязательно
Имя группы.
password
строка
    Варианты:
  • автоматическое создание
  • указать
  • выключить
Тип пароля гостевого пользователя.
sms_custom_server
строка
Сервер SMS. Источник системы.sms-server.name.
sms_server
строка
    Варианты:
  • fortiguard
  • настраиваемый
Отправка SMS через FortiGuard или другой внешний сервер.
sponsor
строка
    Варианты:
  • необязательно
  • обязательно
  • выключено
Установите действие для поля спонсора гостевого пользователя.
sso_attribute_value
string
Имя группы RADIUS-пользователей, представленной этой локальной группой пользователей.
user_id
string
    Варианты:
  • email
  • автоматическое генерирование
  • указать
Тип идентификатора гостевого пользователя.
user_name
string
    Варианты:
  • отключить
  • включить
Включить/выключить ввод имени гостевого пользователя.
username
string
Имя пользователя FortiOS или FortiGate.
vdom
string
По умолчанию:
"root"
Виртуальная область, среди тех, которые определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный блок.

Примечания

Примечание

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

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure user groups.
    fortios_user_group:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      user_group:
        auth_concurrent_override: "enable"
        auth_concurrent_value: "4"
        authtimeout: "5"
        company: "optional"
        email: "disable"
        expire: "8"
        expire_type: "immediately"
        group_type: "firewall"
        guest:
         -
            comment: "Comment."
            company: "<your_own_value>"
            email: "<your_own_value>"
            expiration: "<your_own_value>"
            mobile_phone: "<your_own_value>"
            name: "default_name_17"
            password: "<your_own_value>"
            sponsor: "<your_own_value>"
            user_id: "<your_own_value>"
        http_digest_realm: "<your_own_value>"
        id:  "22"
        match:
         -
            group_name: "<your_own_value>"
            id:  "25"
            server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name)"
        max_accounts: "27"
        member:
         -
            name: "default_name_29 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.adgrp.name user.pop3.name)"
        mobile_phone: "disable"
        multiple_guest_add: "disable"
        name: "default_name_32"
        password: "auto-generate"
        sms_custom_server: "<your_own_value> (source system.sms-server.name)"
        sms_server: "fortiguard"
        sponsor: "optional"
        sso_attribute_value: "<your_own_value>"
        user_id: "email"
        user_name: "disable"

Значения возврата

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

Ключ Возвращаемое значение Описание
build
string
всегда
Номер сборки образа fortigate

Пример:
1547
http_method
string
всегда
Последний метод, используемый для предоставления контента в FortiGate

Пример:
PUT
http_status
string
всегда
Последний результат, предоставленный FortiGate по последней применённой операции

Пример:
200
mkey
string
успех
Главный ключ (id), используемый в последнем вызове FortiGate

Пример:
id
name
string
всегда
Имя таблицы, используемой для выполнения запроса

Пример:
urlfilter
path
string
всегда
Путь к таблице, используемой для выполнения запроса

Пример:
webfilter
revision
string
всегда
Внутренний номер ревизии

Пример:
17.0.2.10658
serial
string
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
string
всегда
Указание результата операции

Пример:
успех
vdom
string
всегда
Используемая виртуальная область

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

Пример:
v5.6.3


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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_user_group_module.html

Spec-Zone.ru

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