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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в GUI Fortigate.
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
firewall_address dictionary	Настроить IPv4 адреса.
allow_routing string	Включить/выключить использование этого адреса в конфигурации статического маршрута. Варианты: `"enable"` `"disable"`
associated_interface string	Сеть интерфейса, связанная с адресом. Источник system.interface.name system.zone.name.
cache_ttl integer	Определяет минимальное TTL отдельных IP-адресов в кэше FQDN, измеряемое в секундах.
clearpass_spt string	Значение SPT (System Posture Token). Варианты: `"unknown"` `"healthy"` `"quarantine"` `"checkup"` `"transient"` `"infected"`
color integer	Цвет значка на GUI.
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 / required	Имя группы FSSO. Источник user.adgrp.name.
hw_model string	Соответствие динамического адреса модели оборудования.
hw_vendor string	Соответствие динамического адреса производителю оборудования.
interface string	Имя интерфейса, IP-адрес которого будет использоваться. Источник system.interface.name.
list list / elements=dictionary	Список IP-адресов.
ip string / required	IP.
net_id string	Идентификатор сети.

obj_id string	Идентификатор объекта.
macaddr list / elements=dictionary	Несколько диапазонов MAC-адресов.
macaddr string / required	Диапазоны MAC-адресов <start>[-<end>], разделенные пробелами.
name string / required	Имя адреса.
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	Соответствие динамического адреса операционной системе.
policy_group string	Имя группы политик.
route_tag integer	Адрес route-tag.
sdn string	SDN. Источник system.sdn-connector.name.
sdn_addr_type string	Тип адресов для сбора. Варианты: `"private"` `"public"` `"all"`
sdn_tag string	Тег SDN.
start_ip string	Первый IP-адрес (включительно) в диапазоне для адреса.
start_mac string	Первый MAC-адрес в диапазоне.
sub_type string	Подтип адреса. Варианты: `"sdn"` `"clearpass-spt"` `"fsso"` `"ems-tag"` `"fortivoice-tag"` `"fortinac-tag"` `"fortipolicy-tag"` `"swc-tag"` `"device-identification"`
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.

Имя строка / обязательно	Имя записи тегирования.
Теги список / элементы=словарь	Теги.
Имя строка / обязательно	Имя тега. Источник системы.object-tagging.tags.name.
арендатор строка	Арендатор.
Тип строка	Тип адреса. Варианты: `"ipmask"` `"iprange"` `"fqdn"` `"geography"` `"wildcard"` `"dynamic"` `"interface-subnet"` `"mac"` `"route-tag"` `"wildcard-fqdn"`
uuid строка	Универсальный уникальный идентификатор (UUID; автоматически назначается, но может быть изменён вручную).
Видимость строка	Включить/отключить видимость адреса в графическом интерфейсе. Варианты: `"enable"` `"disable"`
Маска подсети с подстановкой символов строка	IP-адрес и маска подсети с подстановкой символов.
FQDN с подстановкой символов строка	Полное доменное имя с символами подстановки.
Путь к атрибуту члена строка	Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операций над членами.
Состояние члена строка	Добавить или удалить члена по указанному пути к атрибуту. При указании member_state опция state игнорируется. Варианты: `"present"` `"absent"`
Состояние строка / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
Виртуальная область строка	Виртуальная область, определённая ранее. Виртуальная область (vdom) — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, httpapi — предпочтительный способ выполнения playbooks
Модуль поддерживает режим check_mode.

Примеры

- name: Configure IPv4 addresses.
  fortinet.fortios.fortios_firewall_address:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_address:
          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_17 (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_27"
          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>"
          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>"
          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_49"
                  tags:
                      -
                          name: "default_name_51 (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 строка	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, полученный от FortiGate при последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый при последнем вызове FortiGate Возвращается: успешно Пример: `"id"`
name строка	Название таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер версии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_address_module.html