fortinet.fortimanager.fmgr_pm_pblock_obj модуль — Блок политики adom

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_pm_pblock_obj.

Добавлена в fortinet.fortimanager 2.1.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_pblock_obj словарь	Настройка параметров верхнего уровня.
name строка / обязательно	Имя.
oid целое число	OID.
package settings словарь	Устаревшее, пожалуйста, переименуйте на package_settings. Параметры пакета.
central_nat строка	Устаревшее, пожалуйста, переименуйте на central_nat. Центральный NAT. Варианты: `"disable"` `"enable"`
consolidated_firewall_mode строка	Устаревшее, пожалуйста, переименуйте на consolidated_firewall_mode. Режим консолидированного брандмауэра. Варианты: `"disable"` `"enable"`
fwpolicy_implicit_log строка	Устаревшее, пожалуйста, переименуйте на fwpolicy_implicit_log. Неявный журнал политики брандмауэра. Варианты: `"disable"` `"enable"`
fwpolicy6_implicit_log строка	Устаревшее, пожалуйста, переименуйте на fwpolicy6_implicit_log. Неявный журнал политики брандмауэра IPv6. Варианты: `"disable"` `"enable"`
inspection_mode строка	Устаревшее, пожалуйста, переименуйте на inspection_mode. Режим проверки. Варианты: `"proxy"` `"flow"`
ngfw_mode строка	Устаревшее, пожалуйста, переименуйте на ngfw_mode. Режим NGFW. Варианты: `"profile-based"` `"policy-based"`
policy_offload_level строка	Устаревшее, пожалуйста, переименуйте на policy_offload_level. Уровень разгрузки политики. Варианты: `"disable"` `"default"` `"dos-offload"` `"full-offload"`
ssl_ssh_profile строка	Устаревшее, пожалуйста, переименуйте на ssl_ssh_profile. Профиль SSL/SSH.
type строка	Тип. Варианты: `"pblock"`
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`

END_OF_DOCUMENT_MARKER

rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут нарушены.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут выполнены.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки FortiManager в режиме рабочего пространства; значение может быть глобальным или другим, включая корневой.
workspace_locking_timeout целое число	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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 block adom
      fortinet.fortimanager.fmgr_pm_pblock_obj:
        # 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_pblock_obj:
          name: <string>
          oid: <integer>
          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>
          type: <value in [pblock]>

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

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

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