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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_firewall_ippool.

Новое в fortinet.fortimanager 1.0.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_ippool dictionary	Набор параметров верхнего уровня.
add-nat64-route string	Устарело, переименуйте в add_nat64_route. Включить/отключить добавление маршрута NAT64. Варианты: `"disable"` `"enable"`
arp-intf string	Устарело, переименуйте в arp_intf. Выберите интерфейс из доступных вариантов, который будет отвечать на запросы ARP.
arp-reply string	Устарело, переименуйте в arp_reply. Включить/отключить ответы на запросы ARP при добавлении пула IP к политике Варианты: `"disable"` `"enable"`
associated-interface string	Устарело, переименуйте в associated_interface. Имя связанного интерфейса.
block-size integer	Устарело, переименуйте в block_size. Количество адресов в блоке
cgn-block-size integer	Устарело, переименуйте в cgn_block_size. Количество портов в блоке
cgn-client-endip string	Устарело, переименуйте в cgn_client_endip. Конечный адрес IPv4 клиента
cgn-client-ipv6shift integer	Устарело, переименуйте в cgn_client_ipv6shift. Сдвиг IPv6 для фиксированного выделения.
cgn-client-startip string	Устарело, переименуйте в cgn_client_startip. Начальный адрес IPv4 клиента
cgn-fixedalloc string	Устарело, переименуйте в cgn_fixedalloc. Включить/отключить режим фиксированного выделения. Варианты: `"disable"` `"enable"`
cgn-overload string	Устарело, переименуйте в cgn_overload. Включить/отключить режим перегрузки. Варианты: `"disable"` `"enable"`
cgn-port-end integer	Устарело, переименуйте в cgn_port_end. Конечный общедоступный порт, который может быть выделен.
cgn-port-start integer	Устарело, переименуйте в cgn_port_start. Начальный общедоступный порт, который может быть выделен.
cgn-spa string	Устарело, переименуйте в cgn_spa. Включить/отключить режим выделения одного порта. Варианты: `"disable"` `"enable"`
client-prefix-length integer	Устарело, переименуйте в client_prefix_length. Длина подсети одного детерминированного клиента NAT64
comments string	Комментарий.
dynamic_mapping list / elements=dictionary	Динамическое отображение.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
add-nat64-route string	Устарело, переименуйте в add_nat64_route. Включить/отключить добавление маршрута NAT64. Варианты: `"disable"` `"enable"`
arp-intf string	Устарело, переименуйте в arp_intf. Arp intf.

arp-reply string	Устарело, переименуйте в arp_reply. Ответ ARP. Choices: `"disable"` `"enable"`
associated-interface string	Устарело, переименуйте в associated_interface. Привязанный интерфейс.
block-size integer	Устарело, переименуйте в block_size. Размер блока.
cgn-block-size integer	Устарело, переименуйте в cgn_block_size. Размер блока CGN.
cgn-client-endip string	Устарело, переименуйте в cgn_client_endip. Конечный IP-адрес клиента CGN.
cgn-client-ipv6shift integer	Устарело, переименуйте в cgn_client_ipv6shift. Сдвиг IPv6 для фиксированного распределения.
cgn-client-startip string	Устарело, переименуйте в cgn_client_startip. Начальный IP-адрес клиента CGN.
cgn-fixedalloc string	Устарело, переименуйте в cgn_fixedalloc. Фиксированное распределение CGN. Choices: `"disable"` `"enable"`
cgn-overload string	Устарело, переименуйте в cgn_overload. Перегрузка CGN. Choices: `"disable"` `"enable"`
cgn-port-end integer	Устарело, переименуйте в cgn_port_end. Конечный порт CGN.
cgn-port-start integer	Устарело, переименуйте в cgn_port_start. Начальный порт CGN.
cgn-spa string	Устарело, переименуйте в cgn_spa. CGN SPA. Choices: `"disable"` `"enable"`
client-prefix-length integer	Устарело, переименуйте в client_prefix_length. Длина подсети для одного детерминированного клиента NAT64.
comments string	Комментарии.
endip string	Конечный IP-адрес.
endport integer	Конечный номер порта.
exclude-ip any	(список) Устарело, переименуйте в exclude_ip. Исключить IP-адреса x.
icmp-session-quota integer	Устарело, переименуйте в icmp_session_quota. Максимальное количество одновременных сеансов ICMP, разрешенных для каждого клиента.
nat64 string	Включить/отключить NAT64. Choices: `"disable"` `"enable"`
num-blocks-per-user integer	Устарело, переименуйте в num_blocks_per_user. Количество блоков на пользователя.
pba-interim-log integer	Устарело, переименуйте в pba_interim_log. Интервал ведения журнала промежуточного распределения блоков портов.
pba-timeout integer	Устарело, переименуйте в pba_timeout. Время ожидания PBA.
permit-any-host string	Устарело, переименуйте в permit_any_host. Разрешить любой хост. Choices: `"disable"` `"enable"`
port-per-user integer	Устарело, переименуйте в port_per_user. Количество портов для каждого пользователя.
privileged-port-use-pba string	Устарело, переименуйте в privileged_port_use_pba. Включить/отключить выбор внешнего порта из… Choices: `"disable"` `"enable"`
source-endip string	Устарело, переименуйте в source_endip. Исходный конечный IP-адрес.
source-prefix6 string	Устарело, переименуйте в source_prefix6. Исходная IPv6-сеть для перевода.
source-startip string	Устарело, переименуйте в source_startip. Исходный начальный IP-адрес.

