Модуль fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry — записи, добавленные в базу данных дополнений интернет-сервисов.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать ее в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо настроить с учетом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логический | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log логический | Включить или отключить ведение журнала для задачи. Варианты:
|
firewall_internetserviceaddition_entry словарь | Набор параметров верхнего уровня. |
|
addr_mode псевдонимы: addr-mode строка |
Режим адресации Варианты:
|
|
id целое число / обязательный |
Идентификатор записи |
|
port_range псевдонимы: port-range список / элементы=словарь |
Диапазон портов. |
|
end_port псевдонимы: end-port целое число |
Целочисленное значение конечного порта назначения TCP/UDP/SCTP в диапазоне |
|
id целое число |
Идентификатор диапазона портов пользовательской записи. |
|
start_port псевдонимы: start-port целое число |
Целочисленное значение начального порта назначения TCP/UDP/SCTP в диапазоне |
|
protocol целое число |
Целочисленное значение типа протокола согласно определению IANA |
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
internet-service-addition строка | Устарело; используйте “internet_service_addition” |
internet_service_addition строка | Параметр (internet-service-addition) в запрошенном URL. |
proposed_method строка | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, переопределяющий условия неудачного выполнения. |
rc_succeeded список / элементы=целое число | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note строка | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state строка / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
workspace_locking_adom строка | ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global или другие значения, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 addition database.
fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
internet_service_addition: <your own value>
state: present # <value in [present, absent]>
firewall_internetserviceaddition_entry:
id: 0 # Required variable, integer
# port_range:
# - end_port: <integer>
# id: <integer>
# start_port: <integer>
# protocol: <integer>
# addr_mode: <value in [ipv4, ipv6]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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–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_internetserviceaddition_entry_module.html
