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