Spec-Zone.ru › Ansible 2.9

fortios_vpn_ssl_web_portal – Портал в Fortinet’s FortiOS и FortiGate

Новая версия 2.8.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

  • Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять функцию vpn_ssl_web и категорию портала. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.5

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
строка
IP-адрес FortiOS или FortiGate.
https
булево
    Варианты:
  • нет
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
строка
Значение по умолчанию:
""
Пароль FortiOS или FortiGate.
ssl_verify
булево
добавлен в 2.9
    Варианты:
  • нет
  • да ←
Обеспечивает проверку сертификата FortiGate у надёжного центра сертификации.
state
строка
добавлен в 2.9
    Варианты:
  • присутствует
  • отсутствует
Указывает, нужно ли создать или удалить объект. Этот атрибут присутствовал и в предыдущих версиях на более глубоком уровне. Он был вынесен на внешний уровень.
username
строка
Имя пользователя FortiOS или FortiGate.
vdom
строка
Значение по умолчанию:
"root"
Виртуальная область, среди ранее определённых. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.
vpn_ssl_web_portal
словарь
Значение по умолчанию:
null
Портал.
allow_user_access
строка
    Варианты:
  • веб
  • ftp
  • smb
  • telnet
  • ssh
  • vnc
  • rdp
  • ping
  • citrix
  • portforward
Разрешить пользователям доступ к приложениям SSL-VPN.
auto_connect
строка
    Варианты:
  • включить
  • выключить
Включить/выключить автоматическое подключение клиента при включении системы.
bookmark_group
список
Группа закладок портала.
bookmarks
список
Таблица закладок.
additional_params
строка
Дополнительные параметры.
apptype
строка
    Варианты:
  • citrix
  • ftp
  • portforward
  • rdp
  • smb
  • ssh
  • telnet
  • vnc
  • веб
Тип приложения.
description
строка
Описание.
folder
строка
Параметр сетевой общей папки.
form_data
список
Данные формы.
name
строка / обязательно
Имя.
value
строка
Значение.
host
строка
Имя хоста/IP-параметр.
listening_port
целое число
Порт прослушивания (0-65535).
load_balancing_info
строка
Информация о балансировке нагрузки или куки, которые должны быть предоставлены брокеру соединения.
logon_password
строка
Пароль входа.
logon_user
строка
Имя пользователя входа.
name
строка / обязательно
Имя закладки.
port
целое число
Удаленный порт.
preconnection_blob
строка
Произвольная строка, которая идентифицирует источник RDP.
preconnection_id
целое число
Числовой идентификатор источника RDP (0-2147483648).
remote_port
целое число
Удаленный порт (0-65535).
security
строка
    Варианты:
  • rdp
  • nla
  • tls
  • любой
Режим безопасности для подключения RDP.
server_layout
строка
    Варианты:
  • de-de-qwertz
  • en-gb-qwerty
  • en-us-qwerty
  • es-es-qwerty
  • fr-fr-azerty
  • fr-ch-qwertz
  • it-it-qwerty
  • ja-jp-qwerty
  • pt-br-qwerty
  • sv-se-qwerty
  • tr-tr-qwerty
  • failsafe
Макет клавиатуры сервера.
show_status_window
строка
    Варианты:
  • включить
  • выключить
Включить/выключить отображение окна состояния.
sso
строка
    Варианты:
  • выключить
  • статический
  • автоматический
Single Sign-On.
sso_credential
строка
    Варианты:
  • sslvpn-login
  • альтернативный
Данные для Single Sign-On.
sso_credential_sent_once
string
    Варианты:
  • включить
  • отключить
Данные единого входа (SSO) отправляются на удалённый сервер только один раз.
sso_password
string
Пароль единого входа (SSO).
sso_username
string
Имя пользователя единого входа (SSO).
url
string
Параметр URL.
name
string / обязательно
Имя группы закладок.
custom_lang
string
Изменение языка отображения веб-портала. Переопределяет глобальный язык, заданный в конфигурации. Для добавления пользовательских языковых файлов можно использовать конфигурационные системы custom-language и execute system custom-language. Источник: system.custom-language.name.
customize_forticlient_download_url
string
    Варианты:
  • включить
  • отключить
Включить поддержку настраиваемого URL для скачивания FortiClient.
display_bookmark
string
    Варианты:
  • включить
  • отключить
