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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
pkg строка / обязательно	Параметр (pkg) в запрошенном URL.
pkg_firewall_centralsnatmap словарь	Установленные параметры верхнего уровня.
comments строка	Комментарий.
dst_addr любой	(список или строка) Устаревшее имя, замените на dst_addr. Название адреса назначения из доступных адресов.
dst_addr6 любой	(список или строка) Устаревшее имя, замените на dst_addr6. IPv6 адрес назначения.
dst_port строка	Устаревшее имя, замените на dst_port. Порт назначения или диапазон портов
dstintf любой	(список или строка) Название интерфейса назначения из доступных интерфейсов.
nat строка	Включить/выключить исходный NAT. Варианты: `"disable"` `"enable"`
nat_ippool любой	(список или строка) Устаревшее имя, замените на nat_ippool. Имя пулов IP-адресов, которые будут использоваться для перевода адресов из доступ…
nat_ippool6 любой	(список или строка) Устаревшее имя, замените на nat_ippool6. IPv6 пулы, которые будут использоваться для исходного NAT.
nat_port строка	Устаревшее имя, замените на nat_port. Переведённый порт или диапазон портов
nat46 строка	Включить/выключить NAT46. Варианты: `"disable"` `"enable"`
nat64 строка	Включить/выключить NAT64. Варианты: `"disable"` `"enable"`
orig_addr любой	(список или строка) Устаревшее имя, замените на orig_addr. Исходный адрес.
orig_addr6 любой	(список или строка) Устаревшее имя, замените на orig_addr6. IPv6 исходный адрес.
orig_port любой	(целое число или строка) Устаревшее имя, замените на orig_port. Исходный TCP-порт
policyid целое число / обязательно	Идентификатор политики.

END_OF_DOCUMENT_MARKER

port-preserve string	Устарело, пожалуйста, переименуйте его на port_preserve. Включить/отключить сохранение исходного порта источника из исходного NAT, если… Варианты: `"disable"` `"enable"`
protocol integer	Целочисленное значение для типа протокола
srcintf any	(список или строка) Название интерфейса источника из доступных интерфейсов.
status string	Включить/отключить активный статус этой политики. Варианты: `"disable"` `"enable"`
type string	IPv4/IPv6 исходный NAT. Варианты: `"ipv4"` `"ipv6"`
uuid string	Универсальный уникальный идентификатор
proposed_method string	Переопределённый метод для запроса Json RPC ниже. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc-кодов, с помощью которых будут переопределены условия для завершения неудачно.
rc_succeeded list / elements=integer	Список rc-кодов, с помощью которых будут переопределены условия для успешного завершения.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	Область для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая 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 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 словарь	Результат запроса. Возвращается: всегда
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_pkg_firewall_centralsnatmap_module.html