Модуль fortinet.fortios.fortios_system_ipam — настройка служб управления IP-адресами в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр member_path можно использовать для выполнения операций с элементами.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
system_ipam словарь	Настройка служб управления IP-адресами.
automatic_conflict_resolution строка	Включить или отключить автоматическое разрешение конфликтов. Варианты: `"disable"` `"enable"`
manage_lan_addresses строка	Включить или отключить управление адресами интерфейсов LAN по умолчанию. Варианты: `"disable"` `"enable"`
manage_lan_extension_addresses строка	Включить или отключить управление адресами интерфейсов расширения LAN FortiExtender по умолчанию. Варианты: `"disable"` `"enable"`
manage_ssid_addresses строка	Включить или отключить управление адресами SSID FortiAP по умолчанию. Варианты: `"disable"` `"enable"`
pool_subnet строка	Настройка подсети пула IPAM — подсети классов A–B.
pools список / элементы=словарь	Настройка пулов IPAM.
description строка	Описание.
exclude список / элементы=словарь	Настройка исключаемых подсетей пула.
exclude_subnet строка	Настройка подсети, исключаемой из пула IPAM.
ID целое число / обязательный	ID исключения. См. <a href=’#notes’>примечания</a>.
name строка / обязательный	Имя пула IPAM.
subnet строка	Настройка подсети пула IPAM — подсети классов A–B.
require_subnet_size_match строка	Включить или отключить переназначение подсетей для соответствия запрошенного и фактического размеров. Варианты: `"disable"` `"enable"`
rules список / элементы=словарь	Настройка правил выделения IPAM.
description строка	Описание.
device список / элементы=словарь	Настройка серийного номера или шаблона соответствия FortiGate.
name строка / обязательный	Серийный номер или шаблон FortiGate.
dhcp строка	Включить или отключить DHCP-сервер для соответствующих интерфейсов IPAM. Варианты: `"enable"` `"disable"`
interface список / элементы=словарь	Настройка имени или шаблона соответствия интерфейса.
name строка / обязательный	Имя интерфейса или шаблон.
name строка / обязательный	Имя правила IPAM.
pool список / элементы=словарь	Настройка имени используемого пула IPAM.
name строка / обязательный	Имя пула IPAM. Источник: system.ipam.pools.name.
role строка	Настройка роли интерфейса для поиска соответствия. Варианты: `"any"` `"lan"` `"wan"` `"dmz"` `"undefined"`
server_type строка	Настройка типа используемого сервера IPAM. Варианты: `"fabric-root"` `"cloud"`
status строка	Включить или отключить службы управления IP-адресами. Варианты: `"enable"` `"disable"`
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure IP address management services.
  fortinet.fortios.fortios_system_ipam:
      vdom: "{{ vdom }}"
      system_ipam:
          automatic_conflict_resolution: "disable"
          manage_lan_addresses: "disable"
          manage_lan_extension_addresses: "disable"
          manage_ssid_addresses: "disable"
          pool_subnet: "<your_own_value>"
          pools:
              -
                  description: "<your_own_value>"
                  exclude:
                      -
                          exclude_subnet: "<your_own_value>"
                          ID: "<you_own_value>"
                  name: "default_name_13"
                  subnet: "<your_own_value>"
          require_subnet_size_match: "disable"
          rules:
              -
                  description: "<your_own_value>"
                  device:
                      -
                          name: "default_name_19"
                  dhcp: "enable"
                  interface:
                      -
                          name: "default_name_22"
                  name: "default_name_23"
                  pool:
                      -
                          name: "default_name_25 (source system.ipam.pools.name)"
                  role: "any"
          server_type: "fabric-root"
          status: "enable"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи данных на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Основной ключ (идентификатор), использованный при последнем вызове 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_ipam_module.html