fortinet.fortios.fortios_user_peer модуль — Настройка пользователей-партнеров в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Выбоы:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, является допустимым для выполнения операций с членом. |
member_state строка | Добавить или удалить члена по указанному пути к атрибуту. Если member_state указан, опция state игнорируется. Выбоы:
|
state строка / обязательно | Указывает, необходимо ли создать или удалить объект. Выбоы:
|
user_peer словарь | Настройка пользователей-пиров. |
|
ca строка |
Имя сертификата CA. Источник vpn.certificate.ca.name. |
|
cn строка |
Общее имя сертификата пира. |
|
cn_type строка |
Тип общего имени сертификата пира. Выбоы:
|
|
ldap_mode строка |
Режим аутентификации LDAP для пира. Выбоы:
|
|
ldap_password строка |
Пароль для привязки к серверу LDAP. |
|
ldap_server строка |
Имя сервера LDAP, определенного командой user ldap. Выполняет проверку прав доступа клиента. Источник user.ldap.name. |
|
ldap_username строка |
Имя пользователя для привязки к серверу LDAP. |
|
mandatory_ca_verify строка |
Определяет, что происходит с пиром, если сертификат CA не установлен. Отключение позволяет автоматически считать сертификат пира действительным. Выбоы:
|
|
mfa_mode строка |
Режим MFA для удаленной аутентификации/авторизации пира. Выбоы:
|
|
mfa_password строка |
Единый пароль для удаленной аутентификации. Это поле можно оставить пустым при использовании аутентификации RADIUS, в этом случае FortiGate будет использовать имя пользователя RADIUS в качестве пароля. |
|
mfa_server строка |
Имя удаленного аутентификатора. Выполняет проверку прав доступа клиента. Источник user.radius.name user.ldap.name. |
|
mfa_username строка |
Единое имя пользователя для удаленной аутентификации. |
|
name строка / обязательно |
Имя пира. |
|
ocsp_override_server строка |
Сервер OCSP (Online Certificate Status Protocol) для получения сертификата. Источник vpn.certificate.ocsp-server.name. |
|
passwd строка |
Пароль пира, используемый для двухфакторной аутентификации. |
|
subject строка |
Ограничения имени сертификата пира. |
|
two_factor string |
Включение/выключение двухфакторной аутентификации, применение сертификата и аутентификации на основе пароля. Варианты:
|
vdom string | Виртуальный домен, среди ранее определенных. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. Значение по умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi был снят с поддержки, httpapi — предпочтительный способ запуска playbooks
- Модуль поддерживает 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_peer_module.html
