Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_user_group_dynamicmapping module – Настройка групп пользователей.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_group_dynamicmapping.

Новое в fortinet.fortimanager 2.1.0

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

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

  • Этот модуль позволяет настраивать устройство FortiManager.
  • В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрашиваемом URL.

bypass_validation

boolean

Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

group

string / обязательный

Параметр (group) в запрашиваемом URL.

proposed_method

string

Переопределяемый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых условия сбоя будут переопределены.

rc_succeeded

list / elements=integer

Список кодов rc, для которых условия успешного выполнения будут переопределены.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

user_group_dynamicmapping

dictionary

Набор параметров верхнего уровня.

_scope

list / elements=dictionary

Область действия.

name

string

Имя.

vdom

string

VDOM.

auth_concurrent_override

псевдонимы: auth-concurrent-override

string

Включить или отключить переопределение глобального количества одновременных сеансов аутентификации для этой группы пользователей.

Варианты:

  • "disable"
  • "enable"

auth_concurrent_value

псевдонимы: auth-concurrent-value

integer

Максимальное количество одновременных аутентифицированных подключений на одного пользователя

authtimeout

integer

Тайм-аут аутентификации этой группы пользователей в минутах.

company

string

Задать действие для поля компании гостевого пользователя.

Варианты:

  • "optional"
  • "mandatory"
  • "disabled"

email

string

Включить или отключить поле адреса электронной почты гостевого пользователя.

Варианты:

  • "disable"
  • "enable"

expire

integer

Время в секундах до истечения срока действия учетных записей гостевых пользователей

expire_type

псевдонимы: expire-type

string

Определяет, когда начинается отсчет времени до истечения срока действия.

Варианты:

  • "immediately"
  • "first-successful-login"

group_type

псевдонимы: group-type

string

Задать тип группы: для аутентификации на межсетевом экране, FSSO, RSSO или гостевых пользователей.

Варианты:

  • "firewall"
  • "directory-service"
  • "fsso-service"
  • "guest"
  • "rsso"

guest

list / elements=dictionary

Гость.

comment

string

Комментарий.

company

string

Задать действие для поля компании гостевого пользователя.

email

string

expiration

string

Время истечения срока действия.

group

string

Группа.

id

integer

Идентификатор гостя.

mobile_phone

псевдонимы: mobile-phone

string

Мобильный телефон.

name

string

Имя гостя.

password

any

(список) Пароль гостя.

sponsor

string

Задать действие для поля спонсора гостевого пользователя.

user_id

псевдонимы: user-id

string

Идентификатор гостя.

http_digest_realm

псевдонимы: http-digest-realm

string

Атрибут realm для аутентификации с дайджестом MD5.

id

integer / обязательный

Идентификатор группы.

ldap_memberof

псевдонимы: ldap-memberof

string

Атрибут memberof LDAP.

logic_type

псевдонимы: logic-type

string

Тип логики.

Варианты:

  • "or"
  • "and"

match

list / elements=dictionary

Сопоставление.

_gui_meta

string

Метаданные графического интерфейса.

group_name

псевдонимы: group-name

string

Имя сопоставляемого пользователя или группы на удаленном сервере аутентификации.

id

integer

Идентификатор.

server_name

псевдонимы: server-name

string

Имя удаленного сервера аутентификации.

max_accounts

псевдонимы: max-accounts

integer

Максимальное количество гостевых учетных записей, которые можно создать для этой группы

member

any

(список или строка) Имена пользователей, узлов, серверов LDAP или серверов RADIUS, добавляемых в группу пользователей.

mobile_phone

псевдонимы: mobile-phone

string

Включить или отключить поле номера мобильного телефона гостевого пользователя.

Варианты:

  • "disable"
  • "enable"

multiple_guest_add

псевдонимы: multiple-guest-add

string

Включить или отключить добавление нескольких гостей.

Варианты:

  • "disable"
  • "enable"

negate

string

Отрицание.

Варианты:

  • "disable"
  • "enable"

password

string

Тип пароля гостевого пользователя.

Варианты:

  • "auto-generate"
  • "specify"
  • "disable"

redir_url

псевдонимы: redir-url

string

URL перенаправления.

sms_custom_server

псевдонимы: sms-custom-server

string

Сервер SMS.

sms_server

псевдонимы: sms-server

string

Отправлять SMS через FortiGuard или другой внешний сервер.

Варианты:

  • "fortiguard"
  • "custom"

sponsor

string

Задать действие для поля спонсора гостевого пользователя.

Варианты:

  • "optional"
  • "mandatory"
  • "disabled"

sslvpn_bookmarks_group

псевдонимы: sslvpn-bookmarks-group

any

(список или строка) Группа закладок SSL VPN.

sslvpn_cache_cleaner

псевдонимы: sslvpn-cache-cleaner

string

Очистка кэша SSL VPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_client_check

aliases: sslvpn-client-check

list / elements=string

Проверка клиента SSLVPN.

Варианты:

  • "forticlient"
  • "forticlient-av"
  • "forticlient-fw"
  • "3rdAV"
  • "3rdFW"

sslvpn_ftp

aliases: sslvpn-ftp

string

FTP для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_http

aliases: sslvpn-http

string

HTTP для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_os_check

aliases: sslvpn-os-check

string

Проверка ОС для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_os_check_list

aliases: sslvpn-os-check-list

dictionary

Список проверок ОС для SSLVPN.

action

string

Действие.

Варианты:

  • "allow"
  • "check-up-to-date"
  • "deny"

latest_patch_level

aliases: latest-patch-level

string

Последний уровень исправлений.

name

string

Имя.

tolerance

