Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_certificate_ca – сертификат CA в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля потребуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_certificate_ca.

Добавлено в fortinet.fortios 2.0.0

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

Краткое описание

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

certificate_ca

dictionary

Сертификат CA.

auto_update_days

integer

Количество дней ожидания перед запросом обновленного сертификата CA (0–4294967295, 0 = отключено).

auto_update_days_warning

integer

Количество дней до создания предупреждения об истечении срока действия (0–4294967295, 0 = отключено).

ca

string

Сертификат CA в формате PEM.

ca_identifier

string

Идентификатор CA сервера SCEP.

est_url

string

URL-адрес сервера EST.

fabric_ca

string

Включить или отключить синхронизацию CA в Security Fabric.

Варианты:

  • "disable"
  • "enable"

last_updated

integer

Время последнего обновления CA.

name

string / обязательный

Имя.

obsolete

string

Установить или снять для этого CA признак устаревшего.

Варианты:

  • "disable"
  • "enable"

range

string

Глобальный диапазон IP-адресов или диапазон IP-адресов VDOM для сертификата CA.

Варианты:

  • "global"
  • "vdom"

scep_url

string

URL-адрес сервера SCEP.

source

string

Тип источника сертификата CA.

Варианты:

  • "factory"
  • "user"
  • "bundle"

source_ip

string

Исходный IP-адрес для связи с сервером SCEP.

ssl_inspection_trusted

string

Включить или отключить использование этого CA в качестве доверенного CA для проверки SSL-трафика.

Варианты:

  • "enable"
  • "disable"

trusted

string

Включить или отключить использование в качестве доверенного CA.

Варианты:

  • "enable"
  • "disable"

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: CA certificate.
  fortinet.fortios.fortios_certificate_ca:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      certificate_ca:
          auto_update_days: "0"
          auto_update_days_warning: "0"
          ca: "<your_own_value>"
          ca_identifier: "myId_6"
          est_url: "<your_own_value>"
          fabric_ca: "disable"
          last_updated: "2147483647"
          name: "default_name_10"
          obsolete: "disable"
          range: "global"
          scep_url: "<your_own_value>"
          source: "factory"
          source_ip: "84.230.14.43"
          ssl_inspection_trusted: "enable"
          trusted: "enable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (id), использованный при последнем обращении к FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Использованный виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_certificate_ca_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API