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

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_ippool_dynamicmapping.

Добавлен в fortinet.fortimanager 2.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_dynamicmapping 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 reply. Варианты: `"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. Варианты: `"disable"` `"enable"`
cgn-overload string	Устарело, переименуйте в cgn_overload. Перегрузка CGN. Варианты: `"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, разрешенных для каждого клиента

тип строка	Тип. Варианты: `"overload"` `"one-to-one"` `"fixed-port-range"` `"port-block-allocation"` `"cgn-resource-allocation"`
udp-session-quota целое число	Устаревший, пожалуйста, переименуйте его на udp_session_quota. Максимальное количество одновременных UDP-сессий на клиента
utilization-alarm-clear целое число	Устаревший, пожалуйста, переименуйте его на utilization_alarm_clear. Сброс предупреждения по использованию.
utilization-alarm-raise целое число	Устаревший, пожалуйста, переименуйте его на utilization_alarm_raise. Повышение предупреждения по использованию.
forticloud_access_token строка	Авторизуйте Ansible-клиента с помощью токена доступа к API forticloud.
ippool строка / обязательно	Параметр (ippool) в запрошенном URL.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми условия отказа будут переопределены.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми условия успеха будут переопределены.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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 dynamic mappings of IPv4 IP pool
      fortinet.fortimanager.fmgr_firewall_ippool_dynamicmapping:
        bypass_validation: false
        adom: ansible
        ippool: "ansible-test" # name
        state: present
        firewall_ippool_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          comments: "ansible-comment"
          endip: "222.222.222.253"
          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 dynamic mappings of IPv4 IP pool
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ippool_dynamicmapping"
          params:
            adom: "ansible"
            ippool: "ansible-test" # name
            dynamic_mapping: "your_value"

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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_dynamicmapping_module.html