Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_vpn_certificate_ca – Сертификат CA.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

  • Этот модуль позволяет настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо настроить исходя из исходных данных перед использованием.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательный
параметр (adom) в запрошенном URL
bypass_validation
логическое
    Варианты:
  • нет ←
  • да
устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed
список / элементы=строка
список кодов rc, при которых условия завершения работы будут переопределены
rc_succeeded
список / элементы=строка
список кодов rc, при которых условия успешного завершения работы будут переопределены
state
строка / обязательный
    Варианты:
  • present
  • absent
направление для создания, обновления или удаления объекта
vpn_certificate_ca
словарь
настройка верхнего уровня
_private_key
строка
без описания
auto-update-days
целое число
Количество дней ожидания перед запросом обновленного сертификата CA (0 - 4294967295, 0 = отключено).
auto-update-days-warning
целое число
Количество дней до вывода сообщения об истечении срока действия (0 - 4294967295, 0 = отключено).
ca
строка
Сертификат CA в формате PEM.
last-updated
целое число
Время последнего обновления CA.
name
строка
Имя.
range
строка
    Варианты:
  • global
  • vdom
Диапазон IP-адресов глобального или VDOM для сертификата CA.
scep-url
строка
URL сервера SCEP.
source
строка
    Варианты:
  • factory
  • user
  • bundle
  • fortiguard
Тип источника сертификата CA.
source-ip
строка
IP-адрес источника для связи с сервером SCEP.
trusted
строка
    Варианты:
  • disable
  • enable
Включить/выключить в качестве доверенного CA.
workspace_locking_adom
строка
adom для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть global и другими, включая root
workspace_locking_timeout
целое число
По умолчанию:
300
максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

  • Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Вы также можете переопределить условия завершения работы или успешного завершения с помощью параметров rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: CA certificate.
     fmgr_vpn_certificate_ca:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        vpn_certificate_ca:
           _private_key: <value of string>
           auto-update-days: <value of integer>
           auto-update-days-warning: <value of integer>
           ca: <value of string>
           last-updated: <value of integer>
           name: <value of string>
           range: <value in [global, vdom]>
           scep-url: <value of string>
           source: <value in [factory, user, bundle, ...]>
           source-ip: <value of string>
           trusted: <value in [disable, enable]>

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

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

Ключ Возвращаемое значение Описание
request_url
строка
всегда
Полный запрашиваемый URL

Пример:
/sys/login/user
response_code
целое число
всегда
Статус запроса API

response_message
строка
всегда
Детальное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_vpn_certificate_ca_module.html

Spec-Zone.ru

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