Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_firewall_internetserviceextension — Настройка расширения интернет-служб.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_internetserviceextension.

Добавлено в fortinet.fortimanager 2.10.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiManager.
  • Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

firewall_internetserviceextension

dictionary

Параметры верхнего уровня.

comment

string

Комментарий.

disable_entry

псевдонимы: disable-entry

list / elements=dictionary

Отключенная запись.

addr_mode

псевдонимы: addr-mode

string

Режим адресации

Варианты:

  • "ipv4"
  • "ipv6"

id

integer

Идентификатор отключенной записи.

ip6_range

псевдонимы: ip6-range

list / elements=dictionary

Диапазон IPv6-адресов.

end_ip6

псевдонимы: end-ip6

string

Конечный IPv6-адрес.

id

integer

Идентификатор диапазона отключенных записей.

start_ip6

псевдонимы: start-ip6

string

Начальный IPv6-адрес.

ip_range

псевдонимы: ip-range

list / elements=dictionary

Диапазон IP-адресов.

end_ip

псевдонимы: end-ip

string

Конечный IPv4-адрес.

id

integer

Идентификатор диапазона отключенных записей.

start_ip

псевдонимы: start-ip

string

Начальный IPv4-адрес.

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

entry

list / elements=dictionary

Запись.

addr_mode

псевдонимы: addr-mode

string

Режим адресации

Варианты:

  • "ipv4"
  • "ipv6"

dst

list / elements=string

Адрес назначения или имя группы адресов.

dst6

list / elements=string

Адрес IPv6 назначения или имя группы адресов IPv6.

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

list / elements=string / обязательный

Идентификатор интернет-службы в базе данных интернет-служб.

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global или другое значение, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 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 Extension.
      fortinet.fortimanager.fmgr_firewall_internetserviceextension:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        firewall_internetserviceextension:
          id: [] # Required variable
          # comment: <string>
          # disable_entry:
          #   - addr_mode: <value in [ipv4, ipv6]>
          #     id: <integer>
          #     ip_range:
          #       - end_ip: <string>
          #         id: <integer>
          #         start_ip: <string>
          #     ip6_range:
          #       - end_ip6: <string>
          #         id: <integer>
          #         start_ip6: <string>
          #     port_range:
          #       - end_port: <integer>
          #         id: <integer>
          #         start_port: <integer>
          #     protocol: <integer>
          # entry:
          #   - addr_mode: <value in [ipv4, ipv6]>
          #     dst: <list or string>
          #     dst6: <list or string>
          #     id: <integer>
          #     port_range:
          #       - end_port: <integer>
          #         id: <integer>
          #         start_port: <integer>
          #     protocol: <integer>

Возвращаемые значения

Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager.

Возвращается: при выполнении сложных условий

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки коллекции

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API