Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_switchcontroller_qos_dot1pmap – Настройка QoS 802 для FortiSwitch

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_switchcontroller_qos_dot1pmap.

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

rc_failed

список / элементы=целое

Список кодов rc, при которых будет переопределено условие ошибки.

rc_succeeded

список / элементы=целое

Список кодов rc, при которых будет переопределено условие успешного завершения.

state

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

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

switchcontroller_qos_dot1pmap

словарь

Настройка параметров верхнего уровня.

description

строка

Описание 802.

egress_pri_tagging

строка

Устарело, пожалуйста, переименуйте на egress_pri_tagging. Включить/выключить метки приоритета исходящего кадра.

Варианты:

  • "disable"
  • "enable"

name

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

Имя карты dot1p.

priority_0

строка

Устарело, пожалуйста, переименуйте на priority_0. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

priority_1

строка

Устарело, пожалуйста, переименуйте на priority_1. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

priority_2

строка

Устарело, пожалуйста, переименуйте на priority_2. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

priority_3

строка

Устарело, пожалуйста, переименуйте на priority_3. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

priority-4

string

Устаревшее, пожалуйста, переименуйте на priority_4. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

priority-5

string

Устаревшее, пожалуйста, переименуйте на priority_5. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

priority-6

string

Устаревшее, пожалуйста, переименуйте на priority_6. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

priority-7

string

Устаревшее, пожалуйста, переименуйте на priority_7. Очередь COS, сопоставленная с номером приоритета dot1p.

Варианты:

  • "queue-0"
  • "queue-1"
  • "queue-2"
  • "queue-3"
  • "queue-4"
  • "queue-5"
  • "queue-6"
  • "queue-7"

workspace_locking_adom

string

ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.

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 FortiSwitch QoS 802.
      fortinet.fortimanager.fmgr_switchcontroller_qos_dot1pmap:
        # 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>
        state: present # <value in [present, absent]>
        switchcontroller_qos_dot1pmap:
          description: <string>
          name: <string>
          priority_0: <value in [queue-0, queue-1, queue-2, ...]>
          priority_1: <value in [queue-0, queue-1, queue-2, ...]>
          priority_2: <value in [queue-0, queue-1, queue-2, ...]>
          priority_3: <value in [queue-0, queue-1, queue-2, ...]>
          priority_4: <value in [queue-0, queue-1, queue-2, ...]>
          priority_5: <value in [queue-0, queue-1, queue-2, ...]>
          priority_6: <value in [queue-0, queue-1, queue-2, ...]>
          priority_7: <value in [queue-0, queue-1, queue-2, ...]>
          egress_pri_tagging: <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_dot1pmap_module.html

Spec-Zone.ru

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