Модуль fortinet.fortios.fortios_user_peer — настройка пользователей-пиров в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_user_peer.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя параметры функций пользователей и категории пиров. В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено на FOS v6.0.0
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются косой чертой. Параметр с атрибутом member_path можно использовать для выполнения операций с элементами. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, нужно ли создать или удалить объект. Варианты:
|
user_peer dictionary | Настройка пользователей-пиров. |
|
ca string |
Имя сертификата CA. Источник: vpn.certificate.ca.name. |
|
cn string |
Общее имя сертификата пира. |
|
cn_type string |
Тип общего имени сертификата пира. Варианты:
|
|
ldap_mode string |
Режим аутентификации пиров LDAP. Варианты:
|
|
ldap_password string |
Пароль для привязки к серверу LDAP. |
|
ldap_server string |
Имя сервера LDAP, определенного командой user ldap. Выполняет проверку прав доступа клиента. Источник: user.ldap.name. |
|
ldap_username string |
Имя пользователя для привязки к серверу LDAP. |
|
mandatory_ca_verify string |
Определяет, что происходит с пиром, если сертификат CA не установлен. Отключите этот параметр, чтобы автоматически считать сертификат пира действительным. Варианты:
|
|
mfa_mode string |
Режим MFA для удаленной аутентификации и авторизации пиров. Варианты:
|
|
mfa_password string |
Единый пароль для удаленной аутентификации. Это поле можно оставить пустым при использовании аутентификации RADIUS; в этом случае FortiGate будет использовать имя пользователя RADIUS в качестве пароля. |
|
mfa_server string |
Имя удаленного средства аутентификации. Выполняет проверку прав доступа клиента. Источники: user.radius.name, user.ldap.name. |
|
mfa_username string |
Единое имя пользователя для удаленной аутентификации. |
|
name string / обязательный |
Имя пира. |
|
ocsp_override_server string |
Сервер протокола статуса онлайн-сертификатов (OCSP) для получения сертификатов. Источник: vpn.certificate.ocsp-server.name. |
|
passwd string |
Пароль пира, используемый для двухфакторной аутентификации. |
|
subject string |
Ограничения на имена в сертификате пира. |
|
two_factor string |
Включить или отключить двухфакторную аутентификацию с использованием аутентификации на основе сертификата и пароля. Варианты:
|
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure peer users.
fortinet.fortios.fortios_user_peer:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_peer:
ca: "<your_own_value> (source vpn.certificate.ca.name)"
cn: "<your_own_value>"
cn_type: "string"
ldap_mode: "password"
ldap_password: "<your_own_value>"
ldap_server: "<your_own_value> (source user.ldap.name)"
ldap_username: "<your_own_value>"
mandatory_ca_verify: "enable"
mfa_mode: "none"
mfa_password: "<your_own_value>"
mfa_server: "<your_own_value> (source user.radius.name user.ldap.name)"
mfa_username: "<your_own_value>"
name: "default_name_15"
ocsp_override_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
passwd: "<your_own_value>"
subject: "<your_own_value>"
two_factor: "enable"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_user_peer_module.html
