Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

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

Для использования в playbook укажите: fortinet.fortios.fortios_user_group.

В версии 2.9: плагина fortinet.fortios

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

Обзор

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

Требования

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

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токена. Сгенерировано в GUI Fortigate.
state
строка / обязательно
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект.
user_group
словарь
Настройка групп пользователей.
auth_concurrent_override
строка
    Варианты:
  • enable
  • disable
Включить/выключить переопределение глобального числа одновременных сессий аутентификации для этой группы пользователей.
auth_concurrent_value
целое число
Максимальное количество одновременных аутентифицированных подключений на пользователя (0 - 100).
authtimeout
целое число
Тайм-аут аутентификации в минутах для этой группы пользователей. 0 - использовать глобальную настройку auth-timeout.
company
строка
    Варианты:
  • optional
  • mandatory
  • disabled
Установить действие для поля компании гостевого пользователя.
email
строка
    Варианты:
  • disable
  • enable
Включить/выключить поле электронного адреса гостевого пользователя.
expire
целое число
Время в секундах до истечения срока действия учетных записей гостевых пользователей. (1 - 31536000 сек)
expire_type
строка
    Варианты:
  • immediately
  • first-successful-login
Определение момента начала отсчета времени истечения срока действия.
group_type
строка
    Варианты:
  • firewall
  • fsso-service
  • rsso
  • guest
Установить группу для аутентификации брандмауэра, 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
строка
Имя сервера удалённой аутентификации. Источник: user.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
строка
    Варианты:
  • disable
  • enable
Включить/выключить поле номера мобильного телефона гостевого пользователя.
multiple_guest_add
строка
    Варианты:
  • disable
  • enable
Включить/выключить добавление нескольких гостей.
name
строка / обязательно
Имя группы.
password
строка
    Варианты:
  • авто-сгенерировать
  • указать
  • выключить
Тип пароля гостевого пользователя.
sms_custom_server
строка
Сервер SMS. Источник: system.sms-server.name.
sms_server
строка
    Варианты:
  • fortiguard
  • custom
Отправка SMS через FortiGuard или другой внешний сервер.
sponsor
строка
    Варианты:
  • optional
  • mandatory
  • disabled
Установить действие для поля спонсора гостевого пользователя.
sso_attribute_value
строка
Имя группы RADIUS пользователей, которую представляет эта локальная группа пользователей.
user_id
строка
    Варианты:
  • email
  • авто-сгенерировать
  • указать
Тип идентификатора гостевого пользователя.
user_name
строка
    Варианты:
  • disable
  • enable
Включить/выключить ввод имени гостевого пользователя.
vdom
строка
По умолчанию:
"root"
Виртуальный домен, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

  • Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure user groups.
    fortios_user_group:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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
строка
всегда
Номер сборки образа 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


Авторы

  • 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_user_group_module.html

Spec-Zone.ru

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