Включить отображение виджета закладок на веб-портале.
display_connection_tools
string
    Варианты:
  • включить
  • отключить
Включить отображение виджета инструментов подключения на веб-портале.
display_history
string
    Варианты:
  • включить
  • отключить
Включить отображение виджета истории входа пользователей на веб-портале.
display_status
string
    Варианты:
  • включить
  • отключить
Включить отображение виджета статуса на веб-портале.
dns_server1
string
IPv4 DNS-сервер 1.
dns_server2
string
IPv4 DNS-сервер 2.
dns_suffix
string
Суффикс DNS.
exclusive_routing
string
    Варианты:
  • включить
  • отключить
Включить/отключить маршрутизацию всего трафика только через туннель.
forticlient_download
string
    Варианты:
  • включить
  • отключить
Включить/отключить опцию скачивания FortiClient.
forticlient_download_method
string
    Варианты:
  • прямой
  • ssl-vpn
Метод скачивания FortiClient.
heading
string
Сообщение заголовка веб-портала.
hide_sso_credential
string
    Варианты:
  • включить
  • отключить
Включить, чтобы предотвратить отправку учетных данных SSO клиенту.
host_check
string
    Варианты:
  • нет
  • av
  • fw
  • av-fw
  • custom
Тип проверки хоста, выполняемой на конечных точках.
host_check_interval
integer
Периодичность проверки хоста. Значение 0 означает отключение, и проверка хоста происходит только при подключении конечной точки.
host_check_policy
list
Один или несколько правил, требующих от конечной точки наличия определённого защитного программного обеспечения.
name
string / обязательно
Имя списка программного обеспечения для проверки хоста. Источник: vpn.ssl.web.host-check-software.name.
ip_mode
string
    Варианты:
  • диапазон
  • пользовательская группа
Способ, которым пользователи этого SSL-VPN туннеля получают IP-адреса.
ip_pools
list
IPv4 объекты адресов источников брандмауэра, зарезервированные для клиентов SSL-VPN туннеля.
name
string / обязательно
Имя адреса. Источник firewall.address.name firewall.addrgrp.name.
ipv6_dns_server1
string
IPv6 DNS-сервер 1.
ipv6_dns_server2
string
IPv6 DNS-сервер 2.
ipv6_exclusive_routing
string
    Варианты:
  • включить
  • отключить
Включить/отключить маршрутизацию всего IPv6 трафика только через туннель.
ipv6_pools
list
IPv4 объекты адресов источников брандмауэра, зарезервированные для клиентов SSL-VPN туннеля.
name
string / обязательно
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name.
ipv6_service_restriction
string
    Варианты:
  • включить
  • отключить
Включить/отключить ограничение сервисов IPv6 туннеля.
ipv6_split_tunneling
string
    Варианты:
  • включить
  • отключить
Включить/отключить разделение туннелей IPv6.
ipv6_split_tunneling_routing_address
list
IPv6 SSL-VPN адреса брандмауэра, которые переопределяют целевые адреса правил брандмауэра для управления доступом в режиме разделения туннелей.
name
string / обязательно
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name.
ipv6_tunnel_mode
string
    Варианты:
  • включить
  • отключить
Включить/отключить режим IPv6 SSL-VPN туннеля.
ipv6_wins_server1
string
IPv6 WINS-сервер 1.
ipv6_wins_server2
string
Сервер WINS IPv6 2.
keep_alive
string
    Варианты:
  • enable
  • disable
Включить/выключить автоматическое переподключение для подключений FortiClient.
limit_user_logins
string
    Варианты:
  • enable
  • disable
Включить ограничение одного сеанса SSL-VPN для каждого пользователя.
mac_addr_action
string
    Варианты:
  • allow
  • deny
Действие по MAC-адресу клиента.
mac_addr_check
string
    Варианты:
  • enable
  • disable
Включить/выключить проверку MAC-адреса хоста.
mac_addr_check_rule
list
Правило проверки MAC-адреса клиента.
mac_addr_list
list
Список MAC-адресов клиентов.
addr
string / обязательно
MAC-адрес клиента.
mac_addr_mask
integer
Маска MAC-адреса клиента.
name
string / обязательно
Имя правила проверки MAC-адреса клиента.
macos_forticlient_download_url
string
Ссылка для скачивания Mac FortiClient.
name
string / обязательно
Имя портала.
os_check
string
    Варианты:
  • enable
  • disable