integer

Допуск.

sslvpn_portal

aliases: sslvpn-portal

any

(список или строка) Портал SSLVPN.

sslvpn_portal_heading

aliases: sslvpn-portal-heading

string

Заголовок портала SSLVPN.

sslvpn_rdp

aliases: sslvpn-rdp

string

RDP для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_samba

aliases: sslvpn-samba

string

Samba для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_split_tunneling

aliases: sslvpn-split-tunneling

string

Раздельное туннелирование SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_ssh

aliases: sslvpn-ssh

string

SSH для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_telnet

aliases: sslvpn-telnet

string

Telnet для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_tunnel

aliases: sslvpn-tunnel

string

Туннель SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_tunnel_endip

aliases: sslvpn-tunnel-endip

string

Конечный IP-адрес туннеля SSLVPN.

sslvpn_tunnel_ip_mode

aliases: sslvpn-tunnel-ip-mode

string

Режим IP-адреса туннеля SSLVPN.

Варианты:

  • "range"
  • "usrgrp"

sslvpn_tunnel_startip

aliases: sslvpn-tunnel-startip

string

Начальный IP-адрес туннеля SSLVPN.

sslvpn_virtual_desktop

aliases: sslvpn-virtual-desktop

string

Виртуальный рабочий стол SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_vnc

aliases: sslvpn-vnc

string

VNC для SSLVPN.

Варианты:

  • "disable"
  • "enable"

sslvpn_webapp

aliases: sslvpn-webapp

string

Веб-приложение SSLVPN.

Варианты:

  • "disable"
  • "enable"

sso_attribute_value

aliases: sso-attribute-value

string

Имя группы пользователей RADIUS, которую представляет эта локальная группа пользователей.

user_id

aliases: user-id

string

Тип идентификатора гостевого пользователя.

Варианты:

  • "email"
  • "auto-generate"
  • "specify"

user_name

aliases: user-name

string

Включить или отключить поле ввода имени гостевого пользователя.

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global и другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы именуются с использованием соглашения об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Обычно выполнение модуля может завершиться с ошибкой, если возвращён ненулевой код rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.
  • Чтобы создать или обновить объект, используйте директиву state present.
  • Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure user groups.
      fortinet.fortimanager.fmgr_user_group_dynamicmapping:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        group: <your own value>
        state: present # <value in [present, absent]>
        user_group_dynamicmapping:
          id: 0 # Required variable, integer
          # _scope:
          #   - name: <string>
          #     vdom: <string>
          # auth_concurrent_override: <value in [disable, enable]>
          # auth_concurrent_value: <integer>
          # authtimeout: <integer>
          # company: <value in [optional, mandatory, disabled]>
          # email: <value in [disable, enable]>
          # expire: <integer>
          # expire_type: <value in [immediately, first-successful-login]>
          # group_type: <value in [firewall, directory-service, fsso-service, ...]>
          # guest:
          #   - comment: <string>
          #     company: <string>
          #     email: <string>
          #     expiration: <string>
          #     group: <string>
          #     id: <integer>
          #     mobile_phone: <string>
          #     name: <string>
          #     password: <list or string>
          #     sponsor: <string>
          #     user_id: <string>
          # http_digest_realm: <string>
          # ldap_memberof: <string>
          # logic_type: <value in [or, and]>
          # match:
          #   - _gui_meta: <string>
          #     group_name: <string>
          #     id: <integer>
          #     server_name: <string>
          # max_accounts: <integer>
          # member: <list or string>
          # mobile_phone: <value in [disable, enable]>
          # multiple_guest_add: <value in [disable, enable]>
          # password: <value in [auto-generate, specify, disable]>
          # redir_url: <string>
          # sms_custom_server: <string>
          # sms_server: <value in [fortiguard, custom]>
          # sponsor: <value in [optional, mandatory, disabled]>
          # sslvpn_bookmarks_group: <list or string>
          # sslvpn_cache_cleaner: <value in [disable, enable]>
          # sslvpn_client_check: ["forticlient", "forticlient-av", "forticlient-fw", "3rdAV",
          #                       "3rdFW"]
          # sslvpn_ftp: <value in [disable, enable]>
          # sslvpn_http: <value in [disable, enable]>
          # sslvpn_os_check: <value in [disable, enable]>
          # sslvpn_os_check_list:
          #   action: <value in [allow, check-up-to-date, deny]>
          #   latest_patch_level: <string>
          #   name: <string>
          #   tolerance: <integer>
          # sslvpn_portal: <list or string>
          # sslvpn_portal_heading: <string>
          # sslvpn_rdp: <value in [disable, enable]>
          # sslvpn_samba: <value in [disable, enable]>
          # sslvpn_split_tunneling: <value in [disable, enable]>
          # sslvpn_ssh: <value in [disable, enable]>
          # sslvpn_telnet: <value in [disable, enable]>
          # sslvpn_tunnel: <value in [disable, enable]>
          # sslvpn_tunnel_endip: <string>
          # sslvpn_tunnel_ip_mode: <value in [range, usrgrp]>
          # sslvpn_tunnel_startip: <string>
          # sslvpn_virtual_desktop: <value in [disable, enable]>
          # sslvpn_vnc: <value in [disable, enable]>
          # sslvpn_webapp: <value in [disable, enable]>
          # sso_attribute_value: <string>
          # user_id: <value in [email, auto-generate, specify]>
          # user_name: <value in [disable, enable]>
          # negate: <value in [disable, enable]>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager.

Возвращается: при определённых условиях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortimanager/fmgr_user_group_dynamicmapping_module.html

Spec-Zone.ru

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