Модуль fortinet.fortios.fortios_vpn_ssl_client — клиент в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_vpn_ssl_client.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию vpn_ssl и категорию client. В примерах приведены все параметры; перед использованием необходимо скорректировать значения в соответствии с источниками данных. Протестировано с FOS v6.0.0
Требования
На узле, где выполняется этот модуль, должны быть соблюдены следующие требования.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: |
vpn_ssl_client dictionary | Клиент. |
|
certificate string |
Сертификат, предоставляемый серверу SSL-VPN по его запросу. Источник: vpn.certificate.local.name. |
|
class_id integer |
Идентификатор класса трафика. Источник: firewall.traffic-class.class-id. |
|
comment string |
Комментарий. |
|
distance integer |
Административная дистанция маршрутов, добавляемых SSL-VPN (1–255). |
|
interface string |
Интерфейс SSL для отправки и получения трафика. Источник: system.interface.name. |
|
ipv4_subnets string |
Подсети IPv4, которые защищает клиент. Источник: firewall.address.name, firewall.addrgrp.name. |
|
ipv6_subnets string |
Подсети IPv6, которые защищает клиент. Источник: firewall.address6.name, firewall.addrgrp6.name. |
|
name string / обязательный |
Имя туннеля SSL-VPN. |
|
peer string |
Аутентификация сертификата узла с помощью peer/peergrp. Источник: user.peer.name, user.peergrp.name. |
|
port integer |
Порт сервера SSL-VPN. |
|
priority integer |
Приоритет маршрутов, добавляемых SSL-VPN (1–65535). |
|
psk string |
Предварительно согласованный секрет для аутентификации на сервере (строка ASCII или шестнадцатеричное значение с префиксом 0x). |
|
realm string |
Имя области, настроенной на сервере SSL-VPN. |
|
server string |
Адрес сервера SSL-VPN: IPv4, IPv6 или DNS. |
|
source_ip string |
Адрес IPv4 или IPv6, используемый в качестве источника для подключения SSL-VPN к серверу. |
|
status string |
Включить или отключить конфигурацию этого клиента SSL-VPN. Варианты:
|
|
user string |
Имя пользователя, передаваемое узлу для аутентификации клиента. |
Примечания
Примечание
- Поддержка устаревшего fortiosapi прекращена; для запуска плейбуков рекомендуется использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Client.
fortinet.fortios.fortios_vpn_ssl_client:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_client:
certificate: "<your_own_value> (source vpn.certificate.local.name)"
class_id: "0"
comment: "Comment."
distance: "10"
interface: "<your_own_value> (source system.interface.name)"
ipv4_subnets: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv6_subnets: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
name: "default_name_10"
peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
port: "443"
priority: "1"
psk: "<your_own_value>"
realm: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
status: "enable"
user: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_vpn_ssl_client_module.html
