fortinet.fortimanager.fmgr_waf_profile_urlaccess модуль — список доступа к URL
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_waf_profile_urlaccess.
Добавлена в 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. |
profile строка / обязательно | Параметр (profile) в запрошенном URL. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список кодов rc, с помощью которых будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое | Список кодов rc, с помощью которых будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
waf_profile_urlaccess словарь | Настройка параметров верхнего уровня. |
|
access-pattern список / элементы=словарь |
Устарело, переименуйте на access_pattern. Шаблон доступа. |
|
id целое |
Идентификатор шаблона доступа к URL. |
|
negate строка |
Включение/отключение отрицания совпадения. Варианты:
|
|
pattern строка |
Шаблон URL. |
|
regex строка |
Включение/отключение соответствия шаблону на основе регулярных выражений. Варианты:
|
|
srcaddr строка |
Адрес источника. |
|
action строка |
Действие. Варианты:
|
|
address строка |
Адрес хоста. |
|
id целое / обязательно |
Идентификатор доступа к URL. |
|
log строка |
Включение/выключение ведения журнала. Варианты:
|
|
severity string |
Уровень важности. Варианты:
|
workspace_locking_adom string | ADOM для блокировки в режиме работы FortiManager в рабочей области. Значение может быть глобальным и другими, включая корневой. |
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 помогают в этом.
- Для создания или обновления объекта используйте директиву 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: URL access list
fortinet.fortimanager.fmgr_waf_profile_urlaccess:
# 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>
profile: <your own value>
state: present # <value in [present, absent]>
waf_profile_urlaccess:
access_pattern:
-
id: <integer>
negate: <value in [disable, enable]>
pattern: <string>
regex: <value in [disable, enable]>
srcaddr: <string>
action: <value in [bypass, permit, block]>
address: <string>
id: <integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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_waf_profile_urlaccess_module.html
