fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy46 модуль — Настройка политик IPv4 в IPv6.

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.2.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_hyperscalepolicy46 словарь	Настройка параметров верхнего уровня.
action строка	Принять или отклонить трафик, соответствующий политике. Варианты: `"deny"` `"accept"`
cgn_log_server_grp строка	Устарело, пожалуйста, переименуйте его на cgn_log_server_grp. Имя группы серверов регистрации NP
comments строка	Комментарий.
dstaddr любой	(список или строка) Объекты адресов назначения.
dstintf строка	Имя интерфейса назначения.
name строка	Имя политики.
policy_offload строка	Устарело, пожалуйста, переименуйте на policy_offload. Включить/выключить отгрузку конфигурации политики на процессоры CP. Варианты: `"disable"` `"enable"`
policyid целое число / обязательно	Идентификатор политики
service любой	(список или строка) Имя службы.
srcaddr любой	(список или строка) Объекты адресов источника.
srcintf строка	Имя интерфейса источника.
status строка	Включить/выключить данную политику. Варианты: `"disable"` `"enable"`
tcp_timeout_pid строка	Устарело, пожалуйста, переименуйте на tcp_timeout_pid. Идентификатор профиля таймаута TCP
traffic_shaper строка	Устарело, пожалуйста, переименуйте на traffic_shaper. Формирование трафика.
traffic_shaper_reverse строка	Устарело, пожалуйста, переименуйте на traffic_shaper_reverse. Обратное формирование трафика.

END_OF_DOCUMENT_MARKER

udp-timeout-pid string	Устаревший параметр, пожалуйста, переименуйте его в udp_timeout_pid. Идентификатор профиля таймаута UDP.
uuid string	Универсальный уникальный идентификатор (UUID).
proposed_method string	Переопределённый метод для запроса Json RPC. Выбор: `"update"` `"set"` `"add"`
rc_failed list / элементы=целое число	Список кодов rc, по которым будут переопределены условия для отказа.
rc_succeeded list / элементы=целое число	Список кодов rc, по которым будут переопределены условия для успеха.
state string / обязательно	Направление для создания, обновления или удаления объекта. Выбор: `"present"` `"absent"`
workspace_locking_adom string	Область (ADOM), которая должна быть заблокирована для 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 to IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy46:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_hyperscalepolicy46:
          action: <value in [deny, accept]>
          cgn_log_server_grp: <string>
          comments: <string>
          dstaddr: <list or string>
          dstintf: <string>
          name: <string>
          policy_offload: <value in [disable, enable]>
          policyid: <integer>
          service: <list or string>
          srcaddr: <list or string>
          srcintf: <string>
          status: <value in [disable, enable]>
          tcp_timeout_pid: <string>
          traffic_shaper: <string>
          traffic_shaper_reverse: <string>
          udp_timeout_pid: <string>
          uuid: <string>

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

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

Ключ	Описание
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_hyperscalepolicy46_module.html