fortios_user_peer – Настройка пользователей-партнеров в Fortinet’s FortiOS и FortiGate

Новое в версии 2.9.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функции пользователя и категорию партнеров. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.5

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

fortiosapi>=0.9.8

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
host строка			IP-адрес FortiOS или FortiGate.
https логический тип		Варианты: нет да ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password строка		Значение по умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify логический тип		Варианты: нет да ←	Обеспечивает проверку сертификата FortiGate надёжной удостоверяющей организацией.
state строка / обязательно		Варианты: есть отсутствует	Указывает, нужно ли создать или удалить объект.
user_peer словарь		Значение по умолчанию: null	Настройка пользователей-партнеров.
	ca строка		Имя сертификата CA, возвращённое командой execute vpn certificate ca list. Источник vpn.certificate.ca.name.
	cn строка		Общее имя сертификата партнера.
	cn_type строка	Варианты: строка email FQDN ipv4 ipv6	Тип общего имени сертификата партнера.
	ldap_mode строка	Варианты: пароль имя-принципала	Режим аутентификации партнёра LDAP.
	ldap_password строка		Пароль для привязки к серверу LDAP.
	ldap_server строка		Имя сервера LDAP, определённого командой user ldap. Выполняет проверку прав доступа клиента. Источник user.ldap.name.
	ldap_username строка		Имя пользователя для привязки к серверу LDAP.
	mandatory_ca_verify строка	Варианты: включено выключено	Определяет, что происходит с партнером, если сертификат CA не установлен. Выключение автоматически считает сертификат партнера действительным.
	name строка / обязательно		Имя партнера.
	ocsp_override_server строка		Сервер протокола Online Certificate Status Protocol (OCSP) для получения сертификата. Источник vpn.certificate.ocsp-server.name.
	passwd строка		Пароль партнера, используемый для двухфакторной аутентификации.
	subject строка		Ограничения имени сертификата партнера.
	two_factor строка	Варианты: включено выключено	Включение/выключение двухфакторной аутентификации, применяя аутентификацию на основе сертификата и пароля.
username строка			Имя пользователя FortiOS или FortiGate.
vdom строка		Значение по умолчанию: "root"	Виртуальная область, среди ранее определённых. VDOM – виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

Требуется библиотека fortiosapi, разработанная Fortinet
Выполнять как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure peer users.
    fortios_user_peer:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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"
        name: "default_name_11"
        ocsp_override_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
        passwd: "<your_own_value>"
        subject: "<your_own_value>"
        two_factor: "enable"

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

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

Ключ	Возвращаемое значение	Описание
build строка	всегда	Номер сборки образа fortigate Пример: 1547
http_method строка	всегда	Последний метод, используемый для предоставления содержимого в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, полученный от FortiGate при последней операции Пример: 200
mkey строка	успех	Главный ключ (id), используемый в последнем вызове FortiGate Пример: id
name строка	всегда	Имя таблицы, используемой для выполнения запроса Пример: urlfilter
path строка	всегда	Путь таблицы, используемой для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Используемый виртуальный домен Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Статус

Гарантируется, что этот модуль не будет иметь обратной совместимости. [предварительный просмотр]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Подсказка

Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_user_peer_module.html