fortinet.fortimanager.fmgr_pkg_header_shapingpolicy – no description

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

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

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_pkg_header_shapingpolicy.

Новое в версии 2.10: of fortinet.fortimanager

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation логическое значение		Варианты: нет ← да	устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров
pkg строка / обязательно			параметр (pkg) в запрошенном URL
pkg_header_shapingpolicy словарь			параметры верхнего уровня
	app-category строка		no description
	app-group строка		no description
	application целое число		no description
	class-id целое число		no description
	comment строка		no description
	diffserv-forward строка	Варианты: disable enable	no description
	diffserv-reverse строка	Варианты: disable enable	no description
	diffservcode-forward строка		no description
	diffservcode-rev строка		no description
	dstaddr строка		no description
	dstaddr6 строка		no description
	dstintf строка		no description
	groups строка		no description
	id целое число		no description
	internet-service строка	Варианты: disable enable	no description
	internet-service-custom строка		no description
	internet-service-custom-group строка		no description
	internet-service-group строка		no description
	internet-service-id строка		no description
	internet-service-src строка	Варианты: disable enable	no description
	internet-service-src-custom строка		no description
	internet-service-src-custom-group строка		no description
	internet-service-src-group строка		no description
	internet-service-src-id строка		no description
	ip-version строка	Варианты: 4 6	no description
	per-ip-shaper строка		no description
	schedule строка		no description
	service строка		no description
	srcaddr строка		no description
	srcaddr6 строка		no description
	srcintf строка		no description
	status строка	Варианты: disable enable	no description
	tos строка		no description
	tos-mask строка		no description
	tos-negate строка	Варианты: disable enable	no description
	traffic-shaper строка		no description
	traffic-shaper-reverse строка		no description
	url-category строка		no description
	users строка		no description
rc_failed список / элементы=строка			список кодов rc, с помощью которых будут переопределены условия неудачи
rc_succeeded список / элементы=строка			список кодов rc, с помощью которых будут переопределены условия успеха
state строка / обязательно		Варианты: present absent	директива для создания, обновления или удаления объекта
workspace_locking_adom строка			ADOM для блокировки для FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая root
workspace_locking_timeout целое число		Значение по умолчанию: 300	максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем

Примечания

Примечание

В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачей, если возвращается ненулевой код rc. Вы также можете переопределить условия неудачи или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_pkg_header_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: <value in [present, absent]>
        pkg_header_shapingpolicy:
           app-category: <value of string>
           app-group: <value of string>
           application: <value of integer>
           class-id: <value of integer>
           comment: <value of string>
           diffserv-forward: <value in [disable, enable]>
           diffserv-reverse: <value in [disable, enable]>
           diffservcode-forward: <value of string>
           diffservcode-rev: <value of string>
           dstaddr: <value of string>
           dstaddr6: <value of string>
           dstintf: <value of string>
           groups: <value of string>
           id: <value of integer>
           internet-service: <value in [disable, enable]>
           internet-service-custom: <value of string>
           internet-service-custom-group: <value of string>
           internet-service-group: <value of string>
           internet-service-id: <value of string>
           internet-service-src: <value in [disable, enable]>
           internet-service-src-custom: <value of string>
           internet-service-src-custom-group: <value of string>
           internet-service-src-group: <value of string>
           internet-service-src-id: <value of string>
           ip-version: <value in [4, 6]>
           per-ip-shaper: <value of string>
           schedule: <value of string>
           service: <value of string>
           srcaddr: <value of string>
           srcaddr6: <value of string>
           srcintf: <value of string>
           status: <value in [disable, enable]>
           tos: <value of string>
           tos-mask: <value of string>
           tos-negate: <value in [disable, enable]>
           traffic-shaper: <value of string>
           traffic-shaper-reverse: <value of string>
           url-category: <value of string>
           users: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный URL запроса Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_pkg_header_shapingpolicy_module.html