модуль fortinet.fortimanager.fmgr_vpn_certificate_ca — сертификат ЦС.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_vpn_certificate_ca.

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, которыми будут переопределены условия неудачного выполнения.
rc_succeeded list / элементы=integer	Список кодов rc, которыми будут переопределены условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
vpn_certificate_ca dictionary	Набор параметров верхнего уровня.
_private_key string	Закрытый ключ.
auto_update_days псевдонимы: auto-update-days integer	Количество дней ожидания перед запросом обновлённого сертификата ЦС
auto_update_days_warning псевдонимы: auto-update-days-warning integer	Количество дней до создания предупреждения об истечении срока действия
ca string	Сертификат ЦС в формате PEM.
ca_identifier псевдонимы: ca-identifier string	Идентификатор ЦС сервера SCEP.
est_url псевдонимы: est-url string	URL сервера EST.
fabric_ca псевдонимы: fabric-ca string	Включить или отключить синхронизацию ЦС между устройствами Security Fabric. Варианты: `"disable"` `"enable"`
last_updated псевдонимы: last-updated integer	Время последнего обновления ЦС.
name string / обязательный	Имя.
non_fabric_name псевдонимы: non-fabric-name string	Имя, использовавшееся до того, как ЦС стал синхронизироваться в Security Fabric.
obsolete string	Включить или отключить пометку этого ЦС как устаревшего. Варианты: `"disable"` `"enable"`
range string	Глобальный диапазон IP-адресов или диапазон IP-адресов VDOM для сертификата ЦС. Варианты: `"global"` `"vdom"`
scep_url псевдонимы: scep-url string	URL сервера SCEP.
source string	Тип источника сертификата ЦС. Варианты: `"factory"` `"user"` `"bundle"` `"fortiguard"`
source_ip псевдонимы: source-ip string	Исходный IP-адрес для связи с сервером SCEP.
ssl_inspection_trusted псевдонимы: ssl-inspection-trusted string	Включить или отключить доверие к этому ЦС при проверке SSL. Варианты: `"disable"` `"enable"`
trusted string	Включить или отключить доверие к этому ЦС. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM, который нужно заблокировать при работе FortiManager в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например “var-name” на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой при возврате ненулевого значения rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте указание state present.
Для удаления объекта используйте указание state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: CA certificate.
      fortinet.fortimanager.fmgr_vpn_certificate_ca:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        vpn_certificate_ca:
          name: "your value" # Required variable, string
          # _private_key: <string>
          # auto_update_days: <integer>
          # auto_update_days_warning: <integer>
          # ca: <string>
          # last_updated: <integer>
          # range: <value in [global, vdom]>
          # scep_url: <string>
          # source: <value in [factory, user, bundle, ...]>
          # source_ip: <string>
          # trusted: <value in [disable, enable]>
          # ssl_inspection_trusted: <value in [disable, enable]>
          # ca_identifier: <string>
          # obsolete: <value in [disable, enable]>
          # est_url: <string>
          # fabric_ca: <value in [disable, enable]>
          # non_fabric_name: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложном ответе

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_vpn_certificate_ca_module.html