Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Для использования в playbook укажите: fortinet.fortios.fortios_vpn_ssl_web_portal.

Новое в версии 2.8: модуля fortinet.fortios

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

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

Требования

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

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate.
state
строка
добавлен в 2.9 fortinet.fortios
    Варианты:
  • present
  • absent
Указывает, нужно ли создавать или удалять объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перемещён на этот внешний уровень.
vdom
строка
Значение по умолчанию:
"root"
Виртуальный домен из тех, что определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный блок.
vpn_ssl_web_portal
словарь
Портал.
allow_user_access
строка
    Варианты:
  • web
  • ftp
  • smb
  • telnet
  • ssh
  • vnc
  • rdp
  • ping
  • citrix
  • portforward
Разрешить пользователю доступ к приложениям SSL-VPN.
auto_connect
строка
    Варианты:
  • enable
  • disable
Включить/выключить автоматическое подключение клиентом при включении системы.
bookmark_group
список / элементы=строка
Группа закладок портала.
bookmarks
список / элементы=строка
Таблица закладок.
additional_params
строка
Дополнительные параметры.
apptype
строка
    Варианты:
  • citrix
  • ftp
  • portforward
  • rdp
  • smb
  • ssh
  • telnet
  • vnc
  • web
Тип приложения.
description
строка
Описание.
folder
строка
Параметр сетевой общей папки.
form_data
список / элементы=строка
Данные формы.
name
строка / обязательно
Имя.
value
строка
Значение.
host
строка
Имя хоста/IP-адрес.
listening_port
целое число
Порт прослушивания (0—65535).
logon_password
строка
Пароль входа.
logon_user
строка
Пользователь для входа.
name
строка / обязательно
Имя закладки.
port
целое число
Удаленный порт.
remote_port
целое число
Удаленный порт (0—65535).
security
строка
    Варианты:
  • rdp
  • nla
  • tls
  • any
Режим безопасности для подключения RDP.
server_layout
строка
    Варианты:
  • en-us-qwerty
  • de-de-qwertz
  • fr-fr-azerty
  • it-it-qwerty
  • sv-se-qwerty
  • failsafe
Макет клавиатуры сервера.
show_status_window
строка
    Варианты:
  • enable
  • disable
Включить/выключить отображение окна состояния.
sso
строка
    Варианты:
  • disable
  • static
  • auto
Single Sign-On.
sso_credential
строка
    Варианты:
  • sslvpn-login
  • alternative
Данные для Single Sign-On.
sso_credential_sent_once
строка
    Варианты:
  • enable
  • disable
Данные для Single Sign-On отправляются на удалённый сервер только один раз.
sso_password
строка
Пароль SSO.
sso_username
строка
Имя пользователя SSO.
url
строка
Параметр URL.
name
строка / обязательно
Имя группы закладок.
custom_lang
строка
Изменение языка веб-портала. Переопределяет глобальный язык системы конфигурации. Можно использовать конфигурацию системы custom-language и выполнить систему custom-language для добавления файлов с пользовательскими языками. Источник system.custom-language.name.
customize_forticlient_download_url
строка
    Варианты:
  • enable
  • disable
Включить поддержку настраиваемого URL-адреса загрузки для FortiClient.
display_bookmark
строка
    Варианты:
  • enable
  • disable
Включить отображение виджета закладок веб-портала.
display_connection_tools
строка
    Варианты:
  • enable
  • disable
Включить отображение виджета инструментов подключения веб-портала.
display_history
строка
    Варианты:
  • enable
  • disable
Включить отображение виджета истории входа в систему пользователя на веб-портале.
display_status
строка
    Варианты:
  • enable
  • disable
Включить отображение виджета состояния веб-портала.
dns_server1
строка
IPv4 DNS-сервер 1.
dns_server2
строка
IPv4 DNS-сервер 2.
dns_suffix
строка
Суффикс DNS.
exclusive_routing
строка
    Варианты:
  • enable
  • disable
Включить/выключить прохождение всего трафика только по туннелю.
forticlient_download
строка
    Варианты:
  • enable
  • disable
Включить/выключить опцию загрузки FortiClient.
forticlient_download_method
string
    Варианты:
  • direct
  • ssl-vpn
Метод загрузки FortiClient.
heading
string
Сообщение заголовка веб-портала.
host_check
string
    Варианты:
  • none
  • av
  • fw
  • av-fw
  • custom
Тип проверки хоста на конечных устройствах.
host_check_interval
integer
Периодичность проверки хоста. Значение 0 означает отключение, и проверка хоста выполняется только при подключении конечного устройства.
host_check_policy
list / elements=string
Один или несколько правил, требующих от конечного устройства наличия определенного защитного программного обеспечения.
name
string / required
Имя списка программного обеспечения проверки хоста. Источник vpn.ssl.web.host-check-software.name.
ip_mode
string
    Варианты:
  • range
  • user-group
Метод получения IP-адресов пользователями этого SSL-VPN туннеля.
ip_pools
list / elements=string
Объекты IPv4 адресов источника брандмауэра, зарезервированные для клиентов режима SSL-VPN туннеля.
name
string / required
Имя адреса. Источник firewall.address.name firewall.addrgrp.name.
ipv6_dns_server1
string
IPv6 DNS-сервер 1.
ipv6_dns_server2
string
IPv6 DNS-сервер 2.
ipv6_exclusive_routing
string
    Варианты:
  • enable
  • disable
