Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_firewall_address — настройка IPv4-адресов в Fortinet FortiOS и FortiGate.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_firewall_address.

Добавлено в fortinet.fortios 2.0.0

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

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры межсетевого экрана и категорию адресов. В примерах приведены все параметры и значения, которые перед использованием необходимо скорректировать в соответствии с источниками данных. Проверено с FOS v6.0.0

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.

enable_log

boolean

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

Варианты:

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

firewall_address

dictionary

Настройка адресов IPv4.

agent_id

string

Идентификатор агента телеметрии. Источник: telemetry-controller.agent.agent-id.

allow_routing

string

Включить или отключить использование этого адреса в конфигурациях маршрутизации.

Варианты:

  • "enable"
  • "disable"

associated_interface

string

Сетевой интерфейс, связанный с адресом. Источники: system.interface.name, system.zone.name.

cache_ttl

integer

Задает минимальное значение TTL отдельных IP-адресов в кэше FQDN в секундах.

clearpass_spt

string

Значение SPT (токена состояния системы).

Варианты:

  • "unknown"
  • "healthy"
  • "quarantine"
  • "checkup"
  • "transient"
  • "infected"

color

integer

Цвет значка в графическом интерфейсе.

comment

string

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

country

string

IP-адреса, связанные с определенной страной.

end_ip

string

Последний IP-адрес (включительно) в диапазоне адресов.

end_mac

string

Последний MAC-адрес в диапазоне.

epg_name

string

Имя группы конечных точек.

fabric_object

string

Параметр глобального объекта Security Fabric.

Варианты:

  • "enable"
  • "disable"

filter

string

Фильтр критериев соответствия.

fqdn

string

Адрес с полным доменным именем.

fsso_group

list / elements=dictionary

Группа или группы FSSO.

name

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

Имя группы FSSO. Источник: user.adgrp.name.

hw_model

string

Динамический адрес с фильтром по модели оборудования.

hw_vendor

string

Динамический адрес с фильтром по производителю оборудования.

interface

string

Имя интерфейса, IP-адрес которого следует использовать. Источник: system.interface.name.

list

list / elements=dictionary

Список IP-адресов.

ip

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

IP-адрес.

net_id

string

Идентификатор сети.

obj_id

string

Идентификатор объекта.

macaddr

list / elements=dictionary

Несколько диапазонов MAC-адресов.

macaddr

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

Диапазоны MAC-адресов <start>[-<end>], разделенные пробелами.

name

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

Имя адреса.

node_ip_only

string

Включить или отключить сбор только адресов узлов в Kubernetes.

Варианты:

  • "enable"
  • "disable"

obj_id

string

Идентификатор объекта NSX.

obj_tag

string

Тег динамического объекта адреса.

obj_type

string

Тип объекта.

Варианты:

  • "ip"
  • "mac"

organization

string

Доменное имя организации (синтаксис: organization/domain).

os

string

Динамический адрес с фильтром по операционной системе.

passive_fqdn_learning

string

Включить или отключить пассивное обучение FQDN. Если эта функция включена, FortiGate получает, проверяет и сохраняет FQDN из DNS-запросов конечных точек.

Варианты:

  • "disable"
  • "enable"

policy_group

string

Имя группы политик.

route_tag

integer

Адрес с тегом маршрута.

sdn

string

SDN. Источник: system.sdn-connector.name.

sdn_addr_type

string

Тип собираемых адресов.

Варианты:

  • "private"
  • "public"
  • "all"

sdn_tag

string

Тег SDN.

sso_attribute_value

list / elements=dictionary

Значения атрибутов RADIUS.

name

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

Значение атрибута RADIUS.

start_ip

string

Первый IP-адрес (включительно) в диапазоне адресов.

start_mac

string

Первый MAC-адрес в диапазоне.

sub_type

string

Подтип адреса.

Варианты:

  • "sdn"
  • "clearpass-spt"
  • "fsso"
  • "rsso"
  • "ems-tag"
  • "fortivoice-tag"
  • "fortinac-tag"
  • "swc-tag"
  • "device-identification"
  • "external-resource"
  • "telemetry"
  • "obsolete"
  • "fortipolicy-tag"

