Модуль fortinet.fortimanager.fmgr_firewall_internetservice – Просмотр приложения Интернет-службы.

Примечание

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

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

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

Для использования в playbook укажите: fortinet.fortimanager.fmgr_firewall_internetservice.

Новая функция в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_internetservice словарь	Параметры верхнего уровня.
city любой	(список) Список номеров последовательности городов.
city6 любой	(список) Список номеров последовательности городов IPv6.
country любой	(список) Список номеров последовательности стран.
country6 любой	(список) Список номеров последовательности стран IPv6.
database строка	База данных. Варианты: `"isdb"` `"irdb"`
direction строка	Направление. Варианты: `"src"` `"dst"` `"both"`
entry список / элементы=словарь	Запись.
id целое число	Идентификатор записи.
ip_number целое число	Общее количество IP-адресов.
ip_range_number целое число	Общее количество диапазонов IP-адресов.
port любой	(список) Целочисленное значение порта TCP/IP
protocol целое число	Целое значение типа протокола, определенного IANA
extra_ip_range_number целое число	Количество дополнительных диапазонов IP-адресов.
extra_ip6_range_number целое число	Количество дополнительных диапазонов IP6-адресов.
icon_id целое число	Идентификатор иконки.
id целое число	Идентификатор.
ip_number целое число	Количество IP-адресов.
ip_range_number целое число	Количество диапазонов IP-адресов.

END_OF_DOCUMENT_MARKER

ip6-range-number целое число	Устарело, переименуйте на ip6_range_number. Номер диапазона IPv6.
jitter-threshold целое число	Устарело, переименуйте на jitter_threshold. Пороговое значение джиттера.
latency-threshold целое число	Устарело, переименуйте на latency_threshold. Пороговое значение задержки.
name строка	Имя.
obsolete целое число	Устаревший.
offset целое число	Смещение.
packetloss-threshold целое число	Устарело, переименуйте на packetloss_threshold. Пороговое значение потерь пакетов.
region любой	(список) Список последовательных номеров регионов.
region6 любой	(список) Список последовательных номеров регионов IPv6.
reputation целое число	Репутация.
singularity целое число	Уникальность.
sld-id целое число	Устарело, переименуйте на sld_id. Идентификатор SLD.
forticloud_access_token строка	Авторизуйте Ansible-клиент с токеном доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, по которым будут переопределены условия для завершения работы с ошибкой.
rc_succeeded список / элементы=целое число	Список rc-кодов, по которым будут переопределены условия для успешного завершения работы.
workspace_locking_adom строка	ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Show Internet Service application.
      fortinet.fortimanager.fmgr_firewall_internetservice:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        firewall_internetservice:
          database: <value in [isdb, irdb]>
          direction: <value in [src, dst, both]>
          entry:
            -
              id: <integer>
              ip_number: <integer>
              ip_range_number: <integer>
              port: <list or integer>
              protocol: <integer>
          icon_id: <integer>
          id: <integer>
          name: <string>
          offset: <integer>
          reputation: <integer>
          sld_id: <integer>
          extra_ip_range_number: <integer>
          ip_number: <integer>
          ip_range_number: <integer>
          jitter_threshold: <integer>
          latency_threshold: <integer>
          obsolete: <integer>
          packetloss_threshold: <integer>
          singularity: <integer>
          city: <list or integer>
          country: <list or integer>
          region: <list or integer>
          city6: <list or integer>
          country6: <list or integer>
          extra_ip6_range_number: <integer>
          ip6_range_number: <integer>
          region6: <list or integer>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_internetservice_module.html