Модуль fortinet.fortios.fortios_system_pcp_server — настройка сведений о сервере PCP в 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_pcp_server.

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с атрибутом member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
system_pcp_server dictionary	Настройка сведений о сервере PCP.
pools list / elements=dictionary	Настройка пулов PCP.
allow_opcode list / elements=string	Разрешённый код операции PCP. Варианты: `"map"` `"peer"` `"announce"`
announcement_count integer	Количество объявлений многоадресной рассылки.
arp_reply string	Включить ответ на ARP-запросы для внешнего IP-адреса. Варианты: `"disable"` `"enable"`
client_mapping_limit integer	Лимит сопоставлений для каждого клиента (0–65535).
client_subnet list / elements=dictionary	Подсети, из которых принимаются запросы PCP.
subnet string / обязательный	Подсети клиента.
description string	Описание.
ext_intf string	Имя внешнего интерфейса. Источник: system.interface.name.
extip string	IP-адрес или диапазон адресов внешнего интерфейса, который необходимо сопоставить с адресом во внутренней сети.
extport string	Диапазон номеров входящих портов, который необходимо сопоставить с номером порта во внутренней сети.
id integer	Идентификатор.
intl_intf list / elements=dictionary	Имя внутреннего интерфейса.
interface_name string / обязательный	Имя интерфейса. Источник: system.interface.name.
mapping_filter_limit integer	Лимит фильтров для каждого сопоставления (0–5).
maximal_lifetime integer	Максимальное время жизни сопоставления PCP в секундах (3600–604800).
minimal_lifetime integer	Минимальное время жизни сопоставления PCP в секундах (60–300).
multicast_announcement string	Включить или отключить объявления многоадресной рассылки. Варианты: `"enable"` `"disable"`
name string / обязательный	Имя пула PCP.
recycle_delay integer	Минимальная задержка (в секундах), в течение которой сервер PCP ожидает перед повторным использованием просроченных сопоставлений (0–3600).
third_party string	Разрешить или запретить параметр third party. Варианты: `"allow"` `"disallow"`
third_party_subnet list / elements=dictionary	Подсети, из которых принимаются запросы третьих сторон.
subnet string / обязательный	Подсети третьих сторон.
status string	Включить или отключить сервер PCP. Варианты: `"enable"` `"disable"`
vdom string	Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure PCP server information.
  fortinet.fortios.fortios_system_pcp_server:
      vdom: "{{ vdom }}"
      system_pcp_server:
          pools:
              -
                  allow_opcode: "map"
                  announcement_count: "3"
                  arp_reply: "disable"
                  client_mapping_limit: "0"
                  client_subnet:
                      -
                          subnet: "<your_own_value>"
                  description: "<your_own_value>"
                  ext_intf: "<your_own_value> (source system.interface.name)"
                  extip: "<your_own_value>"
                  extport: "<your_own_value>"
                  id: "14"
                  intl_intf:
                      -
                          interface_name: "<your_own_value> (source system.interface.name)"
                  mapping_filter_limit: "1"
                  maximal_lifetime: "86400"
                  minimal_lifetime: "120"
                  multicast_announcement: "enable"
                  name: "default_name_21"
                  recycle_delay: "0"
                  third_party: "allow"
                  third_party_subnet:
                      -
                          subnet: "<your_own_value>"
          status: "enable"

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

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

Ключ	Описание
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_system_pcp_server_module.html