Модуль fortinet.fortios.fortios_user_certificate – Настройка пользователей с сертификатами в 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_certificate.

Новое в fortinet.fortios 2.0.0

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

Описание

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токенов. Сгенерировано в веб-интерфейсе Fortigate.
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов больше одного. Параметр, помеченный как member_path, является допустимым для выполнения операции member.
member_state строка	Добавить или удалить члена по указанному пути атрибута. Когда задан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_certificate словарь	Настройка пользователей с сертификатами.
common_name строка	Общее имя сертификата.
id целое число	Идентификатор пользователя.
issuer строка	Сертификат CA, используемый для проверки сертификата клиента. Источник vpn.certificate.ca.name.
name строка / обязательный	Имя пользователя.
status строка	Включить/выключить разрешение пользователю с сертификатом пройти аутентификацию на устройстве FortiGate. Варианты: `"enable"` `"disable"`
type строка	Тип метода аутентификации по сертификату. Варианты: `"single-certificate"` `"trusted-issuer"`
vdom строка	Виртуальная область, среди определённых ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure certificate users.
  fortinet.fortios.fortios_user_certificate:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_certificate:
          common_name: "<your_own_value>"
          id: "4"
          issuer: "<your_own_value> (source vpn.certificate.ca.name)"
          name: "default_name_6"
          status: "enable"
          type: "single-certificate"

Значения возврата

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

Ключ	Описание
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 строка	Указание результата операции Возвращается: всегда Пример: `"success"`
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_certificate_module.html