Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
  • Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_token

string

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

adom

string / required

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

bypass_validation

boolean

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

Варианты:

  • false ← (default)
  • true

enable_log

boolean

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

Варианты:

  • false ← (default)
  • true

forticloud_access_token

string

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

group

string / required

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

proposed_method

string

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

Варианты:

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

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

state

string / required

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

Варианты:

  • "present"
  • "absent"

user_group_dynamicmapping

dictionary

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

_scope

list / elements=dictionary

Область видимости.

name

string

Имя.

vdom

string

Vdom.

auth-concurrent-override

string

Устарело, переименуйте в auth_concurrent_override. Включить/отключить переопределение глобального числа одновременных аутентификаций…

Варианты:

  • "disable"
  • "enable"

auth-concurrent-value

integer

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

authtimeout

integer

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

company

string

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

Варианты:

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

email

string

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

Варианты:

  • "disable"
  • "enable"

expire

integer

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

expire-type

string

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

Варианты:

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

group-type

string

Устарело, переименуйте в group_type. Установите группу для аутентификации брандмауэра, FSSO, RSSO или пользователей-гостей.

Choices:

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

guest

list / elements=dictionary

Гость.

comment

string

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

company

string

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

email

string

Электронная почта.

expiration

string

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

group

string

Группа.

id

integer

ID гостя.

mobile-phone

string

Устарело, переименуйте в mobile_phone. Мобильный телефон.

name

string

Имя гостя.

password

any

(list) Пароль гостя.

sponsor

string

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

user-id

string

Устарело, переименуйте в user_id. ID гостя.

http-digest-realm

string

Устарело, переименуйте в http_digest_realm. Атрибут Realm для аутентификации MD5-digest.

id

integer / required

ID группы.

ldap-memberof

string

Устарело, переименуйте в ldap_memberof. Ldap memberof.

logic-type

string

Устарело, переименуйте в logic_type. Тип логики.

Choices:

  • "or"
  • "and"

match

list / elements=dictionary

Соответствие.

_gui_meta

string

Метаданные GUI.

group-name

string

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

id

integer

ID.

server-name

string

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

max-accounts

integer

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

member

any

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

mobile-phone

string

Устарело, переименуйте в mobile_phone. Включить/выключить поле номера мобильного телефона гостевого пользователя.

Choices:

  • "disable"
  • "enable"

multiple-guest-add

string

Устарело, переименуйте в multiple_guest_add. Включить/выключить добавление нескольких гостей.

Choices:

  • "disable"
  • "enable"

password

string

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

Choices:

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

redir-url

string

Устарело, переименуйте в redir_url. URL перенаправления.

sms-custom-server

string

Устарело, переименуйте в sms_custom_server. SMS-сервер.

sms-server

string

Устарело, переименуйте в sms_server. Отправка SMS через FortiGuard или другой внешний сервер.

Choices:

  • "fortiguard"
  • "custom"

sponsor

string

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

Choices:

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

sslvpn-bookmarks-group

any

(список или строка) Устарело, переименуйте в sslvpn_bookmarks_group. Группа закладок SSL VPN.

sslvpn-cache-cleaner

string

Устарело, переименуйте в sslvpn_cache_cleaner. Очистка кэша SSL VPN.

Choices:

  • "disable"
  • "enable"

sslvpn-client-check

list / elements=string

Устарело, переименуйте в sslvpn_client_check. Проверка клиента SSL VPN.

Choices:

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

sslvpn-ftp

string

Устарело, переименуйте в sslvpn_ftp. SSL VPN FTP.

Choices:

  • "disable"
  • "enable"

sslvpn-http

string

Устарело, переименуйте в sslvpn_http. SSL VPN HTTP.

Choices:

  • "disable"
  • "enable"

sslvpn-os-check

string

Устарело, переименуйте в sslvpn_os_check. Проверка ОС SSL VPN.

Choices:

  • "disable"
  • "enable"

sslvpn-os-check-list

dictionary

