fortinet.fortimanager.fmgr_pkg_footer_shapingpolicy модуль — Настройка политик формирования.

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_pkg_footer_shapingpolicy.

Новое в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить перед использованием, используя источники данных.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливать в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиент Ansible с помощью токена доступа к API forticloud.
pkg строка / обязательный	Параметр (pkg) в запрошенном URL.
pkg_footer_shapingpolicy словарь	Настройка параметров верхнего уровня.
app_category любой	(список или строка) Устарело, пожалуйста, переименуйте на app_category. Категория приложения.
app_group любой	(список или строка) Устарело, пожалуйста, переименуйте на app_group. Группа приложений.
application любой	(список) Приложение.
class_id любой	(целое число или строка) Устарело, пожалуйста, переименуйте на class_id. Идентификатор класса.
class_id_reverse целое число	Устарело, пожалуйста, переименуйте на class_id_reverse. Обратный идентификатор класса.
comment строка	Комментарий.
cos строка	Битовая схема VLAN CoS.
cos_mask строка	Устарело, пожалуйста, переименуйте на cos_mask. Оцениваемые биты VLAN CoS.
diffserv_forward строка	Устарело, пожалуйста, переименуйте на diffserv_forward. Diffserv передача. Варианты: `"disable"` `"enable"`
diffserv_reverse строка	Устарело, пожалуйста, переименуйте на diffserv_reverse. Diffserv обратная передача. Варианты: `"disable"` `"enable"`
diffservcode_forward строка	Устарело, пожалуйста, переименуйте на diffservcode_forward. Diffservcode передача.
diffservcode_rev строка	Устарело, пожалуйста, переименуйте на diffservcode_rev. Diffservcode обратная передача.
dstaddr любой	(список или строка) Dstaddr.
dstaddr6 любой	(список или строка) Dstaddr6.
dstintf любой	(список или строка) Dstintf.
groups любой	(список или строка) Группы.
id целое число / обязательный	Идентификатор.

END_OF_DOCUMENT_MARKER

internet-service string	Устарело, переименуйте в internet_service. Интернет-сервис. Choices: `"disable"` `"enable"`
internet-service-custom any	(list or str) Устарело, переименуйте в internet_service_custom. Интернет-сервис, настраиваемый пользователем.
internet-service-custom-group any	(list or str) Устарело, переименуйте в internet_service_custom_group. Группа настраиваемых интернет-сервисов.
internet-service-group any	(list or str) Устарело, переименуйте в internet_service_group. Группа интернет-сервисов.
internet-service-id any	(list or str) Устарело, переименуйте в internet_service_id. Идентификатор интернет-сервиса.
internet-service-name any	(list or str) Устарело, переименуйте в internet_service_name. Имя интернет-сервиса.
internet-service-src string	Устарело, переименуйте в internet_service_src. Исходный интернет-сервис. Choices: `"disable"` `"enable"`
internet-service-src-custom any	(list or str) Устарело, переименуйте в internet_service_src_custom. Настраиваемый исходный интернет-сервис.
internet-service-src-custom-group any	(list or str) Устарело, переименуйте в internet_service_src_custom_group. Группа настраиваемых исходных интернет-сервисов.
internet-service-src-group any	(list or str) Устарело, переименуйте в internet_service_src_group. Группа исходных интернет-сервисов.
internet-service-src-id any	(list or str) Устарело, переименуйте в internet_service_src_id. Идентификатор исходного интернет-сервиса.
internet-service-src-name any	(list or str) Устарело, переименуйте в internet_service_src_name. Имя исходного интернет-сервиса.
ip-version string	Устарело, переименуйте в ip_version. Версия IP. Choices: `"4"` `"6"`
per-ip-shaper string	Устарело, переименуйте в per_ip_shaper. Формирователь на каждый IP-адрес.
schedule string	Расписание.
service any	(list or str) Сервис.
service-type string	Устарело, переименуйте в service_type. Тип сервиса. Choices: `"service"` `"internet-service"`
srcaddr any	(list or str) Исходный адрес.
srcaddr6 any	(list or str) Исходный IPv6 адрес.
srcintf any	(list or str) Исходный интерфейс.
status string	Статус. Choices: `"disable"` `"enable"`
tos string	TOS.

tos-mask string	Устаревшее, пожалуйста, переименуйте его на tos_mask. Маска TOS.
tos-negate string	Устаревшее, пожалуйста, переименуйте его на tos_negate. Отрицание TOS. Варианты: `"disable"` `"enable"`
traffic-shaper string	Устаревшее, пожалуйста, переименуйте его на traffic_shaper. Формирователь трафика.
traffic-shaper-reverse string	Устаревшее, пожалуйста, переименуйте его на traffic_shaper_reverse. Обратный формирователь трафика.
traffic-type string	Устаревшее, пожалуйста, переименуйте его на traffic_type. Тип трафика. Варианты: `"forwarding"` `"local-in"` `"local-out"`
url-category any	(список или строка) Устаревшее, пожалуйста, переименуйте его на url_category. Категория URL.
users any	(список или строка) Пользователи.
uuid string	Уникальный идентификатор.
uuid-idx integer	Устаревшее, пожалуйста, переименуйте его на uuid_idx. Индекс уникального идентификатора.
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: Configure shaping policies.
      fortinet.fortimanager.fmgr_pkg_footer_shapingpolicy:
        # 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, ...]
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_footer_shapingpolicy:
          app_category: <list or string>
          app_group: <list or string>
          application: <list or integer>
          class_id: <integer or string>
          comment: <string>
          diffserv_forward: <value in [disable, enable]>
          diffserv_reverse: <value in [disable, enable]>
          diffservcode_forward: <string>
          diffservcode_rev: <string>
          dstaddr: <list or string>
          dstaddr6: <list or string>
          dstintf: <list or string>
          groups: <list or string>
          id: <integer>
          internet_service: <value in [disable, enable]>
          internet_service_custom: <list or string>
          internet_service_custom_group: <list or string>
          internet_service_group: <list or string>
          internet_service_id: <list or string>
          internet_service_src: <value in [disable, enable]>
          internet_service_src_custom: <list or string>
          internet_service_src_custom_group: <list or string>
          internet_service_src_group: <list or string>
          internet_service_src_id: <list or string>
          ip_version: <value in [4, 6]>
          per_ip_shaper: <string>
          schedule: <string>
          service: <list or string>
          srcaddr: <list or string>
          srcaddr6: <list or string>
          srcintf: <list or string>
          status: <value in [disable, enable]>
          tos: <string>
          tos_mask: <string>
          tos_negate: <value in [disable, enable]>
          traffic_shaper: <string>
          traffic_shaper_reverse: <string>
          url_category: <list or string>
          users: <list or string>
          uuid: <string>
          internet_service_name: <list or string>
          internet_service_src_name: <list or string>
          class_id_reverse: <integer>
          service_type: <value in [service, internet-service]>
          uuid_idx: <integer>
          cos: <string>
          cos_mask: <string>
          traffic_type: <value in [forwarding, local-in, local-out]>

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

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

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