Модуль fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy_cosqueue – Настройка очереди COS.

Примечание

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

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

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

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

Новая версия в 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.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
queue-policy строка	Устарело, используйте «queue_policy»
queue_policy строка	Параметр (queue-policy) в запрошенном URL.
rc_failed список / элементы=целое	Список rc-кодов, с которыми будут переопределены условия для завершения задачи с ошибкой.
rc_succeeded список / элементы=целое	Список rc-кодов, с которыми будут переопределены условия для успешного завершения задачи.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_qos_queuepolicy_cosqueue словарь	Установленные параметры верхнего уровня.
description строка	Описание очереди COS.
drop_policy строка	Устарело, переименуйте на drop_policy. Политика удаления пакетов в очереди COS. Варианты: `"taildrop"` `"weighted-random-early-detection"`
ecn строка	Включение/выключение маркировки пакетов ECN для удаления соответствующих пакетов. Варианты: `"disable"` `"enable"`
max_rate целое	Устарело, переименуйте на max_rate. Максимальная скорость
max_rate_percent целое	Устарело, переименуйте на max_rate_percent. Максимальная скорость
min_rate целое	Устарело, переименуйте на min_rate. Минимальная скорость
min_rate_percent целое	Устарело, переименуйте на min_rate_percent. Минимальная скорость
name строка / обязательно	ID очереди COS.
weight целое	Вес в системе планирования round robin с весами.

END_OF_DOCUMENT_MARKER

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: COS queue configuration.
      fortinet.fortimanager.fmgr_switchcontroller_qos_queuepolicy_cosqueue:
        # 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>
        queue_policy: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_qos_queuepolicy_cosqueue:
          description: <string>
          drop_policy: <value in [taildrop, weighted-random-early-detection]>
          max_rate: <integer>
          min_rate: <integer>
          name: <string>
          weight: <integer>
          max_rate_percent: <integer>
          min_rate_percent: <integer>
          ecn: <value in [disable, enable]>

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

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

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