Модуль fortinet.fortimanager.fmgr_system_localinpolicy — настройка локальной политики входящего трафика IPv4.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_localinpolicy.
Добавлено в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
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, переопределяющий условия, при которых выполнение считается успешным. |
state string / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
system_localinpolicy dictionary | Набор параметров верхнего уровня. |
|
action string |
Действие, применяемое к трафику, соответствующему этой политике. drop — отбрасывать трафик, соответствующий этой политике reject — отклонять трафик, соответствующий этой политике. accept — разрешать трафик, соответствующий этой политике. Варианты:
|
|
description string |
Описание. |
|
dport integer |
Номер порта назначения |
|
dst string |
IP-адрес и маска назначения. |
|
id integer / обязательный |
Номер записи. |
|
intf string |
Имя входящего интерфейса. |
|
protocol string |
Протокол трафика. tcp — только TCP. udp — только UDP. tcp_udp — TCP и UDP. Варианты:
|
|
src string |
IP-адрес и маска источника. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другой ADOM, включая 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: IPv4 local in policy configuration.
fortinet.fortimanager.fmgr_system_localinpolicy:
# workspace_locking_adom: <global or your adom name>
state: present # <value in [present, absent]>
system_localinpolicy:
id: 0 # Required variable, integer
# action: <value in [drop, reject, accept]>
# dport: <integer>
# dst: <string>
# intf: <string>
# protocol: <value in [tcp, udp, tcp_udp]>
# src: <string>
# description: <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_system_localinpolicy_module.html