fortinet.fortimanager.fmgr_user_local модуль — Настройка локальных пользователей.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только в случае расхождений между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_local словарь	Настроены параметры верхнего уровня.
auth_concurrent_override строка	Устарело, пожалуйста, переименуйте на auth_concurrent_override. Включить/выключить переопределение политики policy-auth-concurrent в … Варианты: `"disable"` `"enable"`
auth_concurrent_value целое число	Устарело, пожалуйста, переименуйте на auth_concurrent_value. Максимальное количество одновременных входов в систему от одного пользователя.
authtimeout целое число	Время в минутах до истечения срока действия аутентификации пользователя.
email_to строка	Устарело, пожалуйста, переименуйте на email_to. Электронный адрес получателя двухфакторной аутентификации.
fortitoken строка	Серийный номер FortiToken получателя двухфакторной аутентификации.
history0 любой тип	(список) История0.
history1 любой тип	(список) История1.
id целое число	Идентификатор пользователя.
ldap_server строка	Устарело, пожалуйста, переименуйте на ldap_server. Имя сервера LDAP, с которым пользователь должен пройти аутентификацию.
name строка / обязательно	Имя пользователя.
passwd любой тип	(список) Пароль пользователя.
passwd_policy строка	Устарело, пожалуйста, переименуйте на passwd_policy. Политика пароля для применения к этому пользователю, как определено в конфигурации user password-policy …
ppk_identity строка	Устарело, пожалуйста, переименуйте на ppk_identity. Идентификатор предварительно согласованного ключа Postquantum IKEv2.

END_OF_DOCUMENT_MARKER

ppk-secret any	(list) Устарело, переименуйте в ppk_secret. Предопределённый ключ IKEv2 Postquantum
qkd-profile string	Устарело, переименуйте в qkd_profile. Квантовое распределение ключей
radius-server string	Устарело, переименуйте в radius_server. Имя RADIUS-сервера, с которым пользователь должен пройти аутентификацию.
sms-custom-server string	Устарело, переименуйте в sms_custom_server. SMS-сервер для двухфакторной аутентификации.
sms-phone string	Устарело, переименуйте в sms_phone. Номер мобильного телефона для двухфакторной аутентификации.
sms-server string	Устарело, переименуйте в sms_server. Отправка SMS через FortiGuard или другой внешний сервер. Варианты: `"fortiguard"` `"custom"`
status string	Включить/выключить возможность локального пользователя для аутентификации с устройством FortiGate. Варианты: `"disable"` `"enable"`
tacacs+-server string	Устарело, переименуйте в tacacs__server. Имя TACACS+-сервера, с которым пользователь должен пройти аутентификацию.
two-factor string	Устарело, переименуйте в two_factor. Включить/выключить двухфакторную аутентификацию. Варианты: `"disable"` `"fortitoken"` `"email"` `"sms"` `"fortitoken-cloud"`
two-factor-authentication string	Устарело, переименуйте в two_factor_authentication. Метод аутентификации через FortiToken Cloud. Варианты: `"fortitoken"` `"email"` `"sms"`
two-factor-notification string	Устарело, переименуйте в two_factor_notification. Метод уведомления для активации пользователя через FortiToken Cloud. Варианты: `"email"` `"sms"`
type string	Метод аутентификации. Варианты: `"password"` `"radius"` `"tacacs+"` `"ldap"`
username-case-insensitivity string	Устарело, переименуйте в username_case_insensitivity. Включить/выключить чувствительность к регистру при сопоставлении имен пользователей Варианты: `"disable"` `"enable"`
username-case-sensitivity string	Устарело, переименуйте в username_case_sensitivity. Включить/выключить чувствительность к регистру при сопоставлении имен пользователей Варианты: `"disable"` `"enable"`
username-sensitivity string	Устарело, переименуйте в username_sensitivity. Включить/выключить чувствительность к регистру и диакритическим знакам при сопоставлении имен пользователей … Варианты: `"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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код возврата. Вы также можете переопределить условия для сбоя или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_local_module.html