Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_pm_pkg модуль — Пакет или папка политик.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлен в 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_path

строка / обязательно

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

pm_pkg

словарь

Параметры верхнего уровня.

name

строка / обязательно

Имя.

obj ver

целое число

Устаревшее, пожалуйста, переименуйте в obj_ver. Obj ver.

oid

целое число

Oid.

package setting

словарь

Устаревшее, пожалуйста, переименуйте в package_setting. Настройка пакета.

central-nat

строка

Устаревшее, пожалуйста, переименуйте в central_nat. Центральный nat.

Варианты:

  • "disable"
  • "enable"

consolidated-firewall-mode

строка

Устаревшее, пожалуйста, переименуйте в consolidated_firewall_mode. Объединённый режим брандмауэра.

Варианты:

  • "disable"
  • "enable"

fwpolicy-implicit-log

строка

Устаревшее, пожалуйста, переименуйте в fwpolicy_implicit_log. Неявное протоколирование fwpolicy.

Варианты:

  • "disable"
  • "enable"

fwpolicy6-implicit-log

строка

Устаревшее, пожалуйста, переименуйте в fwpolicy6_implicit_log. Неявное протоколирование fwpolicy6.

Варианты:

  • "disable"
  • "enable"

inspection-mode

строка

Устаревшее, пожалуйста, переименуйте в inspection_mode. Режим инспекции.

Варианты:

  • "proxy"
  • "flow"

ngfw-mode

строка

Устаревшее, пожалуйста, переименуйте в ngfw_mode. Режим NGFW.

Варианты:

  • "profile-based"
  • "policy-based"

ssl-ssh-profile

строка

Устаревшее, пожалуйста, переименуйте в ssl_ssh_profile. Профиль ssl ssh.

package settings

словарь

Устаревшее, пожалуйста, переименуйте в package_settings. Настройки пакета.

central-nat

строка

Устаревшее, пожалуйста, переименуйте в central_nat.

выкл -

вкл -

Варианты:

  • "disable"
  • "enable"

consolidated-firewall-mode

строка

Устаревшее, пожалуйста, переименуйте в consolidated_firewall_mode.

Для пакета политики на основе потоков.

выкл -

вкл -

Варианты:

  • "disable"
  • "enable"
END_OF_DOCUMENT_MARKER

fwpolicy-implicit-log

string

Устаревшее, пожалуйста, переименуйте его на fwpolicy_implicit_log.

disable -

enable -

Варианты:

  • "disable"
  • "enable"

fwpolicy6-implicit-log

string

Устаревшее, пожалуйста, переименуйте его на fwpolicy6_implicit_log.

disable -

enable -

Варианты:

  • "disable"
  • "enable"

inspection-mode

string

Устаревшее, пожалуйста, переименуйте его на inspection_mode.

proxy -

flow -

Варианты:

  • "proxy"
  • "flow"

ngfw-mode

string

Устаревшее, пожалуйста, переименуйте его на ngfw_mode.

Для пакета правил на основе потоков.

profile-based -

policy-based -

Варианты:

  • "profile-based"
  • "policy-based"

policy-offload-level

string

Устаревшее, пожалуйста, переименуйте его на policy_offload_level.

disable -

default -

dos-offload -

full-offload -

Варианты:

  • "disable"
  • "default"
  • "dos-offload"
  • "full-offload"

ssl-ssh-profile

string

Устаревшее, пожалуйста, переименуйте его на ssl_ssh_profile. Профиль SSL-SSH требуется для пакета правил NGFW-режима.

scope member

list / elements=dictionary

Устаревшее, пожалуйста, переименуйте его на scope_member. Член области.

name

string

Имя.

vdom

string

Vdom.

type

string

Тип.

Варианты:

  • "pkg"
  • "folder"

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 (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: Policy package or folder.
      fortinet.fortimanager.fmgr_pm_pkg:
        # 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_path: <your own value>
        state: present # <value in [present, absent]>
        pm_pkg:
          name: <string>
          obj_ver: <integer>
          oid: <integer>
          package_setting:
            central_nat: <value in [disable, enable]>
            consolidated_firewall_mode: <value in [disable, enable]>
            fwpolicy_implicit_log: <value in [disable, enable]>
            fwpolicy6_implicit_log: <value in [disable, enable]>
            inspection_mode: <value in [proxy, flow]>
            ngfw_mode: <value in [profile-based, policy-based]>
            ssl_ssh_profile: <string>
          scope_member:
            -
              name: <string>
              vdom: <string>
          type: <value in [pkg, folder]>
          package_settings:
            central_nat: <value in [disable, enable]>
            consolidated_firewall_mode: <value in [disable, enable]>
            fwpolicy_implicit_log: <value in [disable, enable]>
            fwpolicy6_implicit_log: <value in [disable, enable]>
            inspection_mode: <value in [proxy, flow]>
            ngfw_mode: <value in [profile-based, policy-based]>
            policy_offload_level: <value in [disable, default, dos-offload, ...]>
            ssl_ssh_profile: <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_pm_pkg_module.html

Spec-Zone.ru

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