Модуль fortinet.fortios.fortios_vpn_ssl_client – Клиент в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Вам, возможно, уже установлена эта коллекция, если вы используете пакет 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 и категорию клиента. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется с помощью символа косой черты, если атрибутов более одного. Параметр, помеченный member_path, подходит для выполнения операций с членом. |
member_state строка | Добавить или удалить члена по указанному пути атрибута. При указании member_state опция state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
vdom строка | Виртуальная область, среди определенных ранее. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: |
vpn_ssl_client словарь | Клиент. |
|
certificate строка |
Сертификат для предложения серверу SSL-VPN, если он его запросит. Источник vpn.certificate.local.name. |
|
class_id целое число |
Идентификатор класса трафика. Источник firewall.traffic-class.class-id. |
|
comment строка |
Комментарий. |
|
distance целое число |
Расстояние для маршрутов, добавленных SSL-VPN (1—255). |
|
interface строка |
Интерфейс SSL для отправки/получения трафика. Источник system.interface.name. |
|
ipv4_subnets строка |
Подсети IPv4, которые защищает клиент. Источник firewall.address.name firewall.addrgrp.name. |
|
ipv6_subnets строка |
Подсети IPv6, которые защищает клиент. Источник firewall.address6.name firewall.addrgrp6.name. |
|
name строка / обязательно |
Имя туннеля SSL-VPN. |
|
peer строка |
Проверка сертификата «сообщника» с помощью peer/peergrp. Источник user.peer.name user.peergrp.name. |
|
port целое число |
Порт сервера SSL-VPN. |
|
priority целое число |
Приоритет для маршрутов, добавленных SSL-VPN (1—65535). |
|
psk строка |
Общий предварительно заданный секрет для аутентификации с сервером (строка ASCII или шестнадцатеричное кодирование с ведущим 0x). |
|
realm строка |
Имя области, настроенное на сервере SSL-VPN. |
|
server строка |
Адрес IPv4, IPv6 или DNS-сервера SSL-VPN. |
|
source_ip строка |
Адрес IPv4 или IPv6, используемый в качестве источника для подключения SSL-VPN к серверу. |
|
status строка |
Включить/выключить конфигурацию этого клиента SSL-VPN. Варианты:
|
|
user string |
Имя пользователя, предлагаемое одноранговому узлу для аутентификации клиента. |
Примечания
Примечание
- Устаревший fortiosapi был снят с поддержки, httpapi является предпочтительным способом запуска playbooks
Примеры
- 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 | Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успех Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_vpn_ssl_client_module.html