Модуль fortinet.fortimanager.fmgr_pkg_firewall_centralsnatmap — настройка централизованных политик SNAT.

Примечание

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

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

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

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

Добавлено в 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`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
pkg string / обязательный	Параметр (pkg) в запрашиваемом URL.
pkg_firewall_centralsnatmap dictionary	Параметры верхнего уровня.
action string	Действие централизованного SNAT. Варианты: `"bypass"` `"masquerade"` `"ippool"`
comments string	Комментарий.
dst_addr псевдонимы: dst-addr any	(список или строка) Имя адреса назначения из доступных адресов.
dst_addr6 псевдонимы: dst-addr6 any	(список или строка) IPv6-адрес назначения.
dst_port псевдонимы: dst-port string	Порт назначения или диапазон портов
dstintf any	(список или строка) Имя интерфейса назначения из доступных интерфейсов.
ipv6 string	Включить или отключить IPv6. Варианты: `"disable"` `"enable"`
nat string	Включить или отключить исходящий NAT. Варианты: `"disable"` `"enable"`
nat46 string	Включить или отключить NAT46. Варианты: `"disable"` `"enable"`
nat64 string	Включить или отключить NAT64. Варианты: `"disable"` `"enable"`
nat_ippool псевдонимы: nat-ippool any	(список или строка) Имена пулов IP-адресов, используемых для преобразования адресов, из доступных пулов IP-адресов.
nat_ippool6 псевдонимы: nat-ippool6 any	(список или строка) Пулы IPv6, используемые для исходящего NAT.
nat_port псевдонимы: nat-port string	Преобразованный порт или диапазон портов
orig_addr псевдонимы: orig-addr any	(список или строка) Исходный адрес.
orig_addr6 псевдонимы: orig-addr6 any	(список или строка) Исходный IPv6-адрес.
orig_port псевдонимы: orig-port any	(целое число или строка) Исходный порт TCP
policyid integer / обязательный	Идентификатор политики.
port_preserve псевдонимы: port-preserve string	Включить или отключить сохранение исходного порта источника при исходящем NAT, если этот порт не используется. Варианты: `"disable"` `"enable"`
port_random псевдонимы: port-random string	Включить или отключить случайный выбор порта источника для исходящего NAT. Варианты: `"disable"` `"enable"`
protocol integer	Целочисленное значение типа протокола
src_addr псевдонимы: src-addr any	(список) Исходный адрес источника.
src_addr6 псевдонимы: src-addr6 any	(список) Исходный IPv6-адрес источника.
srcintf any	(список или строка) Имя интерфейса источника из доступных интерфейсов.
status string	Включить или отключить активное состояние этой политики. Варианты: `"disable"` `"enable"`
type string	Исходящий NAT для IPv4/IPv6. Варианты: `"ipv4"` `"ipv6"`
uuid string	Универсальный уникальный идентификатор
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=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 central SNAT policies.
      fortinet.fortimanager.fmgr_pkg_firewall_centralsnatmap:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_centralsnatmap:
          dst_addr: "ansible-test1"
          nat: enable
          orig_addr: "ansible-test1"
          policyid: 2
          status: disable

- 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 central SNAT policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_centralsnatmap"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            central_snat_map: "your_value"

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

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

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