fortinet.fortimanager.fmgr_firewall_internetservicecustom – Настройка пользовательских интернет-служб.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_internetservicecustom.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation логический тип				Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_internetservicecustom словарь					устанавливаемые параметры верхнего уровня
	comment строка				Комментарий.
	disable-entry список / элементы=строка				нет описания
		id целое число			Идентификатор отключения записи.
		ip-range список / элементы=строка			нет описания
			end-ip строка		Конечный IP-адрес.
			id целое число		Идентификатор диапазона отключения записи.
			start-ip строка		Начальный IP-адрес.
		port целое число			нет описания
		protocol целое число			Целое значение типа протокола, определенного IANA (0 - 255).
	entry список / элементы=строка				нет описания
		dst строка			Адрес назначения или имя группы адресов.
		id целое число			Идентификатор записи (1-255).
		port-range список / элементы=строка			нет описания
			end-port целое число		Целое значение конечного порта назначения TCP/UDP/SCTP в диапазоне (1 до 65535).
			id целое число		Идентификатор пользовательского диапазона портов.
			start-port целое число		Целое значение начального порта назначения TCP/UDP/SCTP в диапазоне (1 до 65535).
		protocol целое число			Целое значение типа протокола, определенного IANA (0 - 255).
	master-service-id строка				Идентификатор интернет-службы в базе данных интернет-служб.
	name строка				Имя интернет-службы.
rc_failed список / элементы=строка					список кодов rc, с которыми условия отказа будут переопределены
rc_succeeded список / элементы=строка					список кодов rc, с которыми условия успеха будут переопределены
state строка / обязательно				Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_adom строка					домен для блокировки FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число				Значение по умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем

Примечания

Примечание

Поддержка работы в режиме блокировки рабочей области в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте указание state present.
Для удаления объекта используйте указание state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Также можно переопределить условия для отказа или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure custom Internet Services.
     fmgr_firewall_internetservicecustom:
        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>
        state: <value in [present, absent]>
        firewall_internetservicecustom:
           comment: <value of string>
           disable-entry:
             -
                 id: <value of integer>
                 ip-range:
                   -
                       end-ip: <value of string>
                       id: <value of integer>
                       start-ip: <value of string>
                 port: <value of integer>
                 protocol: <value of integer>
           entry:
             -
                 dst: <value of string>
                 id: <value of integer>
                 port-range:
                   -
                       end-port: <value of integer>
                       id: <value of integer>
                       start-port: <value of integer>
                 protocol: <value of integer>
           master-service-id: <value of string>
           name: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_internetservicecustom_module.html