Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_firewall_ippool — Настройка пулов IP-адресов IPv4.

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.14.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_ippool.

Добавлено в fortinet.fortimanager 1.0.0

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

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

enable_log

boolean

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

Варианты:

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

firewall_ippool

dictionary

Набор параметров верхнего уровня.

add_nat64_route

псевдонимы: add-nat64-route

string

Включить/отключить добавление маршрута NAT64.

Варианты:

  • "disable"
  • "enable"

arp_intf

псевдонимы: arp-intf

string

Выберите интерфейс из доступных вариантов, который будет отвечать на запросы ARP.

arp_reply

псевдонимы: arp-reply

string

Включить/отключить ответы на запросы ARP при добавлении IP-пула в политику

Варианты:

  • "disable"
  • "enable"

associated_interface

псевдонимы: associated-interface

string

Имя связанного интерфейса.

block_size

псевдонимы: block-size

integer

Количество адресов в блоке

cgn_block_size

псевдонимы: cgn-block-size

integer

Количество портов в блоке

cgn_client_endip

псевдонимы: cgn-client-endip

string

Последний IPv4-адрес клиента

cgn_client_ipv6shift

псевдонимы: cgn-client-ipv6shift

integer

Смещение IPv6 для режима фиксированного выделения.

cgn_client_startip

псевдонимы: cgn-client-startip

string

Первый IPv4-адрес клиента

cgn_fixedalloc

псевдонимы: cgn-fixedalloc

string

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

Варианты:

  • "disable"
  • "enable"

cgn_overload

псевдонимы: cgn-overload

string

Включить/отключить режим перегрузки.

Варианты:

  • "disable"
  • "enable"

cgn_port_end

псевдонимы: cgn-port-end

integer

Последний номер общедоступного порта, который может быть выделен.

cgn_port_start

псевдонимы: cgn-port-start

integer

Начальный номер общедоступного порта, который может быть выделен.

cgn_spa

псевдонимы: cgn-spa

string

Включить/отключить режим выделения одного порта.

Варианты:

  • "disable"
  • "enable"

client_prefix_length

псевдонимы: client-prefix-length

integer

Длина подсети одного клиента детерминированного NAT64

comments

string

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

dynamic_mapping

list / элементы=dictionary

Динамическое сопоставление.

_scope

list / элементы=dictionary

Область действия.

name

string

Имя.

vdom

string

VDOM.

add_nat64_route

псевдонимы: add-nat64-route

string

Включить/отключить добавление маршрута NAT64.

Варианты:

  • "disable"
  • "enable"

arp_intf

псевдонимы: arp-intf

string

Интерфейс ARP.

arp_reply

псевдонимы: arp-reply

string

Ответ ARP.

Варианты:

  • "disable"
  • "enable"

associated_interface

псевдонимы: associated-interface

string

Связанный интерфейс.

block_size

псевдонимы: block-size

integer

Размер блока.

cgn_block_size

псевдонимы: cgn-block-size

integer

Размер блока CGN.

cgn_client_endip

псевдонимы: cgn-client-endip

string

Конечный IP-адрес клиента CGN.

cgn_client_ipv6shift

псевдонимы: cgn-client-ipv6shift

integer

Смещение IPv6 для режима фиксированного выделения.

cgn_client_startip

псевдонимы: cgn-client-startip

string

Начальный IP-адрес клиента CGN.

cgn_fixedalloc

псевдонимы: cgn-fixedalloc

string

Фиксированное выделение CGN.

Варианты:

  • "disable"
  • "enable"

cgn_overload

псевдонимы: cgn-overload

string

Перегрузка CGN.

Варианты:

  • "disable"
  • "enable"

cgn_port_end

псевдонимы: cgn-port-end

integer

Конечный порт CGN.

cgn_port_start

псевдонимы: cgn-port-start

integer

Начальный порт CGN.

cgn_spa

псевдонимы: cgn-spa

string

SPA CGN.

Варианты:

  • "disable"
  • "enable"

client_prefix_length

псевдонимы: client-prefix-length

integer

Длина подсети одного клиента детерминированного NAT64

comments

string

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

endip

string

Конечный IP-адрес.

endport

integer

Последний номер порта

exclude_ip

псевдонимы: exclude-ip

any

(список) Исключить IP-адреса x.

icmp_session_quota

псевдонимы: icmp-session-quota

integer

Максимальное количество одновременных сеансов ICMP, разрешённых для каждого клиента

nat64

string

Включить/отключить NAT64.

Варианты:

  • "disable"
  • "enable"

num_blocks_per_user

псевдонимы: num-blocks-per-user

integer

Количество блоков на пользователя.

pba_interim_log

псевдонимы: pba-interim-log

integer

Интервал промежуточного журналирования выделения блоков портов

pba_timeout

псевдонимы: pba-timeout

integer

Тайм-аут PBA.

permit_any_host

псевдонимы: permit-any-host

string

Разрешить любой узел.

Варианты:

  • "disable"
  • "enable"

port_per_user

псевдонимы: port-per-user

integer

Количество портов для каждого пользователя

privileged_port_use_pba

псевдонимы: privileged-port-use-pba

string

