Модуль fortinet.fortimanager.fmgr_pm_pkg_adom — пакет политик или папка.

Примечание

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

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

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

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

Добавлено в 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.
pm_pkg_adom dictionary	Набор параметров верхнего уровня.
name string	Имя.
obj_ver псевдонимы: obj ver integer	Версия объекта.
oid integer	OID.
package_setting псевдонимы: package setting dictionary	Настройка пакета.
central_nat псевдонимы: central-nat string	Централизованное NAT. Варианты: `"disable"` `"enable"`
consolidated_firewall_mode псевдонимы: consolidated-firewall-mode string	Объединённый режим межсетевого экрана. Варианты: `"disable"` `"enable"`
fwpolicy6_implicit_log псевдонимы: fwpolicy6-implicit-log string	Неявное журналирование fwpolicy6. Варианты: `"disable"` `"enable"`
fwpolicy_implicit_log псевдонимы: fwpolicy-implicit-log string	Неявное журналирование fwpolicy. Варианты: `"disable"` `"enable"`
inspection_mode псевдонимы: inspection-mode string	Режим проверки. Варианты: `"proxy"` `"flow"`
ngfw_mode псевдонимы: ngfw-mode string	Режим NGFW. Варианты: `"profile-based"` `"policy-based"`
ssl_ssh_profile псевдонимы: ssl-ssh-profile string	Профиль SSL-SSH.
package_settings псевдонимы: package settings dictionary	Параметры пакета.
central_nat псевдонимы: central-nat string	отключить — включить — Варианты: `"disable"` `"enable"`
consolidated_firewall_mode псевдонимы: consolidated-firewall-mode string	Для пакета политик на основе потока. отключить — включить — Варианты: `"disable"` `"enable"`
fwpolicy6_implicit_log псевдонимы: fwpolicy6-implicit-log string	отключить — включить — Варианты: `"disable"` `"enable"`
fwpolicy_implicit_log псевдонимы: fwpolicy-implicit-log string	отключить — включить — Варианты: `"disable"` `"enable"`
inspection_mode псевдонимы: inspection-mode string	прокси — поток — Варианты: `"proxy"` `"flow"`
ngfw_mode псевдонимы: ngfw-mode string	Для пакета политик на основе потока. на основе профилей — на основе политик — Варианты: `"profile-based"` `"policy-based"`
policy_offload_level псевдонимы: policy-offload-level string	отключить — по умолчанию — выгрузка DoS — полная выгрузка — Варианты: `"disable"` `"default"` `"dos-offload"` `"full-offload"`
ssl_ssh_profile псевдонимы: ssl-ssh-profile string	Профиль SSL-SSH, необходимый для пакета политик в режиме NGFW.
scope_member псевдонимы: scope member list / элементы=dictionary	Элемент области действия.
name string	Имя.
vdom string	VDOM.
type string	Тип. Варианты: `"pkg"` `"folder"`
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия возникновения ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
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.

Примеры

- 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: Create a package in a adom
      fortinet.fortimanager.fmgr_pm_pkg_adom:
        adom: "ansible"
        pm_pkg_adom:
          name: "ansible"
          type: "pkg"

    - name: Create a package in global adom
      fortinet.fortimanager.fmgr_pm_pkg_global:
        pm_pkg_global:
          name: "ansible"
          type: "pkg"

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

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

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