Устарело, переименуйте в sslvpn_os_check_list. Список проверок ОС SSL VPN.

action

string

Действие.

Choices:

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

latest-patch-level

string

Устарело, переименуйте в latest_patch_level. Последний уровень патча.

name

string

Имя.

tolerance

integer

Допуск.

sslvpn-portal

any

(список или строка) Устарело, переименуйте в sslvpn_portal. Портал SSL VPN.

sslvpn-portal-heading

string

Устаревший параметр, переименуйте его в sslvpn_portal_heading. Заголовок портала SSLVPN.

sslvpn-rdp

string

Устаревший параметр, переименуйте его в sslvpn_rdp. SSLVPN RDP.

Выбор:

  • "disable"
  • "enable"

sslvpn-samba

string

Устаревший параметр, переименуйте его в sslvpn_samba. SSLVPN Samba.

Выбор:

  • "disable"
  • "enable"

sslvpn-split-tunneling

string

Устаревший параметр, переименуйте его в sslvpn_split_tunneling. SSLVPN разделенный туннель.

Выбор:

  • "disable"
  • "enable"

sslvpn-ssh

string

Устаревший параметр, переименуйте его в sslvpn_ssh. SSLVPN SSH.

Выбор:

  • "disable"
  • "enable"

sslvpn-telnet

string

Устаревший параметр, переименуйте его в sslvpn_telnet. SSLVPN Telnet.

Выбор:

  • "disable"
  • "enable"

sslvpn-tunnel

string

Устаревший параметр, переименуйте его в sslvpn_tunnel. SSLVPN туннель.

Выбор:

  • "disable"
  • "enable"

sslvpn-tunnel-endip

string

Устаревший параметр, переименуйте его в sslvpn_tunnel_endip. SSLVPN туннель endip.

sslvpn-tunnel-ip-mode

string

Устаревший параметр, переименуйте его в sslvpn_tunnel_ip_mode. SSLVPN туннель режим IP.

Выбор:

  • "range"
  • "usrgrp"

sslvpn-tunnel-startip

string

Устаревший параметр, переименуйте его в sslvpn_tunnel_startip. SSLVPN туннель startip.

sslvpn-virtual-desktop

string

Устаревший параметр, переименуйте его в sslvpn_virtual_desktop. SSLVPN виртуальный рабочий стол.

Выбор:

  • "disable"
  • "enable"

sslvpn-vnc

string

Устаревший параметр, переименуйте его в sslvpn_vnc. SSLVPN VNC.

Выбор:

  • "disable"
  • "enable"

sslvpn-webapp

string

Устаревший параметр, переименуйте его в sslvpn_webapp. SSLVPN веб-приложение.

Выбор:

  • "disable"
  • "enable"

sso-attribute-value

string

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

user-id

string

Устаревший параметр, переименуйте его в user_id. Тип идентификатора гостевого пользователя.

Выбор:

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

user-name

string

Устаревший параметр, переименуйте его в user_name. Включить/выключить ввод имени гостевого пользователя.

Выбор:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM для блокировки в режиме рабочего пространства FortiManager. Значение может быть глобальным и другими, включая 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 помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно, выполнение одного модуля может завершиться неудачей, если возвращается ненулевой код rc. Вы также можете переопределить условия для неудачи или успеха с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure user groups.
      fortinet.fortimanager.fmgr_user_group_dynamicmapping:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        group: <your own value>
        state: present # <value in [present, absent]>
        user_group_dynamicmapping:
          _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>
          id: <integer>
          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]>

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

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

Ключ

Описание

meta

словарь

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

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

request_url

строка

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

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

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

response_code

целое число

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

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

Пример: 0

response_data

список / элементы=строка

Ответ API.

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

response_message

строка

Дескриптивное сообщение ответа API.

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

Пример: "OK."

system_information

словарь

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

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

rc

целое число

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

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

Пример: 0

version_check_warning

список / элементы=строка

Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_group_dynamicmapping_module.html

Spec-Zone.ru

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