Включить/отключить выбор внешнего порта из блока выделения портов для трансляции NAT привилегированных портов

Варианты:

  • "disable"
  • "enable"

source_endip

псевдонимы: source-endip

string

Конечный исходный IP-адрес.

source_prefix6

псевдонимы: source-prefix6

string

Исходная сеть IPv6 для трансляции

source_startip

псевдонимы: source-startip

string

Начальный исходный IP-адрес.

startip

string

Начальный IP-адрес.

startport

integer

Первый номер порта

subnet_broadcast_in_ippool

псевдонимы: subnet-broadcast-in-ippool

string

Включить или отключить включение адреса подсети и широковещательного IP-адреса в пул IP-адресов NAT64.

Варианты:

  • "disable"
  • "enable"

tcp_session_quota

псевдонимы: tcp-session-quota

integer

Максимальное количество одновременных сеансов TCP, разрешённых для одного клиента

type

string

Тип.

Варианты:

  • "overload"
  • "one-to-one"
  • "fixed-port-range"
  • "port-block-allocation"
  • "cgn-resource-allocation"

udp_session_quota

псевдонимы: udp-session-quota

integer

Максимальное количество одновременных сеансов UDP, разрешённых для одного клиента

utilization_alarm_clear

псевдонимы: utilization-alarm-clear

integer

Сброс порогового значения сигнала об использовании ресурсов.

utilization_alarm_raise

псевдонимы: utilization-alarm-raise

integer

Пороговое значение срабатывания сигнала об использовании ресурсов.

endip

string

Последний IPv4-адрес

endport

integer

Последний номер порта

exclude_ip

псевдонимы: exclude-ip

any

(список) Исключаемые IP-адреса x.

icmp_session_quota

псевдонимы: icmp-session-quota

integer

Максимальное количество одновременных сеансов ICMP, разрешённых для одного клиента

name

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

Имя пула IP-адресов.

nat64

string

Включить или отключить NAT64.

Варианты:

  • "disable"
  • "enable"

num_blocks_per_user

псевдонимы: num-blocks-per-user

integer

Количество блоков адресов, которые может использовать пользователь

pba_interim_log

псевдонимы: pba-interim-log

integer

Интервал промежуточного журналирования распределения блоков портов

pba_timeout

псевдонимы: pba-timeout

integer

Тайм-аут распределения блоков портов

permit_any_host

псевдонимы: permit-any-host

string

Включить или отключить NAT с полной конусностью.

Варианты:

  • "disable"
  • "enable"

port_per_user

псевдонимы: port-per-user

integer

Количество портов для каждого пользователя

privileged_port_use_pba

псевдонимы: privileged-port-use-pba

string

Включить или отключить выбор внешнего порта из блока, выделенного механизмом распределения блоков портов, для трансляции привилегированных портов

Варианты:

  • "disable"
  • "enable"

source_endip

псевдонимы: source-endip

string

Последний IPv4-адрес

source_prefix6

псевдонимы: source-prefix6

string

Исходная сеть IPv6 для трансляции

source_startip

псевдонимы: source-startip

string

Первый IPv4-адрес

startip

string

Первый IPv4-адрес

startport

integer

Первый номер порта

subnet_broadcast_in_ippool

псевдонимы: subnet-broadcast-in-ippool

string

Включить или отключить включение адреса подсети и широковещательного IP-адреса в пул IP-адресов NAT64.

Варианты:

  • "disable"
  • "enable"

tcp_session_quota

псевдонимы: tcp-session-quota

integer

Максимальное количество одновременных сеансов TCP, разрешённых для одного клиента

type

string

Тип пула IP-адресов

Варианты:

  • "overload"
  • "one-to-one"
  • "fixed-port-range"
  • "port-block-allocation"
  • "cgn-resource-allocation"

udp_session_quota

псевдонимы: udp-session-quota

integer

Максимальное количество одновременных сеансов UDP, разрешённых для одного клиента

utilization_alarm_clear

псевдонимы: utilization-alarm-clear

integer

Порог сброса сигнала об использовании пула

utilization_alarm_raise

псевдонимы: utilization-alarm-raise

integer

Порог срабатывания сигнала об использовании пула

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых переопределяются условия завершения с ошибкой.

rc_succeeded

list / elements=integer

Список кодов rc, для которых переопределяются условия успешного завершения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

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

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другой ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания освобождения блокировки рабочего пространства другим пользователем, в секундах.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы вида «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Чтобы отключить эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочего пространства; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Как правило, выполнение модуля может завершиться с ошибкой, если возвращён ненулевой код rc. Условия завершения с ошибкой или успешного завершения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 IP pools.
      fortinet.fortimanager.fmgr_firewall_ippool:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_ippool:
          comments: "ansible-comment"
          endip: "222.222.222.254"
          name: "ansible-test"
          startip: "222.222.222.0"
          type: overload # <value in [overload, one-to-one, fixed-port-range, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv4 IP pools
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ippool"
          params:
            adom: "ansible"
            ippool: "your_value"

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Текстовое описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / elements=string

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

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

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

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

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

© 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/fortimanager/fmgr_firewall_ippool_module.html

Spec-Zone.ru

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