Включить, чтобы FortiGate определял действие на основе операционной системы клиента.
os_check_list
list
Проверки ОС SSL VPN.
action
string
    Варианты:
  • deny
  • allow
  • check-up-to-date
Параметры проверки ОС.
latest_patch_level
string
Последний уровень обновления ОС.
name
string / обязательно
Имя.
tolerance
integer
Допустимая разница в уровнях обновлений ОС.
redir_url
string
URL перенаправления входа клиента.
save_password
string
    Варианты:
  • enable
  • disable
Включить/выключить сохранение пароля пользователя FortiClient.
service_restriction
string
    Варианты:
  • enable
  • disable
Включить/выключить ограничение сервисов туннеля.
skip_check_for_unsupported_browser
string
    Варианты:
  • enable
  • disable
Включить пропуск проверки хоста, если браузер её не поддерживает.
skip_check_for_unsupported_os
string
    Варианты:
  • enable
  • disable
Включить пропуск проверки хоста, если операционная система клиента её не поддерживает.
smb_ntlmv1_auth
string
    Варианты:
  • enable
  • disable
Включить поддержку NTLMv1 для аутентификации Samba.
smbv1
string
    Варианты:
  • enable
  • disable
Включить/выключить поддержку SMBv1 для Samba.
split_dns
list
Разделение DNS для SSL VPN.
dns_server1
string
DNS-сервер 1.
dns_server2
string
DNS-сервер 2.
domains
string
Домены разделенного DNS, используемые для клиентов SSL-VPN, разделенные запятой (,) .
id
integer / обязательно
Идентификатор.
ipv6_dns_server1
string
IPv6 DNS-сервер 1.
ipv6_dns_server2
string
IPv6 DNS-сервер 2.
split_tunneling
string
    Варианты:
  • enable
  • disable
Включить/выключить разделение туннелей IPv4.
split_tunneling_routing_address
list
Объекты адресов межсетевого экрана для режима туннеля IPv4 SSL-VPN, которые переопределяют адреса назначения политики межсетевого экрана для управления доступом при разделении туннелей.
name
string / обязательно
Имя адреса. Источник firewall.address.name firewall.addrgrp.name.
state
string
    Варианты:
  • present
  • absent
Устарело
Начиная с Ansible 2.9, рекомендуется использовать параметр "state" на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
theme
string
    Варианты:
  • blue
  • green
  • red
  • melongene
  • mariner
Схема цветовой схемы веб-портала.
tunnel_mode
string
    Варианты:
  • enable
  • disable
Включить/выключить режим туннеля IPv4 SSL-VPN.
user_bookmark
string
    Варианты:
  • enable
  • disable
Включить возможность пользователям веб-портала создавать свои закладки.
user_group_bookmark
строка
    Варианты:
  • enable
  • disable
Включить для пользователей веб-портала возможность создания закладок для всех пользователей в той же группе пользователей.
web_mode
строка
    Варианты:
  • enable
  • disable