subnet

string

IP-адрес и маска подсети адреса.

subnet_name

string

Имя подсети.

sw_version

string

Динамический адрес с фильтром по версии программного обеспечения.

tag_detection_level

string

Уровень обнаружения тегов динамического объекта адреса.

tag_type

string

Тип тега динамического объекта адреса.

tagging

list / elements=dictionary

Назначение тегов объекту конфигурации.

category

string

Категория тега. Источник: system.object-tagging.category.

name

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

Имя записи назначения тегов.

tags

list / elements=dictionary

Теги.

name

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

Имя тега. Источник: system.object-tagging.tags.name.

tenant

string

Арендатор.

type

string

Тип адреса.

Варианты:

  • "ipmask"
  • "iprange"
  • "fqdn"
  • "geography"
  • "wildcard"
  • "dynamic"
  • "interface-subnet"
  • "mac"
  • "route-tag"
  • "wildcard-fqdn"

uuid

string

Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную).

visibility

string

Включить или отключить отображение адреса в графическом интерфейсе.

Варианты:

  • "enable"
  • "disable"

wildcard

string

IP-адрес и маска подсети с подстановочными знаками.

wildcard_fqdn

string

Полное доменное имя с подстановочными знаками.

member_path

string

Путь к атрибуту-члену, над которым нужно выполнить операцию.

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

Параметр с атрибутом member_path можно использовать для выполнения операций с элементами.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен не рекомендованным к использованию; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure IPv4 addresses.
  fortinet.fortios.fortios_firewall_address:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_address:
          agent_id: "<your_own_value> (source telemetry-controller.agent.agent-id)"
          allow_routing: "enable"
          associated_interface: "<your_own_value> (source system.interface.name system.zone.name)"
          cache_ttl: "0"
          clearpass_spt: "unknown"
          color: "0"
          comment: "Comment."
          country: "<your_own_value>"
          end_ip: "<your_own_value>"
          end_mac: "<your_own_value>"
          epg_name: "<your_own_value>"
          fabric_object: "enable"
          filter: "<your_own_value>"
          fqdn: "<your_own_value>"
          fsso_group:
              -
                  name: "default_name_18 (source user.adgrp.name)"
          hw_model: "<your_own_value>"
          hw_vendor: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          list:
              -
                  ip: "<your_own_value>"
                  net_id: "<your_own_value>"
                  obj_id: "<your_own_value>"
          macaddr:
              -
                  macaddr: "<your_own_value>"
          name: "default_name_28"
          node_ip_only: "enable"
          obj_id: "<your_own_value>"
          obj_tag: "<your_own_value>"
          obj_type: "ip"
          organization: "<your_own_value>"
          os: "<your_own_value>"
          passive_fqdn_learning: "disable"
          policy_group: "<your_own_value>"
          route_tag: "0"
          sdn: "<your_own_value> (source system.sdn-connector.name)"
          sdn_addr_type: "private"
          sdn_tag: "<your_own_value>"
          sso_attribute_value:
              -
                  name: "default_name_42"
          start_ip: "<your_own_value>"
          start_mac: "<your_own_value>"
          sub_type: "sdn"
          subnet: "<your_own_value>"
          subnet_name: "<your_own_value>"
          sw_version: "<your_own_value>"
          tag_detection_level: "<your_own_value>"
          tag_type: "<your_own_value>"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_53"
                  tags:
                      -
                          name: "default_name_55 (source system.object-tagging.tags.name)"
          tenant: "<your_own_value>"
          type: "ipmask"
          uuid: "<your_own_value>"
          visibility: "enable"
          wildcard: "<your_own_value>"
          wildcard_fqdn: "<your_own_value>"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при выполнении последней операции

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

Пример: "200"

mkey

string

Основной ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер редакции

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

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

Пример: "success"

vdom

string

Использованный виртуальный домен

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

Пример: "root"

version

string

Версия FortiGate

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

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

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

© 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/fortios/fortios_firewall_address_module.html

Spec-Zone.ru

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