Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_certificate_remote — Дистанционный сертификат в формате PEM в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

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

Новый в fortinet.fortios 2.0.0

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

Обзор

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

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

Авторизация по токену. Сгенерирован из интерфейса Fortigate.

certificate_remote

словарь

Удаленный сертификат в формате PEM.

name

строка / обязательно

Имя.

range

строка

Диапазон IP-адресов глобального или VDOM для удалённого сертификата.

Варианты:

  • "global"
  • "vdom"

remote

строка

Удаленный сертификат.

source

строка

Тип источника удалённого сертификата.

Варианты:

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

enable_log

булево

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

Варианты:

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

member_path

строка

Путь к атрибуту члена для обработки.

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

Параметр с member_path допустим для выполнения операции с членом.

member_state

строка

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

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

Варианты:

  • "present"
  • "absent"

state

строка / обязательно

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

Варианты:

  • "present"
  • "absent"

vdom

строка

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

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

Примечания

Примечание

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

Примеры

- name: Remote certificate as a PEM file.
  fortinet.fortios.fortios_certificate_remote:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      certificate_remote:
          name: "default_name_3"
          range: "global"
          remote: "<your_own_value>"
          source: "factory"

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

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

Ключ

Описание

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_certificate_remote_module.html

Spec-Zone.ru

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