fortinet.fortios.fortios_user_peer – Настройка пользователей-партнёров в FortiOS и FortiGate Fortinet.

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_user_peer.

Новое в версии 2.9: плагина fortinet.fortios

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

Описание

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

Требования

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

ansible>=2.9.0

Параметры

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

Примечания

Примечание

Устаревший fortiosapi был устарел, httpapi — предпочтительный способ запуска книг задач.

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure peer users.
    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"
        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

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
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.10/collections/fortinet/fortios/fortios_user_peer_module.html