Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_user_local module – Настройка локальных пользователей.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.0.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.

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_local

dictionary

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

auth_concurrent_override

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

string

Включить/отключить переопределение параметра policy-auth-concurrent в разделе config system global.

Варианты:

  • "disable"
  • "enable"

auth_concurrent_value

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

integer

Максимальное количество одновременных входов, разрешенных для одного пользователя.

authtimeout

integer

Время в минутах до истечения времени ожидания аутентификации пользователя.

email_to

псевдонимы: email-to

string

fortitoken

string

Серийный номер FortiToken получателя для двухфакторной аутентификации.

history0

any

(список) История0.

history1

any

(список) История1.

history10

any

(список) История10.

history11

any

(список) История11.

history12

any

(список) История12.

history13

any

(список) История13.

history14

any

(список) История14.

history15

any

(список) История15.

history16

any

(список) История16.

history17

any

(список) История17.

history18

any

(список) История18.

history19

any

(список) История19.

history2

any

(список) История2.

history3

any

(список) История3.

history4

any

(список) История4.

history5

any

(список) История5.

history6

any

(список) История6.

history7

any

(список) История7.

history8

any

(список) История8.

history9

any

(список) История9.

id

integer

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

ldap_server

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

string

Имя LDAP-сервера, на котором пользователь должен пройти аутентификацию.

name

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

Имя пользователя.

passwd

any

(список) Пароль пользователя.

passwd_policy

псевдонимы: passwd-policy

string

Политика паролей, применяемая к этому пользователю, как определено в config user password-policy.

ppk_identity

псевдонимы: ppk-identity

string

Идентификатор предварительно совместно используемого постквантового ключа IKEv2.

ppk_secret

псевдонимы: ppk-secret

any

(список) Предварительно совместно используемый постквантовый ключ IKEv2

qkd_profile

псевдонимы: qkd-profile

string

Распределение квантовых ключей

radius_server

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

string

Имя RADIUS-сервера, на котором пользователь должен пройти аутентификацию.

saml_server

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

any

(список) Имя SAML-сервера, на котором пользователь должен пройти аутентификацию.

sms_custom_server

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

string

SMS-сервер получателя для двухфакторной аутентификации.

sms_phone

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

string

Номер мобильного телефона получателя для двухфакторной аутентификации.

sms_server

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

string

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

Варианты:

  • "fortiguard"
  • "custom"

status

string

Разрешить/запретить локальному пользователю проходить аутентификацию на устройстве FortiGate.

Варианты:

  • "disable"
  • "enable"

tacacs__server

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

string

Имя TACACS+-сервера, на котором пользователь должен пройти аутентификацию.

two_factor

псевдонимы: two-factor

string

Включить/отключить двухфакторную аутентификацию.

Варианты:

  • "disable"
  • "fortitoken"
  • "email"
  • "sms"
  • "fortitoken-cloud"

two_factor_authentication

псевдонимы: two-factor-authentication

string

Метод аутентификации с помощью FortiToken Cloud.

Варианты:

  • "fortitoken"
  • "email"
  • "sms"

two_factor_notification

псевдонимы: two-factor-notification

string

Способ уведомления пользователя об активации через FortiToken Cloud.

Варианты:

  • "email"
  • "sms"

type

string

Метод аутентификации.

Варианты:

  • "password"
  • "radius"
  • "tacacs+"
  • "ldap"
  • "saml"

username_case_insensitivity

псевдонимы: username-case-insensitivity

string

Включить/отключить учет регистра при сопоставлении имен пользователей

Варианты:

  • "disable"
  • "enable"

username_case_sensitivity

псевдонимы: username-case-sensitivity

string

Включить/отключить учет регистра при сопоставлении имен пользователей

Варианты:

  • "disable"
  • "enable"

username_sensitivity

псевдонимы: username-sensitivity

string

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

Варианты:

  • "disable"
  • "enable"

workstation

string

Имя рабочей станции удаленного пользователя, если требуется разрешить аутентификацию только с определенной рабочей станции.

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме рабочего пространства. Значением может быть global или другие значения, включая 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
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure local users.
      fortinet.fortimanager.fmgr_user_local:
        bypass_validation: false
        adom: ansible
        state: present
        user_local:
          id: 1
          name: ansible-test-local
          passwd: fortinet
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the local users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_local"
          params:
            adom: "ansible"
            local: "your_value"

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

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

Ключ

Описание

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–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_local_module.html

Spec-Zone.ru

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