Включить/выключить весь IPv6 трафик, проходящий только через туннель.
ipv6_pools
list / elements=string
Объекты IPv4 адресов источника брандмауэра, зарезервированные для клиентов режима SSL-VPN туннеля.
name
string / required
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name.
ipv6_service_restriction
string
    Варианты:
  • enable
  • disable
Включить/выключить ограничение сервисов IPv6 туннеля.
ipv6_split_tunneling
string
    Варианты:
  • enable
  • disable
Включить/выключить IPv6 разделение туннелей.
ipv6_split_tunneling_routing_address
list / elements=string
IPv6 адреса брандмауэра режима туннеля SSL-VPN, которые переопределяют целевые адреса правил брандмауэра для управления доступом при разделении туннелей.
name
string / required
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name.
ipv6_tunnel_mode
string
    Варианты:
  • enable
  • disable
Включить/выключить IPv6 режим SSL-VPN туннеля.
ipv6_wins_server1
string
IPv6 WINS-сервер 1.
ipv6_wins_server2
string
IPv6 WINS-сервер 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 / elements=string
Правило проверки MAC-адреса клиента.
mac_addr_list
list / elements=string
Список MAC-адресов клиентов.
addr
string / required
MAC-адрес клиента.
mac_addr_mask
integer
Маска MAC-адреса клиента.
name
string / required
Имя правила проверки MAC-адреса клиента.
macos_forticlient_download_url
string
URL для загрузки Mac FortiClient.
name
string / required
Имя портала.
os_check
string
    Варианты:
  • enable
  • disable
Включить, чтобы FortiGate определял действие на основе ОС клиента.
os_check_list
list / elements=string
Проверки ОС SSL VPN.
action
string
    Варианты:
  • deny
  • allow
  • check-up-to-date
Варианты проверки ОС.
latest_patch_level
string
Последний уровень обновления ОС.
name
string / required
Имя.
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.
split_dns
list / elements=string
Разделение DNS для SSL VPN.
dns_server1
string
DNS-сервер 1.
dns_server2
string
DNS-сервер 2.
domains
string
Домены разделения DNS для клиентов SSL-VPN, разделенные запятыми (,).
id
целое число / обязательно
Идентификатор.
ipv6_dns_server1
строка
Сервер DNS IPv6 1.
ipv6_dns_server2
строка
Сервер DNS IPv6 2.
split_tunneling
строка
    Варианты:
  • enable
  • disable
Включить/выключить IPv4 разделение туннелей.
split_tunneling_routing_address
список / элементы=строка
Объекты адресов брандмауэра режима туннеля IPv4 SSL-VPN, которые переопределяют адреса назначения политики брандмауэра для управления доступом при разделении туннелей.
name
строка / обязательно
Имя адреса. Имя адреса брандмауэра исходного firewall.address.name firewall.addrgrp.name.
state
строка
    Варианты:
  • present
  • absent
Устаревшее
Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
theme
строка
    Варианты:
  • blue
  • green
  • red
  • melongene
  • mariner
Схема цветовой гаммы веб-портала.
tunnel_mode
строка
    Варианты:
  • enable
  • disable
Включить/выключить режим туннеля IPv4 SSL-VPN.
user_bookmark
строка
    Варианты:
  • enable
  • disable
Включить, чтобы пользователи веб-портала могли создавать свои закладки.
user_group_bookmark
строка
    Варианты:
  • enable
  • disable
Включить, чтобы пользователи веб-портала могли создавать закладки для всех пользователей в той же группе пользователей.
web_mode
строка
    Варианты:
  • enable
  • disable
Включить/выключить веб-режим SSL VPN.
windows_forticlient_download_url
строка
Ссылка для скачивания Windows FortiClient.
wins_server1
строка
Сервер WINS IPv4 1.
wins_server2
строка
Сервер WINS IPv4 1.

Примечания

Примечание

  • Устаревший fortiosapi устарел, httpapi является предпочтительным способом запуска playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Portal.
    fortios_vpn_ssl_web_portal:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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"
                logon_password: "<your_own_value>"
                logon_user: "<your_own_value>"
                name: "default_name_18"
                port: "19"
                remote_port: "20"
                security: "rdp"
                server_layout: "en-us-qwerty"
                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_30"
        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>"
        host_check: "none"
        host_check_interval: "45"
        host_check_policy:
         -
            name: "default_name_47 (source vpn.ssl.web.host-check-software.name)"
        ip_mode: "range"
        ip_pools:
         -
            name: "default_name_50 (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_55 (source firewall.address6.name firewall.addrgrp6.name)"
        ipv6_service_restriction: "enable"
        ipv6_split_tunneling: "enable"
        ipv6_split_tunneling_routing_address:
         -
            name: "default_name_59 (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: "70"
            name: "default_name_71"
        macos_forticlient_download_url: "<your_own_value>"
        name: "default_name_73"
        os_check: "enable"
        os_check_list:
         -
            action: "deny"
            latest_patch_level: "<your_own_value>"
            name: "default_name_78"
            tolerance: "79"
        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"
        split_dns:
         -
            dns_server1: "<your_own_value>"
            dns_server2: "<your_own_value>"
            domains: "<your_own_value>"
            id:  "90"
            ipv6_dns_server1: "<your_own_value>"
            ipv6_dns_server2: "<your_own_value>"
        split_tunneling: "enable"
        split_tunneling_routing_address:
         -
            name: "default_name_95 (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


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_vpn_ssl_web_portal_module.html

Spec-Zone.ru

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