Модуль fortinet.fortimanager.fmgr_firewall_internetserviceextension_entry — записи, добавленные в базу данных расширений интернет-службы.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_internetserviceextension_entry.
Добавлено в fortinet.fortimanager 2.10.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Описание |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в случае расхождения схемы модуля со структурой API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
firewall_internetserviceextension_entry dictionary | Набор параметров верхнего уровня. |
|
addr_mode псевдонимы: addr-mode string |
Режим адресации Варианты:
|
|
dst list / элементы=string |
Адрес назначения или имя группы адресов. |
|
dst6 list / элементы=string |
Адрес IPv6 назначения или имя группы адресов IPv6. |
|
id integer / обязательный |
Идентификатор записи |
|
port_range псевдонимы: port-range list / элементы=dictionary |
Диапазон портов. |
|
end_port псевдонимы: end-port integer |
Целочисленное значение конечного порта назначения TCP/UDP/SCTP в диапазоне |
|
id integer |
Идентификатор пользовательского диапазона портов записи. |
|
start_port псевдонимы: start-port integer |
Целочисленное значение начального порта назначения TCP/UDP/SCTP в диапазоне |
|
protocol integer |
Целочисленное значение типа протокола согласно определению IANA |
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
internet-service-extension string | Устарел. Используйте «internet_service_extension» |
internet_service_extension string | Параметр (internet-service-extension) в запрошенном URL. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
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: Entries added to the Internet Service extension database.
fortinet.fortimanager.fmgr_firewall_internetserviceextension_entry:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
internet_service_extension: <your own value>
state: present # <value in [present, absent]>
firewall_internetserviceextension_entry:
id: 0 # Required variable, integer
# addr_mode: <value in [ipv4, ipv6]>
# dst: <list or string>
# dst6: <list or string>
# port_range:
# - end_port: <integer>
# id: <integer>
# start_port: <integer>
# protocol: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса к API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=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_firewall_internetserviceextension_entry_module.html