startip string	Начальный IP-адрес.
startport integer	Первый номер порта
subnet-broadcast-in-ippool string	Устарело, переименуйте в subnet_broadcast_in_ippool. Включить/выключить включение адреса подсети и… Choices: `"disable"` `"enable"`
tcp-session-quota integer	Устарело, переименуйте в tcp_session_quota. Максимальное количество одновременных TCP-сессий, разрешенных для одного клиента
type string	Тип. Choices: `"overload"` `"one-to-one"` `"fixed-port-range"` `"port-block-allocation"` `"cgn-resource-allocation"`
udp-session-quota integer	Устарело, переименуйте в udp_session_quota. Максимальное количество одновременных UDP-сессий, разрешенных для одного клиента
utilization-alarm-clear integer	Устарело, переименуйте в utilization_alarm_clear. Сброс оповещения об использовании.
utilization-alarm-raise integer	Устарело, переименуйте в utilization_alarm_raise. Активация оповещения об использовании.
endip string	Последний IPv4-адрес
endport integer	Последний номер порта
exclude-ip any	(list) Устарело, переименуйте в exclude_ip. Исключить IP-адреса x.
icmp-session-quota integer	Устарело, переименуйте в icmp_session_quota. Максимальное количество одновременных ICMP-сессий, разрешенных для одного клиента
name string / required	Имя пула IP-адресов.
nat64 string	Включить/выключить NAT64. Choices: `"disable"` `"enable"`
num-blocks-per-user integer	Устарело, переименуйте в num_blocks_per_user. Количество блоков адресов, которые могут использоваться пользователем
pba-interim-log integer	Устарело, переименуйте в pba_interim_log. Интервал ведения промежуточного журнала выделения блоков портов
pba-timeout integer	Устарело, переименуйте в pba_timeout. Время ожидания выделения блока портов
permit-any-host string	Устарело, переименуйте в permit_any_host. Включить/выключить NAT с полным конусом. Choices: `"disable"` `"enable"`
port-per-user integer	Устарело, переименуйте в port_per_user. Количество портов для каждого пользователя
privileged-port-use-pba string	Устарело, переименуйте в privileged_port_use_pba. Включить/выключить выбор внешнего порта из блока портов… Choices: `"disable"` `"enable"`
source-endip string	Устарело, переименуйте в source_endip. Последний IPv4-адрес
source-prefix6 string	Устарело, переименуйте в source_prefix6. Исходная IPv6-сеть для перевода
source-startip string	Устарело, переименуйте в source_startip. Первый IPv4-адрес
startip string	Первый IPv4-адрес
startport integer	Первый номер порта
subnet-broadcast-in-ippool string	Устарело, переименуйте в subnet_broadcast_in_ippool. Включить/выключить включение адреса подсети и широковещательного… Choices: `"disable"` `"enable"`
tcp-session-quota integer	Устарело, переименуйте в tcp_session_quota. Максимальное количество одновременных TCP-сессий, разрешенных для одного клиента
type string	Тип пула IP-адресов Choices: `"overload"` `"one-to-one"` `"fixed-port-range"` `"port-block-allocation"` `"cgn-resource-allocation"`

udp-session-quota integer	Устарело, переименуйте в udp_session_quota. Максимальное количество одновременных UDP-сессий, разрешенных для одного клиента
utilization-alarm-clear integer	Устарело, переименуйте в utilization_alarm_clear. Пороговое значение для очистки тревоги использования пула
utilization-alarm-raise integer	Устарело, переименуйте в utilization_alarm_raise. Пороговое значение для срабатывания тревоги использования пула
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, с которыми будут переопределены условия успеха.
state string / required	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Вы также можете переопределить условия неудачи или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_ippool_module.html