Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.14.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 / обязательный

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

bypass_validation

boolean

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

Варианты:

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

enable_log

boolean

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

Варианты:

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

firewall_ippool_dynamicmapping

dictionary

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

_scope

list / elements=dictionary

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

name

string

Имя.

vdom

string

VDOM.

add_nat64_route

aliases: add-nat64-route

string

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

Варианты:

  • "disable"
  • "enable"

arp_intf

aliases: arp-intf

string

Интерфейс ARP.

arp_reply

aliases: arp-reply

string

Ответ ARP.

Варианты:

  • "disable"
  • "enable"

associated_interface

aliases: associated-interface

string

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

block_size

aliases: block-size

integer

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

cgn_block_size

aliases: cgn-block-size

integer

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

cgn_client_endip

aliases: cgn-client-endip

string

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

cgn_client_ipv6shift

aliases: cgn-client-ipv6shift

integer

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

cgn_client_startip

aliases: cgn-client-startip

string

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

cgn_fixedalloc

aliases: cgn-fixedalloc

string

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

Варианты:

  • "disable"
  • "enable"

cgn_overload

aliases: cgn-overload

string

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

Варианты:

  • "disable"
  • "enable"

cgn_port_end

aliases: cgn-port-end

integer

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

cgn_port_start

aliases: cgn-port-start

integer

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

cgn_spa

aliases: cgn-spa

string

SPA CGN.

Варианты:

  • "disable"
  • "enable"

client_prefix_length

aliases: client-prefix-length

integer

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

comments

string

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

endip

string

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

endport

integer

Номер последнего порта

exclude_ip

aliases: exclude-ip

any

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

icmp_session_quota

aliases: icmp-session-quota

integer

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

nat64

string

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

Варианты:

  • "disable"
  • "enable"

num_blocks_per_user

aliases: num-blocks-per-user

integer

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

pba_interim_log

aliases: pba-interim-log

integer

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

pba_timeout

aliases: pba-timeout

integer

Тайм-аут PBA.

permit_any_host

aliases: permit-any-host

string

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

Варианты:

  • "disable"
  • "enable"

port_per_user

aliases: port-per-user

integer

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

privileged_port_use_pba

aliases: privileged-port-use-pba

string

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

Варианты:

  • "disable"
  • "enable"

source_endip

aliases: source-endip

string

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

source_prefix6

aliases: source-prefix6

string

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

source_startip

aliases: source-startip

string

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

startip

string

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

startport

integer

Номер первого порта

subnet_broadcast_in_ippool

aliases: subnet-broadcast-in-ippool

string

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

Варианты:

  • "disable"
  • "enable"

tcp_session_quota

aliases: tcp-session-quota

integer

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

type

string

Тип.

Варианты:

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

udp_session_quota

aliases: udp-session-quota

integer

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

utilization_alarm_clear

aliases: utilization-alarm-clear

integer

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

utilization_alarm_raise

aliases: utilization-alarm-raise

integer

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

forticloud_access_token

string

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

ippool

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

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

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 и другие значения, включая 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 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

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_dynamicmapping_module.html

Spec-Zone.ru

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