Модуль fortinet.fortimanager.fmgr_vpn_kmipserver — конфигурация записи сервера KMIP.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.12.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_kmipserver dictionary	Набор параметров верхнего уровня.
interface list / элементы=string	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
name string / обязательный	Имя записи сервера KMIP.
password list / элементы=string	Пароль для подключения к серверу KMIP.
server_identity_check псевдонимы: server-identity-check string	Включить или отключить проверку подлинности сервера KMIP Варианты: `"disable"` `"enable"`
server_list псевдонимы: server-list list / элементы=dictionary	Список серверов.
cert list / элементы=string	Клиентский сертификат для подключения к серверу KMIP.
id integer	Идентификатор
port integer	Порт сервера KMIP.
server string	Полное доменное имя (FQDN) или IP-адрес сервера KMIP.
status string	Включить или отключить сервер KMIP. Варианты: `"disable"` `"enable"`
source_ip псевдонимы: source-ip string	IP-адрес FortiGate, используемый для связи с сервером KMIP.
ssl_min_proto_version псевдонимы: ssl-min-proto-version string	Минимальная поддерживаемая версия протокола для SSL/TLS-подключений Варианты: `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
username string	Имя пользователя для подключения к серверу KMIP.
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки workspace другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов записываются в формате snake_case с подчёркиваниями. Замените такие аргументы, как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут отображаться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки workspace. Для этого используются параметры верхнего уровня 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: KMIP server entry configuration.
      fortinet.fortimanager.fmgr_vpn_kmipserver:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        vpn_kmipserver:
          name: "your value" # Required variable, string
          # interface: <list or string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # password: <list or string>
          # server_identity_check: <value in [disable, enable]>
          # server_list:
          #   - cert: <list or string>
          #     id: <integer>
          #     port: <integer>
          #     server: <string>
          #     status: <value in [disable, enable]>
          # source_ip: <string>
          # ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]>
          # username: <string>
          # vrf_select: <integer>

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

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

Ключ	Описание
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	Предупреждение о том, что используемые в playbook параметры не поддерживаются текущей версией 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_kmipserver_module.html