Включить/отключить веб-режим SSL VPN.
windows_forticlient_download_url
строка
URL загрузки Windows FortiClient.
wins_server1
строка
IPv4 WINS-сервер 1.
wins_server2
строка
IPv4 WINS-сервер 1.

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Запуск как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Portal.
    fortios_vpn_ssl_web_portal:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      vpn_ssl_web_portal:
        allow_user_access: "web"
        auto_connect: "enable"
        bookmark_group:
         -
            bookmarks:
             -
                additional_params: "<your_own_value>"
                apptype: "citrix"
                description: "<your_own_value>"
                folder: "<your_own_value>"
                form_data:
                 -
                    name: "default_name_12"
                    value: "<your_own_value>"
                host: "<your_own_value>"
                listening_port: "15"
                load_balancing_info: "<your_own_value>"
                logon_password: "<your_own_value>"
                logon_user: "<your_own_value>"
                name: "default_name_19"
                port: "20"
                preconnection_blob: "<your_own_value>"
                preconnection_id: "22"
                remote_port: "23"
                security: "rdp"
                server_layout: "de-de-qwertz"
                show_status_window: "enable"
                sso: "disable"
                sso_credential: "sslvpn-login"
                sso_credential_sent_once: "enable"
                sso_password: "<your_own_value>"
                sso_username: "<your_own_value>"
                url: "myurl.com"
            name: "default_name_33"
        custom_lang: "<your_own_value> (source system.custom-language.name)"
        customize_forticlient_download_url: "enable"
        display_bookmark: "enable"
        display_connection_tools: "enable"
        display_history: "enable"
        display_status: "enable"
        dns_server1: "<your_own_value>"
        dns_server2: "<your_own_value>"
        dns_suffix: "<your_own_value>"
        exclusive_routing: "enable"
        forticlient_download: "enable"
        forticlient_download_method: "direct"
        heading: "<your_own_value>"
        hide_sso_credential: "enable"
        host_check: "none"
        host_check_interval: "49"
        host_check_policy:
         -
            name: "default_name_51 (source vpn.ssl.web.host-check-software.name)"
        ip_mode: "range"
        ip_pools:
         -
            name: "default_name_54 (source firewall.address.name firewall.addrgrp.name)"
        ipv6_dns_server1: "<your_own_value>"
        ipv6_dns_server2: "<your_own_value>"
        ipv6_exclusive_routing: "enable"
        ipv6_pools:
         -
            name: "default_name_59 (source firewall.address6.name firewall.addrgrp6.name)"
        ipv6_service_restriction: "enable"
        ipv6_split_tunneling: "enable"
        ipv6_split_tunneling_routing_address:
         -
            name: "default_name_63 (source firewall.address6.name firewall.addrgrp6.name)"
        ipv6_tunnel_mode: "enable"
        ipv6_wins_server1: "<your_own_value>"
        ipv6_wins_server2: "<your_own_value>"
        keep_alive: "enable"
        limit_user_logins: "enable"
        mac_addr_action: "allow"
        mac_addr_check: "enable"
        mac_addr_check_rule:
         -
            mac_addr_list:
             -
                addr: "<your_own_value>"
            mac_addr_mask: "74"
            name: "default_name_75"
        macos_forticlient_download_url: "<your_own_value>"
        name: "default_name_77"
        os_check: "enable"
        os_check_list:
         -
            action: "deny"
            latest_patch_level: "<your_own_value>"
            name: "default_name_82"
            tolerance: "83"
        redir_url: "<your_own_value>"
        save_password: "enable"
        service_restriction: "enable"
        skip_check_for_unsupported_browser: "enable"
        skip_check_for_unsupported_os: "enable"
        smb_ntlmv1_auth: "enable"
        smbv1: "enable"
        split_dns:
         -
            dns_server1: "<your_own_value>"
            dns_server2: "<your_own_value>"
            domains: "<your_own_value>"
            id:  "95"
            ipv6_dns_server1: "<your_own_value>"
            ipv6_dns_server2: "<your_own_value>"
        split_tunneling: "enable"
        split_tunneling_routing_address:
         -
            name: "default_name_100 (source firewall.address.name firewall.addrgrp.name)"
        theme: "blue"
        tunnel_mode: "enable"
        user_bookmark: "enable"
        user_group_bookmark: "enable"
        web_mode: "enable"
        windows_forticlient_download_url: "<your_own_value>"
        wins_server1: "<your_own_value>"
        wins_server2: "<your_own_value>"

Значения возврата

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

Ключ Возвращаемое значение Описание
build
строка
всегда
Номер сборки образа fortigate

Пример:
1547
http_method
строка
всегда
Последний метод, используемый для размещения содержимого в FortiGate

Пример:
PUT
http_status
строка
всегда
Последний результат, полученный от FortiGate при последнем примененном действии

Пример:
200
mkey
строка
успех
Главный ключ (id), использованный при последнем обращении к FortiGate

Пример:
id
name
строка
всегда
Имя таблицы, используемой для выполнения запроса

Пример:
urlfilter
path
строка
всегда
Путь к таблице, используемой для выполнения запроса

Пример:
webfilter
revision
строка
всегда
Внутренний номер ревизии

Пример:
17.0.2.10658
serial
строка
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
строка
всегда
Указание результата операции

Пример:
успех
vdom
строка
всегда
Используемый виртуальный домен

Пример:
root
version
строка
всегда
Версия FortiGate

Пример:
v5.6.3


Состояние

  • Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_vpn_ssl_web_portal_module.html

Spec-Zone.ru

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