Модуль fortinet.fortimanager.fmgr_vpnsslweb_realm — область.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_vpnsslweb_realm.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль предназначен для настройки устройства FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
vpnsslweb_realm dictionary | Набор параметров верхнего уровня. |
|
login_page псевдонимы: login-page string |
HTML-код страницы входа SSL-VPN, заменяющий исходный. |
|
max_concurrent_user псевдонимы: max-concurrent-user integer |
Максимальное количество одновременных пользователей |
|
nas_ip псевдонимы: nas-ip string |
IP-адрес, используемый в качестве NAS-IP для связи с сервером RADIUS. |
|
radius_port псевдонимы: radius-port integer |
Номер порта службы RADIUS |
|
radius_server псевдонимы: radius-server string |
Сервер RADIUS, связанный с областью. |
|
url_path псевдонимы: url-path string |
Путь URL для доступа к странице входа SSL-VPN. |
|
virtual_host псевдонимы: virtual-host string |
Имя виртуального хоста для области. |
|
virtual_host_only псевдонимы: virtual-host-only string |
Включить/отключить обязательное использование метода виртуального хоста для доступа клиентов SSL-VPN. Варианты:
|
|
virtual_host_server_cert псевдонимы: virtual-host-server-cert string |
Имя сертификата сервера, используемого для этой области. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов соответствуют соглашению об именовании с подчеркиванием (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Чтобы игнорировать эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня 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: Realm.
fortinet.fortimanager.fmgr_vpnsslweb_realm:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
vpnsslweb_realm:
# login_page: <string>
# max_concurrent_user: <integer>
# url_path: <string>
# virtual_host: <string>
# nas_ip: <string>
# radius_server: <string>
# radius_port: <integer>
# virtual_host_only: <value in [disable, enable]>
# virtual_host_server_cert: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение, если параметры плейбука не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_vpnsslweb_realm_module.html
