Модуль fortinet.fortimanager.fmgr_vpnsslweb_hostchecksoftware – Программное обеспечение проверки хостов SSL-VPN.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_vpnsslweb_hostchecksoftware.
Добавлен в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых условия будут переопределены для неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых условия будут переопределены для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
vpnsslweb_hostchecksoftware словарь | Набор параметров верхнего уровня. |
|
check-item-list список / элементы=словарь |
Устаревшее, пожалуйста, переименуйте на check_item_list. Список элементов проверки. |
|
action строка |
Действие. Варианты:
|
|
id целое число |
Идентификатор |
|
md5s любой |
(список) контрольная сумма MD5. |
|
target строка |
Цель. |
|
type строка |
Тип. Варианты:
|
|
version строка |
Версия. |
|
guid строка |
Глобально уникальный идентификатор. |
|
name строка / обязательно |
Имя. |
|
os_type строка |
Устаревшее, пожалуйста, переименуйте на os_type. Тип ОС. Варианты:
|
|
type строка |
Тип. Варианты:
|
|
версия строка |
Версия. |
workspace_locking_adom строка | Область управления (ADOM), которая должна быть заблокирована для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют имена с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов всё ещё доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: SSL-VPN host check software.
fortinet.fortimanager.fmgr_vpnsslweb_hostchecksoftware:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
vpnsslweb_hostchecksoftware:
check_item_list:
-
action: <value in [deny, require]>
id: <integer>
md5s: <list or string>
target: <string>
type: <value in [file, registry, process]>
version: <string>
guid: <string>
name: <string>
os_type: <value in [macos, windows]>
type: <value in [av, fw]>
version: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращаемое значение: всегда |
|
request_url строка |
Полный URL запроса. Возвращаемое значение: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращаемое значение: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращаемое значение: всегда |
|
response_message строка |
Описание ответа API. Возвращаемое значение: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращаемое значение: всегда |
rc целое число | Статус запроса. Возвращаемое значение: всегда Пример: |
предупреждение_проверки_версии список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращаемое значение: сложный |
Ссылки на коллекцию
© 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/fortimanager/fmgr_vpnsslweb_hostchecksoftware_module.html
